Klasse AbstractJobsResource<JRAR extends AbstractResult<JobResponse>,JRPAR extends AbstractResult<Pageable<JobResponse>>,VAR extends AbstractResult<Void>>

java.lang.Object

com.cloudconvert.resource.AbstractResource

com.cloudconvert.resource.AbstractJobsResource<JRAR,JRPAR,VAR>

Alle implementierten Schnittstellen:

Closeable, AutoCloseable

Bekannte direkte Unterklassen:

AsyncJobsResource, JobsResource

public abstract class AbstractJobsResource<JRAR extends AbstractResult<JobResponse>,JRPAR extends AbstractResult<Pageable<JobResponse>>,VAR extends AbstractResult<Void>>
extends AbstractResource

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	PATH_SEGMENT_JOBS
static final String	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
AbstractJobsResource(SettingsProvider settingsProvider, ObjectMapperProvider objectMapperProvider)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
abstract JRAR	create(@NotNull Map<String,TaskRequest> tasks)	Create a job with one ore more tasks.
abstract JRAR	create(@NotNull Map<String,TaskRequest> tasks, @NotNull String tag)	Create a job with one ore more tasks.
abstract VAR	delete(@NotNull String jobId)	Delete a job, including all tasks and data.
protected org.apache.http.client.methods.HttpUriRequest	getCreateHttpUriRequest(@NotNull Map<String,TaskRequest> tasks, @NotNull String tag)
protected org.apache.http.client.methods.HttpUriRequest	getDeleteHttpUriRequest(@NotNull String jobId)
protected org.apache.http.client.methods.HttpUriRequest	getListHttpUriRequest(@NotNull Map<Filter,String> filters, @NotNull List<Include> includes, @Nullable Pagination pagination)
protected org.apache.http.client.methods.HttpUriRequest	getShowHttpUriRequest(@NotNull String jobId)
protected org.apache.http.client.methods.HttpUriRequest	getWaitHttpUriRequest(@NotNull String jobId)
abstract JRPAR	list()	List all jobs.
abstract JRPAR	list(@NotNull Map<Filter,String> filters)	List all jobs.
abstract JRPAR	list(@NotNull Map<Filter,String> filters, @NotNull List<Include> includes)	List all jobs.
abstract JRPAR	list(@NotNull Map<Filter,String> filters, @NotNull List<Include> includes, @Nullable Pagination pagination)	List all jobs.
abstract JRAR	show(@NotNull String jobId)	Show a job.
abstract JRAR	wait(@NotNull String jobId)	Wait until the job status is finished or error.

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

Von Schnittstelle geerbte Methoden java.io.Closeable

close

Felddetails

PATH_SEGMENT_JOBS

public static final String PATH_SEGMENT_JOBS

Siehe auch:

• Konstantenfeldwerte

PATH_SEGMENT_WAIT

public static final String PATH_SEGMENT_WAIT

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

AbstractJobsResource

public AbstractJobsResource(SettingsProvider settingsProvider,
 ObjectMapperProvider objectMapperProvider)

Methodendetails

create

public abstract JRAR create(@NotNull
 @NotNull Map<String,TaskRequest> tasks)
                     throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

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

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

CloudConvertClientException

CloudConvertServerException

create

public abstract JRAR create(@NotNull
 @NotNull Map<String,TaskRequest> tasks,
 @NotNull
 @NotNull String tag)
                     throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

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

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

CloudConvertClientException

CloudConvertServerException

getCreateHttpUriRequest

protected org.apache.http.client.methods.HttpUriRequest getCreateHttpUriRequest(@NotNull
 @NotNull Map<String,TaskRequest> tasks,
 @NotNull
 @NotNull String tag)
                                                                         throws IOException,
URISyntaxException

Löst aus:

IOException

URISyntaxException

show

public abstract JRAR show(@NotNull
 @NotNull String jobId)
                   throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Show a job. Requires the task.read scope.

Parameter:

jobId - job id

Gibt zurück:

AbstractJobsResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

getShowHttpUriRequest

protected org.apache.http.client.methods.HttpUriRequest getShowHttpUriRequest(@NotNull
 @NotNull String jobId)
                                                                       throws URISyntaxException

Löst aus:

URISyntaxException

wait

public abstract JRAR wait(@NotNull
 @NotNull String jobId)
                   throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

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.

Parameter:

jobId - job id

Gibt zurück:

AbstractJobsResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

getWaitHttpUriRequest

protected org.apache.http.client.methods.HttpUriRequest getWaitHttpUriRequest(@NotNull
 @NotNull String jobId)
                                                                       throws URISyntaxException

Löst aus:

URISyntaxException

list

public abstract JRPAR list()
                    throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

List all jobs. Requires the task.read scope.

Gibt zurück:

AbstractJobsResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

list

public abstract JRPAR list(@NotNull
 @NotNull Map<Filter,String> filters)
                    throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

List all jobs. Requires the task.read scope.

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

CloudConvertClientException

CloudConvertServerException

list

public abstract JRPAR list(@NotNull
 @NotNull Map<Filter,String> filters,
 @NotNull
 @NotNull List<Include> includes)
                    throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

List all jobs. Requires the task.read scope.

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

CloudConvertClientException

CloudConvertServerException

list

public abstract JRPAR list(@NotNull
 @NotNull Map<Filter,String> filters,
 @NotNull
 @NotNull List<Include> includes,
 @Nullable
 @Nullable Pagination pagination)
                    throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

List all jobs. Requires the task.read scope.

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

CloudConvertClientException

CloudConvertServerException

getListHttpUriRequest

protected org.apache.http.client.methods.HttpUriRequest getListHttpUriRequest(@NotNull
 @NotNull Map<Filter,String> filters,
 @NotNull
 @NotNull List<Include> includes,
 @Nullable
 @Nullable Pagination pagination)
                                                                       throws IOException,
URISyntaxException

Löst aus:

IOException

URISyntaxException

delete

public abstract VAR delete(@NotNull
 @NotNull String jobId)
                    throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

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

Parameter:

jobId - job id

Gibt zurück:

AbstractJobsResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

getDeleteHttpUriRequest

protected org.apache.http.client.methods.HttpUriRequest getDeleteHttpUriRequest(@NotNull
 @NotNull String jobId)
                                                                         throws URISyntaxException

Löst aus:

URISyntaxException