Class PartitionReadRequest (6.71.0)

public final class PartitionReadRequest extends GeneratedMessageV3 implements PartitionReadRequestOrBuilder

The request for PartitionRead

Protobuf type google.spanner.v1.PartitionReadRequest

Static Fields

COLUMNS_FIELD_NUMBER

public static final int COLUMNS_FIELD_NUMBER
Field Value
Type Description
int

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
Type Description
int

KEY_SET_FIELD_NUMBER

public static final int KEY_SET_FIELD_NUMBER
Field Value
Type Description
int

PARTITION_OPTIONS_FIELD_NUMBER

public static final int PARTITION_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER
Field Value
Type Description
int

TABLE_FIELD_NUMBER

public static final int TABLE_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PartitionReadRequest getDefaultInstance()
Returns
Type Description
PartitionReadRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PartitionReadRequest.Builder newBuilder()
Returns
Type Description
PartitionReadRequest.Builder

newBuilder(PartitionReadRequest prototype)

public static PartitionReadRequest.Builder newBuilder(PartitionReadRequest prototype)
Parameter
Name Description
prototype PartitionReadRequest
Returns
Type Description
PartitionReadRequest.Builder

parseDelimitedFrom(InputStream input)

public static PartitionReadRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PartitionReadRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionReadRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionReadRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PartitionReadRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PartitionReadRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PartitionReadRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionReadRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PartitionReadRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PartitionReadRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PartitionReadRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionReadRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PartitionReadRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PartitionReadRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionReadRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionReadRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PartitionReadRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PartitionReadRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionReadRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionReadRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PartitionReadRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PartitionReadRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PartitionReadRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionReadRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PartitionReadRequest> parser()
Returns
Type Description
Parser<PartitionReadRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the columns.

getDefaultInstanceForType()

public PartitionReadRequest getDefaultInstanceForType()
Returns
Type Description
PartitionReadRequest

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
Type Description
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
Type Description
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
Type Description
KeySet

The keySet.

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
Type Description
KeySetOrBuilder

getParserForType()

public Parser<PartitionReadRequest> getParserForType()
Returns
Type Description
Parser<PartitionReadRequest>
Overrides

getPartitionOptions()

public PartitionOptions getPartitionOptions()

Additional options that affect how many partitions are created.

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

Returns
Type Description
PartitionOptions

The partitionOptions.

getPartitionOptionsOrBuilder()

public PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()

Additional options that affect how many partitions are created.

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

Returns
Type Description
PartitionOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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
Type Description
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
Type Description
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
Type Description
TransactionSelector

The transaction.

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

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
Type Description
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
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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PartitionReadRequest.Builder newBuilderForType()
Returns
Type Description
PartitionReadRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PartitionReadRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PartitionReadRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PartitionReadRequest.Builder toBuilder()
Returns
Type Description
PartitionReadRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException