Cloud Bigtable V2 API - Class Google::Cloud::Bigtable::V2::PrepareQueryRequest (v1.10.0)

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

Request message for Bigtable.PrepareQuery

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 preparing the query. Note that this app_profile_id is only used for preparing the query. The actual query execution will use the app profile specified in the ExecuteQueryRequest. 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 preparing the query. Note that this app_profile_id is only used for preparing the query. The actual query execution will use the app profile specified in the ExecuteQueryRequest. If not specified, the default application profile will be used.
Returns
  • (::String) — Optional. This value specifies routing for preparing the query. Note that this app_profile_id is only used for preparing the query. The actual query execution will use the app profile specified in the ExecuteQueryRequest. 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>

#param_types

def param_types() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::V2::Type}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::V2::Type}) — Required. param_types is a map of parameter identifier strings to their Types.

    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 param_types["firstName"] = Bytes then @firstName will be a query parameter of type Bytes. The specific Value to be used for the query execution must be sent in ExecuteQueryRequest in the params map.

#param_types=

def param_types=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::V2::Type}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::V2::Type}) — Required. param_types is a map of parameter identifier strings to their Types.

    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 param_types["firstName"] = Bytes then @firstName will be a query parameter of type Bytes. The specific Value to be used for the query execution must be sent in ExecuteQueryRequest in the params map.

Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::V2::Type}) — Required. param_types is a map of parameter identifier strings to their Types.

    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 param_types["firstName"] = Bytes then @firstName will be a query parameter of type Bytes. The specific Value to be used for the query execution must be sent in ExecuteQueryRequest in the params map.

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