Firestore v1 API - Class WriteRequest (3.2.0) 

public sealed class WriteRequest : IMessage<WriteRequest>, IEquatable<WriteRequest>, IDeepCloneable<WriteRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class WriteRequest.

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.

Inheritance

object > WriteRequest

Namespace

GoogleCloudGoogle.Cloud.FirestoreV1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

WriteRequest()

public WriteRequest()

WriteRequest(WriteRequest)

public WriteRequest(WriteRequest other)
Parameter
NameDescription
otherWriteRequest

Properties

Database

public string Database { get; set; }

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

Property Value
TypeDescription
string

Labels

public MapField<string, string> Labels { get; }

Labels associated with this write request.

Property Value
TypeDescription
MapFieldstringstring

StreamId

public string StreamId { get; set; }

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.

Property Value
TypeDescription
string

StreamToken

public ByteString StreamToken { get; set; }

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.

Property Value
TypeDescription
ByteString

Writes

public RepeatedField<Write> Writes { get; }

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.

Property Value
TypeDescription
RepeatedFieldWrite