Struct gapi_grpc::google::firestore::v1::WriteRequest

pub struct WriteRequest {
    pub database: String,
    pub stream_id: String,
    pub writes: Vec<Write>,
    pub stream_token: Vec<u8>,
    pub labels: HashMap<String, String>,
}

The request for [Firestore.Write][google.firestore.v1.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.

Fields

database: String

Required. The database name. In the format: projects/{project_id}/databases/{database_id}. This is only required in the first message.

stream_id: 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.

writes: 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.

stream_token: Vec<u8>

A stream token that was previously sent by the server.

The client should set this field to the token from the most recent [WriteResponse][google.firestore.v1.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.

labels: HashMap<String, String>

Labels associated with this write request.

Trait Implementations

impl Clone for WriteRequest

fn clone(&self) -> WriteRequest

Returns a copy of the value.

pub 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 Default for WriteRequest

fn default() -> WriteRequest

Returns the “default value” for a type.

impl Message for WriteRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<WriteRequest> for WriteRequest

fn eq(&self, other: &WriteRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WriteRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for WriteRequest