Class: Google::Cloud::Firestore::V1::RunAggregationQueryRequest

Inherits:

Object

• Object
• Google::Cloud::Firestore::V1::RunAggregationQueryRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/firestore/v1/firestore.rb

Overview

The request for Firestore.RunAggregationQuery.

Instance Attribute Summary

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

  Starts a new transaction as part of the query, defaulting to read-only.

• #parent ⇒ ::String

  Required.

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

  Executes the query at the given timestamp.

• #structured_aggregation_query ⇒ ::Google::Cloud::Firestore::V1::StructuredAggregationQuery

  An aggregation query.

• #transaction ⇒ ::String

  Run the aggregation within an already active transaction.

Instance Attribute Details

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

Returns Starts a new transaction as part of the query, defaulting to read-only.

The new transaction ID will be returned as the first response in the stream.

Returns:

• (::Google::Cloud::Firestore::V1::TransactionOptions) —

  Starts a new transaction as part of the query, defaulting to read-only.

  The new transaction ID will be returned as the first response in the stream.

# File 'proto_docs/google/firestore/v1/firestore.rb', line 439

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

#parent ⇒ ::String

Returns Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom.

Returns:

• (::String) —

  Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

# File 'proto_docs/google/firestore/v1/firestore.rb', line 439

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

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

Returns Executes the query at the given timestamp.

Requires:

• Cannot be more than 270 seconds in the past.

Returns:

• (::Google::Protobuf::Timestamp) —

  Executes the query at the given timestamp.

  Requires:

  • Cannot be more than 270 seconds in the past.

# File 'proto_docs/google/firestore/v1/firestore.rb', line 439

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

#structured_aggregation_query ⇒ ::Google::Cloud::Firestore::V1::StructuredAggregationQuery

Returns An aggregation query.

Returns:

• (::Google::Cloud::Firestore::V1::StructuredAggregationQuery) —

  An aggregation query.

# File 'proto_docs/google/firestore/v1/firestore.rb', line 439

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

#transaction ⇒ ::String

Returns Run the aggregation within an already active transaction.

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

Returns:

• (::String) —

  Run the aggregation within an already active transaction.

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

# File 'proto_docs/google/firestore/v1/firestore.rb', line 439

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