Class PartitionReadRequest.Builder (6.54.0)

public static final class PartitionReadRequest.Builder extends GeneratedMessageV3.Builder<PartitionReadRequest.Builder> implements PartitionReadRequestOrBuilder

The request for PartitionRead

Protobuf type google.spanner.v1.PartitionReadRequest

Static Methods

getDescriptor()

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

Methods

addAllColumns(Iterable<String> values)

public PartitionReadRequest.Builder addAllColumns(Iterable<String> values)

The columns of table to be returned for each row matching this request.

repeated string columns = 5;

Parameter
NameDescription
valuesIterable<String>

The columns to add.

Returns
TypeDescription
PartitionReadRequest.Builder

This builder for chaining.

addColumns(String value)

public PartitionReadRequest.Builder addColumns(String value)

The columns of table to be returned for each row matching this request.

repeated string columns = 5;

Parameter
NameDescription
valueString

The columns to add.

Returns
TypeDescription
PartitionReadRequest.Builder

This builder for chaining.

addColumnsBytes(ByteString value)

public PartitionReadRequest.Builder addColumnsBytes(ByteString value)

The columns of table to be returned for each row matching this request.

repeated string columns = 5;

Parameter
NameDescription
valueByteString

The bytes of the columns to add.

Returns
TypeDescription
PartitionReadRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public PartitionReadRequest build()
Returns
TypeDescription
PartitionReadRequest

buildPartial()

public PartitionReadRequest buildPartial()
Returns
TypeDescription
PartitionReadRequest

clear()

public PartitionReadRequest.Builder clear()
Returns
TypeDescription
PartitionReadRequest.Builder
Overrides

clearColumns()

public PartitionReadRequest.Builder clearColumns()

The columns of table to be returned for each row matching this request.

repeated string columns = 5;

Returns
TypeDescription
PartitionReadRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIndex()

public PartitionReadRequest.Builder clearIndex()

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

string index = 4;

Returns
TypeDescription
PartitionReadRequest.Builder

This builder for chaining.

clearKeySet()

public PartitionReadRequest.Builder clearKeySet()

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
PartitionReadRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPartitionOptions()

public PartitionReadRequest.Builder clearPartitionOptions()

Additional options that affect how many partitions are created.

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

Returns
TypeDescription
PartitionReadRequest.Builder

clearSession()

public PartitionReadRequest.Builder clearSession()

Required. The session used to create the partitions.

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

Returns
TypeDescription
PartitionReadRequest.Builder

This builder for chaining.

clearTable()

public PartitionReadRequest.Builder clearTable()

Required. The name of the table in the database to be read.

string table = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
PartitionReadRequest.Builder

This builder for chaining.

clearTransaction()

public PartitionReadRequest.Builder clearTransaction()

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

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

Returns
TypeDescription
PartitionReadRequest.Builder

clone()

public PartitionReadRequest.Builder clone()
Returns
TypeDescription
PartitionReadRequest.Builder
Overrides

getColumns(int index)

public String getColumns(int index)

The columns of table to be returned for each row matching this request.

repeated string columns = 5;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The columns at the given index.

getColumnsBytes(int index)

public ByteString getColumnsBytes(int index)

The columns of table to be returned for each row matching this request.

repeated string columns = 5;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the columns at the given index.

getColumnsCount()

public int getColumnsCount()

The columns of table to be returned for each row matching this request.

repeated string columns = 5;

Returns
TypeDescription
int

The count of columns.

getColumnsList()

public ProtocolStringList getColumnsList()

The columns of table to be returned for each row matching this request.

repeated string columns = 5;

Returns
TypeDescription
ProtocolStringList

A list containing the columns.

getDefaultInstanceForType()

public PartitionReadRequest getDefaultInstanceForType()
Returns
TypeDescription
PartitionReadRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getIndex()

public String getIndex()

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

string index = 4;

Returns
TypeDescription
String

The index.

getIndexBytes()

public ByteString getIndexBytes()

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

string index = 4;

Returns
TypeDescription
ByteString

The bytes for index.

getKeySet()

public KeySet getKeySet()

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
KeySet

The keySet.

getKeySetBuilder()

public KeySet.Builder getKeySetBuilder()

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
KeySet.Builder

getKeySetOrBuilder()

public KeySetOrBuilder getKeySetOrBuilder()

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
KeySetOrBuilder

getPartitionOptions()

public PartitionOptions getPartitionOptions()

Additional options that affect how many partitions are created.

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

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 = 9;

Returns
TypeDescription
PartitionOptions.Builder

getPartitionOptionsOrBuilder()

public PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()

Additional options that affect how many partitions are created.

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

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

getTable()

public String getTable()

Required. The name of the table in the database to be read.

string table = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The table.

getTableBytes()

public ByteString getTableBytes()

Required. The name of the table in the database to be read.

string table = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for table.

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
TypeDescription
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
TypeDescription
TransactionSelectorOrBuilder

hasKeySet()

public boolean hasKeySet()

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the keySet field is set.

hasPartitionOptions()

public boolean hasPartitionOptions()

Additional options that affect how many partitions are created.

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

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(PartitionReadRequest other)

public PartitionReadRequest.Builder mergeFrom(PartitionReadRequest other)
Parameter
NameDescription
otherPartitionReadRequest
Returns
TypeDescription
PartitionReadRequest.Builder

mergeKeySet(KeySet value)

public PartitionReadRequest.Builder mergeKeySet(KeySet value)

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueKeySet
Returns
TypeDescription
PartitionReadRequest.Builder

mergePartitionOptions(PartitionOptions value)

public PartitionReadRequest.Builder mergePartitionOptions(PartitionOptions value)

Additional options that affect how many partitions are created.

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

Parameter
NameDescription
valuePartitionOptions
Returns
TypeDescription
PartitionReadRequest.Builder

mergeTransaction(TransactionSelector value)

public PartitionReadRequest.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
TypeDescription
PartitionReadRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setColumns(int index, String value)

public PartitionReadRequest.Builder setColumns(int index, String value)

The columns of table to be returned for each row matching this request.

repeated string columns = 5;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The columns to set.

Returns
TypeDescription
PartitionReadRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setIndex(String value)

public PartitionReadRequest.Builder setIndex(String value)

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

string index = 4;

Parameter
NameDescription
valueString

The index to set.

Returns
TypeDescription
PartitionReadRequest.Builder

This builder for chaining.

setIndexBytes(ByteString value)

public PartitionReadRequest.Builder setIndexBytes(ByteString value)

If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

string index = 4;

Parameter
NameDescription
valueByteString

The bytes for index to set.

Returns
TypeDescription
PartitionReadRequest.Builder

This builder for chaining.

setKeySet(KeySet value)

public PartitionReadRequest.Builder setKeySet(KeySet value)

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueKeySet
Returns
TypeDescription
PartitionReadRequest.Builder

setKeySet(KeySet.Builder builderForValue)

public PartitionReadRequest.Builder setKeySet(KeySet.Builder builderForValue)

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

.google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueKeySet.Builder
Returns
TypeDescription
PartitionReadRequest.Builder

setPartitionOptions(PartitionOptions value)

public PartitionReadRequest.Builder setPartitionOptions(PartitionOptions value)

Additional options that affect how many partitions are created.

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

Parameter
NameDescription
valuePartitionOptions
Returns
TypeDescription
PartitionReadRequest.Builder

setPartitionOptions(PartitionOptions.Builder builderForValue)

public PartitionReadRequest.Builder setPartitionOptions(PartitionOptions.Builder builderForValue)

Additional options that affect how many partitions are created.

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

Parameter
NameDescription
builderForValuePartitionOptions.Builder
Returns
TypeDescription
PartitionReadRequest.Builder

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

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

setSession(String value)

public PartitionReadRequest.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
PartitionReadRequest.Builder

This builder for chaining.

setSessionBytes(ByteString value)

public PartitionReadRequest.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
PartitionReadRequest.Builder

This builder for chaining.

setTable(String value)

public PartitionReadRequest.Builder setTable(String value)

Required. The name of the table in the database to be read.

string table = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The table to set.

Returns
TypeDescription
PartitionReadRequest.Builder

This builder for chaining.

setTableBytes(ByteString value)

public PartitionReadRequest.Builder setTableBytes(ByteString value)

Required. The name of the table in the database to be read.

string table = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for table to set.

Returns
TypeDescription
PartitionReadRequest.Builder

This builder for chaining.

setTransaction(TransactionSelector value)

public PartitionReadRequest.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
TypeDescription
PartitionReadRequest.Builder

setTransaction(TransactionSelector.Builder builderForValue)

public PartitionReadRequest.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
TypeDescription
PartitionReadRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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