Class GetRequest.Builder (2.0.0)

public static class GetRequest.Builder

The builder of GetRequests.

Inheritance

java.lang.Object > GetRequest.Builder

Constructors

Builder()

protected Builder()

Methods

build()

public GetRequest build()
Returns
TypeDescription
GetRequest

builds and returns a brand new instance of a GetRequest using values set on this builder

setIncludeStart(boolean includeStart)

public GetRequest.Builder setIncludeStart(boolean includeStart)

Sets whether or not to include the object whose ID is specified via the #setStartId(String) method.

Parameter
NameDescription
includeStartboolean

whether or not to return the start index

Returns
TypeDescription
GetRequest.Builder

this builder

setLimit(Integer limit)

public GetRequest.Builder setLimit(Integer limit)

Sets the maximum number of objects to return.

Parameter
NameDescription
limitInteger

the maximum number of objects to return

Returns
TypeDescription
GetRequest.Builder

this builder

setReturningIdsOnly(boolean returningIdsOnly)

public GetRequest.Builder setReturningIdsOnly(boolean returningIdsOnly)

Sets whether just objects containing just their key are returned, or whether the complete objects are returned.

Parameter
NameDescription
returningIdsOnlyboolean

whether to only return object keys

Returns
TypeDescription
GetRequest.Builder

this builder

setStartId(String startId)

public GetRequest.Builder setStartId(String startId)

Sets the Id of the first object to return. You may exclude this object by using the #setIncludeStart(boolean) method.

Parameter
NameDescription
startIdString

the Id of the first object to return

Returns
TypeDescription
GetRequest.Builder

this builder