io.orchestrate.client

Interface Client

All Known Implementing Classes:

OrchestrateClient

public interface Client

A client used to read and write data to the Orchestrate.io service.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Stops the thread pool and closes all connections in use by all the operations.
OrchestrateRequest<java.lang.Boolean>	deleteCollection(java.lang.String collection) Delete all KV objects from a collection in the Orchestrate service.
EventResource	event(java.lang.String collection, java.lang.String key) The resource for the event features in the Orchestrate API.
KvResource	kv(java.lang.String collection, java.lang.String key) The resource for the KV features in the Orchestrate API.
KvListResource	listCollection(java.lang.String collection) The resource for the KV list features in the Orchestrate API.
void	ping() Health check that sends a ping to the Orchestrate service.
void	ping(java.lang.String collection) Deprecated.
OrchestrateRequest<KvMetadata>	postValue(java.lang.String collection, java.lang.Object value) Store an object by value in the collection specified to the Orchestrate service which will auto-generate a key for it.
RelationResource	relation(java.lang.String collection, java.lang.String key) The resource for the relation features in the Orchestrate API.
CollectionSearchResource	searchCollection(java.lang.String collection) The resource for the collection search features in the Orchestrate API.

Method Detail

close

void close()
           throws java.io.IOException

Stops the thread pool and closes all connections in use by all the operations.

Throws:

java.io.IOException - If resources couldn't be stopped.

deleteCollection

OrchestrateRequest<java.lang.Boolean> deleteCollection(java.lang.String collection)

Delete all KV objects from a collection in the Orchestrate service.

Usage:

 client.deleteCollection("someCollection").get();
 
 

Parameters:

collection - The name of collection to delete.

Returns:

The prepared request object.

event

EventResource event(java.lang.String collection,
                  java.lang.String key)

The resource for the event features in the Orchestrate API.

Parameters:

collection - The name of the collection.

key - The name of the key with events.

Returns:

The event resource.

kv

KvResource kv(java.lang.String collection,
            java.lang.String key)

The resource for the KV features in the Orchestrate API.

Parameters:

collection - The name of the collection.

key - The name of a key.

Returns:

The KV resource.

listCollection

KvListResource listCollection(java.lang.String collection)

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

Parameters:

collection - The name of the collection.

Returns:

The KV list resource.

ping

void ping()
          throws java.io.IOException

Health check that sends a ping to the Orchestrate service.

Throws:

java.io.IOException - If the health check failed.

ping

@Deprecated
void ping(java.lang.String collection)
          throws java.io.IOException

Deprecated.

Parameters:

collection - The name of the collection.

Throws:

java.io.IOException - If the ping request failed.

See Also:

ping()

postValue

OrchestrateRequest<KvMetadata> postValue(java.lang.String collection,
                                       java.lang.Object value)
                                         throws java.io.IOException

Store an object by value in the collection specified to the Orchestrate service which will auto-generate a key for it.

Usage:

 DomainObject obj = new DomainObject();
 KvMetadata kvMetadata =
         client.postValue("someCollection", obj).get();
 
 

Parameters:

collection - The name of the collection.

value - The object to store.

Returns:

The prepared put request.

Throws:

java.io.IOException - If the request failed.

relation

RelationResource relation(java.lang.String collection,
                        java.lang.String key)

The resource for the relation features in the Orchestrate API.

Parameters:

collection - The name of the collection.

key - The name of the key.

Returns:

The relation resource.

searchCollection

CollectionSearchResource searchCollection(java.lang.String collection)

The resource for the collection search features in the Orchestrate API.

Parameters:

collection - The name of the collection to search.

Returns:

The collection search resource.