View Source GoogleApi.Firestore.V1beta1.Model.Target (google_api_firestore v0.26.0)
A specification of a set of documents to listen to.
Attributes
-
documents
(type:GoogleApi.Firestore.V1beta1.Model.DocumentsTarget.t
, default:nil
) - A target specified by a set of document names. -
expectedCount
(type:integer()
, default:nil
) - The number of documents that last matched the query at the resume token or read time. This value is only relevant when aresume_type
is provided. This value being present and greater than zero signals that the client wantsExistenceFilter.unchanged_names
to be included in the response. -
once
(type:boolean()
, default:nil
) - If the target should be removed once it is current and consistent. -
query
(type:GoogleApi.Firestore.V1beta1.Model.QueryTarget.t
, default:nil
) - A target specified by a query. -
readTime
(type:DateTime.t
, default:nil
) - Start listening after a specificread_time
. The client must know the state of matching documents at this time. -
resumeToken
(type:String.t
, default:nil
) - A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail. -
targetId
(type:integer()
, default:nil
) - The target ID that identifies the target on the stream. Must be a positive number and non-zero. Iftarget_id
is 0 (or unspecified), the server will assign an ID for this target and return that in aTargetChange::ADD
event. Once a target withtarget_id=0
is added, all subsequent targets must also havetarget_id=0
. If anAddTarget
request withtarget_id != 0
is sent to the server after a target withtarget_id=0
is added, the server will immediately send a response with aTargetChange::Remove
event. Note that if the client sends multipleAddTarget
requests without an ID, the order of IDs returned inTargetChage.target_ids
are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one. Iftarget_id
is non-zero, there must not be an existing active target on this stream with the same ID.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Firestore.V1beta1.Model.Target{ documents: GoogleApi.Firestore.V1beta1.Model.DocumentsTarget.t() | nil, expectedCount: integer() | nil, once: boolean() | nil, query: GoogleApi.Firestore.V1beta1.Model.QueryTarget.t() | nil, readTime: DateTime.t() | nil, resumeToken: String.t() | nil, targetId: integer() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.