Package com.onfido.model

Class WebhookEventPayloadResource

java.lang.Object

com.onfido.model.WebhookEventPayloadResource

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.9.0")
public class WebhookEventPayloadResource
extends Object

The resource affected by this event.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebhookEventPayloadResource.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_APPLICANT_ID
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_DASHBOARD_URL
static String	SERIALIZED_NAME_ERROR
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_INPUT
static String	SERIALIZED_NAME_LINK
static String	SERIALIZED_NAME_OUTPUT
static String	SERIALIZED_NAME_REASONS
static String	SERIALIZED_NAME_TASK_DEF_ID
static String	SERIALIZED_NAME_TASK_DEF_VERSION
static String	SERIALIZED_NAME_UPDATED_AT
static String	SERIALIZED_NAME_WORKFLOW_ID
static String	SERIALIZED_NAME_WORKFLOW_RUN_ID
static String	SERIALIZED_NAME_WORKFLOW_VERSION_ID

Constructor Summary

Constructors

Constructor	Description
WebhookEventPayloadResource()

Method Summary

Modifier and Type	Method	Description
WebhookEventPayloadResource	addReasonsItem(String reasonsItem)
WebhookEventPayloadResource	applicantId(UUID applicantId)
WebhookEventPayloadResource	createdAt(OffsetDateTime createdAt)
WebhookEventPayloadResource	dashboardUrl(String dashboardUrl)
boolean	equals(Object o)
WebhookEventPayloadResource	error(WorkflowRunError error)
static WebhookEventPayloadResource	fromJson(String jsonString)	Create an instance of WebhookEventPayloadResource given an JSON string
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
UUID	getApplicantId()	The unique identifier for the Applicant.
OffsetDateTime	getCreatedAt()	The date and time when the resource was created.
String	getDashboardUrl()	The URL for viewing the resource on Onfido Dashboard.
WorkflowRunError	getError()	Error object that details why a Workflow Run is in Error status.
String	getId()	The identifier of the resource.
Object	getInput()	Input object with the fields used by the Task execution.
WorkflowRunLink	getLink()	Object for the configuration of the Workflow Run link.
Object	getOutput()	Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.
List<String>	getReasons()	The reasons the Workflow Run outcome was reached.
String	getTaskDefId()	The identifier for the Task Definition.
String	getTaskDefVersion()	The task definition version.
OffsetDateTime	getUpdatedAt()	The date and time when the resource was last updated.
UUID	getWorkflowId()	The unique identifier for the Workflow.
UUID	getWorkflowRunId()	Get workflowRunId
Integer	getWorkflowVersionId()	The identifier for the Workflow version.
int	hashCode()
WebhookEventPayloadResource	id(String id)
WebhookEventPayloadResource	input(Object input)
WebhookEventPayloadResource	link(WorkflowRunLink link)
WebhookEventPayloadResource	output(Object output)
WebhookEventPayloadResource	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
WebhookEventPayloadResource	reasons(List<String> reasons)
void	setApplicantId(UUID applicantId)
void	setCreatedAt(OffsetDateTime createdAt)
void	setDashboardUrl(String dashboardUrl)
void	setError(WorkflowRunError error)
void	setId(String id)
void	setInput(Object input)
void	setLink(WorkflowRunLink link)
void	setOutput(Object output)
void	setReasons(List<String> reasons)
void	setTaskDefId(String taskDefId)
void	setTaskDefVersion(String taskDefVersion)
void	setUpdatedAt(OffsetDateTime updatedAt)
void	setWorkflowId(UUID workflowId)
void	setWorkflowRunId(UUID workflowRunId)
void	setWorkflowVersionId(Integer workflowVersionId)
WebhookEventPayloadResource	taskDefId(String taskDefId)
WebhookEventPayloadResource	taskDefVersion(String taskDefVersion)
String	toJson()	Convert an instance of WebhookEventPayloadResource to an JSON string
String	toString()
WebhookEventPayloadResource	updatedAt(OffsetDateTime updatedAt)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found
WebhookEventPayloadResource	workflowId(UUID workflowId)
WebhookEventPayloadResource	workflowRunId(UUID workflowRunId)
WebhookEventPayloadResource	workflowVersionId(Integer workflowVersionId)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_APPLICANT_ID

public static final String SERIALIZED_NAME_APPLICANT_ID

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_DASHBOARD_URL

public static final String SERIALIZED_NAME_DASHBOARD_URL

See Also:

Constant Field Values

SERIALIZED_NAME_WORKFLOW_ID

public static final String SERIALIZED_NAME_WORKFLOW_ID

See Also:

Constant Field Values

SERIALIZED_NAME_WORKFLOW_RUN_ID

public static final String SERIALIZED_NAME_WORKFLOW_RUN_ID

See Also:

Constant Field Values

SERIALIZED_NAME_WORKFLOW_VERSION_ID

public static final String SERIALIZED_NAME_WORKFLOW_VERSION_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TASK_DEF_ID

public static final String SERIALIZED_NAME_TASK_DEF_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TASK_DEF_VERSION

public static final String SERIALIZED_NAME_TASK_DEF_VERSION

See Also:

Constant Field Values

SERIALIZED_NAME_INPUT

public static final String SERIALIZED_NAME_INPUT

See Also:

Constant Field Values

SERIALIZED_NAME_OUTPUT

public static final String SERIALIZED_NAME_OUTPUT

See Also:

Constant Field Values

SERIALIZED_NAME_REASONS

public static final String SERIALIZED_NAME_REASONS

See Also:

Constant Field Values

SERIALIZED_NAME_LINK

public static final String SERIALIZED_NAME_LINK

See Also:

Constant Field Values

SERIALIZED_NAME_ERROR

public static final String SERIALIZED_NAME_ERROR

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

WebhookEventPayloadResource

public WebhookEventPayloadResource()

Method Detail

id

public WebhookEventPayloadResource id(String id)

getId

@Nullable
public String getId()

The identifier of the resource.

Returns:

id

setId

public void setId(String id)

applicantId

public WebhookEventPayloadResource applicantId(UUID applicantId)

getApplicantId

@Nullable
public UUID getApplicantId()

The unique identifier for the Applicant.

Returns:

applicantId

setApplicantId

public void setApplicantId(UUID applicantId)

createdAt

public WebhookEventPayloadResource createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

The date and time when the resource was created.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public WebhookEventPayloadResource updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

The date and time when the resource was last updated.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

dashboardUrl

public WebhookEventPayloadResource dashboardUrl(String dashboardUrl)

getDashboardUrl

@Nullable
public String getDashboardUrl()

The URL for viewing the resource on Onfido Dashboard.

Returns:

dashboardUrl

setDashboardUrl

public void setDashboardUrl(String dashboardUrl)

workflowId

public WebhookEventPayloadResource workflowId(UUID workflowId)

getWorkflowId

@Nullable
public UUID getWorkflowId()

The unique identifier for the Workflow.

Returns:

workflowId

setWorkflowId

public void setWorkflowId(UUID workflowId)

workflowRunId

public WebhookEventPayloadResource workflowRunId(UUID workflowRunId)

getWorkflowRunId

@Nullable
public UUID getWorkflowRunId()

Get workflowRunId

Returns:

workflowRunId

setWorkflowRunId

public void setWorkflowRunId(UUID workflowRunId)

workflowVersionId

public WebhookEventPayloadResource workflowVersionId(Integer workflowVersionId)

getWorkflowVersionId

@Nullable
public Integer getWorkflowVersionId()

The identifier for the Workflow version.

Returns:

workflowVersionId

setWorkflowVersionId

public void setWorkflowVersionId(Integer workflowVersionId)

taskDefId

public WebhookEventPayloadResource taskDefId(String taskDefId)

getTaskDefId

@Nullable
public String getTaskDefId()

The identifier for the Task Definition.

Returns:

taskDefId

setTaskDefId

public void setTaskDefId(String taskDefId)

taskDefVersion

public WebhookEventPayloadResource taskDefVersion(String taskDefVersion)

getTaskDefVersion

@Nullable
public String getTaskDefVersion()

The task definition version.

Returns:

taskDefVersion

setTaskDefVersion

public void setTaskDefVersion(String taskDefVersion)

input

public WebhookEventPayloadResource input(Object input)

getInput

@Nullable
public Object getInput()

Input object with the fields used by the Task execution.

Returns:

input

setInput

public void setInput(Object input)

output

public WebhookEventPayloadResource output(Object output)

getOutput

@Nullable
public Object getOutput()

Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.

Returns:

output

setOutput

public void setOutput(Object output)

reasons

public WebhookEventPayloadResource reasons(List<String> reasons)

addReasonsItem

public WebhookEventPayloadResource addReasonsItem(String reasonsItem)

getReasons

@Nullable
public List<String> getReasons()

The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow Version.

Returns:

reasons

setReasons

public void setReasons(List<String> reasons)

link

public WebhookEventPayloadResource link(WorkflowRunLink link)

getLink

@Nullable
public WorkflowRunLink getLink()

Object for the configuration of the Workflow Run link.

Returns:

link

setLink

public void setLink(WorkflowRunLink link)

error

public WebhookEventPayloadResource error(WorkflowRunError error)

getError

@Nullable
public WorkflowRunError getError()

Error object that details why a Workflow Run is in Error status.

Returns:

error

setError

public void setError(WorkflowRunError error)

putAdditionalProperty

public WebhookEventPayloadResource putAdditionalProperty(String key,
                                                         Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the WebhookEventPayloadResource instance itself

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an 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

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to WebhookEventPayloadResource

fromJson

public static WebhookEventPayloadResource fromJson(String jsonString)
                                            throws IOException

Create an instance of WebhookEventPayloadResource given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of WebhookEventPayloadResource

Throws:

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

toJson

public String toJson()

Convert an instance of WebhookEventPayloadResource to an JSON string

Returns:

JSON string