Cloud Bigtable V2 API - Class Google::Cloud::Bigtable::V2::ExecuteQueryRequest (v1.1.0)

Reference documentation and code samples for the Cloud Bigtable V2 API class Google::Cloud::Bigtable::V2::ExecuteQueryRequest.

Request message for Bigtable.ExecuteQuery

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#app_profile_id

def app_profile_id() -> ::String
Returns
  • (::String) — Optional. This value specifies routing for replication. If not specified, the default application profile will be used.

#app_profile_id=

def app_profile_id=(value) -> ::String
Parameter
  • value (::String) — Optional. This value specifies routing for replication. If not specified, the default application profile will be used.
Returns
  • (::String) — Optional. This value specifies routing for replication. If not specified, the default application profile will be used.

#instance_name

def instance_name() -> ::String
Returns
  • (::String) — Required. The unique name of the instance against which the query should be executed. Values are of the form projects/<project>/instances/<instance>

#instance_name=

def instance_name=(value) -> ::String
Parameter
  • value (::String) — Required. The unique name of the instance against which the query should be executed. Values are of the form projects/<project>/instances/<instance>
Returns
  • (::String) — Required. The unique name of the instance against which the query should be executed. Values are of the form projects/<project>/instances/<instance>

#params

def params() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::V2::Value}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::V2::Value}) — Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string. In query string, a parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName) in the query string.

    For example, if params["firstName"] = bytes_value: "foo" type {bytes_type {}} then @firstName will be replaced with googlesql bytes value "foo" in the query string during query evaluation.

    In case of Value.kind is not set, it will be set to corresponding null value in googlesql. params["firstName"] = type {string_type {}} then @firstName will be replaced with googlesql null string.

    Value.type should always be set and no inference of type will be made from Value.kind. If Value.type is not set, we will return INVALID_ARGUMENT error.

#params=

def params=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::V2::Value}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::V2::Value}) — Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string. In query string, a parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName) in the query string.

    For example, if params["firstName"] = bytes_value: "foo" type {bytes_type {}} then @firstName will be replaced with googlesql bytes value "foo" in the query string during query evaluation.

    In case of Value.kind is not set, it will be set to corresponding null value in googlesql. params["firstName"] = type {string_type {}} then @firstName will be replaced with googlesql null string.

    Value.type should always be set and no inference of type will be made from Value.kind. If Value.type is not set, we will return INVALID_ARGUMENT error.

Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::V2::Value}) — Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string. In query string, a parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName) in the query string.

    For example, if params["firstName"] = bytes_value: "foo" type {bytes_type {}} then @firstName will be replaced with googlesql bytes value "foo" in the query string during query evaluation.

    In case of Value.kind is not set, it will be set to corresponding null value in googlesql. params["firstName"] = type {string_type {}} then @firstName will be replaced with googlesql null string.

    Value.type should always be set and no inference of type will be made from Value.kind. If Value.type is not set, we will return INVALID_ARGUMENT error.

#proto_format

def proto_format() -> ::Google::Cloud::Bigtable::V2::ProtoFormat
Returns

#proto_format=

def proto_format=(value) -> ::Google::Cloud::Bigtable::V2::ProtoFormat
Parameter
Returns

#query

def query() -> ::String
Returns
  • (::String) — Required. The query string.

#query=

def query=(value) -> ::String
Parameter
  • value (::String) — Required. The query string.
Returns
  • (::String) — Required. The query string.

#resume_token

def resume_token() -> ::String
Returns
  • (::String) — Optional. If this request is resuming a previously interrupted query execution, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the query execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. Otherwise the request will fail.

#resume_token=

def resume_token=(value) -> ::String
Parameter
  • value (::String) — Optional. If this request is resuming a previously interrupted query execution, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the query execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. Otherwise the request will fail.
Returns
  • (::String) — Optional. If this request is resuming a previously interrupted query execution, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the query execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. Otherwise the request will fail.