io.orchestrate.client

Class KvListResource

java.lang.Object

io.orchestrate.client.KvListResource

public class KvListResource
extends java.lang.Object

The resource for the KV list features in the Orchestrate API.

Field Summary

Fields

Modifier and Type	Field and Description
protected OrchestrateClient	client The Orchestrate client to make requests with.
protected com.fasterxml.jackson.databind.ObjectMapper	mapper The object mapper used to deserialize JSON responses.

Method Summary

Methods

Modifier and Type	Method and Description
<T> OrchestrateRequest<KvList<T>>	get(java.lang.Class<T> clazz) Fetch a paginated, lexicographically ordered list of items contained in a collection.
KvListResource	inclusive() Add the 'startKey' to the result set, equivalent to:
KvListResource	inclusive(boolean inclusive) If inclusive is true the 'startKey' will be included in the result set.
KvListResource	limit(int limit) The number of results to return.
KvListResource	startKey(java.lang.String startKey) The start of the key range to paginate from including the specified value if it exists.

Methods inherited from class java.lang.Object

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

Field Detail

client

protected final OrchestrateClient client

The Orchestrate client to make requests with.

mapper

protected final com.fasterxml.jackson.databind.ObjectMapper mapper

The object mapper used to deserialize JSON responses.

Method Detail

get

public <T> OrchestrateRequest<KvList<T>> get(@NonNull
                                    java.lang.Class<T> clazz)

Fetch a paginated, lexicographically ordered list of items contained in a collection.

Usage:

 KvList<String> objects =
         client.listCollection("someCollection")
               .limit(10)
               .get(String.class)
               .get();
 
 

Type Parameters:

T - The type to deserialize the result of the request to.

Parameters:

clazz - Type information for marshalling objects at runtime.

Returns:

The prepared get request.

inclusive

public KvListResource inclusive()

Add the 'startKey' to the result set, equivalent to:

 this.inclusive(Boolean.TRUE);
 
 

Returns:

The KV list resource.

See Also:

inclusive(boolean)

inclusive

public KvListResource inclusive(boolean inclusive)

If inclusive is true the 'startKey' will be included in the result set.

Parameters:

inclusive - Whether to include the 'startKey' in the result set.

Returns:

The KV list resource.

limit

public KvListResource limit(int limit)

The number of results to return.

Parameters:

limit - The number of KV objects to retrieve.

Returns:

The KV list resource.

startKey

public KvListResource startKey(java.lang.String startKey)

The start of the key range to paginate from including the specified value if it exists.

Parameters:

startKey - The start of the key range to paginate from.

Returns:

The KV list resource.