com.google.cloud.spanner

Class Options

java.lang.Object

com.google.cloud.spanner.Options

All Implemented Interfaces:

Serializable

public final class Options
extends Object
implements Serializable

Specifies options for various spanner operations

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Options.ListOption Marker interface to mark options applicable to list operations in admin API.
static interface	Options.QueryOption Marker interface to mark options applicable to query operation.
static interface	Options.ReadAndQueryOption Marker interface to mark options applicable to both Read and Query operations
static interface	Options.ReadOption Marker interface to mark options applicable to read operation

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static Options.ListOption	filter(String filter) Specifying this will cause the given filter to be applied to the list operation.
int	hashCode()
static Options.ReadOption	limit(long limit) Specifying this will cause the read to yield at most this many rows.
static Options.ListOption	pageSize(int pageSize) Specifying this will cause the list operations to fetch at most this many records in a page.
static Options.ListOption	pageToken(String pageToken) Specifying this will cause the list operation to start fetching the record from this onwards.
static Options.ReadAndQueryOption	prefetchChunks(int prefetchChunks) Specifying this will allow the client to prefetch up to prefetchChunks PartialResultSet chunks for read and query.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

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.

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.

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.

pageToken

public static Options.ListOption pageToken(String pageToken)

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

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(com.google.cloud.spanner.Options.ListOption...)

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

Parameters:

filter - 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".

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