Class: Google::Apis::DatastoreV1::RunQueryRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RunQueryRequest

Returns a new instance of RunQueryRequest.



2524
2525
2526
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2524

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

Instance Attribute Details

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


2486
2487
2488
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2486

def database_id
  @database_id
end

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

A GQL query. Corresponds to the JSON property gqlQuery

Returns:



2491
2492
2493
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2491

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) 


2498
2499
2500
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2498

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:



2512
2513
2514
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2512

def partition_id
  @partition_id
end

#query ⇒ Google::Apis::DatastoreV1::Query

A query for entities. Corresponds to the JSON property query

Returns:



2517
2518
2519
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2517

def query
  @query
end

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

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

Returns:



2522
2523
2524
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2522

def read_options
  @read_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2529
2530
2531
2532
2533
2534
2535
2536
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2529

def update!(**args)
  @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)
  @query = args[:query] if args.key?(:query)
  @read_options = args[:read_options] if args.key?(:read_options)
end