Package com.cloudconvert.resource

Class AbstractConvertFilesResource<TRAR extends AbstractResult<TaskResponse>,ORP extends AbstractResult<Pageable<OperationResponse>>>

java.lang.Object

com.cloudconvert.resource.AbstractResource

com.cloudconvert.resource.AbstractConvertFilesResource<TRAR,ORP>

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

AsyncConvertFilesResource, ConvertFilesResource

public abstract class AbstractConvertFilesResource<TRAR extends AbstractResult<TaskResponse>,ORP extends AbstractResult<Pageable<OperationResponse>>>
extends AbstractResource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH_SEGMENT_CONVERT
static final String	PATH_SEGMENT_FORMATS

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
AbstractConvertFilesResource(SettingsProvider settingsProvider, ObjectMapperProvider objectMapperProvider)

Method Summary

Modifier and Type	Method	Description
abstract TRAR	convert(@NotNull ConvertFilesTaskRequest convertFilesTaskRequest)	Create a task to convert one input file from input_format to output_format.
abstract ORP	convertFormats()	List all supported formats, their engines and possible options.
abstract ORP	convertFormats(@NotNull Map<Filter,String> filters)	List all supported formats, their engines and possible options.
abstract ORP	convertFormats(@NotNull Map<Filter,String> filters, @NotNull List<Include> includes)	List all supported formats, their engines and possible options.
abstract ORP	convertFormats(@NotNull Map<Filter,String> filters, @NotNull List<Include> includes, @Nullable Boolean alternative)	List all supported formats, their engines and possible options.
protected org.apache.http.client.methods.HttpUriRequest	getConvertFormatsHttpUriRequest(@NotNull Map<Filter,String> filters, @NotNull List<Include> includes, @Nullable Boolean alternative)
protected org.apache.http.client.methods.HttpUriRequest	getConvertHttpUriRequest(@NotNull ConvertFilesTaskRequest convertFilesTaskRequest)

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

Methods inherited from interface java.io.Closeable

close

Field Details

PATH_SEGMENT_CONVERT

public static final String PATH_SEGMENT_CONVERT

See Also:

• Constant Field Values

PATH_SEGMENT_FORMATS

public static final String PATH_SEGMENT_FORMATS

See Also:

• Constant Field Values

Constructor Details

AbstractConvertFilesResource

public AbstractConvertFilesResource(SettingsProvider settingsProvider,
 ObjectMapperProvider objectMapperProvider)

Method Details

convert

public abstract TRAR convert(@NotNull
 @NotNull ConvertFilesTaskRequest convertFilesTaskRequest)
                      throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

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

Parameters:

convertFilesTaskRequest - ConvertFilesTaskRequest

Returns:

AbstractConvertFilesResource

Throws:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

getConvertHttpUriRequest

protected org.apache.http.client.methods.HttpUriRequest getConvertHttpUriRequest(@NotNull
 @NotNull ConvertFilesTaskRequest convertFilesTaskRequest)
                                                                          throws IOException,
URISyntaxException

Throws:

IOException

URISyntaxException

convertFormats

public abstract ORP convertFormats()
                            throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

List all supported formats, their engines and possible options.

Returns:

AbstractConvertFilesResource

Throws:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

convertFormats

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

List all supported formats, their engines and possible options.

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:

AbstractConvertFilesResource

Throws:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

convertFormats

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

List all supported formats, their engines and possible options.

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:

AbstractConvertFilesResource

Throws:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

convertFormats

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

List all supported formats, their engines and possible options.

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:

AbstractConvertFilesResource

Throws:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

getConvertFormatsHttpUriRequest

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

Throws:

IOException

URISyntaxException