Class: Google::Apis::DatastoreV1::RunAggregationQueryRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datastore_v1/classes.rb,
lib/google/apis/datastore_v1/representations.rb,
lib/google/apis/datastore_v1/representations.rb

Overview

The request for Datastore.RunAggregationQuery.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RunAggregationQueryRequest

Returns a new instance of RunAggregationQueryRequest.



2423
2424
2425
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2423

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#aggregation_query ⇒ Google::Apis::DatastoreV1::AggregationQuery

Datastore query for running an aggregation over a Query. Corresponds to the JSON property aggregationQuery

Returns:



2384
2385
2386
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2384

def aggregation_query
  @aggregation_query
end

#database_id ⇒ 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. Corresponds to the JSON property databaseId

Returns:

  • (String) 


2390
2391
2392
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2390

def database_id
  @database_id
end

#gql_query ⇒ Google::Apis::DatastoreV1::GqlQuery

A GQL query. Corresponds to the JSON property gqlQuery

Returns:



2395
2396
2397
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2395

def gql_query
  @gql_query
end

#mode ⇒ String

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. Corresponds to the JSON property mode

Returns:

  • (String) 


2402
2403
2404
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2402

def mode
  @mode
end

#partition_id ⇒ Google::Apis::DatastoreV1::PartitionId

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions:

  • May be "". - Must be valid UTF-8 bytes. - Must have values that match regex [A-Za-z\d\.\-_]1,100`If the value of any dimension matches regex. *, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. Corresponds to the JSON propertypartitionId`

Returns:



2416
2417
2418
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2416

def partition_id
  @partition_id
end

#read_options ⇒ Google::Apis::DatastoreV1::ReadOptions

The options shared by read requests. Corresponds to the JSON property readOptions

Returns:



2421
2422
2423
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2421

def read_options
  @read_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2428

def update!(**args)
  @aggregation_query = args[:aggregation_query] if args.key?(:aggregation_query)
  @database_id = args[:database_id] if args.key?(:database_id)
  @gql_query = args[:gql_query] if args.key?(:gql_query)
  @mode = args[:mode] if args.key?(:mode)
  @partition_id = args[:partition_id] if args.key?(:partition_id)
  @read_options = args[:read_options] if args.key?(:read_options)
end