Class PartitionOptions.Builder (6.62.0)

public static final class PartitionOptions.Builder extends GeneratedMessageV3.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PartitionOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PartitionOptions.Builder
Overrides

build()

public PartitionOptions build()
Returns
TypeDescription
PartitionOptions

buildPartial()

public PartitionOptions buildPartial()
Returns
TypeDescription
PartitionOptions

clear()

public PartitionOptions.Builder clear()
Returns
TypeDescription
PartitionOptions.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PartitionOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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 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
PartitionOptions.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PartitionOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PartitionOptions.Builder
Overrides

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

int64 partition_size_bytes = 1;

Returns
TypeDescription
PartitionOptions.Builder

This builder for chaining.

clone()

public PartitionOptions.Builder clone()
Returns
TypeDescription
PartitionOptions.Builder
Overrides

getDefaultInstanceForType()

public PartitionOptions getDefaultInstanceForType()
Returns
TypeDescription
PartitionOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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 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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PartitionOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionOptions.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PartitionOptions.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PartitionOptions.Builder
Overrides

mergeFrom(PartitionOptions other)

public PartitionOptions.Builder mergeFrom(PartitionOptions other)
Parameter
NameDescription
otherPartitionOptions
Returns
TypeDescription
PartitionOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PartitionOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PartitionOptions.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public PartitionOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PartitionOptions.Builder
Overrides

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 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;

Parameter
NameDescription
valuelong

The maxPartitions to set.

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

int64 partition_size_bytes = 1;

Parameter
NameDescription
valuelong

The partitionSizeBytes to set.

Returns
TypeDescription
PartitionOptions.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PartitionOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PartitionOptions.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PartitionOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PartitionOptions.Builder
Overrides