Package com.cloudconvert.resource.async

Class AsyncTasksResource

java.lang.Object

com.cloudconvert.resource.AbstractResource

com.cloudconvert.resource.AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

com.cloudconvert.resource.async.AsyncTasksResource

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class AsyncTasksResource
extends AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Field Summary

Fields inherited from class com.cloudconvert.resource.AbstractTasksResource

PATH_SEGMENT_CANCEL, PATH_SEGMENT_OPERATIONS, PATH_SEGMENT_RETRY, PATH_SEGMENT_TASKS, 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

AsyncTasksResource(SettingsProvider settingsProvider, ObjectMapperProvider objectMapperProvider, AsyncRequestExecutor asyncRequestExecutor, AsyncConvertFilesResource asyncConvertFilesResource, AsyncOptimizeFilesResource asyncOptimizeFilesResource, AsyncCaptureWebsitesResource asyncCaptureWebsitesResource, AsyncMergeFilesResource asyncMergeFilesResource, AsyncCreateArchivesResource asyncCreateArchivesResource, AsyncExecuteCommandsResource asyncExecuteCommandsResource, AsyncCreateThumbnailsResource asyncCreateThumbnailsResource, AsyncGetMetadataResource asyncGetMetadataResource, AsyncWriteMetadataResource asyncWriteMetadataResource, AsyncAddWatermarkResource asyncAddWatermarkResource)

Method Summary

Modifier and Type	Method	Description
AsyncResult<TaskResponse>	archive(@NotNull CreateArchivesTaskRequest createArchivesTaskRequest)	Create a task to create a ZIP, RAR, 7Z, TAR, TAR.GZ or TAR.BZ2 archive.
AsyncResult<TaskResponse>	cancel(@NotNull java.lang.String taskId)	Cancel a task that is in status waiting or processing.
AsyncResult<TaskResponse>	capture(@NotNull CaptureWebsitesTaskRequest captureWebsitesTaskRequest)	Create a task to convert a website to PDF or to capture a screenshot of a website (png, jpg).
void	close()
AsyncResult<TaskResponse>	command(@NotNull ExecuteCommandsTaskRequest executeCommandsTaskRequest)	Create a task to execute a command.
AsyncResult<TaskResponse>	convert(@NotNull ConvertFilesTaskRequest convertFilesTaskRequest)	Create a task to convert one input file from input_format to output_format.
AsyncResult<Pageable<OperationResponse>>	convertFormats()	List all supported formats, their engines and possible options.
AsyncResult<Pageable<OperationResponse>>	convertFormats(@NotNull java.util.Map<Filter,java.lang.String> filters)	List all supported formats, their engines and possible options.
AsyncResult<Pageable<OperationResponse>>	convertFormats(@NotNull java.util.Map<Filter,java.lang.String> filters, @NotNull java.util.List<Include> includes)	List all supported formats, their engines and possible options.
AsyncResult<Pageable<OperationResponse>>	convertFormats(@NotNull java.util.Map<Filter,java.lang.String> filters, @NotNull java.util.List<Include> includes, @Nullable java.lang.Boolean alternative)	List all supported formats, their engines and possible options.
AsyncResult<java.lang.Void>	delete(@NotNull java.lang.String taskId)	Delete a task, including all data.
AsyncResult<Pageable<TaskResponse>>	list()	List all tasks with their status, payload and result.
AsyncResult<Pageable<TaskResponse>>	list(@NotNull java.util.Map<Filter,java.lang.String> filters)	List all tasks with their status, payload and result.
AsyncResult<Pageable<TaskResponse>>	list(@NotNull java.util.Map<Filter,java.lang.String> filters, @NotNull java.util.List<Include> includes)	List all tasks with their status, payload and result.
AsyncResult<Pageable<TaskResponse>>	list(@NotNull java.util.Map<Filter,java.lang.String> filters, @NotNull java.util.List<Include> includes, @Nullable Pagination pagination)	List all tasks with their status, payload and result.
AsyncResult<TaskResponse>	merge(@NotNull MergeFilesTaskRequest mergeFilesTaskRequest)	Create a task to merge at least two files to one PDF.
AsyncResult<TaskResponse>	metadata(@NotNull GetMetadataTaskRequest getMetadataTaskRequest)	Create a task to extract metadata from one file.
AsyncResult<Pageable<OperationResponse>>	operations()	List all possible operations, formats, engines and possible options.
AsyncResult<Pageable<OperationResponse>>	operations(@NotNull java.util.Map<Filter,java.lang.String> filters)	List all possible operations, formats, engines and possible options.
AsyncResult<Pageable<OperationResponse>>	operations(@NotNull java.util.Map<Filter,java.lang.String> filters, @NotNull java.util.List<Include> includes)	List all possible operations, formats, engines and possible options.
AsyncResult<Pageable<OperationResponse>>	operations(@NotNull java.util.Map<Filter,java.lang.String> filters, @NotNull java.util.List<Include> includes, @Nullable java.lang.Boolean alternative)	List all possible operations, formats, engines and possible options.
AsyncResult<TaskResponse>	optimize(@NotNull OptimizeFilesTaskRequest optimizeFilesTaskRequest)	Create a task to optimize and compress a file.
AsyncResult<TaskResponse>	retry(@NotNull java.lang.String taskId)	Create a new task, based on the payload of another task.
AsyncResult<TaskResponse>	show(@NotNull java.lang.String taskId)	Show a task.
AsyncResult<TaskResponse>	show(@NotNull java.lang.String taskId, @NotNull java.util.List<Include> includes)	Show a task.
AsyncResult<TaskResponse>	thumbnail(@NotNull CreateThumbnailsTaskRequest createThumbnailsTaskRequest)	Create a task to create a thumbnail of one file.
AsyncResult<TaskResponse>	wait(@NotNull java.lang.String taskId)	Wait until the task status is finished or error.
AsyncResult<TaskResponse>	watermark(@NotNull AddWatermarkTaskRequest addWatermarkTaskRequest)	Create a task to add a watermark to a file.
AsyncResult<TaskResponse>	writeMetadata(@NotNull WriteMetadataTaskRequest writeMetadataTaskRequest)	Create a task to write file metadata.

Methods inherited from class com.cloudconvert.resource.AbstractTasksResource

getCancelHttpUriRequest, getDeleteHttpUriRequest, getListHttpUriRequest, getOperationsHttpUriRequest, getRetryHttpUriRequest, 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

AsyncTasksResource

public AsyncTasksResource(SettingsProvider settingsProvider,
ObjectMapperProvider objectMapperProvider,
AsyncRequestExecutor asyncRequestExecutor,
AsyncConvertFilesResource asyncConvertFilesResource,
AsyncOptimizeFilesResource asyncOptimizeFilesResource,
AsyncCaptureWebsitesResource asyncCaptureWebsitesResource,
AsyncMergeFilesResource asyncMergeFilesResource,
AsyncCreateArchivesResource asyncCreateArchivesResource,
AsyncExecuteCommandsResource asyncExecuteCommandsResource,
AsyncCreateThumbnailsResource asyncCreateThumbnailsResource,
AsyncGetMetadataResource asyncGetMetadataResource,
AsyncWriteMetadataResource asyncWriteMetadataResource,
AsyncAddWatermarkResource asyncAddWatermarkResource)

Method Details

show

public AsyncResult<TaskResponse> show(@NotNull
@NotNull java.lang.String taskId)
                               throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

Show a task. Requires the task.read scope.

Specified by:

show in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

taskId - task id

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

show

public AsyncResult<TaskResponse> show(@NotNull
@NotNull java.lang.String taskId,
@NotNull
@NotNull java.util.List<Include> includes)
                               throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

Show a task. Requires the task.read scope.

Specified by:

show in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

taskId - task id

includes - (optional) Include retries, depends_on_tasks, payload and/or job in the result. Multiple include values are separated by , (comma).

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

wait

public AsyncResult<TaskResponse> wait(@NotNull
@NotNull java.lang.String taskId)
                               throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

Wait until the task status is finished or error. This makes the request block until the task 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 task which results in longer processing times than usual. Using an asynchronous approach with webhooks is beneficial in such cases.

Specified by:

wait in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

taskId - task id

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

list

public AsyncResult<Pageable<TaskResponse>> list()
                                         throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

List all tasks with their status, payload and result. Requires the task.read scope.

Specified by:

list in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

list

public AsyncResult<Pageable<TaskResponse>> list(@NotNull
@NotNull java.util.Map<Filter,java.lang.String> filters)
                                         throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

List all tasks with their status, payload and result. Requires the task.read scope.

Specified by:

list in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

filters - (optional) Filters: - job_id - The result will be filtered to include only tasks for a specific Job ID. - status - The result will be filtered to include only tasks with a specific status (waiting, processing, finished or error). - operation - Filter result to only include tasks of with a matching operation (for example convert or import/s3).

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

list

public AsyncResult<Pageable<TaskResponse>> list(@NotNull
@NotNull java.util.Map<Filter,java.lang.String> filters,
@NotNull
@NotNull java.util.List<Include> includes)
                                         throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

List all tasks with their status, payload and result. Requires the task.read scope.

Specified by:

list in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

filters - (optional) Filters: - job_id - The result will be filtered to include only tasks for a specific Job ID. - status - The result will be filtered to include only tasks with a specific status (waiting, processing, finished or error). - operation - Filter result to only include tasks of with a matching operation (for example convert or import/s3).

includes - (optional) Include retries and/or depends_on_tasks in the result.

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

list

public AsyncResult<Pageable<TaskResponse>> list(@NotNull
@NotNull java.util.Map<Filter,java.lang.String> filters,
@NotNull
@NotNull java.util.List<Include> includes,
@Nullable
@Nullable Pagination pagination)
                                         throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

List all tasks with their status, payload and result. Requires the task.read scope.

Specified by:

list in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

filters - (optional) Filters: - job_id - The result will be filtered to include only tasks for a specific Job ID. - status - The result will be filtered to include only tasks with a specific status (waiting, processing, finished or error). - operation - Filter result to only include tasks of with a matching operation (for example convert or import/s3).

includes - (optional) Include retries and/or depends_on_tasks in the result.

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

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

cancel

public AsyncResult<TaskResponse> cancel(@NotNull
@NotNull java.lang.String taskId)
                                 throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

Cancel a task that is in status waiting or processing. Requires the task.write scope.

Specified by:

cancel in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

taskId - task id

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

retry

public AsyncResult<TaskResponse> retry(@NotNull
@NotNull java.lang.String taskId)
                                throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

Create a new task, based on the payload of another task. Requires the task.write scope.

Specified by:

retry in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

taskId - task id

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

delete

public AsyncResult<java.lang.Void> delete(@NotNull
@NotNull java.lang.String taskId)
                                   throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

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

Specified by:

delete in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

taskId - task id

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

operations

public AsyncResult<Pageable<OperationResponse>> operations()
                                                    throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

List all possible operations, formats, engines and possible options.

Specified by:

operations in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

operations

public AsyncResult<Pageable<OperationResponse>> operations(@NotNull
@NotNull java.util.Map<Filter,java.lang.String> filters)
                                                    throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

List all possible operations, formats, engines and possible options.

Specified by:

operations in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

filters - (optional) Filters: - operation - The result will be filtered to include only possible operations with a matching operation name (e.g. convert or optimize). - input_format - The result will be filtered to include only possible conversions with a matching input format. - output_format - The result will be filtered to include only possible conversions with a matching output format. - engine - Filter result to only include conversions with a matching engine name. - engine_version - Filter result to only include conversions with a matching engine version.

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

operations

public AsyncResult<Pageable<OperationResponse>> operations(@NotNull
@NotNull java.util.Map<Filter,java.lang.String> filters,
@NotNull
@NotNull java.util.List<Include> includes)
                                                    throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

List all possible operations, formats, engines and possible options.

Specified by:

operations in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

filters - (optional) Filters: - operation - The result will be filtered to include only possible operations with a matching operation name (e.g. convert or optimize). - input_format - The result will be filtered to include only possible conversions with a matching input format. - output_format - The result will be filtered to include only possible conversions with a matching output format. - engine - Filter result to only include conversions with a matching engine name. - engine_version - Filter result to only include conversions with a matching engine version.

includes - (optional) Include options and/or engine_versions in the result.

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

operations

public AsyncResult<Pageable<OperationResponse>> operations(@NotNull
@NotNull java.util.Map<Filter,java.lang.String> filters,
@NotNull
@NotNull java.util.List<Include> includes,
@Nullable
@Nullable java.lang.Boolean alternative)
                                                    throws java.io.IOException,
java.net.URISyntaxException

Description copied from class: AbstractTasksResource

List all possible operations, formats, engines and possible options.

Specified by:

operations in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

filters - (optional) Filters: - operation - The result will be filtered to include only possible operations with a matching operation name (e.g. convert or optimize). - input_format - The result will be filtered to include only possible conversions with a matching input format. - output_format - The result will be filtered to include only possible conversions with a matching output format. - engine - Filter result to only include conversions with a matching engine name. - engine_version - Filter result to only include conversions with a matching engine version.

includes - (optional) Include options and/or engine_versions in the result.

alternative - (optional) For some formats multiple alternative engines are available. If set to true, the result includes these alternative conversion types. Default to false.

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

convert

public AsyncResult<TaskResponse> convert(@NotNull
@NotNull ConvertFilesTaskRequest convertFilesTaskRequest)
                                  throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

Create a task to convert one input file from input_format to output_format. Requires the task.write scope.

Specified by:

convert in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

convertFilesTaskRequest - ConvertFilesTaskRequest

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

convertFormats

public AsyncResult<Pageable<OperationResponse>> convertFormats()
                                                        throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

List all supported formats, their engines and possible options.

Specified by:

convertFormats in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

convertFormats

public AsyncResult<Pageable<OperationResponse>> convertFormats(@NotNull
@NotNull java.util.Map<Filter,java.lang.String> filters)
                                                        throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

List all supported formats, their engines and possible options.

Specified by:

convertFormats in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

filters - (optional) Filters: - input_format - The result will be filtered to include only possible conversions with a matching input format. - output_format - The result will be filtered to include only possible conversions with a matching output format. - engine - Filter result to only include conversions with a matching engine name. - engine_version - Filter result to only include conversions with a matching engine version.

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

convertFormats

public AsyncResult<Pageable<OperationResponse>> convertFormats(@NotNull
@NotNull java.util.Map<Filter,java.lang.String> filters,
@NotNull
@NotNull java.util.List<Include> includes)
                                                        throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

List all supported formats, their engines and possible options.

Specified by:

convertFormats in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

filters - (optional) Filters: - input_format - The result will be filtered to include only possible conversions with a matching input format. - output_format - The result will be filtered to include only possible conversions with a matching output format. - engine - Filter result to only include conversions with a matching engine name. - engine_version - Filter result to only include conversions with a matching engine version.

includes - (optional) Include options and/or engine_versions in the result.

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

convertFormats

public AsyncResult<Pageable<OperationResponse>> convertFormats(@NotNull
@NotNull java.util.Map<Filter,java.lang.String> filters,
@NotNull
@NotNull java.util.List<Include> includes,
@Nullable
@Nullable java.lang.Boolean alternative)
                                                        throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

List all supported formats, their engines and possible options.

Specified by:

convertFormats in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

filters - (optional) Filters: - input_format - The result will be filtered to include only possible conversions with a matching input format. - output_format - The result will be filtered to include only possible conversions with a matching output format. - engine - Filter result to only include conversions with a matching engine name. - engine_version - Filter result to only include conversions with a matching engine version.

includes - (optional) Include options and/or engine_versions in the result.

alternative - (optional) For some formats multiple alternative engines are available. If set to true, the result includes these alternative conversion types. Default to false.

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

optimize

public AsyncResult<TaskResponse> optimize(@NotNull
@NotNull OptimizeFilesTaskRequest optimizeFilesTaskRequest)
                                   throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

Create a task to optimize and compress a file. Currently supported formats are PDF, PNG and JPG.

Specified by:

optimize in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

optimizeFilesTaskRequest - OptimizeFilesTaskRequest

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

capture

public AsyncResult<TaskResponse> capture(@NotNull
@NotNull CaptureWebsitesTaskRequest captureWebsitesTaskRequest)
                                  throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

Create a task to convert a website to PDF or to capture a screenshot of a website (png, jpg).

Specified by:

capture in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

captureWebsitesTaskRequest - CaptureWebsitesTaskRequest

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

merge

public AsyncResult<TaskResponse> merge(@NotNull
@NotNull MergeFilesTaskRequest mergeFilesTaskRequest)
                                throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

Create a task to merge at least two files to one PDF. If input files are not PDFs yet, they are automatically converted to PDF.

Specified by:

merge in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

mergeFilesTaskRequest - MergeFilesTaskRequest

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

archive

public AsyncResult<TaskResponse> archive(@NotNull
@NotNull CreateArchivesTaskRequest createArchivesTaskRequest)
                                  throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

Create a task to create a ZIP, RAR, 7Z, TAR, TAR.GZ or TAR.BZ2 archive.

Specified by:

archive in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

createArchivesTaskRequest - CreateArchivesTaskRequest

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

command

public AsyncResult<TaskResponse> command(@NotNull
@NotNull ExecuteCommandsTaskRequest executeCommandsTaskRequest)
                                  throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

Create a task to execute a command. Currently, ffmpeg, imagemagick and graphicsmagick commands re supported. You can access the files from the input task in the /input/{taskName}/ (For example: /input/import-1/) directory. All files that are created in the /output/ directory are available for following tasks (e.g. export tasks).

Specified by:

command in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

executeCommandsTaskRequest - ExecuteCommandsTaskRequest

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

thumbnail

public AsyncResult<TaskResponse> thumbnail(@NotNull
@NotNull CreateThumbnailsTaskRequest createThumbnailsTaskRequest)
                                    throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

Create a task to create a thumbnail of one file. Requires the task.write scope.

Specified by:

thumbnail in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

createThumbnailsTaskRequest - CreateThumbnailsTaskRequest

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

metadata

public AsyncResult<TaskResponse> metadata(@NotNull
@NotNull GetMetadataTaskRequest getMetadataTaskRequest)
                                   throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

Create a task to extract metadata from one file. Requires the task.write scope.

Specified by:

metadata in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

getMetadataTaskRequest - GetMetadataTaskRequest

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

writeMetadata

public AsyncResult<TaskResponse> writeMetadata(@NotNull
@NotNull WriteMetadataTaskRequest writeMetadataTaskRequest)
                                        throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

Create a task to write file metadata.

Specified by:

writeMetadata in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

writeMetadataTaskRequest - WriteMetadataTaskRequest

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

watermark

public AsyncResult<TaskResponse> watermark(@NotNull
@NotNull AddWatermarkTaskRequest addWatermarkTaskRequest)
                                    throws java.io.IOException,
java.net.URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractTasksResource

Create a task to add a watermark to a file. Requires the task.write scope.

Specified by:

watermark in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Parameters:

addWatermarkTaskRequest - AddWatermarkTaskRequest

Returns:

AbstractTasksResource

Throws:

java.io.IOException

java.net.URISyntaxException

CloudConvertClientException

CloudConvertServerException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Overrides:

close in class AbstractTasksResource<AsyncResult<TaskResponse>,AsyncResult<Pageable<TaskResponse>>,AsyncResult<java.lang.Void>,AsyncResult<Pageable<OperationResponse>>>

Throws:

java.io.IOException