Class GetRequest (2.0.0)

public class GetRequest

A request to list objects in an index. You can specify a number of restrictions, such as the number of objects to return, the id of the first object to return, whether to only return keys, etc.


   GetRequest request = GetRequest.newBuilder()
       .setLimit(500)
       .setStartId("some-id")
       .setReturningIdsOnly(true)
       .build();

Inheritance

Object > GetRequest

Static Methods

newBuilder()

public static GetRequest.Builder newBuilder()
Returns
Type Description
GetRequest.Builder

newBuilder(GetRequest request)

public static final GetRequest.Builder newBuilder(GetRequest request)
Parameter
Name Description
request GetRequest
Returns
Type Description
GetRequest.Builder

Constructors

GetRequest(GetRequest.Builder builder)

protected GetRequest(GetRequest.Builder builder)
Parameter
Name Description
builder GetRequest.Builder

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getLimit()

public int getLimit()
Returns
Type Description
int

the maximum number of objects returned by this request

getStartId()

public String getStartId()
Returns
Type Description
String

the Id of the first object to return

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

isIncludeStart()

public boolean isIncludeStart()
Returns
Type Description
boolean

whether or not the object with the start Id is returned

isReturningIdsOnly()

public Boolean isReturningIdsOnly()
Returns
Type Description
Boolean

whether or not index schema is returned with each index

toString()

public String toString()
Returns
Type Description
String
Overrides