io.orchestrate.client

Class SingleEventResource

java.lang.Object

io.orchestrate.client.SingleEventResource

public class SingleEventResource
extends java.lang.Object

The resource for interacting with an individual Event instance.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
<T> OrchestrateRequest<Event<T>>	get(java.lang.Class<T> clazz) Fetch the single Event instance.
SingleEventResource	ifMatch(java.lang.String ref) Sets a conditional If-Match header.
OrchestrateRequest<EventMetadata>	merge(java.lang.String jsonString) Merge patch the Event (Merge the json value with the specified json value).
protected <T> OrchestrateRequest<T>	parseLink(java.lang.String name, com.fasterxml.jackson.databind.JsonNode jsonNode, io.orchestrate.client.ResponseConverter<T> clazz)
OrchestrateRequest<EventMetadata>	patch(JsonPatch patchOps) Patch (Partial Update) the Event.
OrchestrateRequest<java.lang.Boolean>	purge() Delete the Event instance.
protected byte[]	toJsonBytes(java.lang.Object value)
protected com.fasterxml.jackson.databind.JsonNode	toJsonNode(org.glassfish.grizzly.http.HttpContent response)
protected com.fasterxml.jackson.databind.JsonNode	toJsonNodeOrNull(org.glassfish.grizzly.http.HttpContent response)
protected <T> KvObject<T>	toKvObject(org.glassfish.grizzly.http.HttpContent response, java.lang.String collection, java.lang.String key, java.lang.Class<T> clazz)
protected <T> KvObject<T>	toKvObject(com.fasterxml.jackson.databind.JsonNode result, java.lang.Class<T> clazz)
OrchestrateRequest<EventMetadata>	update(java.lang.Object value) Update the Event instance to have an entirely new value.

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.

jacksonMapper

protected final JacksonMapper jacksonMapper

Method Detail

ifMatch

public SingleEventResource ifMatch(java.lang.String ref)

Sets a conditional If-Match header. This is for conditional updates or deletes.

Parameters:

ref - the expected ref

Returns:

this resource

get

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

Fetch the single Event instance.

Type Parameters:

T - The type for the Event value.

Parameters:

clazz - The Class to serialize the Event's value as.

Returns:

An OrchestrateRequest representing the active request.

purge

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

Delete the Event instance.

Returns:

The active request.

update

public OrchestrateRequest<EventMetadata> update(@NonNull
                                                java.lang.Object value)

Update the Event instance to have an entirely new value.

Parameters:

value - the updated value for the Event instance.

Returns:

the active request.

patch

public OrchestrateRequest<EventMetadata> patch(JsonPatch patchOps)

Patch (Partial Update) the Event.

Parameters:

patchOps - The list of operations to perform in the patch.

Returns:

the active request.

merge

public OrchestrateRequest<EventMetadata> merge(java.lang.String jsonString)

Merge patch the Event (Merge the json value with the specified json value).

Parameters:

jsonString - the json string to merge into the Event value.

Returns:

the active request.

toJsonBytes

protected byte[] toJsonBytes(java.lang.Object value)

toJsonNodeOrNull

protected com.fasterxml.jackson.databind.JsonNode toJsonNodeOrNull(org.glassfish.grizzly.http.HttpContent response)
                                                            throws java.io.IOException

Throws:

java.io.IOException

toJsonNode

protected com.fasterxml.jackson.databind.JsonNode toJsonNode(org.glassfish.grizzly.http.HttpContent response)
                                                      throws java.io.IOException

Throws:

java.io.IOException

toKvObject

protected <T> KvObject<T> toKvObject(com.fasterxml.jackson.databind.JsonNode result,
                                     java.lang.Class<T> clazz)
                              throws java.io.IOException

Throws:

java.io.IOException

toKvObject

protected <T> KvObject<T> toKvObject(org.glassfish.grizzly.http.HttpContent response,
                                     java.lang.String collection,
                                     java.lang.String key,
                                     java.lang.Class<T> clazz)
                              throws java.io.IOException

Throws:

java.io.IOException

parseLink

protected <T> OrchestrateRequest<T> parseLink(java.lang.String name,
                                              com.fasterxml.jackson.databind.JsonNode jsonNode,
                                              io.orchestrate.client.ResponseConverter<T> clazz)