Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::ExecutePipelineRequest (v2.3.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::ExecutePipelineRequest.

The request for Firestore.ExecutePipeline.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#database

def database() -> ::String
Returns
  • (::String) — Required. Database identifier, in the form projects/{project}/databases/{database}.

#database=

def database=(value) -> ::String
Parameter
  • value (::String) — Required. Database identifier, in the form projects/{project}/databases/{database}.
Returns
  • (::String) — Required. Database identifier, in the form projects/{project}/databases/{database}.

#new_transaction

def new_transaction() -> ::Google::Cloud::Firestore::V1::TransactionOptions
Returns
  • (::Google::Cloud::Firestore::V1::TransactionOptions) — Execute the pipeline in a new transaction.

    The identifier of the newly created transaction will be returned in the first response on the stream. This defaults to a read-only transaction.

    Note: The following fields are mutually exclusive: new_transaction, transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

#new_transaction=

def new_transaction=(value) -> ::Google::Cloud::Firestore::V1::TransactionOptions
Parameter
  • value (::Google::Cloud::Firestore::V1::TransactionOptions) — Execute the pipeline in a new transaction.

    The identifier of the newly created transaction will be returned in the first response on the stream. This defaults to a read-only transaction.

    Note: The following fields are mutually exclusive: new_transaction, transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Firestore::V1::TransactionOptions) — Execute the pipeline in a new transaction.

    The identifier of the newly created transaction will be returned in the first response on the stream. This defaults to a read-only transaction.

    Note: The following fields are mutually exclusive: new_transaction, transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

#read_time

def read_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Execute the pipeline in a snapshot transaction at the given time.

    This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

    Note: The following fields are mutually exclusive: read_time, transaction, new_transaction. If a field in that set is populated, all other fields in the set will automatically be cleared.

#read_time=

def read_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — Execute the pipeline in a snapshot transaction at the given time.

    This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

    Note: The following fields are mutually exclusive: read_time, transaction, new_transaction. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Timestamp) — Execute the pipeline in a snapshot transaction at the given time.

    This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

    Note: The following fields are mutually exclusive: read_time, transaction, new_transaction. If a field in that set is populated, all other fields in the set will automatically be cleared.

#structured_pipeline

def structured_pipeline() -> ::Google::Cloud::Firestore::V1::StructuredPipeline
Returns

#structured_pipeline=

def structured_pipeline=(value) -> ::Google::Cloud::Firestore::V1::StructuredPipeline
Parameter
Returns

#transaction

def transaction() -> ::String
Returns
  • (::String) — Run the query within an already active transaction.

    The value here is the opaque transaction ID to execute the query in.

    Note: The following fields are mutually exclusive: transaction, new_transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

#transaction=

def transaction=(value) -> ::String
Parameter
  • value (::String) — Run the query within an already active transaction.

    The value here is the opaque transaction ID to execute the query in.

    Note: The following fields are mutually exclusive: transaction, new_transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Run the query within an already active transaction.

    The value here is the opaque transaction ID to execute the query in.

    Note: The following fields are mutually exclusive: transaction, new_transaction, read_time. If a field in that set is populated, all other fields in the set will automatically be cleared.