public static final class PrepareQueryRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<PrepareQueryRequest.Builder> implements PrepareQueryRequestOrBuilder
Request message for Bigtable.PrepareQueryProtobuf type
google.bigtable.v2.PrepareQueryRequest| Modifier and Type | Method and Description |
|---|---|
PrepareQueryRequest |
build() |
PrepareQueryRequest |
buildPartial() |
PrepareQueryRequest.Builder |
clear() |
PrepareQueryRequest.Builder |
clearAppProfileId()
Optional.
|
PrepareQueryRequest.Builder |
clearDataFormat() |
PrepareQueryRequest.Builder |
clearInstanceName()
Required.
|
PrepareQueryRequest.Builder |
clearParamTypes() |
PrepareQueryRequest.Builder |
clearProtoFormat()
Protocol buffer format as described by ProtoSchema and ProtoRows
messages.
|
PrepareQueryRequest.Builder |
clearQuery()
Required.
|
boolean |
containsParamTypes(String key)
Required.
|
String |
getAppProfileId()
Optional.
|
com.google.protobuf.ByteString |
getAppProfileIdBytes()
Optional.
|
PrepareQueryRequest.DataFormatCase |
getDataFormatCase() |
PrepareQueryRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getInstanceName()
Required.
|
com.google.protobuf.ByteString |
getInstanceNameBytes()
Required.
|
Map<String,Type> |
getMutableParamTypes()
Deprecated.
|
Map<String,Type> |
getParamTypes()
Deprecated.
|
int |
getParamTypesCount()
Required.
|
Map<String,Type> |
getParamTypesMap()
Required.
|
Type |
getParamTypesOrDefault(String key,
Type defaultValue)
Required.
|
Type |
getParamTypesOrThrow(String key)
Required.
|
ProtoFormat |
getProtoFormat()
Protocol buffer format as described by ProtoSchema and ProtoRows
messages.
|
ProtoFormat.Builder |
getProtoFormatBuilder()
Protocol buffer format as described by ProtoSchema and ProtoRows
messages.
|
ProtoFormatOrBuilder |
getProtoFormatOrBuilder()
Protocol buffer format as described by ProtoSchema and ProtoRows
messages.
|
String |
getQuery()
Required.
|
com.google.protobuf.ByteString |
getQueryBytes()
Required.
|
boolean |
hasProtoFormat()
Protocol buffer format as described by ProtoSchema and ProtoRows
messages.
|
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number) |
boolean |
isInitialized() |
PrepareQueryRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
PrepareQueryRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
PrepareQueryRequest.Builder |
mergeFrom(PrepareQueryRequest other) |
PrepareQueryRequest.Builder |
mergeProtoFormat(ProtoFormat value)
Protocol buffer format as described by ProtoSchema and ProtoRows
messages.
|
PrepareQueryRequest.Builder |
putAllParamTypes(Map<String,Type> values)
Required.
|
PrepareQueryRequest.Builder |
putParamTypes(String key,
Type value)
Required.
|
Type.Builder |
putParamTypesBuilderIfAbsent(String key)
Required.
|
PrepareQueryRequest.Builder |
removeParamTypes(String key)
Required.
|
PrepareQueryRequest.Builder |
setAppProfileId(String value)
Optional.
|
PrepareQueryRequest.Builder |
setAppProfileIdBytes(com.google.protobuf.ByteString value)
Optional.
|
PrepareQueryRequest.Builder |
setInstanceName(String value)
Required.
|
PrepareQueryRequest.Builder |
setInstanceNameBytes(com.google.protobuf.ByteString value)
Required.
|
PrepareQueryRequest.Builder |
setProtoFormat(ProtoFormat.Builder builderForValue)
Protocol buffer format as described by ProtoSchema and ProtoRows
messages.
|
PrepareQueryRequest.Builder |
setProtoFormat(ProtoFormat value)
Protocol buffer format as described by ProtoSchema and ProtoRows
messages.
|
PrepareQueryRequest.Builder |
setQuery(String value)
Required.
|
PrepareQueryRequest.Builder |
setQueryBytes(com.google.protobuf.ByteString value)
Required.
|
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<PrepareQueryRequest.Builder>protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<PrepareQueryRequest.Builder>protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<PrepareQueryRequest.Builder>public PrepareQueryRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessage.Builder<PrepareQueryRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<PrepareQueryRequest.Builder>public PrepareQueryRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic PrepareQueryRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic PrepareQueryRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic PrepareQueryRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PrepareQueryRequest.Builder>public PrepareQueryRequest.Builder mergeFrom(PrepareQueryRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessage.Builder<PrepareQueryRequest.Builder>public PrepareQueryRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PrepareQueryRequest.Builder>IOExceptionpublic PrepareQueryRequest.DataFormatCase getDataFormatCase()
getDataFormatCase in interface PrepareQueryRequestOrBuilderpublic PrepareQueryRequest.Builder clearDataFormat()
public 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 PrepareQueryRequestOrBuilderpublic 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 PrepareQueryRequestOrBuilderpublic PrepareQueryRequest.Builder setInstanceName(String value)
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) = { ... }
value - The instanceName to set.public PrepareQueryRequest.Builder clearInstanceName()
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) = { ... }
public PrepareQueryRequest.Builder setInstanceNameBytes(com.google.protobuf.ByteString value)
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) = { ... }
value - The bytes for instanceName to set.public String getAppProfileId()
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.
string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];getAppProfileId in interface PrepareQueryRequestOrBuilderpublic com.google.protobuf.ByteString getAppProfileIdBytes()
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.
string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];getAppProfileIdBytes in interface PrepareQueryRequestOrBuilderpublic PrepareQueryRequest.Builder setAppProfileId(String value)
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.
string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];value - The appProfileId to set.public PrepareQueryRequest.Builder clearAppProfileId()
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.
string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];public PrepareQueryRequest.Builder setAppProfileIdBytes(com.google.protobuf.ByteString value)
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.
string app_profile_id = 2 [(.google.api.field_behavior) = OPTIONAL];value - The bytes for appProfileId to set.public String getQuery()
Required. The query string.
string query = 3 [(.google.api.field_behavior) = REQUIRED];getQuery in interface PrepareQueryRequestOrBuilderpublic com.google.protobuf.ByteString getQueryBytes()
Required. The query string.
string query = 3 [(.google.api.field_behavior) = REQUIRED];getQueryBytes in interface PrepareQueryRequestOrBuilderpublic PrepareQueryRequest.Builder setQuery(String value)
Required. The query string.
string query = 3 [(.google.api.field_behavior) = REQUIRED];value - The query to set.public PrepareQueryRequest.Builder clearQuery()
Required. The query string.
string query = 3 [(.google.api.field_behavior) = REQUIRED];public PrepareQueryRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
Required. The query string.
string query = 3 [(.google.api.field_behavior) = REQUIRED];value - The bytes for query to set.public boolean hasProtoFormat()
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
.google.bigtable.v2.ProtoFormat proto_format = 4;hasProtoFormat in interface PrepareQueryRequestOrBuilderpublic ProtoFormat getProtoFormat()
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
.google.bigtable.v2.ProtoFormat proto_format = 4;getProtoFormat in interface PrepareQueryRequestOrBuilderpublic PrepareQueryRequest.Builder setProtoFormat(ProtoFormat value)
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
.google.bigtable.v2.ProtoFormat proto_format = 4;public PrepareQueryRequest.Builder setProtoFormat(ProtoFormat.Builder builderForValue)
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
.google.bigtable.v2.ProtoFormat proto_format = 4;public PrepareQueryRequest.Builder mergeProtoFormat(ProtoFormat value)
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
.google.bigtable.v2.ProtoFormat proto_format = 4;public PrepareQueryRequest.Builder clearProtoFormat()
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
.google.bigtable.v2.ProtoFormat proto_format = 4;public ProtoFormat.Builder getProtoFormatBuilder()
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
.google.bigtable.v2.ProtoFormat proto_format = 4;public ProtoFormatOrBuilder getProtoFormatOrBuilder()
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
.google.bigtable.v2.ProtoFormat proto_format = 4;getProtoFormatOrBuilder in interface PrepareQueryRequestOrBuilderpublic int getParamTypesCount()
PrepareQueryRequestOrBuilderRequired. `param_types` is a map of parameter identifier strings to their `Type`s. 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.
map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
getParamTypesCount in interface PrepareQueryRequestOrBuilderpublic boolean containsParamTypes(String key)
Required. `param_types` is a map of parameter identifier strings to their `Type`s. 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.
map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
containsParamTypes in interface PrepareQueryRequestOrBuilder@Deprecated public Map<String,Type> getParamTypes()
getParamTypesMap() instead.getParamTypes in interface PrepareQueryRequestOrBuilderpublic Map<String,Type> getParamTypesMap()
Required. `param_types` is a map of parameter identifier strings to their `Type`s. 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.
map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
getParamTypesMap in interface PrepareQueryRequestOrBuilderpublic Type getParamTypesOrDefault(String key, Type defaultValue)
Required. `param_types` is a map of parameter identifier strings to their `Type`s. 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.
map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
getParamTypesOrDefault in interface PrepareQueryRequestOrBuilderpublic Type getParamTypesOrThrow(String key)
Required. `param_types` is a map of parameter identifier strings to their `Type`s. 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.
map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
getParamTypesOrThrow in interface PrepareQueryRequestOrBuilderpublic PrepareQueryRequest.Builder clearParamTypes()
public PrepareQueryRequest.Builder removeParamTypes(String key)
Required. `param_types` is a map of parameter identifier strings to their `Type`s. 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.
map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
@Deprecated public Map<String,Type> getMutableParamTypes()
public PrepareQueryRequest.Builder putParamTypes(String key, Type value)
Required. `param_types` is a map of parameter identifier strings to their `Type`s. 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.
map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
public PrepareQueryRequest.Builder putAllParamTypes(Map<String,Type> values)
Required. `param_types` is a map of parameter identifier strings to their `Type`s. 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.
map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
public Type.Builder putParamTypesBuilderIfAbsent(String key)
Required. `param_types` is a map of parameter identifier strings to their `Type`s. 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.
map<string, .google.bigtable.v2.Type> param_types = 6 [(.google.api.field_behavior) = REQUIRED];
Copyright © 2026 Google LLC. All rights reserved.