Class PartitionQueryRequest.Builder

Version 6.24.0

• 6.80.1 (latest)
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

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

The request for PartitionQuery

Protobuf type google.spanner.v1.PartitionQueryRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PartitionQueryRequest.Builder

Implements

PartitionQueryRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PartitionQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
PartitionQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public PartitionQueryRequest build()

Returns

Type	Description
PartitionQueryRequest

buildPartial()

public PartitionQueryRequest buildPartial()

Returns

Type	Description
PartitionQueryRequest

clear()

public PartitionQueryRequest.Builder clear()

Returns

Type	Description
PartitionQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public PartitionQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
PartitionQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public PartitionQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
PartitionQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParamTypes()

public PartitionQueryRequest.Builder clearParamTypes()

Returns

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;

Returns

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;

Returns

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

Returns

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

Returns

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;

Returns

Type	Description
PartitionQueryRequest.Builder

clone()

public PartitionQueryRequest.Builder clone()

Returns

Type	Description
PartitionQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

Name	Description
key	String

Returns

Type	Description
boolean

getDefaultInstanceForType()

public PartitionQueryRequest getDefaultInstanceForType()

Returns

Type	Description
PartitionQueryRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMutableParamTypes()

public Map<String,Type> getMutableParamTypes()

Use alternate mutation accessors instead.

Returns

Type	Description
Map<String,Type>

getParamTypes()

public Map<String,Type> getParamTypes()

Use #getParamTypesMap() instead.

Returns

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;

Returns

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;

Returns

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;

Parameters

Name	Description
key	String
defaultValue	Type

Returns

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;

Parameter

Name	Description
key	String

Returns

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;

Returns

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;

Returns

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;

Returns

Type	Description
StructOrBuilder

getPartitionOptions()

public PartitionOptions getPartitionOptions()

Additional options that affect how many partitions are created.

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

Returns

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;

Returns

Type	Description
PartitionOptions.Builder

getPartitionOptionsOrBuilder()

public PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()

Additional options that affect how many partitions are created.

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

Returns

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

Returns

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

Returns

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

Returns

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

Returns

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;

Returns

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;

Returns

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;

Returns

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;

Returns

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;

Returns

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;

Returns

Type	Description
boolean	Whether the transaction field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PartitionQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PartitionQueryRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public PartitionQueryRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
PartitionQueryRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(PartitionQueryRequest other)

public PartitionQueryRequest.Builder mergeFrom(PartitionQueryRequest other)

Parameter

Name	Description
other	PartitionQueryRequest

Returns

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;

Parameter

Name	Description
value	Struct

Returns

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;

Parameter

Name	Description
value	PartitionOptions

Returns

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;

Parameter

Name	Description
value	TransactionSelector

Returns

Type	Description
PartitionQueryRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PartitionQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
PartitionQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Name	Description
values	Map<String,Type>

Returns

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;

Parameters

Name	Description
key	String
value	Type

Returns

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;

Parameter

Name	Description
key	String

Returns

Type	Description
PartitionQueryRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PartitionQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
PartitionQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

Name	Description
value	Struct

Returns

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;

Parameter

Name	Description
builderForValue	Builder

Returns

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;

Parameter

Name	Description
value	PartitionOptions

Returns

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;

Parameter

Name	Description
builderForValue	PartitionOptions.Builder

Returns

Type	Description
PartitionQueryRequest.Builder

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
PartitionQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Name	Description
value	String The session to set.

Returns

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

Parameter

Name	Description
value	ByteString The bytes for session to set.

Returns

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

Parameter

Name	Description
value	String The sql to set.

Returns

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

Parameter

Name	Description
value	ByteString The bytes for sql to set.

Returns

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;

Parameter

Name	Description
value	TransactionSelector

Returns

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;

Parameter

Name	Description
builderForValue	TransactionSelector.Builder

Returns

Type	Description
PartitionQueryRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final PartitionQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
PartitionQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)