Package com.cloudconvert.resource.async

Class AsyncJobsResource

java.lang.Object

com.cloudconvert.resource.AbstractResource

com.cloudconvert.resource.AbstractJobsResource<AsyncResult<JobResponse>,AsyncResult<Pageable<JobResponse>>,AsyncResult<Void>>

com.cloudconvert.resource.async.AsyncJobsResource

All Implemented Interfaces:

Closeable, AutoCloseable

public class AsyncJobsResource
extends AbstractJobsResource<AsyncResult<JobResponse>,AsyncResult<Pageable<JobResponse>>,AsyncResult<Void>>

Field Summary

Fields inherited from class com.cloudconvert.resource.AbstractJobsResource

PATH_SEGMENT_JOBS, PATH_SEGMENT_WAIT

Fields inherited from class com.cloudconvert.resource.AbstractResource

BEARER, HEADER_AUTHORIZATION, HEADER_USER_AGENT, INPUT_STREAM_TYPE_REFERENCE, JOB_RESPONSE_PAGEABLE_TYPE_REFERENCE, JOB_RESPONSE_TYPE_REFERENCE, MAP_STRING_TO_OBJECT_TYPE_REFERENCE, OPERATION_RESPONSE_PAGEABLE_TYPE_REFERENCE, TASK_RESPONSE_PAGEABLE_TYPE_REFERENCE, TASK_RESPONSE_TYPE_REFERENCE, USER_RESPONSE_TYPE_REFERENCE, V2, VALUE_USER_AGENT, VOID_TYPE_REFERENCE, WEBHOOKS_RESPONSE_PAGEABLE_TYPE_REFERENCE, WEBHOOKS_RESPONSE_TYPE_REFERENCE

Constructor Summary

Constructors

Constructor	Description
AsyncJobsResource(SettingsProvider settingsProvider, ObjectMapperProvider objectMapperProvider, AsyncRequestExecutor asyncRequestExecutor)

Method Summary

Modifier and Type	Method	Description
void	close()
AsyncResult<JobResponse>	create(@NotNull Map<String,TaskRequest> tasks)	Create a job with one ore more tasks.
AsyncResult<JobResponse>	create(@NotNull Map<String,TaskRequest> tasks, @NotNull String tag)	Create a job with one ore more tasks.
AsyncResult<Void>	delete(@NotNull String jobId)	Delete a job, including all tasks and data.
AsyncResult<Pageable<JobResponse>>	list()	List all jobs.
AsyncResult<Pageable<JobResponse>>	list(@NotNull Map<Filter,String> filters)	List all jobs.
AsyncResult<Pageable<JobResponse>>	list(@NotNull Map<Filter,String> filters, @NotNull List<Include> includes)	List all jobs.
AsyncResult<Pageable<JobResponse>>	list(@NotNull Map<Filter,String> filters, @NotNull List<Include> includes, @Nullable Pagination pagination)	List all jobs.
AsyncResult<JobResponse>	show(@NotNull String jobId)	Show a job.
AsyncResult<JobResponse>	wait(@NotNull String jobId)	Wait until the job status is finished or error.

Methods inherited from class com.cloudconvert.resource.AbstractJobsResource

getCreateHttpUriRequest, getDeleteHttpUriRequest, getListHttpUriRequest, getShowHttpUriRequest, getWaitHttpUriRequest

Methods inherited from class com.cloudconvert.resource.AbstractResource

getHttpEntity, getHttpEntity, getHttpUriRequest, getHttpUriRequest, getJson, getSyncUri, getSyncUri, getUri, getUri, requestToMap

Methods inherited from class java.lang.Object

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

Constructor Details

AsyncJobsResource

public AsyncJobsResource(SettingsProvider settingsProvider,
 ObjectMapperProvider objectMapperProvider,
 AsyncRequestExecutor asyncRequestExecutor)

Method Details

create

public AsyncResult<JobResponse> create(@NotNull
 @NotNull Map<String,TaskRequest> tasks)
                                throws IOException,
URISyntaxException

Description copied from class: AbstractJobsResource

Create a job with one ore more tasks. Requires the task.write scope.

Specified by:

create in class AbstractJobsResource<AsyncResult<JobResponse>,AsyncResult<Pageable<JobResponse>>,AsyncResult<Void>>

Parameters:

tasks - The example on the right consists of three tasks: import-my-file, convert-my-file and export-my-file. You can name these tasks however you want, but only alphanumeric characters, - and _ are allowed in the task names.

Each task has a operation, which is the endpoint for creating the task (for example: convert, import/s3 or export/s3). The other parameters are the same as for creating the task using their direct endpoint. The input parameter allows it to directly reference the name of another task, created with the same job request.

Returns:

AbstractJobsResource

Throws:

IOException

URISyntaxException

create

public AsyncResult<JobResponse> create(@NotNull
 @NotNull Map<String,TaskRequest> tasks,
 @NotNull
 @NotNull String tag)
                                throws IOException,
URISyntaxException

Description copied from class: AbstractJobsResource

Create a job with one ore more tasks. Requires the task.write scope.

Specified by:

create in class AbstractJobsResource<AsyncResult<JobResponse>,AsyncResult<Pageable<JobResponse>>,AsyncResult<Void>>

Parameters:

tasks - The example on the right consists of three tasks: import-my-file, convert-my-file and export-my-file. You can name these tasks however you want, but only alphanumeric characters, - and _ are allowed in the task names.

Each task has a operation, which is the endpoint for creating the task (for example: convert, import/s3 or export/s3). The other parameters are the same as for creating the task using their direct endpoint. The input parameter allows it to directly reference the name of another task, created with the same job request.

tag - An arbitrary string to identify the job. Does not have any effect and can be used to associate the job with an ID in your application.

Returns:

AbstractJobsResource

Throws:

IOException

URISyntaxException

show

public AsyncResult<JobResponse> show(@NotNull
 @NotNull String jobId)
                              throws IOException,
URISyntaxException

Description copied from class: AbstractJobsResource

Show a job. Requires the task.read scope.

Specified by:

show in class AbstractJobsResource<AsyncResult<JobResponse>,AsyncResult<Pageable<JobResponse>>,AsyncResult<Void>>

Parameters:

jobId - job id

Returns:

AbstractJobsResource

Throws:

IOException

URISyntaxException

wait

public AsyncResult<JobResponse> wait(@NotNull
 @NotNull String jobId)
                              throws IOException,
URISyntaxException

Description copied from class: AbstractJobsResource

Wait until the job status is finished or error. This makes the request block until the job has been completed. Requires the task.read scope.

We do not recommend using this for long running jobs (e.g. video encodings). Your system might automatically time out requests if there is not data transferred for a longer time.

In general, please avoid to block your application until a CloudConvert job completes. There might be cases in which we need to queue your job which results in longer processing times than usual. Using an asynchronous approach with webhooks is beneficial in such cases.

Specified by:

wait in class AbstractJobsResource<AsyncResult<JobResponse>,AsyncResult<Pageable<JobResponse>>,AsyncResult<Void>>

Parameters:

jobId - job id

Returns:

AbstractJobsResource

Throws:

IOException

URISyntaxException

list

public AsyncResult<Pageable<JobResponse>> list()
                                        throws IOException,
URISyntaxException

Description copied from class: AbstractJobsResource

List all jobs. Requires the task.read scope.

Specified by:

list in class AbstractJobsResource<AsyncResult<JobResponse>,AsyncResult<Pageable<JobResponse>>,AsyncResult<Void>>

Returns:

AbstractJobsResource

Throws:

IOException

URISyntaxException

list

public AsyncResult<Pageable<JobResponse>> list(@NotNull
 @NotNull Map<Filter,String> filters)
                                        throws IOException,
URISyntaxException

Description copied from class: AbstractJobsResource

List all jobs. Requires the task.read scope.

Specified by:

list in class AbstractJobsResource<AsyncResult<JobResponse>,AsyncResult<Pageable<JobResponse>>,AsyncResult<Void>>

Parameters:

filters - (optional) Filters: - status - The result will be filtered to include only jobs with a specific status (processing, finished or error). - tag - The result will be filtered to include only jobs with a tag.

Returns:

AbstractJobsResource

Throws:

IOException

URISyntaxException

list

public AsyncResult<Pageable<JobResponse>> list(@NotNull
 @NotNull Map<Filter,String> filters,
 @NotNull
 @NotNull List<Include> includes)
                                        throws IOException,
URISyntaxException

Description copied from class: AbstractJobsResource

List all jobs. Requires the task.read scope.

Specified by:

list in class AbstractJobsResource<AsyncResult<JobResponse>,AsyncResult<Pageable<JobResponse>>,AsyncResult<Void>>

Parameters:

filters - (optional) Filters: - status - The result will be filtered to include only jobs with a specific status (processing, finished or error). - tag - The result will be filtered to include only jobs with a tag.

includes - (optional) Include tasks in the result.

Returns:

AbstractJobsResource

Throws:

IOException

URISyntaxException

list

public AsyncResult<Pageable<JobResponse>> list(@NotNull
 @NotNull Map<Filter,String> filters,
 @NotNull
 @NotNull List<Include> includes,
 @Nullable
 @Nullable Pagination pagination)
                                        throws IOException,
URISyntaxException

Description copied from class: AbstractJobsResource

List all jobs. Requires the task.read scope.

Specified by:

list in class AbstractJobsResource<AsyncResult<JobResponse>,AsyncResult<Pageable<JobResponse>>,AsyncResult<Void>>

Parameters:

filters - (optional) Filters: - status - The result will be filtered to include only jobs with a specific status (processing, finished or error). - tag - The result will be filtered to include only jobs with a tag.

includes - (optional) Include tasks in the result.

pagination - (optional) Pagination: - per_page - Number of tasks per page, defaults to 100. - page - The result page to show.

Returns:

AbstractJobsResource

Throws:

IOException

URISyntaxException

delete

public AsyncResult<Void> delete(@NotNull
 @NotNull String jobId)
                         throws IOException,
URISyntaxException

Description copied from class: AbstractJobsResource

Delete a job, including all tasks and data. Requires the task.write scope. Jobs are deleted automatically 24 hours after they have ended.

Specified by:

delete in class AbstractJobsResource<AsyncResult<JobResponse>,AsyncResult<Pageable<JobResponse>>,AsyncResult<Void>>

Parameters:

jobId - job id

Returns:

AbstractJobsResource

Throws:

IOException

URISyntaxException

close

public void close()
           throws IOException

Throws:

IOException