Package org.nuxeo.ecm.core.scroll

Class DocumentScrollRequest.Builder

java.lang.Object

org.nuxeo.ecm.core.scroll.DocumentScrollRequest.Builder

Enclosing class:

DocumentScrollRequest

public static class DocumentScrollRequest.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_SCROLL_SIZE
static final Duration	DEFAULT_TIMEOUT
protected String	name
protected final String	query
protected String	reference
protected String	repository
protected int	size
protected Duration	timeout
static final String	UNKNOWN
protected String	username

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String nxqlQuery)

Method Summary

Modifier and Type	Method	Description
DocumentScrollRequest	build()
String	getName()
String	getQuery()
String	getReference()
String	getRepository()
int	getSize()
Duration	getTimeout()
String	getUsername()
DocumentScrollRequest.Builder	name(String name)	Uses a registered scroll implementation, null for default implementation.
DocumentScrollRequest.Builder	reference(String reference)	Associates a reference to the scroll.
DocumentScrollRequest.Builder	repository(String repository)	The repository to execute the NXQL request.
DocumentScrollRequest.Builder	size(int size)	The number of item to fetch.
DocumentScrollRequest.Builder	timeout(Duration timeout)	Maximum duration between iteration on Scroll.
DocumentScrollRequest.Builder	username(String username)	The user executing the NXQL request.

Methods inherited from class java.lang.Object

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

Field Details

query

protected final String query

name

protected String name

username

protected String username

repository

protected String repository

reference

protected String reference

timeout

protected Duration timeout

size

protected int size

UNKNOWN

public static final String UNKNOWN

See Also:

• Constant Field Values

DEFAULT_SCROLL_SIZE

public static final int DEFAULT_SCROLL_SIZE

See Also:

• Constant Field Values

DEFAULT_TIMEOUT

public static final Duration DEFAULT_TIMEOUT

Constructor Details

Builder

protected Builder(String nxqlQuery)

Method Details

name

public DocumentScrollRequest.Builder name(String name)

Uses a registered scroll implementation, null for default implementation.

timeout

public DocumentScrollRequest.Builder timeout(Duration timeout)

Maximum duration between iteration on Scroll.

size

public DocumentScrollRequest.Builder size(int size)

The number of item to fetch.

repository

public DocumentScrollRequest.Builder repository(String repository)

The repository to execute the NXQL request.

username

public DocumentScrollRequest.Builder username(String username)

The user executing the NXQL request.

reference

public DocumentScrollRequest.Builder reference(String reference)

Associates a reference to the scroll.

Since:

2021.44

getName

public String getName()

getQuery

public String getQuery()

getTimeout

public Duration getTimeout()

getSize

public int getSize()

getUsername

public String getUsername()

getRepository

public String getRepository()

getReference

public String getReference()

build

public DocumentScrollRequest build()