Cloud Bigtable V2 API - Class Google::Cloud::Bigtable::V2::ExecuteQueryRequest (v1.10.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.

    If Value.kind is not set, the value is treated as a NULL value of the given type. For example, if params["firstName"] = type {string_type {}} then @firstName will be replaced with googlesql null string.

    If query is set, any empty Value.type in the map will be rejected with INVALID_ARGUMENT.

    If prepared_query is set, any empty Value.type in the map will be inferred from the param_types in the PrepareQueryRequest. Any non-empty Value.type must match the corresponding param_types entry, or be rejected with INVALID_ARGUMENT.

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

    If Value.kind is not set, the value is treated as a NULL value of the given type. For example, if params["firstName"] = type {string_type {}} then @firstName will be replaced with googlesql null string.

    If query is set, any empty Value.type in the map will be rejected with INVALID_ARGUMENT.

    If prepared_query is set, any empty Value.type in the map will be inferred from the param_types in the PrepareQueryRequest. Any non-empty Value.type must match the corresponding param_types entry, or be rejected with INVALID_ARGUMENT.

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.

    If Value.kind is not set, the value is treated as a NULL value of the given type. For example, if params["firstName"] = type {string_type {}} then @firstName will be replaced with googlesql null string.

    If query is set, any empty Value.type in the map will be rejected with INVALID_ARGUMENT.

    If prepared_query is set, any empty Value.type in the map will be inferred from the param_types in the PrepareQueryRequest. Any non-empty Value.type must match the corresponding param_types entry, or be rejected with INVALID_ARGUMENT.

#prepared_query

def prepared_query() -> ::String
Returns
  • (::String) —

    A prepared query that was returned from PrepareQueryResponse.

    Exactly one of query and prepared_query is required. Setting both or neither is an INVALID_ARGUMENT.

    Setting this field also places restrictions on several other fields:

    • data_format must be empty.
    • validate_only must be false.
    • params must match the param_types set in the PrepareQueryRequest.

#prepared_query=

def prepared_query=(value) -> ::String
Parameter
  • value (::String) —

    A prepared query that was returned from PrepareQueryResponse.

    Exactly one of query and prepared_query is required. Setting both or neither is an INVALID_ARGUMENT.

    Setting this field also places restrictions on several other fields:

    • data_format must be empty.
    • validate_only must be false.
    • params must match the param_types set in the PrepareQueryRequest.
Returns
  • (::String) —

    A prepared query that was returned from PrepareQueryResponse.

    Exactly one of query and prepared_query is required. Setting both or neither is an INVALID_ARGUMENT.

    Setting this field also places restrictions on several other fields:

    • data_format must be empty.
    • validate_only must be false.
    • params must match the param_types set in the PrepareQueryRequest.

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

    Exactly one of query and prepared_query is required. Setting both or neither is an INVALID_ARGUMENT.

#query=

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

    Exactly one of query and prepared_query is required. Setting both or neither is an INVALID_ARGUMENT.

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

    Exactly one of query and prepared_query is required. Setting both or neither is an INVALID_ARGUMENT.

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