Class FetchOptions (2.0.0)

Describes the limit, offset, and chunk size to be applied when executing a PreparedQuery.

limit is the maximum number of results the query will return.

offset is the number of results to skip before returning any results. Results that are skipped due to offset do not count against limit.
Note: Using offset still retrieves skipped entities internally. This affects the latency of the query, and your application is billed for the operations required to retrieve them. Using cursors lets you avoid these costs.

startCursor and endCursor are previously generated cursors that point to locations in a result set. If specified queries will start and end at these locations.

prefetchSize is the number of results retrieved on the first call to the datastore.

chunkSize determines the internal chunking strategy of the Iterator returned by PreparedQuery#asIterator(FetchOptions) and the Iterable returned by PreparedQuery#asIterable(FetchOptions).

Note that unlike limit, offset and cursor, prefetchSize and chunkSize have no impact on the result of the PreparedQuery, but rather only the performance of the PreparedQuery.

Notes on usage:
The recommended way to instantiate a FetchOptions object is to import FetchOptions and invoke a static creation method followed by an instance mutator (if needed):

 import com.google.appengine.api.datastore.FetchOptions;

 Cursor cursor = ...

 ...

 // limit 10
 datastoreService.prepare(query).asList(FetchOptions.Builder.withLimit(10));

 // limit 10, start cursor
 datastoreService.prepare(query).asList(FetchOptions.Builder.withLimit(10).startCursor(cursor));
 

Deprecated. Instead of using DEFAULT_CHUNK_SIZE, do not specify a chunk size.

Sets the chunk size. Please read the class javadoc for an explanation of how chunk size is used.

Deprecated. use #startCursor instead.

Sets the cursor to start the query from.

Sets the cursor at which to end the query.

Returns the chunk size, or null if no chunk size was provided.

Deprecated. use #getStartCursor() instead

Returns the end cursor, or null if no end cursor was provided.

Returns the limit, or null if no limit was provided.

Returns the offset, or null if no offset was provided.

Returns the prefetch size, or null if no prefetch size was provided.

Returns the start cursor, or null if no start cursor was provided.

Sets the limit. Please read the class javadoc for an explanation of how limit is used.

Sets the offset. Please read the class javadoc for an explanation of how offset is used.

Sets the number of entities to prefetch.

Sets the cursor at which to start the query.