com.evrythng.java.wrapper.service

Class BatchService

java.lang.Object

com.evrythng.java.wrapper.core.EvrythngServiceBase

com.evrythng.java.wrapper.service.BatchService

public class BatchService
extends EvrythngServiceBase

Service wrapper for the /batches endpoint of the EVRYTHNG API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_BATCH
static String	PATH_BATCH_TASK
static String	PATH_BATCH_TASK_LOGS
static String	PATH_BATCH_TASKS
static String	PATH_BATCHES

Constructor Summary

Constructors

Constructor and Description
BatchService(ApiManager apiManager)

Method Summary

Modifier and Type	Method and Description
EvrythngApiBuilder.Builder<Batch>	batchCreator(Batch batch) Creates a new Batch.
EvrythngApiBuilder.Builder<Boolean>	batchDeleter(String batchId) Deletes the referenced Batch.
EvrythngApiBuilder.Builder<List<Batch>>	batchesReader() Retrieves Batch resources.
EvrythngApiBuilder.Builder<Batch>	batchReader(String batchId) Retrieves the referenced Batch.
EvrythngApiBuilder.Builder<Batch>	batchUpdater(String batchId, Batch batch) Updates the referenced Batch.
EvrythngApiBuilder.Builder<List<JobLogEntry>>	logsReader(String batchId, String taskId) Retrieves the JobLogEntry elements generated by the task.
EvrythngApiBuilder.Builder<AcceptedResourceResponse>	taskCreator(String batchId, TaskOnBatch task) Creates a new TaskOnBatch to be completed asynchronously on a batch.
EvrythngApiBuilder.Builder<TaskOnBatch>	taskReader(String batchId, String taskId) Retrieves the referenced TaskOnBatch of the batch.
EvrythngApiBuilder.Builder<List<TaskOnBatch>>	tasksReader(String batchId) Retrieves TaskOnBatch resources of the batch.

Methods inherited from class com.evrythng.java.wrapper.core.EvrythngServiceBase

absoluteUri, delete, deleteMultiple, encodeBase64, get, getConfig, iterator, mqttUrl, onBuilderCreated, post, post, postAsynchronously, postMultipart, postMultipart, put, put, putMultipart, putMultipart, putMultiple, urlEncodePathPart

Methods inherited from class java.lang.Object

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

Field Detail

PATH_BATCHES

public static final String PATH_BATCHES

See Also:

Constant Field Values

PATH_BATCH

public static final String PATH_BATCH

See Also:

Constant Field Values

PATH_BATCH_TASKS

public static final String PATH_BATCH_TASKS

See Also:

Constant Field Values

PATH_BATCH_TASK

public static final String PATH_BATCH_TASK

See Also:

Constant Field Values

PATH_BATCH_TASK_LOGS

public static final String PATH_BATCH_TASK_LOGS

See Also:

Constant Field Values

Constructor Detail

BatchService

public BatchService(ApiManager apiManager)

Method Detail

batchCreator

public EvrythngApiBuilder.Builder<Batch> batchCreator(Batch batch)
                                               throws EvrythngClientException

Creates a new Batch.

POST "/batches"

Parameters:

batch - the instance holding the Batch resource data

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

batchesReader

public EvrythngApiBuilder.Builder<List<Batch>> batchesReader()
                                                      throws EvrythngClientException

Retrieves Batch resources.

GET "/batches"

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

batchReader

public EvrythngApiBuilder.Builder<Batch> batchReader(String batchId)
                                              throws EvrythngClientException

Retrieves the referenced Batch.

GET "/batches/%s"

Parameters:

batchId - batch id

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

batchUpdater

public EvrythngApiBuilder.Builder<Batch> batchUpdater(String batchId,
                                                      Batch batch)
                                               throws EvrythngClientException

Updates the referenced Batch.

PUT "/batches/%s"

Parameters:

batchId - batch id

batch - Batch instance

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

batchDeleter

public EvrythngApiBuilder.Builder<Boolean> batchDeleter(String batchId)
                                                 throws EvrythngClientException

Deletes the referenced Batch.

DELETE "/batches/%s"

Parameters:

batchId - batch id

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

taskCreator

public EvrythngApiBuilder.Builder<AcceptedResourceResponse> taskCreator(String batchId,
                                                                        TaskOnBatch task)
                                                                 throws EvrythngClientException

Creates a new TaskOnBatch to be completed asynchronously on a batch.

POST "/batches/%s/tasks"

Parameters:

batchId - batch id

task - the instance holding the TaskOnBatch resource data

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

tasksReader

public EvrythngApiBuilder.Builder<List<TaskOnBatch>> tasksReader(String batchId)
                                                          throws EvrythngClientException

Retrieves TaskOnBatch resources of the batch.

GET "/batches/%s/tasks"

Parameters:

batchId - batch id

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

taskReader

public EvrythngApiBuilder.Builder<TaskOnBatch> taskReader(String batchId,
                                                          String taskId)
                                                   throws EvrythngClientException

Retrieves the referenced TaskOnBatch of the batch.

GET "/batches/%s/tasks/%s"

Parameters:

batchId - batch id

taskId - task id

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

logsReader

public EvrythngApiBuilder.Builder<List<JobLogEntry>> logsReader(String batchId,
                                                                String taskId)
                                                         throws EvrythngClientException

Retrieves the JobLogEntry elements generated by the task.

GET "/batches/%s/tasks/%s/logs"

Parameters:

batchId - batch id

taskId - task id

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException