GoogleApi.Firestore.V1beta1.Model.WriteRequest (google_api_firestore v0.21.3) View Source

The request for Firestore.Write. The first request creates a stream, or resumes an existing one from a token. When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request. When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.

Attributes

  • labels (type: map(), default: nil) - Labels associated with this write request.
  • streamId (type: String.t, default: nil) - The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.
  • streamToken (type: String.t, default: nil) - A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the stream_id field. Leave this field unset when creating a new stream.
  • writes (type: list(GoogleApi.Firestore.V1beta1.Model.Write.t), default: nil) - The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Firestore.V1beta1.Model.WriteRequest{
  labels: map() | nil,
  streamId: String.t() | nil,
  streamToken: String.t() | nil,
  writes: [GoogleApi.Firestore.V1beta1.Model.Write.t()] | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.