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

java.lang.Object

com.cloudconvert.resource.AbstractResource

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

Alle implementierten Schnittstellen:

Closeable, AutoCloseable

Bekannte direkte Unterklassen:

AsyncConvertFilesResource, ConvertFilesResource

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

Feldübersicht

Felder

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

Methodenübersicht

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

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_CONVERT

public static final String PATH_SEGMENT_CONVERT

Siehe auch:

• Konstantenfeldwerte

PATH_SEGMENT_FORMATS

public static final String PATH_SEGMENT_FORMATS

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

AbstractConvertFilesResource

public AbstractConvertFilesResource(SettingsProvider settingsProvider,
 ObjectMapperProvider objectMapperProvider)

Methodendetails

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.

Parameter:

convertFilesTaskRequest - ConvertFilesTaskRequest

Gibt zurück:

AbstractConvertFilesResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

getConvertHttpUriRequest

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

Löst aus:

IOException

URISyntaxException

convertFormats

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

List all supported formats, their engines and possible options.

Gibt zurück:

AbstractConvertFilesResource

Löst aus:

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.

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 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.

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 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.

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

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

Löst aus:

IOException

URISyntaxException