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

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

Instance Attribute Summary collapse

Instance Attribute Details

#explain_options ⇒ ::Google::Cloud::Firestore::V1::ExplainOptions

Returns Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

Returns:



463
464
465
466
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 463

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

#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:



463
464
465
466
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 463

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



463
464
465
466
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 463

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.

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.

Returns:

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

    Executes the query at the given timestamp.

    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.



463
464
465
466
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 463

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:



463
464
465
466
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 463

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.



463
464
465
466
 
# File 'proto_docs/google/firestore/v1/firestore.rb', line 463

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