Package com.onfido.model

Class WorkflowRun

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

    • Constructor Detail

      • WorkflowRun

        public WorkflowRun()

    • Method Detail

      • getApplicantId

        @Nonnull
public UUID getApplicantId()
        The unique identifier for the Applicant.
        Returns:
        applicantId

      • setApplicantId

        public void setApplicantId​(UUID applicantId)

      • getWorkflowId

        @Nonnull
public UUID getWorkflowId()
        The unique identifier for the Workflow.
        Returns:
        workflowId

      • setWorkflowId

        public void setWorkflowId​(UUID workflowId)

      • getTags

        @Nullable
public List<String> getTags()
        Tags or labels assigned to the workflow run.
        Returns:
        tags

      • setTags

        public void setTags​(List<String> tags)

      • getCustomerUserId

        @Nullable
public String getCustomerUserId()
        Customer-provided user identifier.
        Returns:
        customerUserId

      • setCustomerUserId

        public void setCustomerUserId​(String customerUserId)

      • getLink

        @Nullable
public WorkflowRunLink getLink()
        Object for the configuration of the Workflow Run link.
        Returns:
        link

      • getCreatedAt

        @Nullable
public OffsetDateTime getCreatedAt()
        The date and time when the Workflow Run was created.
        Returns:
        createdAt

      • setCreatedAt

        public void setCreatedAt​(OffsetDateTime createdAt)

      • getUpdatedAt

        @Nullable
public OffsetDateTime getUpdatedAt()
        The date and time when the Workflow Run was last updated.
        Returns:
        updatedAt

      • setUpdatedAt

        public void setUpdatedAt​(OffsetDateTime updatedAt)

      • getId

        @Nonnull
public UUID getId()
        The unique identifier for the Workflow Run.
        Returns:
        id

      • setId

        public void setId​(UUID id)

      • getWorkflowVersionId

        @Nullable
public Integer getWorkflowVersionId()
        The identifier for the Workflow version.
        Returns:
        workflowVersionId

      • setWorkflowVersionId

        public void setWorkflowVersionId​(Integer workflowVersionId)

      • getDashboardUrl

        @Nullable
public String getDashboardUrl()
        The URL for viewing the Workflow Run results on your Onfido Dashboard.
        Returns:
        dashboardUrl

      • setDashboardUrl

        public void setDashboardUrl​(String dashboardUrl)

      • getOutput

        @Nullable
public Object getOutput()
        Output object contains all of the properties configured on the Workflow version.
        Returns:
        output

      • setOutput

        public void setOutput​(Object output)

      • 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)

      • getError

        @Nullable
public WorkflowRunError getError()
        Error object. Only set when the Workflow Run status is 'error'.
        Returns:
        error

      • getSdkToken

        @Nullable
public String getSdkToken()
        Client token to use when loading this workflow run in the Onfido SDK.
        Returns:
        sdkToken

      • setSdkToken

        public void setSdkToken​(String sdkToken)

      • putAdditionalProperty

        public WorkflowRun 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 WorkflowRun 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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode 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 WorkflowRun

      • fromJson

        public static WorkflowRun fromJson​(String jsonString)
                            throws IOException
        Create an instance of WorkflowRun given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of WorkflowRun
        Throws:
        IOException - if the JSON string is invalid with respect to WorkflowRun

      • toJson

        public String toJson()
        Convert an instance of WorkflowRun to an JSON string
        Returns:
        JSON string