Class PartitionReadRequest (6.25.1)

Stay organized with collections Save and categorize content based on your preferences.
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
TypeDescription
int

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
TypeDescription
int

KEY_SET_FIELD_NUMBER

public static final int KEY_SET_FIELD_NUMBER
Field Value
TypeDescription
int

PARTITION_OPTIONS_FIELD_NUMBER

public static final int PARTITION_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER
Field Value
TypeDescription
int

TABLE_FIELD_NUMBER

public static final int TABLE_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PartitionReadRequest getDefaultInstance()
Returns
TypeDescription
PartitionReadRequest

getDescriptor()

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

newBuilder()

public static PartitionReadRequest.Builder newBuilder()
Returns
TypeDescription
PartitionReadRequest.Builder

newBuilder(PartitionReadRequest prototype)

public static PartitionReadRequest.Builder newBuilder(PartitionReadRequest prototype)
Parameter
NameDescription
prototypePartitionReadRequest
Returns
TypeDescription
PartitionReadRequest.Builder

parseDelimitedFrom(InputStream input)

public static PartitionReadRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PartitionReadRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionReadRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionReadRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PartitionReadRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PartitionReadRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PartitionReadRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionReadRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PartitionReadRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PartitionReadRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PartitionReadRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionReadRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PartitionReadRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PartitionReadRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionReadRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionReadRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PartitionReadRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PartitionReadRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionReadRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionReadRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PartitionReadRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PartitionReadRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PartitionReadRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionReadRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PartitionReadRequest> parser()
Returns
TypeDescription
Parser<PartitionReadRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
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

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.

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

getParserForType()

public Parser<PartitionReadRequest> getParserForType()
Returns
TypeDescription
Parser<PartitionReadRequest>
Overrides

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.

getPartitionOptionsOrBuilder()

public PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()

Additional options that affect how many partitions are created.

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

Returns
TypeDescription
PartitionOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
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.

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PartitionReadRequest.Builder newBuilderForType()
Returns
TypeDescription
PartitionReadRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PartitionReadRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PartitionReadRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PartitionReadRequest.Builder toBuilder()
Returns
TypeDescription
PartitionReadRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException