com.ibm.watson.developer_cloud.document_conversion.v1.helpers

Class BatchHelper

java.lang.Object

com.ibm.watson.developer_cloud.document_conversion.v1.helpers.BatchHelper

public class BatchHelper
extends Object

Helper for the batch API calls NOTE: The methods in this class should not be called directly! Please make all calls to the service using the DocumentConversion class.

See Also:

DocumentConversion

Constructor Summary

Constructors

Constructor and Description
BatchHelper(DocumentConversion docConversionService) Sets the service object.

Method Summary

Modifier and Type	Method and Description
Batch	createBatch(String name, List<Property> properties) Creates a new batch with name and properties POST /v1/batches.
String	filterJson(com.google.gson.JsonObject jsonObject) Escapes the Json object string to filter and send in the request.
Batch	getBatch(String batchId) Gets an existing batch GET /v1/batches/{batch_id}.
BatchCollection	getBatchCollection(Map<String,Object> batchListParams) Gets a collection of all existing batches with optional query parameters for filtering results.
Batch	updateBatch(String batchId, String name, List<Property> properties) Updates an existing batch with the provided name and properties PUT /v1/batches/{batch_id}.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchHelper

public BatchHelper(DocumentConversion docConversionService)

Sets the service object.

Parameters:

docConversionService - the doc conversion service

Method Detail

createBatch

public Batch createBatch(String name,
                         List<Property> properties)

Creates a new batch with name and properties POST /v1/batches.

Parameters:

name - the name of the created batch

properties - the properties for the created batch

Returns:

requested Batch

See Also:

DocumentConversion.createBatch(String, List)

getBatchCollection

public BatchCollection getBatchCollection(Map<String,Object> batchListParams)

Gets a collection of all existing batches with optional query parameters for filtering results. GET /v1/batches

Parameters:

batchListParams - The parameters to be used in the batch list service call. The parameters - token, limit, name and since are optional

• String token - The reference to the starting element of the requested page which is provided by the server, pass null to get the first page
• int limit - The number of batches to get, pass 0 to use the default limit from server (100)
• String name - The name of batches to get, pass null to exclude this filter
• Date since - The date to filter on, batches created on or after the provided date and time format will be returned, pass null to exclude this filter

Returns:

Batches based on filtering parameters provided

See Also:

DocumentConversion.getBatchCollection(Map)

getBatch

public Batch getBatch(String batchId)

Gets an existing batch GET /v1/batches/{batch_id}.

Parameters:

batchId - id for the batch to be updated

Returns:

requested Batch

See Also:

DocumentConversion.getBatch(String)

updateBatch

public Batch updateBatch(String batchId,
                         String name,
                         List<Property> properties)

Updates an existing batch with the provided name and properties PUT /v1/batches/{batch_id}.

Parameters:

batchId - id for the batch to be updated

name - name of the batch to be updated

properties - properties of the batch to be updated

Returns:

updated Batch

See Also:

DocumentConversion.updateBatch(String, String, List)

filterJson

public String filterJson(com.google.gson.JsonObject jsonObject)

Escapes the Json object string to filter and send in the request.

Parameters:

jsonObject - Json Object to be filtered

Returns:

filtered Json String