public static final class PartitionQueryRequest.Builder extends GeneratedMessageV3.Builder<PartitionQueryRequest.Builder> implements PartitionQueryRequestOrBuilderThe request for PartitionQuery
Protobuf type google.spanner.v1.PartitionQueryRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PartitionQueryRequest.BuilderImplements
PartitionQueryRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PartitionQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| PartitionQueryRequest.Builder |
build()
public PartitionQueryRequest build()| Type | Description |
| PartitionQueryRequest |
buildPartial()
public PartitionQueryRequest buildPartial()| Type | Description |
| PartitionQueryRequest |
clear()
public PartitionQueryRequest.Builder clear()| Type | Description |
| PartitionQueryRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public PartitionQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| PartitionQueryRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public PartitionQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| PartitionQueryRequest.Builder |
clearParamTypes()
public PartitionQueryRequest.Builder clearParamTypes()| Type | Description |
| PartitionQueryRequest.Builder |
clearParams()
public PartitionQueryRequest.Builder clearParams() Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the
parameter name (for example, @firstName). Parameter names can contain
letters, numbers, and underscores.
Parameters can appear anywhere that a literal value is expected. The same
parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
.google.protobuf.Struct params = 4;
| Type | Description |
| PartitionQueryRequest.Builder |
clearPartitionOptions()
public PartitionQueryRequest.Builder clearPartitionOptions()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Type | Description |
| PartitionQueryRequest.Builder |
clearSession()
public PartitionQueryRequest.Builder clearSession()Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| PartitionQueryRequest.Builder | This builder for chaining. |
clearSql()
public PartitionQueryRequest.Builder clearSql()Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| PartitionQueryRequest.Builder | This builder for chaining. |
clearTransaction()
public PartitionQueryRequest.Builder clearTransaction()Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Type | Description |
| PartitionQueryRequest.Builder |
clone()
public PartitionQueryRequest.Builder clone()| Type | Description |
| PartitionQueryRequest.Builder |
containsParamTypes(String key)
public boolean containsParamTypes(String key) It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type BYTES and values
of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact
SQL type for some or all of the SQL query parameters. See the
definition of Type for more information
about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Name | Description |
| key | String |
| Type | Description |
| boolean |
getDefaultInstanceForType()
public PartitionQueryRequest getDefaultInstanceForType()| Type | Description |
| PartitionQueryRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getMutableParamTypes()
public Map<String,Type> getMutableParamTypes()Use alternate mutation accessors instead.
| Type | Description |
| Map<String,Type> |
getParamTypes()
public Map<String,Type> getParamTypes()Use #getParamTypesMap() instead.
| Type | Description |
| Map<String,Type> |
getParamTypesCount()
public int getParamTypesCount() It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type BYTES and values
of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact
SQL type for some or all of the SQL query parameters. See the
definition of Type for more information
about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Type | Description |
| int |
getParamTypesMap()
public Map<String,Type> getParamTypesMap() It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type BYTES and values
of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact
SQL type for some or all of the SQL query parameters. See the
definition of Type for more information
about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Type | Description |
| Map<String,Type> |
getParamTypesOrDefault(String key, Type defaultValue)
public Type getParamTypesOrDefault(String key, Type defaultValue) It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type BYTES and values
of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact
SQL type for some or all of the SQL query parameters. See the
definition of Type for more information
about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Name | Description |
| key | String |
| defaultValue | Type |
| Type | Description |
| Type |
getParamTypesOrThrow(String key)
public Type getParamTypesOrThrow(String key) It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type BYTES and values
of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact
SQL type for some or all of the SQL query parameters. See the
definition of Type for more information
about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Name | Description |
| key | String |
| Type | Description |
| Type |
getParams()
public Struct getParams() Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the
parameter name (for example, @firstName). Parameter names can contain
letters, numbers, and underscores.
Parameters can appear anywhere that a literal value is expected. The same
parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
.google.protobuf.Struct params = 4;
| Type | Description |
| Struct | The params. |
getParamsBuilder()
public Struct.Builder getParamsBuilder() Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the
parameter name (for example, @firstName). Parameter names can contain
letters, numbers, and underscores.
Parameters can appear anywhere that a literal value is expected. The same
parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
.google.protobuf.Struct params = 4;
| Type | Description |
| Builder |
getParamsOrBuilder()
public StructOrBuilder getParamsOrBuilder() Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the
parameter name (for example, @firstName). Parameter names can contain
letters, numbers, and underscores.
Parameters can appear anywhere that a literal value is expected. The same
parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
.google.protobuf.Struct params = 4;
| Type | Description |
| StructOrBuilder |
getPartitionOptions()
public PartitionOptions getPartitionOptions()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Type | Description |
| PartitionOptions | The partitionOptions. |
getPartitionOptionsBuilder()
public PartitionOptions.Builder getPartitionOptionsBuilder()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Type | Description |
| PartitionOptions.Builder |
getPartitionOptionsOrBuilder()
public PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Type | Description |
| PartitionOptionsOrBuilder |
getSession()
public String getSession()Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The session. |
getSessionBytes()
public ByteString getSessionBytes()Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| ByteString | The bytes for session. |
getSql()
public String getSql()Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The sql. |
getSqlBytes()
public ByteString getSqlBytes()Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for sql. |
getTransaction()
public TransactionSelector getTransaction()Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Type | Description |
| TransactionSelector | The transaction. |
getTransactionBuilder()
public TransactionSelector.Builder getTransactionBuilder()Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Type | Description |
| TransactionSelector.Builder |
getTransactionOrBuilder()
public TransactionSelectorOrBuilder getTransactionOrBuilder()Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Type | Description |
| TransactionSelectorOrBuilder |
hasParams()
public boolean hasParams() Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the
parameter name (for example, @firstName). Parameter names can contain
letters, numbers, and underscores.
Parameters can appear anywhere that a literal value is expected. The same
parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
.google.protobuf.Struct params = 4;
| Type | Description |
| boolean | Whether the params field is set. |
hasPartitionOptions()
public boolean hasPartitionOptions()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Type | Description |
| boolean | Whether the partitionOptions field is set. |
hasTransaction()
public boolean hasTransaction()Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Type | Description |
| boolean | Whether the transaction field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Name | Description |
| number | int |
| Type | Description |
| MapField |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PartitionQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| PartitionQueryRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public PartitionQueryRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| PartitionQueryRequest.Builder |
mergeFrom(PartitionQueryRequest other)
public PartitionQueryRequest.Builder mergeFrom(PartitionQueryRequest other)| Name | Description |
| other | PartitionQueryRequest |
| Type | Description |
| PartitionQueryRequest.Builder |
mergeParams(Struct value)
public PartitionQueryRequest.Builder mergeParams(Struct value) Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the
parameter name (for example, @firstName). Parameter names can contain
letters, numbers, and underscores.
Parameters can appear anywhere that a literal value is expected. The same
parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
.google.protobuf.Struct params = 4;
| Name | Description |
| value | Struct |
| Type | Description |
| PartitionQueryRequest.Builder |
mergePartitionOptions(PartitionOptions value)
public PartitionQueryRequest.Builder mergePartitionOptions(PartitionOptions value)Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Name | Description |
| value | PartitionOptions |
| Type | Description |
| PartitionQueryRequest.Builder |
mergeTransaction(TransactionSelector value)
public PartitionQueryRequest.Builder mergeTransaction(TransactionSelector value)Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Name | Description |
| value | TransactionSelector |
| Type | Description |
| PartitionQueryRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PartitionQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| PartitionQueryRequest.Builder |
putAllParamTypes(Map<String,Type> values)
public PartitionQueryRequest.Builder putAllParamTypes(Map<String,Type> values) It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type BYTES and values
of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact
SQL type for some or all of the SQL query parameters. See the
definition of Type for more information
about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Name | Description |
| values | Map<String,Type> |
| Type | Description |
| PartitionQueryRequest.Builder |
putParamTypes(String key, Type value)
public PartitionQueryRequest.Builder putParamTypes(String key, Type value) It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type BYTES and values
of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact
SQL type for some or all of the SQL query parameters. See the
definition of Type for more information
about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Name | Description |
| key | String |
| value | Type |
| Type | Description |
| PartitionQueryRequest.Builder |
removeParamTypes(String key)
public PartitionQueryRequest.Builder removeParamTypes(String key) It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type BYTES and values
of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact
SQL type for some or all of the SQL query parameters. See the
definition of Type for more information
about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Name | Description |
| key | String |
| Type | Description |
| PartitionQueryRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public PartitionQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| PartitionQueryRequest.Builder |
setParams(Struct value)
public PartitionQueryRequest.Builder setParams(Struct value) Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the
parameter name (for example, @firstName). Parameter names can contain
letters, numbers, and underscores.
Parameters can appear anywhere that a literal value is expected. The same
parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
.google.protobuf.Struct params = 4;
| Name | Description |
| value | Struct |
| Type | Description |
| PartitionQueryRequest.Builder |
setParams(Struct.Builder builderForValue)
public PartitionQueryRequest.Builder setParams(Struct.Builder builderForValue) Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the
parameter name (for example, @firstName). Parameter names can contain
letters, numbers, and underscores.
Parameters can appear anywhere that a literal value is expected. The same
parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
.google.protobuf.Struct params = 4;
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| PartitionQueryRequest.Builder |
setPartitionOptions(PartitionOptions value)
public PartitionQueryRequest.Builder setPartitionOptions(PartitionOptions value)Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Name | Description |
| value | PartitionOptions |
| Type | Description |
| PartitionQueryRequest.Builder |
setPartitionOptions(PartitionOptions.Builder builderForValue)
public PartitionQueryRequest.Builder setPartitionOptions(PartitionOptions.Builder builderForValue)Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Name | Description |
| builderForValue | PartitionOptions.Builder |
| Type | Description |
| PartitionQueryRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PartitionQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| PartitionQueryRequest.Builder |
setSession(String value)
public PartitionQueryRequest.Builder setSession(String value)Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Name | Description |
| value | StringThe session to set. |
| Type | Description |
| PartitionQueryRequest.Builder | This builder for chaining. |
setSessionBytes(ByteString value)
public PartitionQueryRequest.Builder setSessionBytes(ByteString value)Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Name | Description |
| value | ByteStringThe bytes for session to set. |
| Type | Description |
| PartitionQueryRequest.Builder | This builder for chaining. |
setSql(String value)
public PartitionQueryRequest.Builder setSql(String value)Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | StringThe sql to set. |
| Type | Description |
| PartitionQueryRequest.Builder | This builder for chaining. |
setSqlBytes(ByteString value)
public PartitionQueryRequest.Builder setSqlBytes(ByteString value)Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | ByteStringThe bytes for sql to set. |
| Type | Description |
| PartitionQueryRequest.Builder | This builder for chaining. |
setTransaction(TransactionSelector value)
public PartitionQueryRequest.Builder setTransaction(TransactionSelector value)Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Name | Description |
| value | TransactionSelector |
| Type | Description |
| PartitionQueryRequest.Builder |
setTransaction(TransactionSelector.Builder builderForValue)
public PartitionQueryRequest.Builder setTransaction(TransactionSelector.Builder builderForValue)Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Name | Description |
| builderForValue | TransactionSelector.Builder |
| Type | Description |
| PartitionQueryRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final PartitionQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| PartitionQueryRequest.Builder |