Tinkex.Types.FutureRetrieveRequest (Tinkex v0.4.0)

Copy Markdown View Source

Request to retrieve the result of a future/async operation.

Mirrors Python tinker.types.FutureRetrieveRequest.

Summary

Functions

Parse from JSON map.

Create a new FutureRetrieveRequest.

Convert to JSON-encodable map.

Types

t()

@type t() :: %Tinkex.Types.FutureRetrieveRequest{
  allow_metadata_only: boolean(),
  request_id: String.t()
}

Functions

from_json(json)

@spec from_json(map()) :: t()

Parse from JSON map.

new(request_id, opts \\ [])

@spec new(
  String.t(),
  keyword()
) :: t()

Create a new FutureRetrieveRequest.

to_json(future_retrieve_request)

@spec to_json(t()) :: map()

Convert to JSON-encodable map.