PartitionReadRequest.Builder (Google Cloud Spanner Parent 6.25.1 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<PartitionReadRequest.Builder>
    - - com.google.spanner.v1.PartitionReadRequest.Builder

All Implemented Interfaces:: Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, PartitionReadRequestOrBuilder, Cloneable

Enclosing class:: PartitionReadRequest

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

 The request for [PartitionRead][google.spanner.v1.Spanner.PartitionRead]

Protobuf type google.spanner.v1.PartitionReadRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PartitionReadRequest.Builder`	`addAllColumns(Iterable<String> values)` The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
`PartitionReadRequest.Builder`	`addColumns(String value)` The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
`PartitionReadRequest.Builder`	`addColumnsBytes(ByteString value)` The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
`PartitionReadRequest.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, Object value)`
`PartitionReadRequest`	`build()`
`PartitionReadRequest`	`buildPartial()`
`PartitionReadRequest.Builder`	`clear()`
`PartitionReadRequest.Builder`	`clearColumns()` The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
`PartitionReadRequest.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`PartitionReadRequest.Builder`	`clearIndex()` If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table].
`PartitionReadRequest.Builder`	`clearKeySet()` Required.
`PartitionReadRequest.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`PartitionReadRequest.Builder`	`clearPartitionOptions()` Additional options that affect how many partitions are created.
`PartitionReadRequest.Builder`	`clearSession()` Required.
`PartitionReadRequest.Builder`	`clearTable()` Required.
`PartitionReadRequest.Builder`	`clearTransaction()` Read only snapshot transactions are supported, read/write and single use transactions are not.
`PartitionReadRequest.Builder`	`clone()`
`String`	`getColumns(int index)` The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
`ByteString`	`getColumnsBytes(int index)` The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
`int`	`getColumnsCount()` The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
`ProtocolStringList`	`getColumnsList()` The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
`PartitionReadRequest`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getIndex()` If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table].
`ByteString`	`getIndexBytes()` If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table].
`KeySet`	`getKeySet()` Required.
`KeySet.Builder`	`getKeySetBuilder()` Required.
`KeySetOrBuilder`	`getKeySetOrBuilder()` Required.
`PartitionOptions`	`getPartitionOptions()` Additional options that affect how many partitions are created.
`PartitionOptions.Builder`	`getPartitionOptionsBuilder()` Additional options that affect how many partitions are created.
`PartitionOptionsOrBuilder`	`getPartitionOptionsOrBuilder()` Additional options that affect how many partitions are created.
`String`	`getSession()` Required.
`ByteString`	`getSessionBytes()` Required.
`String`	`getTable()` Required.
`ByteString`	`getTableBytes()` Required.
`TransactionSelector`	`getTransaction()` Read only snapshot transactions are supported, read/write and single use transactions are not.
`TransactionSelector.Builder`	`getTransactionBuilder()` Read only snapshot transactions are supported, read/write and single use transactions are not.
`TransactionSelectorOrBuilder`	`getTransactionOrBuilder()` Read only snapshot transactions are supported, read/write and single use transactions are not.
`boolean`	`hasKeySet()` Required.
`boolean`	`hasPartitionOptions()` Additional options that affect how many partitions are created.
`boolean`	`hasTransaction()` Read only snapshot transactions are supported, read/write and single use transactions are not.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`PartitionReadRequest.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`PartitionReadRequest.Builder`	`mergeFrom(Message other)`
`PartitionReadRequest.Builder`	`mergeFrom(PartitionReadRequest other)`
`PartitionReadRequest.Builder`	`mergeKeySet(KeySet value)` Required.
`PartitionReadRequest.Builder`	`mergePartitionOptions(PartitionOptions value)` Additional options that affect how many partitions are created.
`PartitionReadRequest.Builder`	`mergeTransaction(TransactionSelector value)` Read only snapshot transactions are supported, read/write and single use transactions are not.
`PartitionReadRequest.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`PartitionReadRequest.Builder`	`setColumns(int index, String value)` The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
`PartitionReadRequest.Builder`	`setField(Descriptors.FieldDescriptor field, Object value)`
`PartitionReadRequest.Builder`	`setIndex(String value)` If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table].
`PartitionReadRequest.Builder`	`setIndexBytes(ByteString value)` If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table].
`PartitionReadRequest.Builder`	`setKeySet(KeySet.Builder builderForValue)` Required.
`PartitionReadRequest.Builder`	`setKeySet(KeySet value)` Required.
`PartitionReadRequest.Builder`	`setPartitionOptions(PartitionOptions.Builder builderForValue)` Additional options that affect how many partitions are created.
`PartitionReadRequest.Builder`	`setPartitionOptions(PartitionOptions value)` Additional options that affect how many partitions are created.
`PartitionReadRequest.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)`
`PartitionReadRequest.Builder`	`setSession(String value)` Required.
`PartitionReadRequest.Builder`	`setSessionBytes(ByteString value)` Required.
`PartitionReadRequest.Builder`	`setTable(String value)` Required.
`PartitionReadRequest.Builder`	`setTableBytes(ByteString value)` Required.
`PartitionReadRequest.Builder`	`setTransaction(TransactionSelector.Builder builderForValue)` Read only snapshot transactions are supported, read/write and single use transactions are not.
`PartitionReadRequest.Builder`	`setTransaction(TransactionSelector value)` Read only snapshot transactions are supported, read/write and single use transactions are not.
`PartitionReadRequest.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

clear
```
public PartitionReadRequest.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

getDefaultInstanceForType
```
public PartitionReadRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public PartitionReadRequest build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public PartitionReadRequest buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public PartitionReadRequest.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

setField

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

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

clearField
```
public PartitionReadRequest.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

clearOneof
```
public PartitionReadRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

setRepeatedField

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

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

addRepeatedField

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

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

mergeFrom
```
public PartitionReadRequest.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<PartitionReadRequest.Builder>

mergeFrom

public PartitionReadRequest.Builder mergeFrom(PartitionReadRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<PartitionReadRequest.Builder>

mergeFrom

public PartitionReadRequest.Builder mergeFrom(CodedInputStream input,
                                              ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<PartitionReadRequest.Builder>
Throws:: IOException

getSession
```
public String getSession()
```
```
 Required. The session used to create the partitions.
 
```
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getSession in interface PartitionReadRequestOrBuilder

Returns:

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

getSessionBytes in interface PartitionReadRequestOrBuilder

Returns:

The bytes for session.

setSession
```
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) = { ... }
Parameters:

value - The session to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setSessionBytes
```
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) = { ... }
Parameters:

value - The bytes for session to set.

Returns:

This builder for chaining.

hasTransaction
```
public boolean hasTransaction()
```
```
 Read only snapshot transactions are supported, read/write and single use
 transactions are not.
 
```
.google.spanner.v1.TransactionSelector transaction = 2;
Specified by:

hasTransaction in interface PartitionReadRequestOrBuilder

Returns:

Whether the transaction field is set.

getTransaction
```
public TransactionSelector getTransaction()
```
```
 Read only snapshot transactions are supported, read/write and single use
 transactions are not.
 
```
.google.spanner.v1.TransactionSelector transaction = 2;
Specified by:

getTransaction in interface PartitionReadRequestOrBuilder

Returns:

The transaction.

setTransaction

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;

setTransaction

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;

mergeTransaction

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;

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;

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;

getTransactionOrBuilder

public TransactionSelectorOrBuilder getTransactionOrBuilder()

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

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

Specified by:: getTransactionOrBuilder in interface PartitionReadRequestOrBuilder

getTable
```
public String getTable()
```
```
 Required. The name of the table in the database to be read.
 
```
string table = 3 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getTable in interface PartitionReadRequestOrBuilder

Returns:

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];
Specified by:

getTableBytes in interface PartitionReadRequestOrBuilder

Returns:

The bytes for table.

setTable
```
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];
Parameters:

value - The table to set.

Returns:

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:: This builder for chaining.

setTableBytes
```
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];
Parameters:

value - The bytes for table to set.

Returns:

This builder for chaining.

getIndex

public String getIndex()

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

string index = 4;

Specified by:: getIndex in interface PartitionReadRequestOrBuilder
Returns:: The index.

getIndexBytes

public ByteString getIndexBytes()

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

string index = 4;

Specified by:: getIndexBytes in interface PartitionReadRequestOrBuilder
Returns:: The bytes for index.

setIndex

public PartitionReadRequest.Builder setIndex(String value)

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

string index = 4;

Parameters:: value - The index to set.
Returns:: This builder for chaining.

clearIndex

public PartitionReadRequest.Builder clearIndex()

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

string index = 4;

Returns:: This builder for chaining.

setIndexBytes

public PartitionReadRequest.Builder setIndexBytes(ByteString value)

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

string index = 4;

Parameters:: value - The bytes for index to set.
Returns:: This builder for chaining.

getColumnsList

public ProtocolStringList getColumnsList()

 The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.

repeated string columns = 5;

Specified by:: getColumnsList in interface PartitionReadRequestOrBuilder
Returns:: A list containing the columns.

getColumnsCount

public int getColumnsCount()

 The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.

repeated string columns = 5;

Specified by:: getColumnsCount in interface PartitionReadRequestOrBuilder
Returns:: The count of columns.

getColumns
```
public String getColumns(int index)
```
```
 The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.
 
```
repeated string columns = 5;
Specified by:

getColumns in interface PartitionReadRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The columns at the given index.

getColumnsBytes
```
public ByteString getColumnsBytes(int index)
```
```
 The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.
 
```
repeated string columns = 5;
Specified by:

getColumnsBytes in interface PartitionReadRequestOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the columns at the given index.

setColumns

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

 The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.

repeated string columns = 5;

Parameters:: index - The index to set the value at.; value - The columns to set.
Returns:: This builder for chaining.

addColumns

public PartitionReadRequest.Builder addColumns(String value)

 The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.

repeated string columns = 5;

Parameters:: value - The columns to add.
Returns:: This builder for chaining.

addAllColumns

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

 The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.

repeated string columns = 5;

Parameters:: values - The columns to add.
Returns:: This builder for chaining.

clearColumns

public PartitionReadRequest.Builder clearColumns()

 The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.

repeated string columns = 5;

Returns:: This builder for chaining.

addColumnsBytes

public PartitionReadRequest.Builder addColumnsBytes(ByteString value)

 The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.

repeated string columns = 5;

Parameters:: value - The bytes of the columns to add.
Returns:: This builder for chaining.