public final class Options extends Object implements Serializable
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
|
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() |
public static Options.ReadOption limit(long limit)
public static Options.ReadAndQueryOption prefetchChunks(int prefetchChunks)
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.public static Options.ListOption pageSize(int pageSize)
public static Options.ListOption pageToken(String pageToken)
public static Options.ListOption filter(String filter)
filter
- An expression for filtering the results of the request. Filter rules are case
insensitive. Some examples of using filters are:
Copyright © 2019 Google LLC. All rights reserved.