Class GetRequest.Builder (2.0.0)

public static class GetRequest.Builder

The builder of GetRequests.

Inheritance

java.lang.Object > GetRequest.Builder

protected Builder()

public GetRequest build()

Returns
Type	Description
`GetRequest`	builds and returns a brand new instance of a GetRequest using values set on this builder

public GetRequest.Builder setIncludeStart(boolean includeStart)

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

Parameter
Name	Description
`includeStart`	`boolean` whether or not to return the start index

Returns
Type	Description
`GetRequest.Builder`	this builder

public GetRequest.Builder setLimit(Integer limit)

Sets the maximum number of objects to return.

Parameter
Name	Description
`limit`	`Integer` the maximum number of objects to return

Returns
Type	Description
`GetRequest.Builder`	this builder

public GetRequest.Builder setReturningIdsOnly(boolean returningIdsOnly)

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

Parameter
Name	Description
`returningIdsOnly`	`boolean` whether to only return object keys

Returns
Type	Description
`GetRequest.Builder`	this builder

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
Name	Description
`startId`	`String` the Id of the first object to return

Returns
Type	Description
`GetRequest.Builder`	this builder