com.faunadb.client.query

Class Pagination

java.lang.Object

com.faunadb.client.query.Expr

com.faunadb.client.query.Pagination

public final class Pagination
extends Expr

A pagination expression. Instances of this class are not thread safe and must not be modified concurrently from different threads.

See Language.Paginate(Expr) for details.

See Also:

FaunaDB Read Functions, Language.Paginate(Expr)

Method Summary

Modifier and Type	Method and Description
Pagination	after(Expr cursor) Sets the cursor of the pagination to move forward.
Pagination	before(Expr cursor) Sets the cursor of the pagination to move backwards.
Pagination	cursor(Expr cursor) Sets the cursor object of the pagination.
Pagination	events(boolean events) Define if the pagination should return events or not.
Pagination	events(Expr events) Define if the pagination should return events or not.
Pagination	size(Expr size) Sets the maximum number of elements per page to return.
Pagination	size(java.lang.Integer size) Sets the maximum number of elements per page to return.
Pagination	sources(boolean sources) Define if the pagination should return source information or not.
Pagination	sources(Expr sources) Define if the pagination should return source information or not.
protected java.util.Map<java.lang.String,Expr>	toJson()
Pagination	ts(Expr ts) Sets the timestamp for the pagination.
Pagination	ts(java.lang.Long ts) Sets the timestamp for the pagination.

Methods inherited from class com.faunadb.client.query.Expr

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

toJson

protected java.util.Map<java.lang.String,Expr> toJson()

Specified by:

toJson in class Expr

cursor

public Pagination cursor(Expr cursor)

Sets the cursor object of the pagination.

Parameters:

cursor - the cursor object

Returns:

this Pagination instance

before

public Pagination before(Expr cursor)

Sets the cursor of the pagination to move backwards.

Parameters:

cursor - the before cursor

Returns:

this Pagination instance

after

public Pagination after(Expr cursor)

Sets the cursor of the pagination to move forward.

Parameters:

cursor - the after cursor

Returns:

this Pagination instance

ts

public Pagination ts(Expr ts)

Sets the timestamp for the pagination.

Parameters:

ts - the desired timestamp. Type: timestamp

Returns:

this Pagination instance

See Also:

Language.Time(Expr), Language.Value(Instant)

ts

public Pagination ts(java.lang.Long ts)

Sets the timestamp for the pagination.

Parameters:

ts - the desired timestamp in UNIX microseconds

Returns:

this Pagination instance

size

public Pagination size(Expr size)

Sets the maximum number of elements per page to return.

Parameters:

size - the desired page size. Type: Number

Returns:

this Pagination instance

size

public Pagination size(java.lang.Integer size)

Sets the maximum number of elements per page to return.

Parameters:

size - the desired page size

Returns:

this Pagination instance

sources

public Pagination sources(Expr sources)

Define if the pagination should return source information or not. By default source information is not returned.

Parameters:

sources - a boolean value

Returns:

this Pagination instance

sources

public Pagination sources(boolean sources)

Define if the pagination should return source information or not. By default source information is not returned.

Parameters:

sources - a boolean value

Returns:

this Pagination instance

events

public Pagination events(Expr events)

Define if the pagination should return events or not. By default events are not returned.

Parameters:

events - a boolean value

Returns:

this Pagination instance

events

public Pagination events(boolean events)

Define if the pagination should return events or not. By default events are not returned.

Parameters:

events - a boolean value

Returns:

this Pagination instance