Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::RunAggregationQueryRequest (v0.15.0)

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::RunAggregationQueryRequest.

The request for Datastore.RunAggregationQuery.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#aggregation_query

def aggregation_query() -> ::Google::Cloud::Datastore::V1::AggregationQuery
Returns

#aggregation_query=

def aggregation_query=(value) -> ::Google::Cloud::Datastore::V1::AggregationQuery
Parameter
Returns

#database_id

def database_id() -> ::String
Returns
  • (::String) — The ID of the database against which to make the request.

    '(default)' is not allowed; please use empty string '' to refer the default database.

#database_id=

def database_id=(value) -> ::String
Parameter
  • value (::String) — The ID of the database against which to make the request.

    '(default)' is not allowed; please use empty string '' to refer the default database.

Returns
  • (::String) — The ID of the database against which to make the request.

    '(default)' is not allowed; please use empty string '' to refer the default database.

#gql_query

def gql_query() -> ::Google::Cloud::Datastore::V1::GqlQuery
Returns

#gql_query=

def gql_query=(value) -> ::Google::Cloud::Datastore::V1::GqlQuery
Parameter
Returns

#mode

def mode() -> ::Google::Cloud::Datastore::V1::QueryMode
Returns
  • (::Google::Cloud::Datastore::V1::QueryMode) — Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to NORMAL mode where no additional statistics will be returned with the query results.

#mode=

def mode=(value) -> ::Google::Cloud::Datastore::V1::QueryMode
Parameter
  • value (::Google::Cloud::Datastore::V1::QueryMode) — Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to NORMAL mode where no additional statistics will be returned with the query results.
Returns
  • (::Google::Cloud::Datastore::V1::QueryMode) — Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to NORMAL mode where no additional statistics will be returned with the query results.

#partition_id

def partition_id() -> ::Google::Cloud::Datastore::V1::PartitionId
Returns
  • (::Google::Cloud::Datastore::V1::PartitionId) — Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.

#partition_id=

def partition_id=(value) -> ::Google::Cloud::Datastore::V1::PartitionId
Parameter
  • value (::Google::Cloud::Datastore::V1::PartitionId) — Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.
Returns
  • (::Google::Cloud::Datastore::V1::PartitionId) — Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.

#project_id

def project_id() -> ::String
Returns
  • (::String) — Required. The ID of the project against which to make the request.

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::String) — Required. The ID of the project against which to make the request.
Returns
  • (::String) — Required. The ID of the project against which to make the request.

#read_options

def read_options() -> ::Google::Cloud::Datastore::V1::ReadOptions
Returns

#read_options=

def read_options=(value) -> ::Google::Cloud::Datastore::V1::ReadOptions
Parameter
Returns