Class: Google::Cloud::Datastore::V1::RunQueryRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/datastore/v1/datastore.rb

Overview

The request for Datastore.RunQuery.

Instance Attribute Summary collapse

Instance Attribute Details

#database_id ⇒ ::String

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



122
123
124
125
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 122

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

#explain_options ⇒ ::Google::Cloud::Datastore::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:



122
123
124
125
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 122

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

#gql_query ⇒ ::Google::Cloud::Datastore::V1::GqlQuery

Returns The GQL query to run. This query must be a non-aggregation query.

Returns:



122
123
124
125
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 122

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

#partition_id ⇒ ::Google::Cloud::Datastore::V1::PartitionId

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



122
123
124
125
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 122

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

#project_id ⇒ ::String

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



122
123
124
125
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 122

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

#property_mask ⇒ ::Google::Cloud::Datastore::V1::PropertyMask

Returns The properties to return. This field must not be set for a projection query.

See LookupRequest.property_mask.

Returns:



122
123
124
125
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 122

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

#query ⇒ ::Google::Cloud::Datastore::V1::Query

Returns The query to run.

Returns:



122
123
124
125
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 122

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

#read_options ⇒ ::Google::Cloud::Datastore::V1::ReadOptions

Returns The options for this query.

Returns:



122
123
124
125
 
# File 'proto_docs/google/datastore/v1/datastore.rb', line 122

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