Class Options (6.80.1)

Version 6.80.1

• 6.85.0 (latest)
• 6.83.0
• 6.82.0
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public final class Options implements Serializable

Specifies options for various spanner operations

Inheritance

Object > Options

Implements

Serializable

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

bufferRows(int bufferRows)

public static Options.ReadAndQueryOption bufferRows(int bufferRows)

Parameter
Name	Description
bufferRows	int

Returns
Type	Description
Options.ReadAndQueryOption

commitStats()

public static Options.TransactionOption commitStats()

Specifying this instructs the transaction to request CommitStats from the backend.

Returns
Type	Description
Options.TransactionOption

dataBoostEnabled(Boolean dataBoostEnabled)

public static Options.DataBoostQueryOption dataBoostEnabled(Boolean dataBoostEnabled)

If this is for PartitionedRead or PartitionedQuery and this field is set to true, the request will be executed via Spanner independent compute resources.

Parameter
Name	Description
dataBoostEnabled	Boolean

Returns
Type	Description
com.google.cloud.spanner.Options.DataBoostQueryOption

decodeMode(DecodeMode decodeMode)

public static Options.ReadAndQueryOption decodeMode(DecodeMode decodeMode)

Parameter
Name	Description
decodeMode	DecodeMode

Returns
Type	Description
Options.ReadAndQueryOption

directedRead(DirectedReadOptions directedReadOptions)

public static Options.ReadAndQueryOption directedRead(DirectedReadOptions directedReadOptions)

Option to request DirectedRead for ReadOnlyTransaction and SingleUseTransaction.

The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries. Not all requests can be sent to non-leader replicas. In particular, some requests such as reads within read-write transactions must be sent to a designated leader replica. These requests ignore DirectedReadOptions.

Parameter
Name	Description
directedReadOptions	DirectedReadOptions

Returns
Type	Description
Options.ReadAndQueryOption

etag(String etag)

public static Options.DeleteAdminApiOption etag(String etag)

Specifying this will help in optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. Operations that support this option are:

• InstanceAdminClient#deleteInstanceConfig

Parameter
Name	Description
etag	String

Returns
Type	Description
Options.DeleteAdminApiOption

excludeTxnFromChangeStreams()

public static Options.UpdateTransactionOption excludeTxnFromChangeStreams()

Specifying this instructs the transaction to be excluded from being recorded in change streams with the DDL option allow_txn_exclusion=true. This does not exclude the transaction from being recorded in the change streams with the DDL option allow_txn_exclusion being false or unset.

Returns
Type	Description
Options.UpdateTransactionOption

filter(String filter)

public static Options.ListOption filter(String filter)

Specifying this will cause the given filter to be applied to the list operation. List operations that support this options are:

• InstanceAdminClient#listInstances

If this option is passed to any other list operation, it will throw an IllegalArgumentException.

Parameter
Name	Description
filter	String An expression for filtering the results of the request. Filter rules are case insensitive. Some examples of using filters are: name:* The entity has a name. name:Howl The entity's name contains "howl". name:HOWL Equivalent to above. NAME:howl Equivalent to above. labels.env:* The entity has the label env. labels.env:dev The entity has a label env whose value contains "dev". name:howl labels.env:dev The entity's name contains "howl" and it has the label env whose value contains "dev".

Returns
Type	Description
Options.ListOption

limit(long limit)

public static Options.ReadOption limit(long limit)

Specifying this will cause the read to yield at most this many rows. This should be greater than 0.

Parameter
Name	Description
limit	long

Returns
Type	Description
Options.ReadOption

maxCommitDelay(Duration maxCommitDelay)

public static Options.TransactionOption maxCommitDelay(Duration maxCommitDelay)

Parameter
Name	Description
maxCommitDelay	Duration

Returns
Type	Description
Options.TransactionOption

optimisticLock()

public static Options.TransactionOption optimisticLock()

Specifying this instructs the transaction to request Optimistic Lock from the backend. In this concurrency mode, operations during the execution phase, i.e., reads and queries, are performed without acquiring locks, and transactional consistency is ensured by running a validation process in the commit phase (when any needed locks are acquired). The validation process succeeds only if there are no conflicting committed transactions (that committed mutations to the read data at a commit timestamp after the read timestamp).

Returns
Type	Description
Options.TransactionOption

orderBy(Options.RpcOrderBy orderBy)

public static Options.ReadOption orderBy(Options.RpcOrderBy orderBy)

Specifies the order_by to use for the RPC.

Parameter
Name	Description
orderBy	Opt