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

Class OutputHelper

java.lang.Object

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

public class OutputHelper
extends Object

Helper class for all output 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
OutputHelper(DocumentConversion docConversionService) Sets the service object.

Method Summary

Modifier and Type	Method and Description
InputStream	getOutput(String outputId) Gets the content of the output requested.
OutputCollection	getOutputCollection(Map<String,Object> outputListParams) Gets a collection of all generated outputs 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

OutputHelper

public OutputHelper(DocumentConversion docConversionService)

Sets the service object.

Parameters:

docConversionService - the doc conversion service

Method Detail

getOutputCollection

public OutputCollection getOutputCollection(Map<String,Object> outputListParams)

Gets a collection of all generated outputs with optional query parameters for filtering results. GET /v1/output

Parameters:

outputListParams - The parameters to be used in the output 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 outputs to get, pass 0 to use the default limit from server (100)
• Date since - The date to filter on, outputs created on or after the provided date and time format will be returned.
• String job_id - The id of a job to filter outputs by, pass null to exclude this filter
• String media_type - The Internet media type to filter on, pass null to exclude this filter

Returns:

Outputs based on filtering parameters provided

See Also:

DocumentConversion.getOutputCollection(Map)

getOutput

public InputStream getOutput(String outputId)

Gets the content of the output requested.

Parameters:

outputId - The id of the output to get

Returns:

The requested Output

See Also:

DocumentConversion.getOutput(String)