Class: Google::Firestore::V1beta1::WriteRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#database ⇒ String

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

Returns:

  • (String) —

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



363
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 363

class WriteRequest; end

#labels ⇒ Hash{String => String}

Returns Labels associated with this write request.

Returns:

  • (Hash{String => String}) —

    Labels associated with this write request.



363
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 363

class WriteRequest; end

#stream_id ⇒ String

Returns 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.

Returns:

  • (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.



363
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 363

class WriteRequest; end

#stream_token ⇒ String

Returns 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.

Returns:

  • (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.



363
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 363

class WriteRequest; end

#writes ⇒ Array<Google::Firestore::V1beta1::Write>

Returns 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.

Returns:

  • (Array<Google::Firestore::V1beta1::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.



363
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 363

class WriteRequest; end