Class PartitionQueryRequest.Builder

public static final class PartitionQueryRequest.Builder extends GeneratedMessageV3.Builder<PartitionQueryRequest.Builder> implements PartitionQueryRequestOrBuilder

The request for PartitionQuery

Protobuf type google.spanner.v1.PartitionQueryRequest

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PartitionQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns Overrides

build()

public PartitionQueryRequest build()
Returns
TypeDescription
PartitionQueryRequest

buildPartial()

public PartitionQueryRequest buildPartial()
Returns
TypeDescription
PartitionQueryRequest

clear()

public PartitionQueryRequest.Builder clear()
Returns Overrides

clearField(Descriptors.FieldDescriptor field)

public PartitionQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PartitionQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns Overrides

clearParamTypes()

public PartitionQueryRequest.Builder clearParamTypes()
Returns

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;

Returns

clearPartitionOptions()

public PartitionQueryRequest.Builder clearPartitionOptions()

Additional options that affect how many partitions are created.

.google.spanner.v1.PartitionOptions partition_options = 6;

Returns

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) = { ... }

Returns
TypeDescription
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];

Returns
TypeDescription
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;

Returns

clone()

public PartitionQueryRequest.Builder clone()
Returns Overrides

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public PartitionQueryRequest getDefaultInstanceForType()
Returns
TypeDescription
PartitionQueryRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMutableParamTypes()

public Map<String,Type> getMutableParamTypes()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Type>

getParamTypes()

public Map<String,Type> getParamTypes()

Use #getParamTypesMap() instead.

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Parameters
NameDescription
keyString
defaultValueType
Returns
TypeDescription
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;

Parameter
NameDescription
keyString
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
StructOrBuilder

getPartitionOptions()

public PartitionOptions getPartitionOptions()

Additional options that affect how many partitions are created.

.google.spanner.v1.PartitionOptions partition_options = 6;

Returns
TypeDescription
PartitionOptions

The partitionOptions.

getPartitionOptionsBuilder()

public PartitionOptions.Builder getPartitionOptionsBuilder()

Additional options that affect how many partitions are created.

.google.spanner.v1.PartitionOptions partition_options = 6;

Returns

getPartitionOptionsOrBuilder()

public PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()

Additional options that affect how many partitions are created.

.google.spanner.v1.PartitionOptions partition_options = 6;

Returns

getSession()

public String getSession()

Required. The session used to create the partitions.

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

Returns
TypeDescription
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) = { ... }

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns

getTransactionOrBuilder()

public TransactionSelectorOrBuilder getTransactionOrBuilder()

Read only snapshot transactions are supported, read/write and single use transactions are not.

.google.spanner.v1.TransactionSelector transaction = 2;

Returns

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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
boolean

Whether the transaction field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PartitionQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PartitionQueryRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns Overrides

mergeFrom(PartitionQueryRequest other)

public PartitionQueryRequest.Builder mergeFrom(PartitionQueryRequest other)
Parameter
NameDescription
otherPartitionQueryRequest
Returns

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;

Parameter
NameDescription
valueStruct
Returns

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;

Parameter
NameDescription
valuePartitionOptions
Returns

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;

Parameter
NameDescription
valueTransactionSelector
Returns

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PartitionQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns Overrides

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;

Parameter
NameDescription
valuesMap<String,Type>
Returns

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;

Parameters
NameDescription
keyString
valueType
Returns

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;

Parameter
NameDescription
keyString
Returns

setField(Descriptors.FieldDescriptor field, Object value)

public PartitionQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns Overrides

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;

Parameter
NameDescription
valueStruct
Returns

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;

Parameter
NameDescription
builderForValueBuilder
Returns

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;

Parameter
NameDescription
valuePartitionOptions
Returns

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;

Parameter
NameDescription
builderForValuePartitionOptions.Builder
Returns

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PartitionQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns Overrides

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) = { ... }

Parameter
NameDescription
valueString

The session to set.

Returns
TypeDescription
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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for session to set.

Returns
TypeDescription
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];

Parameter
NameDescription
valueString

The sql to set.

Returns
TypeDescription
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];

Parameter
NameDescription
valueByteString

The bytes for sql to set.

Returns
TypeDescription
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;

Parameter
NameDescription
valueTransactionSelector
Returns

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;

Parameter
NameDescription
builderForValueTransactionSelector.Builder
Returns

setUnknownFields(UnknownFieldSet unknownFields)

public final PartitionQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns Overrides