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

Class BatchDocumentHelper

java.lang.Object

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

public class BatchDocumentHelper
extends Object

Helper for the batch documents 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
BatchDocumentHelper(DocumentConversion docConversionService) Sets the service object.

Method Summary

Modifier and Type	Method and Description
BatchDocumentResponse	addDocumentToBatch(String batchId, String documentId) Adds a document to the batch whose ids are specified PUT /v1/batches/{batch_id}/documents/{document_id}.
BatchDocumentResponse	getBatchDocument(String batchId, String documentId) Retrieves the document from the batch whose ids are specified GET /v1/batches/{batch_id}/documents/{document_id}.
BatchDocumentCollection	getBatchDocumentCollection(String batchId, Map<String,Object> batchDocListParams) Gets a list of existing documents in the batch with optional query parameters for filtering results.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchDocumentHelper

public BatchDocumentHelper(DocumentConversion docConversionService)

Sets the service object.

Parameters:

docConversionService - the doc conversion service

Method Detail

addDocumentToBatch

public BatchDocumentResponse addDocumentToBatch(String batchId,
                                                String documentId)

Adds a document to the batch whose ids are specified PUT /v1/batches/{batch_id}/documents/{document_id}.

Parameters:

batchId - id of the batch to be retrieved

documentId - id of the document to be retrieved

Returns:

BatchDocumentResponse

See Also:

DocumentConversion.addDocumentToBatch(String, String)

getBatchDocumentCollection

public BatchDocumentCollection getBatchDocumentCollection(String batchId,
                                                          Map<String,Object> batchDocListParams)

Gets a list of existing documents in the batch with optional query parameters for filtering results. GET /v1/batches/{batch_id}/documents

Parameters:

batchId - The id for the batch whose documents are returned

batchDocListParams - The parameters to be used in the batch documents list service call. The parameters - token, limit, since, job_id and media_type 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 documents in a batch to get, pass 0 to use the default limit from server (100)
• Date since - The date to filter on, documents added to the batch on or after the provided date and time format will be returned.

Returns:

Documents in a batch based on the filtering parameters provided

See Also:

DocumentConversion.getBatchDocumentCollection(String, Map)

getBatchDocument

public BatchDocumentResponse getBatchDocument(String batchId,
                                              String documentId)

Retrieves the document from the batch whose ids are specified GET /v1/batches/{batch_id}/documents/{document_id}.

Parameters:

batchId - id of the batch to be retrieved

documentId - id of the document to be retrieved

Returns:

BatchDocumentResponse

See Also:

DocumentConversion.getBatchDocument(String, String)