@Generated public final class ExecuteQueryRequest extends com.google.protobuf.GeneratedMessage implements ExecuteQueryRequestOrBuilder
Request message for Bigtable.ExecuteQueryProtobuf type
google.bigtable.v2.ExecuteQueryRequest| Modifier and Type | Class and Description |
|---|---|
static class |
ExecuteQueryRequest.Builder
Request message for Bigtable.ExecuteQuery
Protobuf type
google.bigtable.v2.ExecuteQueryRequest |
static class |
ExecuteQueryRequest.DataFormatCase |
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
APP_PROFILE_ID_FIELD_NUMBER |
static int |
INSTANCE_NAME_FIELD_NUMBER |
static int |
PARAMS_FIELD_NUMBER |
static int |
PREPARED_QUERY_FIELD_NUMBER |
static int |
PROTO_FORMAT_FIELD_NUMBER |
static int |
QUERY_FIELD_NUMBER |
static int |
RESUME_TOKEN_FIELD_NUMBER |
| 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.
|
boolean |
equals(Object obj) |
String |
getAppProfileId()
Optional.
|
com.google.protobuf.ByteString |
getAppProfileIdBytes()
Optional.
|
ExecuteQueryRequest.DataFormatCase |
getDataFormatCase() |
static ExecuteQueryRequest |
getDefaultInstance() |
ExecuteQueryRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.Parser<ExecuteQueryRequest> |
getParserForType() |
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.
|
int |
getSerializedSize() |
int |
hashCode() |
boolean |
hasProtoFormat()
Deprecated.
google.bigtable.v2.ExecuteQueryRequest.proto_format is deprecated. See
google/bigtable/v2/bigtable.proto;l=1153
|
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static ExecuteQueryRequest.Builder |
newBuilder() |
static ExecuteQueryRequest.Builder |
newBuilder(ExecuteQueryRequest prototype) |
ExecuteQueryRequest.Builder |
newBuilderForType() |
protected ExecuteQueryRequest.Builder |
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) |
static ExecuteQueryRequest |
parseDelimitedFrom(InputStream input) |
static ExecuteQueryRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExecuteQueryRequest |
parseFrom(byte[] data) |
static ExecuteQueryRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExecuteQueryRequest |
parseFrom(ByteBuffer data) |
static ExecuteQueryRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExecuteQueryRequest |
parseFrom(com.google.protobuf.ByteString data) |
static ExecuteQueryRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExecuteQueryRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ExecuteQueryRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ExecuteQueryRequest |
parseFrom(InputStream input) |
static ExecuteQueryRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ExecuteQueryRequest> |
parser() |
ExecuteQueryRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashFields, toStringaddAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int INSTANCE_NAME_FIELD_NUMBER
public static final int APP_PROFILE_ID_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
public static final int PREPARED_QUERY_FIELD_NUMBER
public static final int PROTO_FORMAT_FIELD_NUMBER
public static final int RESUME_TOKEN_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageprotected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessagepublic ExecuteQueryRequest.DataFormatCase getDataFormatCase()
getDataFormatCase in interface ExecuteQueryRequestOrBuilderpublic 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) = { ... }
getInstanceName in interface ExecuteQueryRequestOrBuilderpublic 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) = { ... }
getInstanceNameBytes in interface ExecuteQueryRequestOrBuilderpublic 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];getAppProfileId in interface ExecuteQueryRequestOrBuilderpublic 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];getAppProfileIdBytes in interface ExecuteQueryRequestOrBuilder@Deprecated public String getQuery()
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];getQuery in interface ExecuteQueryRequestOrBuilder@Deprecated public com.google.protobuf.ByteString getQueryBytes()
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];getQueryBytes in interface ExecuteQueryRequestOrBuilderpublic 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;getPreparedQuery in interface ExecuteQueryRequestOrBuilder@Deprecated public boolean hasProtoFormat()
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
.google.bigtable.v2.ProtoFormat proto_format = 4 [deprecated = true];hasProtoFormat in interface ExecuteQueryRequestOrBuilder@Deprecated public ProtoFormat getProtoFormat()
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
.google.bigtable.v2.ProtoFormat proto_format = 4 [deprecated = true];getProtoFormat in interface ExecuteQueryRequestOrBuilder@Deprecated public ProtoFormatOrBuilder getProtoFormatOrBuilder()
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
.google.bigtable.v2.ProtoFormat proto_format = 4 [deprecated = true];getProtoFormatOrBuilder in interface ExecuteQueryRequestOrBuilderpublic 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];getResumeToken in interface ExecuteQueryRequestOrBuilderpublic int getParamsCount()
ExecuteQueryRequestOrBuilder
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];
getParamsCount in interface ExecuteQueryRequestOrBuilderpublic 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];
containsParams in interface ExecuteQueryRequestOrBuilder@Deprecated public Map<String,Value> getParams()
getParamsMap() instead.getParams in interface ExecuteQueryRequestOrBuilderpublic 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];
getParamsMap in interface ExecuteQueryRequestOrBuilderpublic 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];
getParamsOrDefault in interface ExecuteQueryRequestOrBuilderpublic 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];
getParamsOrThrow in interface ExecuteQueryRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessagepublic void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageIOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessagepublic boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ExecuteQueryRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExecuteQueryRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExecuteQueryRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExecuteQueryRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExecuteQueryRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExecuteQueryRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ExecuteQueryRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static ExecuteQueryRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ExecuteQueryRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ExecuteQueryRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ExecuteQueryRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ExecuteQueryRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ExecuteQueryRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ExecuteQueryRequest.Builder newBuilder()
public static ExecuteQueryRequest.Builder newBuilder(ExecuteQueryRequest prototype)
public ExecuteQueryRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ExecuteQueryRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
newBuilderForType in class com.google.protobuf.AbstractMessagepublic static ExecuteQueryRequest getDefaultInstance()
public static com.google.protobuf.Parser<ExecuteQueryRequest> parser()
public com.google.protobuf.Parser<ExecuteQueryRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessagepublic ExecuteQueryRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2026 Google LLC. All rights reserved.