com.google.bigtable.v2

Interface ExecuteQueryRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ExecuteQueryRequest, ExecuteQueryRequest.Builder

@Generated
public interface ExecuteQueryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsParams(String key) Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string.
String	getAppProfileId() Optional.
com.google.protobuf.ByteString	getAppProfileIdBytes() Optional.
ExecuteQueryRequest.DataFormatCase	getDataFormatCase()
String	getInstanceName() Required.
com.google.protobuf.ByteString	getInstanceNameBytes() Required.
Map<String,Value>	getParams() Deprecated.
int	getParamsCount() Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string.
Map<String,Value>	getParamsMap() Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string.
Value	getParamsOrDefault(String key, Value defaultValue) Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string.
Value	getParamsOrThrow(String key) Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string.
com.google.protobuf.ByteString	getPreparedQuery() A prepared query that was returned from `PrepareQueryResponse`.
ProtoFormat	getProtoFormat() Deprecated. google.bigtable.v2.ExecuteQueryRequest.proto_format is deprecated. See google/bigtable/v2/bigtable.proto;l=1153
ProtoFormatOrBuilder	getProtoFormatOrBuilder() Deprecated.
String	getQuery() Deprecated. google.bigtable.v2.ExecuteQueryRequest.query is deprecated. See google/bigtable/v2/bigtable.proto;l=1132
com.google.protobuf.ByteString	getQueryBytes() Deprecated. google.bigtable.v2.ExecuteQueryRequest.query is deprecated. See google/bigtable/v2/bigtable.proto;l=1132
com.google.protobuf.ByteString	getResumeToken() Optional.
boolean	hasProtoFormat() Deprecated. google.bigtable.v2.ExecuteQueryRequest.proto_format is deprecated. See google/bigtable/v2/bigtable.proto;l=1153

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getInstanceName

String getInstanceName()

 Required. The unique name of the instance against which the query should be
 executed.
 Values are of the form `projects/<project>/instances/<instance>`
 

string instance_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The instanceName.

getInstanceNameBytes

com.google.protobuf.ByteString getInstanceNameBytes()

 Required. The unique name of the instance against which the query should be
 executed.
 Values are of the form `projects/<project>/instances/<instance>`
 

string instance_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for instanceName.

getAppProfileId

String getAppProfileId()

 Optional. This value specifies routing for replication. If not specified,
 the `default` application profile will be used.
 

string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The appProfileId.

getAppProfileIdBytes

com.google.protobuf.ByteString getAppProfileIdBytes()

 Optional. This value specifies routing for replication. If not specified,
 the `default` application profile will be used.
 

string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for appProfileId.

getQuery

@Deprecated
String getQuery()

Deprecated. google.bigtable.v2.ExecuteQueryRequest.query is deprecated. See google/bigtable/v2/bigtable.proto;l=1132

 Required. The query string.

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

string query = 3 [deprecated = true, (.google.api.field_behavior) = REQUIRED];

Returns:

The query.

getQueryBytes

@Deprecated
com.google.protobuf.ByteString getQueryBytes()

Deprecated. google.bigtable.v2.ExecuteQueryRequest.query is deprecated. See google/bigtable/v2/bigtable.proto;l=1132

 Required. The query string.

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

string query = 3 [deprecated = true, (.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for query.

getPreparedQuery

com.google.protobuf.ByteString getPreparedQuery()

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

bytes prepared_query = 9;

Returns:

The preparedQuery.

hasProtoFormat

@Deprecated
boolean hasProtoFormat()

Deprecated. google.bigtable.v2.ExecuteQueryRequest.proto_format is deprecated. See google/bigtable/v2/bigtable.proto;l=1153

 Protocol buffer format as described by ProtoSchema and ProtoRows
 messages.
 

.google.bigtable.v2.ProtoFormat proto_format = 4 [deprecated = true];

Returns:

Whether the protoFormat field is set.

getProtoFormat

@Deprecated
ProtoFormat getProtoFormat()

Deprecated. google.bigtable.v2.ExecuteQueryRequest.proto_format is deprecated. See google/bigtable/v2/bigtable.proto;l=1153

 Protocol buffer format as described by ProtoSchema and ProtoRows
 messages.
 

.google.bigtable.v2.ProtoFormat proto_format = 4 [deprecated = true];

Returns:

The protoFormat.

getProtoFormatOrBuilder

@Deprecated
ProtoFormatOrBuilder getProtoFormatOrBuilder()

Deprecated.

 Protocol buffer format as described by ProtoSchema and ProtoRows
 messages.
 

.google.bigtable.v2.ProtoFormat proto_format = 4 [deprecated = true];

getResumeToken

com.google.protobuf.ByteString getResumeToken()

 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.
 

bytes resume_token = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The resumeToken.

getParamsCount

int getParamsCount()

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

map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];

containsParams

boolean containsParams(String key)

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

map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];

getParams

@Deprecated
Map<String,Value> getParams()

Deprecated.

Use getParamsMap() instead.

getParamsMap

Map<String,Value> getParamsMap()

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

map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];

getParamsOrDefault

Value getParamsOrDefault(String key,
                         Value defaultValue)

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

map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];

getParamsOrThrow

Value getParamsOrThrow(String key)

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

map<string, .google.bigtable.v2.Value> params = 7 [(.google.api.field_behavior) = REQUIRED];

getDataFormatCase

ExecuteQueryRequest.DataFormatCase getDataFormatCase()