com.cloudinary.media_editing.api

Class TransformApi

java.lang.Object

com.cloudinary.media_editing.api.TransformApi

public class TransformApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TransformApi()
TransformApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)
TransformResult	transform(java.lang.String cloudName, TransformRequest transformRequest) Transform a media asset Transform a media asset
okhttp3.Call	transformAsync(java.lang.String cloudName, TransformRequest transformRequest, ApiCallback<TransformResult> _callback) Transform a media asset (asynchronously) Transform a media asset
okhttp3.Call	transformCall(java.lang.String cloudName, TransformRequest transformRequest, ApiCallback _callback) Build call for transform
ApiResponse<TransformResult>	transformWithHttpInfo(java.lang.String cloudName, TransformRequest transformRequest) Transform a media asset Transform a media asset

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformApi

public TransformApi()

TransformApi

public TransformApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

transformCall

public okhttp3.Call transformCall(java.lang.String cloudName,
                                  TransformRequest transformRequest,
                                  ApiCallback _callback)
                           throws ApiException

Build call for transform

Parameters:

cloudName - Name of the Cloud (required)

transformRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	Return transformed media	-
202	Request enqueued	-
400	Illegal request error	-
401	Authentication error	-
500	Server error	-

transform

public TransformResult transform(java.lang.String cloudName,
                                 TransformRequest transformRequest)
                          throws ApiException

Transform a media asset Transform a media asset

Parameters:

cloudName - Name of the Cloud (required)

transformRequest - (optional)

Returns:

TransformResult

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	Return transformed media	-
202	Request enqueued	-
400	Illegal request error	-
401	Authentication error	-
500	Server error	-

transformWithHttpInfo

public ApiResponse<TransformResult> transformWithHttpInfo(java.lang.String cloudName,
                                                          TransformRequest transformRequest)
                                                   throws ApiException

Transform a media asset Transform a media asset

Parameters:

cloudName - Name of the Cloud (required)

transformRequest - (optional)

Returns:

ApiResponse<TransformResult>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	Return transformed media	-
202	Request enqueued	-
400	Illegal request error	-
401	Authentication error	-
500	Server error	-

transformAsync

public okhttp3.Call transformAsync(java.lang.String cloudName,
                                   TransformRequest transformRequest,
                                   ApiCallback<TransformResult> _callback)
                            throws ApiException

Transform a media asset (asynchronously) Transform a media asset

Parameters:

cloudName - Name of the Cloud (required)

transformRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	Return transformed media	-
202	Request enqueued	-
400	Illegal request error	-
401	Authentication error	-
500	Server error	-