Package com.google.cloud.spanner

Class PartitionOptions

java.lang.Object

com.google.cloud.spanner.PartitionOptions

All Implemented Interfaces:

Serializable

public class PartitionOptions
extends Object
implements Serializable

Defines the configuration for the number and size of partitions returned from BatchReadOnlyTransaction.partitionRead(com.google.cloud.spanner.PartitionOptions, java.lang.String, com.google.cloud.spanner.KeySet, java.lang.Iterable<java.lang.String>, com.google.cloud.spanner.Options.ReadOption...), BatchReadOnlyTransaction.partitionReadUsingIndex(com.google.cloud.spanner.PartitionOptions, java.lang.String, java.lang.String, com.google.cloud.spanner.KeySet, java.lang.Iterable<java.lang.String>, com.google.cloud.spanner.Options.ReadOption...) and BatchReadOnlyTransaction.partitionQuery(com.google.cloud.spanner.PartitionOptions, com.google.cloud.spanner.Statement, com.google.cloud.spanner.Options.QueryOption...)

Note: these options may not be honored based on the other parameters in the request.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PartitionOptions.Builder	Builder for PartitionOptions instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static PartitionOptions	getDefaultInstance()
long	getMaxPartitions()	Returns the maximum number of partitions to be created.
long	getPartitionSizeBytes()	Returns the size of the partition in bytes.
int	hashCode()
static PartitionOptions.Builder	newBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getDefaultInstance

public static PartitionOptions getDefaultInstance()

newBuilder

public static PartitionOptions.Builder newBuilder()

getPartitionSizeBytes

public long getPartitionSizeBytes()

Returns the size of the partition in bytes.

getMaxPartitions

public long getMaxPartitions()

Returns the maximum number of partitions to be created.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object