Struct google_firestore1_beta1::WriteRequest [−][src]
pub struct WriteRequest { pub writes: Option<Vec<Write>>, pub labels: Option<HashMap<String, String>>, pub stream_token: Option<String>, pub stream_id: Option<String>, }
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.
Activities
This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).
- databases documents write projects (request)
Fields
writes: Option<Vec<Write>>
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.
labels: Option<HashMap<String, String>>
Labels associated with this write request.
stream_token: Option<String>
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.
stream_id: Option<String>
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.
Trait Implementations
impl Default for WriteRequest
[src]
impl Default for WriteRequest
fn default() -> WriteRequest
[src]
fn default() -> WriteRequest
Returns the "default value" for a type. Read more
impl Clone for WriteRequest
[src]
impl Clone for WriteRequest
fn clone(&self) -> WriteRequest
[src]
fn clone(&self) -> WriteRequest
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for WriteRequest
[src]
impl Debug for WriteRequest
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl RequestValue for WriteRequest
[src]
impl RequestValue for WriteRequest
Auto Trait Implementations
impl Send for WriteRequest
impl Send for WriteRequest
impl Sync for WriteRequest
impl Sync for WriteRequest