Class PartitionOptions.Builder (6.108.0)

public static final class PartitionOptions.Builder extends GeneratedMessage.Builder<PartitionOptions.Builder> implements PartitionOptionsOrBuilder

Options for a PartitionQueryRequest and PartitionReadRequest.

Protobuf type google.spanner.v1.PartitionOptions

Static Methods

getDescriptor()

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

Methods

build()

public PartitionOptions build()
Returns
Type Description
PartitionOptions

buildPartial()

public PartitionOptions buildPartial()
Returns
Type Description
PartitionOptions

clear()

public PartitionOptions.Builder clear()
Returns
Type Description
PartitionOptions.Builder
Overrides

clearMaxPartitions()

public PartitionOptions.Builder clearMaxPartitions()

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

The desired maximum number of partitions to return. For example, this might 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 can be smaller or larger than this maximum count request.

int64 max_partitions = 2;

Returns
Type Description
PartitionOptions.Builder

This builder for chaining.

clearPartitionSizeBytes()

public PartitionOptions.Builder clearPartitionSizeBytes()

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 can be smaller or larger than this size request.

int64 partition_size_bytes = 1;

Returns
Type Description
PartitionOptions.Builder

This builder for chaining.

getDefaultInstanceForType()

public PartitionOptions getDefaultInstanceForType()
Returns
Type Description
PartitionOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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 might 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 can be smaller or larger than this maximum count request.

int64 max_partitions = 2;

Returns
Type Description
long

The maxPartitions.

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 can be smaller or larger than this size request.

int64 partition_size_bytes = 1;

Returns
Type Description
long

The partitionSizeBytes.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PartitionOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionOptions.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PartitionOptions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PartitionOptions.Builder
Overrides

mergeFrom(PartitionOptions other)

public PartitionOptions.Builder mergeFrom(PartitionOptions other)
Parameter
Name Description
other PartitionOptions
Returns
Type Description
PartitionOptions.Builder

setMaxPartitions(long value)

public PartitionOptions.Builder setMaxPartitions(long value)

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

The desired maximum number of partitions to return. For example, this might 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 can be smaller or larger than this maximum count request.

int64 max_partitions = 2;

Parameter
Name Description
value long

The maxPartitions to set.

Returns
Type Description
PartitionOptions.Builder

This builder for chaining.

setPartitionSizeBytes(long value)

public PartitionOptions.Builder setPartitionSizeBytes(long value)

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 can be smaller or larger than this size request.

int64 partition_size_bytes = 1;

Parameter
Name Description
value long

The partitionSizeBytes to set.

Returns
Type Description
PartitionOptions.Builder

This builder for chaining.