io.orchestrate.client

Class EventResource

java.lang.Object

io.orchestrate.client.EventResource

public class EventResource
extends java.lang.Object

The resource for the event 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
EventResource	end(long end) The exclusive end of a time range to query.
<T> OrchestrateRequest<EventList<T>>	get(java.lang.Class<T> clazz) Fetch events for a key in the Orchestrate service.
OrchestrateRequest<java.lang.Boolean>	put(java.lang.Object value) put(Object, Long).
OrchestrateRequest<java.lang.Boolean>	put(java.lang.Object value, java.lang.Long timestamp) Store an event to a key in the Orchestrate service.
EventResource	start(long start) The inclusive start of a time range to query.
EventResource	type(java.lang.String type) The type for an event, e.g.

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<EventList<T>> get(java.lang.Class<T> clazz)

Fetch events for a key in the Orchestrate service.

Usage:

 EventList<DomainObject> events =
         client.event("someCollection", "someKey")
               .type("eventType")
               .get(DomainObject.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.

put

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

put(Object, Long).

put

public OrchestrateRequest<java.lang.Boolean> put(@NonNull
                                        java.lang.Object value,
                                        @Nullable
                                        java.lang.Long timestamp)

Store an event to a key in the Orchestrate service.

Usage:

 DomainObject obj = new DomainObject(); // a POJO
 boolean result =
         client.event("someCollection", "someKey")
               .type("someType")
               .put(obj)
               .get();
 
 

Parameters:

value - The object to store as the event.

timestamp - The timestamp to store the event at.

Returns:

The prepared put request.

type

public EventResource type(java.lang.String type)

The type for an event, e.g. "update" or "tweet" etc.

Parameters:

type - The type of event.

Returns:

The event resource.

start

public EventResource start(long start)

The inclusive start of a time range to query.

Parameters:

start - The timestamp to get events from.

Returns:

The event resource.

end

public EventResource end(long end)

The exclusive end of a time range to query.

Parameters:

end - The timestamp to get events up to.

Returns:

The event resource.