Klasse AsyncJobsResource

java.lang.Object

com.cloudconvert.resource.AbstractResource

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

com.cloudconvert.resource.async.AsyncJobsResource

Alle implementierten Schnittstellen:

Closeable, AutoCloseable

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

Feldübersicht

Von Klasse geerbte Felder com.cloudconvert.resource.AbstractJobsResource

PATH_SEGMENT_JOBS, PATH_SEGMENT_WAIT

Von Klasse geerbte Felder 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

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
AsyncJobsResource(SettingsProvider settingsProvider, ObjectMapperProvider objectMapperProvider, AsyncRequestExecutor asyncRequestExecutor)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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.

Von Klasse geerbte Methoden com.cloudconvert.resource.AbstractJobsResource

getCreateHttpUriRequest, getDeleteHttpUriRequest, getListHttpUriRequest, getShowHttpUriRequest, getWaitHttpUriRequest

Von Klasse geerbte Methoden com.cloudconvert.resource.AbstractResource

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

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

AsyncJobsResource

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

Methodendetails

create

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

Beschreibung aus Klasse kopiert: AbstractJobsResource

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

Angegeben von:

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

Parameter:

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.

Gibt zurück:

AbstractJobsResource

Löst aus:

IOException

URISyntaxException

create

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

Beschreibung aus Klasse kopiert: AbstractJobsResource

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

Angegeben von:

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

Parameter:

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.

Gibt zurück:

AbstractJobsResource

Löst aus:

IOException

URISyntaxException

show

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

Beschreibung aus Klasse kopiert: AbstractJobsResource

Show a job. Requires the task.read scope.

Angegeben von:

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

Parameter:

jobId - job id

Gibt zurück:

AbstractJobsResource

Löst aus:

IOException

URISyntaxException

wait

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

Beschreibung aus Klasse kopiert: 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.

Angegeben von:

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

Parameter:

jobId - job id

Gibt zurück:

AbstractJobsResource

Löst aus:

IOException

URISyntaxException

list

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

Beschreibung aus Klasse kopiert: AbstractJobsResource

List all jobs. Requires the task.read scope.

Angegeben von:

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

Gibt zurück:

AbstractJobsResource

Löst aus:

IOException

URISyntaxException

list

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

Beschreibung aus Klasse kopiert: AbstractJobsResource

List all jobs. Requires the task.read scope.

Angegeben von:

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

Parameter:

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.

Gibt zurück:

AbstractJobsResource

Löst aus:

IOException

URISyntaxException

list

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

Beschreibung aus Klasse kopiert: AbstractJobsResource

List all jobs. Requires the task.read scope.

Angegeben von:

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

Parameter:

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.

Gibt zurück:

AbstractJobsResource

Löst aus:

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

Beschreibung aus Klasse kopiert: AbstractJobsResource

List all jobs. Requires the task.read scope.

Angegeben von:

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

Parameter:

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.

Gibt zurück:

AbstractJobsResource

Löst aus:

IOException

URISyntaxException

delete

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

Beschreibung aus Klasse kopiert: AbstractJobsResource

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

Angegeben von:

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

Parameter:

jobId - job id

Gibt zurück:

AbstractJobsResource

Löst aus:

IOException

URISyntaxException

close

public void close()
           throws IOException

Löst aus:

IOException