Class BatchPartition (6.56.0)

public final class BatchPartition extends GeneratedMessageV3 implements BatchPartitionOrBuilder

Identifies a database partition generated for a particular read or query. To read rows from the partition, use ExecutePartitionAction.

Protobuf type google.spanner.executor.v1.BatchPartition

Static Fields

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
TypeDescription
int

PARTITION_FIELD_NUMBER

public static final int PARTITION_FIELD_NUMBER
Field Value
TypeDescription
int

PARTITION_TOKEN_FIELD_NUMBER

public static final int PARTITION_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

TABLE_FIELD_NUMBER

public static final int TABLE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchPartition getDefaultInstance()
Returns
TypeDescription
BatchPartition

getDescriptor()

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

newBuilder()

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

newBuilder(BatchPartition prototype)

public static BatchPartition.Builder newBuilder(BatchPartition prototype)
Parameter
NameDescription
prototypeBatchPartition
Returns
TypeDescription
BatchPartition.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public BatchPartition getDefaultInstanceForType()
Returns
TypeDescription
BatchPartition

getIndex()

public String getIndex()

Index name if the partition was generated for an index read.

optional string index = 4;

Returns
TypeDescription
String

The index.

getIndexBytes()

public ByteString getIndexBytes()

Index name if the partition was generated for an index read.

optional string index = 4;

Returns
TypeDescription
ByteString

The bytes for index.

getParserForType()

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

getPartition()

public ByteString getPartition()

Serialized Partition instance.

bytes partition = 1;

Returns
TypeDescription
ByteString

The partition.

getPartitionToken()

public ByteString getPartitionToken()

The partition token decrypted from partition.

bytes partition_token = 2;

Returns
TypeDescription
ByteString

The partitionToken.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTable()

public String getTable()

Table name is set iff the partition was generated for a read (as opposed to a query).

optional string table = 3;

Returns
TypeDescription
String

The table.

getTableBytes()

public ByteString getTableBytes()

Table name is set iff the partition was generated for a read (as opposed to a query).

optional string table = 3;

Returns
TypeDescription
ByteString

The bytes for table.

hasIndex()

public boolean hasIndex()

Index name if the partition was generated for an index read.

optional string index = 4;

Returns
TypeDescription
boolean

Whether the index field is set.

hasTable()

public boolean hasTable()

Table name is set iff the partition was generated for a read (as opposed to a query).

optional string table = 3;

Returns
TypeDescription
boolean

Whether the table 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 BatchPartition.Builder newBuilderForType()
Returns
TypeDescription
BatchPartition.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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