com.cloudinary.media_editing.model

Class TransformRequest

java.lang.Object

com.cloudinary.media_editing.model.TransformRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-07-24T12:33:09.634+03:00[Asia/Jerusalem]")
public class TransformRequest
extends java.lang.Object

TransformRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransformRequest.CustomTypeAdapterFactory
static class	TransformRequest.InputTypeEnum The media input type
static class	TransformRequest.ResourceTypeEnum The resource type to be processed

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashSet<java.lang.String>	openapiFields
static java.util.HashSet<java.lang.String>	openapiRequiredFields
static java.lang.String	SERIALIZED_NAME_ASYNC
static java.lang.String	SERIALIZED_NAME_INPUT_TYPE
static java.lang.String	SERIALIZED_NAME_MEDIA_SOURCE
static java.lang.String	SERIALIZED_NAME_MEDIA_TARGET
static java.lang.String	SERIALIZED_NAME_NOTIFICATION_URL
static java.lang.String	SERIALIZED_NAME_RESOURCE_TYPE
static java.lang.String	SERIALIZED_NAME_TRANSFORMATION_DESCRIPTOR
static java.lang.String	SERIALIZED_NAME_URL

Constructor Summary

Constructors

Constructor and Description
TransformRequest()

Method Summary

Modifier and Type	Method and Description
TransformRequest	async(java.lang.Boolean async)
boolean	equals(java.lang.Object o)
static TransformRequest	fromJson(java.lang.String jsonString) Create an instance of TransformRequest given an JSON string
java.lang.Boolean	getAsync() Whether to perform the request asynchronously.
TransformRequest.InputTypeEnum	getInputType() The media input type
MediaConnectorInstance	getMediaSource() Get mediaSource
MediaConnectorInstance	getMediaTarget() Get mediaTarget
java.net.URI	getNotificationUrl() The URL to send notifications once a transformation has completed
TransformRequest.ResourceTypeEnum	getResourceType() The resource type to be processed
TransformationDescriptor	getTransformationDescriptor() Get transformationDescriptor
java.net.URI	getUrl() URL of the asset to be transformed
int	hashCode()
TransformRequest	inputType(TransformRequest.InputTypeEnum inputType)
TransformRequest	mediaSource(MediaConnectorInstance mediaSource)
TransformRequest	mediaTarget(MediaConnectorInstance mediaTarget)
TransformRequest	notificationUrl(java.net.URI notificationUrl)
TransformRequest	resourceType(TransformRequest.ResourceTypeEnum resourceType)
void	setAsync(java.lang.Boolean async)
void	setInputType(TransformRequest.InputTypeEnum inputType)
void	setMediaSource(MediaConnectorInstance mediaSource)
void	setMediaTarget(MediaConnectorInstance mediaTarget)
void	setNotificationUrl(java.net.URI notificationUrl)
void	setResourceType(TransformRequest.ResourceTypeEnum resourceType)
void	setTransformationDescriptor(TransformationDescriptor transformationDescriptor)
void	setUrl(java.net.URI url)
java.lang.String	toJson() Convert an instance of TransformRequest to an JSON string
java.lang.String	toString()
TransformRequest	transformationDescriptor(TransformationDescriptor transformationDescriptor)
TransformRequest	url(java.net.URI url)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj) Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_INPUT_TYPE

public static final java.lang.String SERIALIZED_NAME_INPUT_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_RESOURCE_TYPE

public static final java.lang.String SERIALIZED_NAME_RESOURCE_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_URL

public static final java.lang.String SERIALIZED_NAME_URL

See Also:

Constant Field Values

SERIALIZED_NAME_MEDIA_SOURCE

public static final java.lang.String SERIALIZED_NAME_MEDIA_SOURCE

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSFORMATION_DESCRIPTOR

public static final java.lang.String SERIALIZED_NAME_TRANSFORMATION_DESCRIPTOR

See Also:

Constant Field Values

SERIALIZED_NAME_ASYNC

public static final java.lang.String SERIALIZED_NAME_ASYNC

See Also:

Constant Field Values

SERIALIZED_NAME_NOTIFICATION_URL

public static final java.lang.String SERIALIZED_NAME_NOTIFICATION_URL

See Also:

Constant Field Values

SERIALIZED_NAME_MEDIA_TARGET

public static final java.lang.String SERIALIZED_NAME_MEDIA_TARGET

See Also:

Constant Field Values

openapiFields

public static java.util.HashSet<java.lang.String> openapiFields

openapiRequiredFields

public static java.util.HashSet<java.lang.String> openapiRequiredFields

Constructor Detail

TransformRequest

public TransformRequest()

Method Detail

inputType

public TransformRequest inputType(TransformRequest.InputTypeEnum inputType)

getInputType

@Nonnull
public TransformRequest.InputTypeEnum getInputType()

The media input type

Returns:

inputType

setInputType

public void setInputType(TransformRequest.InputTypeEnum inputType)

resourceType

public TransformRequest resourceType(TransformRequest.ResourceTypeEnum resourceType)

getResourceType

@Nullable
public TransformRequest.ResourceTypeEnum getResourceType()

The resource type to be processed

Returns:

resourceType

setResourceType

public void setResourceType(TransformRequest.ResourceTypeEnum resourceType)

url

public TransformRequest url(java.net.URI url)

getUrl

@Nullable
public java.net.URI getUrl()

URL of the asset to be transformed

Returns:

url

setUrl

public void setUrl(java.net.URI url)

mediaSource

public TransformRequest mediaSource(MediaConnectorInstance mediaSource)

getMediaSource

@Nullable
public MediaConnectorInstance getMediaSource()

Get mediaSource

Returns:

mediaSource

setMediaSource

public void setMediaSource(MediaConnectorInstance mediaSource)

transformationDescriptor

public TransformRequest transformationDescriptor(TransformationDescriptor transformationDescriptor)

getTransformationDescriptor

@Nonnull
public TransformationDescriptor getTransformationDescriptor()

Get transformationDescriptor

Returns:

transformationDescriptor

setTransformationDescriptor

public void setTransformationDescriptor(TransformationDescriptor transformationDescriptor)

async

public TransformRequest async(java.lang.Boolean async)

getAsync

@Nullable
public java.lang.Boolean getAsync()

Whether to perform the request asynchronously. Use a notification URL to be notified once the transformation has completed

Returns:

async

setAsync

public void setAsync(java.lang.Boolean async)

notificationUrl

public TransformRequest notificationUrl(java.net.URI notificationUrl)

getNotificationUrl

@Nullable
public java.net.URI getNotificationUrl()

The URL to send notifications once a transformation has completed

Returns:

notificationUrl

setNotificationUrl

public void setNotificationUrl(java.net.URI notificationUrl)

mediaTarget

public TransformRequest mediaTarget(MediaConnectorInstance mediaTarget)

getMediaTarget

@Nullable
public MediaConnectorInstance getMediaTarget()

Get mediaTarget

Returns:

mediaTarget

setMediaTarget

public void setMediaTarget(MediaConnectorInstance mediaTarget)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws java.io.IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

java.io.IOException - if the JSON Object is invalid with respect to TransformRequest

fromJson

public static TransformRequest fromJson(java.lang.String jsonString)
                                 throws java.io.IOException

Create an instance of TransformRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of TransformRequest

Throws:

java.io.IOException - if the JSON string is invalid with respect to TransformRequest

toJson

public java.lang.String toJson()

Convert an instance of TransformRequest to an JSON string

Returns:

JSON string