Class Options

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

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

pageSize(int pageSize)

public static Options.ListOption pageSize(int pageSize)

Specifying this will cause the list operations to fetch at most this many records in a page.

Parameter

Name	Description
pageSize	`int`

Returns

Type	Description
Options.ListOption

pageToken(String pageToken)

public static Options.ListOption pageToken(String pageToken)

Specifying this will cause the list operation to start fetching the record from this onwards.

Parameter

Name	Description
pageToken	`String`

Returns

Type	Description
Options.ListOption

prefetchChunks(int prefetchChunks)

public static Options.ReadAndQueryOption prefetchChunks(int prefetchChunks)

Specifying this will allow the client to prefetch up to prefetchChunks PartialResultSet chunks for read and query. The data size of each chunk depends on the server implementation but a good rule of thumb is that each chunk will be up to 1 MiB. Larger values reduce the likelihood of blocking while consuming results at the cost of greater memory consumption. prefetchChunks should be greater than 0. To get good performance choose a value that is large enough to allow buffering of chunks for an entire row. Apart from the buffered chunks, there can be at most one more row buffered in the client.

Parameter

Name	Description
prefetchChunks	`int`

Returns

Type	Description
Options.ReadAndQueryOption

priority(Options.RpcPriority priority)

public static Options.ReadQueryUpdateTransactionOption priority(Options.RpcPriority priority)

Specifies the priority to use for the RPC.

Parameter

Name	Description
priority	`Options.RpcPriority`

Returns

Type	Description
Options.ReadQueryUpdateTransactionOption

tag(String name)

public static Options.ReadQueryUpdateTransactionOption tag(String name)

Specifying this will cause the reads, queries, updates and writes operations statistics collection to be grouped by tag.

Parameter

Name	Description
name	`String`

Returns

Type	Description
Options.ReadQueryUpdateTransactionOption

Methods

equals(Object o)

public boolean equals(Object o)

Parameter

Name	Description
o	`Object`

Returns

Type	Description
boolean

Overrides

Object.equals(Object)

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

Object.hashCode()

toString()

public String toString()

Returns

Type	Description
String

Overrides

Object.toString()