Package com.plaid.client.model

Class Error

java.lang.Object
com.plaid.client.model.Error
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class Error
extends java.lang.Object
We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.

  • Field Details

  • Constructor Details

  • Method Details

    • errorType

      public Error errorType​(Error.ErrorTypeEnum errorType)

    • getErrorType

      public Error.ErrorTypeEnum getErrorType()
      A broad categorization of the error. Safe for programatic use.
      Returns:
      errorType

    • setErrorType

      public void setErrorType​(Error.ErrorTypeEnum errorType)

    • errorCode

      public Error errorCode​(java.lang.String errorCode)

    • getErrorCode

      public java.lang.String getErrorCode()
      The particular error code. Safe for programmatic use.
      Returns:
      errorCode

    • setErrorCode

      public void setErrorCode​(java.lang.String errorCode)

    • errorMessage

      public Error errorMessage​(java.lang.String errorMessage)

    • getErrorMessage

      public java.lang.String getErrorMessage()
      A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
      Returns:
      errorMessage

    • setErrorMessage

      public void setErrorMessage​(java.lang.String errorMessage)

    • displayMessage

      public Error displayMessage​(java.lang.String displayMessage)

    • getDisplayMessage

      @Nullable public java.lang.String getDisplayMessage()
      A user-friendly representation of the error code. `null` if the error is not related to user action. This may change over time and is not safe for programmatic use.
      Returns:
      displayMessage

    • setDisplayMessage

      public void setDisplayMessage​(java.lang.String displayMessage)

    • requestId

      public Error requestId​(java.lang.String requestId)

    • getRequestId

      @Nullable public java.lang.String getRequestId()
      A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
      Returns:
      requestId

    • setRequestId

      public void setRequestId​(java.lang.String requestId)

    • causes

      public Error causes​(java.util.List<java.lang.Object> causes)

    • addCausesItem

      public Error addCausesItem​(java.lang.Object causesItem)

    • getCauses

      @Nullable public java.util.List<java.lang.Object> getCauses()
      In the Assets product, a request can pertain to more than one Item. If an error is returned for such a request, `causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified. `causes` will only be provided for the `error_type` `ASSET_REPORT_ERROR`.
      Returns:
      causes

    • setCauses

      public void setCauses​(java.util.List<java.lang.Object> causes)

    • status

      public Error status​(java.lang.Double status)

    • getStatus

      @Nullable public java.lang.Double getStatus()
      The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
      Returns:
      status

    • setStatus

      public void setStatus​(java.lang.Double status)

    • documentationUrl

      public Error documentationUrl​(java.lang.String documentationUrl)

    • getDocumentationUrl

      @Nullable public java.lang.String getDocumentationUrl()
      The URL of a Plaid documentation page with more information about the error
      Returns:
      documentationUrl

    • setDocumentationUrl

      public void setDocumentationUrl​(java.lang.String documentationUrl)

    • suggestedAction

      public Error suggestedAction​(java.lang.String suggestedAction)

    • getSuggestedAction

      @Nullable public java.lang.String getSuggestedAction()
      Suggested steps for resolving the error
      Returns:
      suggestedAction

    • setSuggestedAction

      public void setSuggestedAction​(java.lang.String suggestedAction)

    • 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