Klasse ConvertFilesResource

java.lang.Object

com.cloudconvert.resource.AbstractResource

com.cloudconvert.resource.AbstractConvertFilesResource<Result<TaskResponse>,Result<Pageable<OperationResponse>>>

com.cloudconvert.resource.sync.ConvertFilesResource

Alle implementierten Schnittstellen:

Closeable, AutoCloseable

public class ConvertFilesResource
extends AbstractConvertFilesResource<Result<TaskResponse>,Result<Pageable<OperationResponse>>>

Feldübersicht

Von Klasse geerbte Felder com.cloudconvert.resource.AbstractConvertFilesResource

PATH_SEGMENT_CONVERT, PATH_SEGMENT_FORMATS

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
ConvertFilesResource(SettingsProvider settingsProvider, ObjectMapperProvider objectMapperProvider, RequestExecutor requestExecutor)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	close()
Result<TaskResponse>	convert(@NotNull ConvertFilesTaskRequest convertFilesTaskRequest)	Create a task to convert one input file from input_format to output_format.
Result<Pageable<OperationResponse>>	convertFormats()	List all supported formats, their engines and possible options.
Result<Pageable<OperationResponse>>	convertFormats(@NotNull Map<Filter,String> filters)	List all supported formats, their engines and possible options.
Result<Pageable<OperationResponse>>	convertFormats(@NotNull Map<Filter,String> filters, @NotNull List<Include> includes)	List all supported formats, their engines and possible options.
Result<Pageable<OperationResponse>>	convertFormats(@NotNull Map<Filter,String> filters, @NotNull List<Include> includes, @Nullable Boolean alternative)	List all supported formats, their engines and possible options.

Von Klasse geerbte Methoden com.cloudconvert.resource.AbstractConvertFilesResource

getConvertFormatsHttpUriRequest, getConvertHttpUriRequest

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

ConvertFilesResource

public ConvertFilesResource(SettingsProvider settingsProvider,
 ObjectMapperProvider objectMapperProvider,
 RequestExecutor requestExecutor)

Methodendetails

convert

public Result<TaskResponse> convert(@NotNull
 @NotNull ConvertFilesTaskRequest convertFilesTaskRequest)
                             throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Beschreibung aus Klasse kopiert: AbstractConvertFilesResource

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

Angegeben von:

convert in Klasse AbstractConvertFilesResource<Result<TaskResponse>,Result<Pageable<OperationResponse>>>

Parameter:

convertFilesTaskRequest - ConvertFilesTaskRequest

Gibt zurück:

AbstractConvertFilesResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

convertFormats

public Result<Pageable<OperationResponse>> convertFormats()
                                                   throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Beschreibung aus Klasse kopiert: AbstractConvertFilesResource

List all supported formats, their engines and possible options.

Angegeben von:

convertFormats in Klasse AbstractConvertFilesResource<Result<TaskResponse>,Result<Pageable<OperationResponse>>>

Gibt zurück:

AbstractConvertFilesResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

convertFormats

public Result<Pageable<OperationResponse>> convertFormats(@NotNull
 @NotNull Map<Filter,String> filters)
                                                   throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Beschreibung aus Klasse kopiert: AbstractConvertFilesResource

List all supported formats, their engines and possible options.

Angegeben von:

convertFormats in Klasse AbstractConvertFilesResource<Result<TaskResponse>,Result<Pageable<OperationResponse>>>

Parameter:

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.

Gibt zurück:

AbstractConvertFilesResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

convertFormats

public Result<Pageable<OperationResponse>> convertFormats(@NotNull
 @NotNull Map<Filter,String> filters,
 @NotNull
 @NotNull List<Include> includes)
                                                   throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Beschreibung aus Klasse kopiert: AbstractConvertFilesResource

List all supported formats, their engines and possible options.

Angegeben von:

convertFormats in Klasse AbstractConvertFilesResource<Result<TaskResponse>,Result<Pageable<OperationResponse>>>

Parameter:

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.

Gibt zurück:

AbstractConvertFilesResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

convertFormats

public Result<Pageable<OperationResponse>> convertFormats(@NotNull
 @NotNull Map<Filter,String> filters,
 @NotNull
 @NotNull List<Include> includes,
 @Nullable
 @Nullable Boolean alternative)
                                                   throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Beschreibung aus Klasse kopiert: AbstractConvertFilesResource

List all supported formats, their engines and possible options.

Angegeben von:

convertFormats in Klasse AbstractConvertFilesResource<Result<TaskResponse>,Result<Pageable<OperationResponse>>>

Parameter:

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.

Gibt zurück:

AbstractConvertFilesResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

close

public void close()
           throws IOException

Löst aus:

IOException