Class PartitionOptions (6.74.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
Type Description
int

PARTITION_SIZE_BYTES_FIELD_NUMBER

public static final int PARTITION_SIZE_BYTES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PartitionOptions getDefaultInstance()
Returns
Type Description
PartitionOptions

getDescriptor()

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

newBuilder()

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

newBuilder(PartitionOptions prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PartitionOptions getDefaultInstanceForType()
Returns
Type Description
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
Type Description
long

The maxPartitions.

getParserForType()

public Parser<PartitionOptions> getParserForType()
Returns
Type Description
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
Type Description
long

The partitionSizeBytes.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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