io.orchestrate.client

Class KvResource

java.lang.Object

io.orchestrate.client.KvResource

public class KvResource
extends java.lang.Object

The resource for the KV 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
OrchestrateRequest<java.lang.Boolean>	delete() delete(boolean).
OrchestrateRequest<java.lang.Boolean>	delete(boolean purge) Purge a KV object from a collection in the Orchestrate.io service.
<T> OrchestrateRequest<KvObject<T>>	get(java.lang.Class<T> clazz) get(Class).
<T> OrchestrateRequest<KvObject<T>>	get(java.lang.Class<T> clazz, java.lang.String ref) Fetch an object by key from the Orchestrate service.
KvResource	ifAbsent() Equivalent to this.ifAbsent(Boolean.TRUE).
KvResource	ifAbsent(boolean ifAbsent) Whether to store the object if no key already exists.
KvResource	ifMatch(java.lang.String objectRef) The last known version of the stored object to match for the request to succeed.
OrchestrateRequest<KvMetadata>	put(java.lang.Object value) Store an object by key to the Orchestrate service.

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

delete

public OrchestrateRequest<java.lang.Boolean> delete()

delete(boolean).

delete

public OrchestrateRequest<java.lang.Boolean> delete(boolean purge)

Purge a KV object from a collection in the Orchestrate.io service. This will permanently remove the record from the service, and cannot be undone.

Usage:

 boolean result =
         client.kv("someCollection", "someKey")
               .delete(Boolean.TRUE)
               .get();
 
 

Parameters:

purge - If true, permanently delete the object AND its "ref" history from Orchestrate.

Returns:

The prepared delete request.

get

public <T> OrchestrateRequest<KvObject<T>> get(java.lang.Class<T> clazz)

get(Class).

get

public <T> OrchestrateRequest<KvObject<T>> get(@NonNull
                                      java.lang.Class<T> clazz,
                                      @Nullable
                                      java.lang.String ref)

Fetch an object by key from the Orchestrate service.

Usage:

 KvObject<DomainObject> object =
         client.kv("someCollection", "someKey")
               .get(DomainObject.class)
               .get();
 
 

Type Parameters:

T - The type to deserialize the result to.

Parameters:

clazz - Type information for marshalling objects at runtime.

ref - The version of the object to get.

Returns:

This KV resource.

ifAbsent

public KvResource ifAbsent()

Equivalent to this.ifAbsent(Boolean.TRUE).

Returns:

This KV resource.

See Also:

ifAbsent(boolean)

ifAbsent

public KvResource ifAbsent(boolean ifAbsent)

Whether to store the object if no key already exists.

Parameters:

ifAbsent - If true

Returns:

This KV resource.

ifMatch

public KvResource ifMatch(@NonNull
                 java.lang.String objectRef)

The last known version of the stored object to match for the request to succeed.

Parameters:

objectRef - The last known version of the stored object.

Returns:

This KV resource.

put

public OrchestrateRequest<KvMetadata> put(@NonNull
                                 java.lang.Object value)

Store an object by key to the Orchestrate service.

Usage:

 DomainObject obj = new DomainObject();
 KvMetadata kvMetadata =
         client.kv("someCollection", "someKey")
               .put(obj)
               .get();
 
 

Parameters:

value - The object to store.

Returns:

The prepared put request.