Class: Google::Cloud::Firestore::V1::ExecutePipelineRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/firestore.rb

Overview

The request for Firestore.ExecutePipeline.

Instance Attribute Summary collapse

Instance Attribute Details

#database ⇒ ::String

Returns Required. Database identifier, in the form projects/{project}/databases/{database}.

Returns:

  • (::String) —

    Required. Database identifier, in the form projects/{project}/databases/{database}.



485
486
487
488
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 485

class ExecutePipelineRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#new_transaction ⇒ ::Google::Cloud::Firestore::V1::TransactionOptions

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



485
486
487
488
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 485

class ExecutePipelineRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_time ⇒ ::Google::Protobuf::Timestamp

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



485
486
487
488
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 485

class ExecutePipelineRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#structured_pipeline ⇒ ::Google::Cloud::Firestore::V1::StructuredPipeline

Returns A pipelined operation.

Returns:



485
486
487
488
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 485

class ExecutePipelineRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transaction ⇒ ::String

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



485
486
487
488
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 485

class ExecutePipelineRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end