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

Class JobHelper

java.lang.Object

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

public class JobHelper
extends Object

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

Method Summary

Modifier and Type	Method and Description
JobResponse	createJob(String name, String batchId, ConversionTarget conversionTarget, com.google.gson.JsonObject config) Creates a new job by submitting a batch for processing POST /v1/jobs.
Job	getJob(String jobId) Gets information about a job GET /v1/jobs/{job_id}.
JobCollection	getJobCollection(Map<String,Object> jobListParams) Gets a list of all jobs with optional query parameters for filtering results.
InputStream	getJobLog(String jobId) Gets the job processing log GET /v1/jobs/{job_id}/log.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobHelper

public JobHelper(DocumentConversion docConversionService)

Sets the service object.

Parameters:

docConversionService - the doc conversion service

Method Detail

getJobCollection

public JobCollection getJobCollection(Map<String,Object> jobListParams)

Gets a list of all jobs with optional query parameters for filtering results. GET /v1/jobs

Parameters:

jobListParams - The parameters to be used in the job list service call. The parameters - token, limit, since, name, since and status 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 jobs to get, pass 0 to use the default limit from server (100)
• String name - The name of the jobs to get, pass null to exclude this filter
• Date since - The date to filter on, jobs created on or after the provided date and time format will be returned, pass null to exclude this filter
• String status - The status of the job to filter on, pass null to exclude this filter

Returns:

Jobs based on filtering parameters provided

See Also:

DocumentConversion.getJobCollection(Map)

createJob

public JobResponse createJob(String name,
                             String batchId,
                             ConversionTarget conversionTarget,
                             com.google.gson.JsonObject config)

Creates a new job by submitting a batch for processing POST /v1/jobs.

Parameters:

name - The name of the job

batchId - The id of the batch to process

conversionTarget - The conversion target to use

config - The configuration to use for the job (optional), pass null to use default config

Returns:

JobResponse

See Also:

DocumentConversion.createJob(String, String, ConversionTarget, JsonObject)

getJob

public Job getJob(String jobId)

Gets information about a job GET /v1/jobs/{job_id}.

Parameters:

jobId - The id of the job

Returns:

Job

See Also:

DocumentConversion.getJob(String)

getJobLog

public InputStream getJobLog(String jobId)

Gets the job processing log GET /v1/jobs/{job_id}/log.

Parameters:

jobId - The id of the job

Returns:

Job's processing log

See Also:

DocumentConversion.getJobLog(String)