Package io.voucherify.client.model

Class AsyncActionBase

java.lang.Object

io.voucherify.client.model.AsyncActionBase

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class AsyncActionBase
extends Object

This is an object representing an asynchronous action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AsyncActionBase.CustomTypeAdapterFactory
static enum	AsyncActionBase.ObjectEnum	The type of the object represented by JSON.
static enum	AsyncActionBase.StatusEnum	Status of the async action.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_OPERATION_STATUS
static final String	SERIALIZED_NAME_PROCESSING_TIME
static final String	SERIALIZED_NAME_PROGRESS
static final String	SERIALIZED_NAME_REQUEST_ID
static final String	SERIALIZED_NAME_STATUS
static final String	SERIALIZED_NAME_TYPE
static final String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
AsyncActionBase()

Method Summary

Modifier and Type	Method	Description
AsyncActionBase	_object(AsyncActionBase.ObjectEnum _object)
AsyncActionBase	createdAt(OffsetDateTime createdAt)
boolean	equals(Object o)
static AsyncActionBase	fromJson(String jsonString)	Create an instance of AsyncActionBase given an JSON string
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the async action was scheduled in ISO 8601 format.
String	getId()	Async action unique ID.
AsyncActionBase.ObjectEnum	getObject()	The type of the object represented by JSON.
String	getOperationStatus()	Status of async action processing.
Integer	getProcessingTime()	The length of time it took to process the request in milliseconds.
Integer	getProgress()	% progress to completion of the asynchronous action.
String	getRequestId()	Unique request ID.
AsyncActionBase.StatusEnum	getStatus()	Status of the async action.
String	getType()	Type of async action.
OffsetDateTime	getUpdatedAt()	Timestamp representing the date and time when the async action was updated.
int	hashCode()
AsyncActionBase	id(String id)
AsyncActionBase	operationStatus(String operationStatus)
AsyncActionBase	processingTime(Integer processingTime)
AsyncActionBase	progress(Integer progress)
AsyncActionBase	requestId(String requestId)
void	setCreatedAt(OffsetDateTime createdAt)
void	setId(String id)
void	setObject(AsyncActionBase.ObjectEnum _object)
void	setOperationStatus(String operationStatus)
void	setProcessingTime(Integer processingTime)
void	setProgress(Integer progress)
void	setRequestId(String requestId)
void	setStatus(AsyncActionBase.StatusEnum status)
void	setType(String type)
void	setUpdatedAt(OffsetDateTime updatedAt)
AsyncActionBase	status(AsyncActionBase.StatusEnum status)
String	toJson()	Convert an instance of AsyncActionBase to an JSON string
String	toString()
AsyncActionBase	type(String type)
AsyncActionBase	updatedAt(OffsetDateTime updatedAt)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

• Constant Field Values

SERIALIZED_NAME_OPERATION_STATUS

public static final String SERIALIZED_NAME_OPERATION_STATUS

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_REQUEST_ID

public static final String SERIALIZED_NAME_REQUEST_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_PROCESSING_TIME

public static final String SERIALIZED_NAME_PROCESSING_TIME

See Also:

• Constant Field Values

SERIALIZED_NAME_PROGRESS

public static final String SERIALIZED_NAME_PROGRESS

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

AsyncActionBase

public AsyncActionBase()

Method Details

id

public AsyncActionBase id(String id)

getId

@Nullable
public String getId()

Async action unique ID.

Returns:

id

setId

public void setId(String id)

type

public AsyncActionBase type(String type)

getType

@Nullable
public String getType()

Type of async action.

Returns:

type

setType

public void setType(String type)

status

public AsyncActionBase status(AsyncActionBase.StatusEnum status)

getStatus

@Nullable
public AsyncActionBase.StatusEnum getStatus()

Status of the async action. Informs you whether the async action has already been completed.

Returns:

status

setStatus

public void setStatus(AsyncActionBase.StatusEnum status)

operationStatus

public AsyncActionBase operationStatus(String operationStatus)

getOperationStatus

@Nullable
public String getOperationStatus()

Status of async action processing. Informs about the async action status, whether it failed, succeeded, or the status is unknown.

Returns:

operationStatus

setOperationStatus

public void setOperationStatus(String operationStatus)

createdAt

public AsyncActionBase createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp representing the date and time when the async action was scheduled in ISO 8601 format.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public AsyncActionBase updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp representing the date and time when the async action was updated. The value is shown in the ISO 8601 format.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

requestId

public AsyncActionBase requestId(String requestId)

getRequestId

@Nullable
public String getRequestId()

Unique request ID.

Returns:

requestId

setRequestId

public void setRequestId(String requestId)

processingTime

public AsyncActionBase processingTime(Integer processingTime)

getProcessingTime

@Nullable
public Integer getProcessingTime()

The length of time it took to process the request in milliseconds.

Returns:

processingTime

setProcessingTime

public void setProcessingTime(Integer processingTime)

progress

public AsyncActionBase progress(Integer progress)

getProgress

@Nullable
public Integer getProgress()

% progress to completion of the asynchronous action. minimum: 0 maximum: 100

Returns:

progress

setProgress

public void setProgress(Integer progress)

_object

public AsyncActionBase _object(AsyncActionBase.ObjectEnum _object)

getObject

@Nullable
public AsyncActionBase.ObjectEnum getObject()

The type of the object represented by JSON. This object stores information about the `async_action`.

Returns:

_object

setObject

public void setObject(AsyncActionBase.ObjectEnum _object)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

fromJson

public static AsyncActionBase fromJson(String jsonString)
                                throws IOException

Create an instance of AsyncActionBase given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of AsyncActionBase

Throws:

IOException - if the JSON string is invalid with respect to AsyncActionBase

toJson

public String toJson()

Convert an instance of AsyncActionBase to an JSON string

Returns:

JSON string