ReadRequest.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<ReadRequest.Builder>
    - - com.google.spanner.v1.ReadRequest.Builder

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

Enclosing class:: ReadRequest

public static final class ReadRequest.Builder
extends GeneratedMessageV3.Builder<ReadRequest.Builder>
implements ReadRequestOrBuilder

 The request for [Read][google.spanner.v1.Spanner.Read] and
 [StreamingRead][google.spanner.v1.Spanner.StreamingRead].

Protobuf type google.spanner.v1.ReadRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReadRequest.Builder`	`addAllColumns(Iterable<String> values)` Required.
`ReadRequest.Builder`	`addColumns(String value)` Required.
`ReadRequest.Builder`	`addColumnsBytes(ByteString value)` Required.
`ReadRequest.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, Object value)`
`ReadRequest`	`build()`
`ReadRequest`	`buildPartial()`
`ReadRequest.Builder`	`clear()`
`ReadRequest.Builder`	`clearColumns()` Required.
`ReadRequest.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`ReadRequest.Builder`	`clearIndex()` If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table].
`ReadRequest.Builder`	`clearKeySet()` Required.
`ReadRequest.Builder`	`clearLimit()` If greater than zero, only the first `limit` rows are yielded.
`ReadRequest.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`ReadRequest.Builder`	`clearPartitionToken()` If present, results will be restricted to the specified partition previously created using PartitionRead().
`ReadRequest.Builder`	`clearRequestOptions()` Common options for this request.
`ReadRequest.Builder`	`clearResumeToken()` If this request is resuming a previously interrupted read, `resume_token` should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption.
`ReadRequest.Builder`	`clearSession()` Required.
`ReadRequest.Builder`	`clearTable()` Required.
`ReadRequest.Builder`	`clearTransaction()` The transaction to use.
`ReadRequest.Builder`	`clone()`
`String`	`getColumns(int index)` Required.
`ByteString`	`getColumnsBytes(int index)` Required.
`int`	`getColumnsCount()` Required.
`ProtocolStringList`	`getColumnsList()` Required.
`ReadRequest`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getIndex()` If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table].
`ByteString`	`getIndexBytes()` If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table].
`KeySet`	`getKeySet()` Required.
`KeySet.Builder`	`getKeySetBuilder()` Required.
`KeySetOrBuilder`	`getKeySetOrBuilder()` Required.
`long`	`getLimit()` If greater than zero, only the first `limit` rows are yielded.
`ByteString`	`getPartitionToken()` If present, results will be restricted to the specified partition previously created using PartitionRead().
`RequestOptions`	`getRequestOptions()` Common options for this request.
`RequestOptions.Builder`	`getRequestOptionsBuilder()` Common options for this request.
`RequestOptionsOrBuilder`	`getRequestOptionsOrBuilder()` Common options for this request.
`ByteString`	`getResumeToken()` If this request is resuming a previously interrupted read, `resume_token` should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption.
`String`	`getSession()` Required.
`ByteString`	`getSessionBytes()` Required.
`String`	`getTable()` Required.
`ByteString`	`getTableBytes()` Required.
`TransactionSelector`	`getTransaction()` The transaction to use.
`TransactionSelector.Builder`	`getTransactionBuilder()` The transaction to use.
`TransactionSelectorOrBuilder`	`getTransactionOrBuilder()` The transaction to use.
`boolean`	`hasKeySet()` Required.
`boolean`	`hasRequestOptions()` Common options for this request.
`boolean`	`hasTransaction()` The transaction to use.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ReadRequest.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`ReadRequest.Builder`	`mergeFrom(Message other)`
`ReadRequest.Builder`	`mergeFrom(ReadRequest other)`
`ReadRequest.Builder`	`mergeKeySet(KeySet value)` Required.
`ReadRequest.Builder`	`mergeRequestOptions(RequestOptions value)` Common options for this request.
`ReadRequest.Builder`	`mergeTransaction(TransactionSelector value)` The transaction to use.
`ReadRequest.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`ReadRequest.Builder`	`setColumns(int index, String value)` Required.
`ReadRequest.Builder`	`setField(Descriptors.FieldDescriptor field, Object value)`
`ReadRequest.Builder`	`setIndex(String value)` If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table].
`ReadRequest.Builder`	`setIndexBytes(ByteString value)` If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table].
`ReadRequest.Builder`	`setKeySet(KeySet.Builder builderForValue)` Required.
`ReadRequest.Builder`	`setKeySet(KeySet value)` Required.
`ReadRequest.Builder`	`setLimit(long value)` If greater than zero, only the first `limit` rows are yielded.
`ReadRequest.Builder`	`setPartitionToken(ByteString value)` If present, results will be restricted to the specified partition previously created using PartitionRead().
`ReadRequest.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)`
`ReadRequest.Builder`	`setRequestOptions(RequestOptions.Builder builderForValue)` Common options for this request.
`ReadRequest.Builder`	`setRequestOptions(RequestOptions value)` Common options for this request.
`ReadRequest.Builder`	`setResumeToken(ByteString value)` If this request is resuming a previously interrupted read, `resume_token` should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption.
`ReadRequest.Builder`	`setSession(String value)` Required.
`ReadRequest.Builder`	`setSessionBytes(ByteString value)` Required.
`ReadRequest.Builder`	`setTable(String value)` Required.
`ReadRequest.Builder`	`setTableBytes(ByteString value)` Required.
`ReadRequest.Builder`	`setTransaction(TransactionSelector.Builder builderForValue)` The transaction to use.
`ReadRequest.Builder`	`setTransaction(TransactionSelector value)` The transaction to use.
`ReadRequest.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<ReadRequest.Builder>

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

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<ReadRequest.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<ReadRequest.Builder>

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

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

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

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

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

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

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

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<ReadRequest.Builder>

setField

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

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

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

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<ReadRequest.Builder>

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

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<ReadRequest.Builder>

setRepeatedField

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

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

addRepeatedField

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

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

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

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ReadRequest.Builder>

mergeFrom

public ReadRequest.Builder mergeFrom(ReadRequest other)

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

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<ReadRequest.Builder>

mergeFrom

public ReadRequest.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<ReadRequest.Builder>
Throws:: IOException

getSession
```
public String getSession()
```
```
 Required. The session in which the read should be performed.
 
```
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getSession in interface ReadRequestOrBuilder

Returns:

The session.

getSessionBytes
```
public ByteString getSessionBytes()
```
```
 Required. The session in which the read should be performed.
 
```
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getSessionBytes in interface ReadRequestOrBuilder

Returns:

The bytes for session.

setSession
```
public ReadRequest.Builder setSession(String value)
```
```
 Required. The session in which the read should be performed.
 
```
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 ReadRequest.Builder clearSession()
```
```
 Required. The session in which the read should be performed.
 
```
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns:

This builder for chaining.

setSessionBytes
```
public ReadRequest.Builder setSessionBytes(ByteString value)
```
```
 Required. The session in which the read should be performed.
 
```
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()
```
```
 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.
 
```
.google.spanner.v1.TransactionSelector transaction = 2;
Specified by:

hasTransaction in interface ReadRequestOrBuilder

Returns:

Whether the transaction field is set.

getTransaction

public TransactionSelector getTransaction()

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.

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

Specified by:: getTransaction in interface ReadRequestOrBuilder
Returns:: The transaction.

setTransaction

public ReadRequest.Builder setTransaction(TransactionSelector value)

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.

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

setTransaction

public ReadRequest.Builder setTransaction(TransactionSelector.Builder builderForValue)

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.

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

mergeTransaction

public ReadRequest.Builder mergeTransaction(TransactionSelector value)

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.

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

clearTransaction

public ReadRequest.Builder clearTransaction()

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.

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

getTransactionBuilder

public TransactionSelector.Builder getTransactionBuilder()

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.

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

getTransactionOrBuilder

public TransactionSelectorOrBuilder getTransactionOrBuilder()

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.

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

Specified by:: getTransactionOrBuilder in interface ReadRequestOrBuilder

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 ReadRequestOrBuilder

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 ReadRequestOrBuilder

Returns:

The bytes for table.

setTable
```
public ReadRequest.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 ReadRequest.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 ReadRequest.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.ReadRequest.table]. This index is
 used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set]
 and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.

string index = 4;

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

getIndexBytes

public ByteString getIndexBytes()

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

string index = 4;

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

setIndex

public ReadRequest.Builder setIndex(String value)

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

string index = 4;

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

clearIndex

public ReadRequest.Builder clearIndex()

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

string index = 4;

Returns:: This builder for chaining.

setIndexBytes

public ReadRequest.Builder setIndexBytes(ByteString value)

 If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is
 used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set]
 and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.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()
```
```
 Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
 this request.
 
```
repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getColumnsList in interface ReadRequestOrBuilder

Returns:

A list containing the columns.

getColumnsCount
```
public int getColumnsCount()
```
```
 Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
 this request.
 
```
repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getColumnsCount in interface ReadRequestOrBuilder

Returns:

The count of columns.

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

getColumns in interface ReadRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The columns at the given index.

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

getColumnsBytes in interface ReadRequestOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the columns at the given index.

setColumns

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

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

repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];

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

addColumns

public ReadRequest.Builder addColumns(String value)

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

repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];

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

addAllColumns

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

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

repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];

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

clearColumns

public ReadRequest.Builder clearColumns()

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

repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];

Returns:: This builder for chaining.

addColumnsBytes

public ReadRequest.Builder addColumnsBytes(ByteString value)

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

repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];

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