Class Options (6.86.0)

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()