Class PartitionOptions (6.53.0)

public final class PartitionOptions extends GeneratedMessageV3 implements PartitionOptionsOrBuilder

Options for a PartitionQueryRequest and PartitionReadRequest.

Protobuf type google.spanner.v1.PartitionOptions

Static Fields

MAX_PARTITIONS_FIELD_NUMBER

public static final int MAX_PARTITIONS_FIELD_NUMBER
Field Value
TypeDescription
int

PARTITION_SIZE_BYTES_FIELD_NUMBER

public static final int PARTITION_SIZE_BYTES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PartitionOptions getDefaultInstance()
Returns
TypeDescription
PartitionOptions

getDescriptor()

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

newBuilder()

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

newBuilder(PartitionOptions prototype)

public static PartitionOptions.Builder newBuilder(PartitionOptions prototype)
Parameter
NameDescription
prototypePartitionOptions
Returns
TypeDescription
PartitionOptions.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PartitionOptions getDefaultInstanceForType()
Returns
TypeDescription
PartitionOptions

getMaxPartitions()

public long getMaxPartitions()

Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.

The desired maximum number of partitions to return. For example, this may be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be smaller or larger than this maximum count request.

int64 max_partitions = 2;

Returns
TypeDescription
long

The maxPartitions.

getParserForType()

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

getPartitionSizeBytes()

public long getPartitionSizeBytes()

Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.

The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request.

int64 partition_size_bytes = 1;

Returns
TypeDescription
long

The partitionSizeBytes.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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 PartitionOptions.Builder newBuilderForType()
Returns
TypeDescription
PartitionOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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