Struct google_firestore1_beta1::WriteRequest

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 RequestValue for WriteRequest

impl Default for WriteRequest

fn default() -> WriteRequest

Returns the "default value" for a type.

impl Clone for WriteRequest

fn clone(&self) -> WriteRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WriteRequest

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for WriteRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for WriteRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.