PlaidError (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.PlaidError

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class PlaidError
extends 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. An Item with a non-`null` error object will only be part of an API response when calling `/item/get` to view Item status. Otherwise, error fields will be `null` if no error has occurred; if an error has occurred, an error code will be returned instead.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_CAUSES`
`static String`	`SERIALIZED_NAME_DISPLAY_MESSAGE`
`static String`	`SERIALIZED_NAME_DOCUMENTATION_URL`
`static String`	`SERIALIZED_NAME_ERROR_CODE`
`static String`	`SERIALIZED_NAME_ERROR_MESSAGE`
`static String`	`SERIALIZED_NAME_ERROR_TYPE`
`static String`	`SERIALIZED_NAME_REQUEST_ID`
`static String`	`SERIALIZED_NAME_STATUS`
`static String`	`SERIALIZED_NAME_SUGGESTED_ACTION`

Constructor Summary

Constructors
Constructor and Description

PlaidError()

Constructors
Constructor and Description
`PlaidError()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PlaidError`	`addCausesItem(Object causesItem)`
`PlaidError`	`causes(List<Object> causes)`
`PlaidError`	`displayMessage(String displayMessage)`
`PlaidError`	`documentationUrl(String documentationUrl)`
`boolean`	`equals(Object o)`
`PlaidError`	`errorCode(String errorCode)`
`PlaidError`	`errorMessage(String errorMessage)`
`PlaidError`	`errorType(PlaidErrorType errorType)`
`List<Object>`	`getCauses()` In the Assets product, a request can pertain to more than one Item.
`String`	`getDisplayMessage()` A user-friendly representation of the error code.
`String`	`getDocumentationUrl()` The URL of a Plaid documentation page with more information about the error
`String`	`getErrorCode()` The particular error code.
`String`	`getErrorMessage()` A developer-friendly representation of the error code.
`PlaidErrorType`	`getErrorType()` Get errorType
`String`	`getRequestId()` A unique ID identifying the request, to be used for troubleshooting purposes.
`Integer`	`getStatus()` The HTTP status code associated with the error.
`String`	`getSuggestedAction()` Suggested steps for resolving the error
`int`	`hashCode()`
`PlaidError`	`requestId(String requestId)`
`void`	`setCauses(List<Object> causes)`
`void`	`setDisplayMessage(String displayMessage)`
`void`	`setDocumentationUrl(String documentationUrl)`
`void`	`setErrorCode(String errorCode)`
`void`	`setErrorMessage(String errorMessage)`
`void`	`setErrorType(PlaidErrorType errorType)`
`void`	`setRequestId(String requestId)`
`void`	`setStatus(Integer status)`
`void`	`setSuggestedAction(String suggestedAction)`
`PlaidError`	`status(Integer status)`
`PlaidError`	`suggestedAction(String suggestedAction)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_ERROR_TYPE
```
public static final String SERIALIZED_NAME_ERROR_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ERROR_CODE
```
public static final String SERIALIZED_NAME_ERROR_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ERROR_MESSAGE
```
public static final String SERIALIZED_NAME_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DISPLAY_MESSAGE
```
public static final String SERIALIZED_NAME_DISPLAY_MESSAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REQUEST_ID
```
public static final String SERIALIZED_NAME_REQUEST_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CAUSES
```
public static final String SERIALIZED_NAME_CAUSES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STATUS
```
public static final String SERIALIZED_NAME_STATUS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DOCUMENTATION_URL
```
public static final String SERIALIZED_NAME_DOCUMENTATION_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SUGGESTED_ACTION
```
public static final String SERIALIZED_NAME_SUGGESTED_ACTION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PlaidError
```
public PlaidError()
```
- Method Detail
  - errorType
```
public PlaidError errorType(PlaidErrorType errorType)
```
  - getErrorType
```
public PlaidErrorType getErrorType()
```
    Get errorType
    
    Returns:
    
    errorType
  - setErrorType
```
public void setErrorType(PlaidErrorType errorType)
```
  - errorCode
```
public PlaidError errorCode(String errorCode)
```
  - getErrorCode
```
public String getErrorCode()
```
    The particular error code. Safe for programmatic use.
    
    Returns:
    
    errorCode
  - setErrorCode
```
public void setErrorCode(String errorCode)
```
  - errorMessage
```
public PlaidError errorMessage(String errorMessage)
```
  - getErrorMessage
```
public 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(String errorMessage)
```
  - displayMessage
```
public PlaidError displayMessage(String displayMessage)
```
  - getDisplayMessage
```
@Nullable
public 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(String displayMessage)
```
  - requestId
```
public PlaidError requestId(String requestId)
```
  - getRequestId
```
@Nullable
public 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(String requestId)
```
  - causes
```
public PlaidError causes(List<Object> causes)
```
  - addCausesItem
```
public PlaidError addCausesItem(Object causesItem)
```
  - getCauses
```
@Nullable
public List<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`. `causes` will also not be populated inside an error nested within a `warning` object.
    
    Returns:
    
    causes
  - setCauses
```
public void setCauses(List<Object> causes)
```
  - status
```
public PlaidError status(Integer status)
```
  - getStatus
```
@Nullable
public Integer 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(Integer status)
```
  - documentationUrl
```
public PlaidError documentationUrl(String documentationUrl)
```
  - getDocumentationUrl
```
@Nullable
public String getDocumentationUrl()
```
    The URL of a Plaid documentation page with more information about the error
    
    Returns:
    
    documentationUrl
  - setDocumentationUrl
```
public void setDocumentationUrl(String documentationUrl)
```
  - suggestedAction
```
public PlaidError suggestedAction(String suggestedAction)
```
  - getSuggestedAction
```
@Nullable
public String getSuggestedAction()
```
    Suggested steps for resolving the error
    
    Returns:
    
    suggestedAction
  - setSuggestedAction
```
public void setSuggestedAction(String suggestedAction)
```
  - 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

Class PlaidError

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ERROR_TYPE

SERIALIZED_NAME_ERROR_CODE

SERIALIZED_NAME_ERROR_MESSAGE

SERIALIZED_NAME_DISPLAY_MESSAGE

SERIALIZED_NAME_REQUEST_ID

SERIALIZED_NAME_CAUSES

SERIALIZED_NAME_STATUS

SERIALIZED_NAME_DOCUMENTATION_URL

SERIALIZED_NAME_SUGGESTED_ACTION

Constructor Detail

PlaidError

Method Detail

errorType

getErrorType

setErrorType

errorCode

getErrorCode

setErrorCode

errorMessage

getErrorMessage

setErrorMessage

displayMessage

getDisplayMessage

setDisplayMessage

requestId

getRequestId

setRequestId

causes

addCausesItem

getCauses

setCauses

status

getStatus

setStatus

documentationUrl

getDocumentationUrl

setDocumentationUrl

suggestedAction

getSuggestedAction

setSuggestedAction

equals

hashCode

toString