Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.plaid.client.model.Cause Maven / Gradle / Ivy
/*
* The Plaid API
* The Plaid REST API. Please see https://plaid.com/docs/api for more details.
*
* The version of the OpenAPI document: 2020-09-14_1.503.5
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.plaid.client.model;
import java.util.Objects;
import java.util.Arrays;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import com.plaid.client.model.CauseAllOf;
import com.plaid.client.model.PlaidError;
import com.plaid.client.model.PlaidErrorType;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
/**
* An error object and associated `item_id` used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.
*/
@ApiModel(description = "An error object and associated `item_id` used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-03-28T21:00:55.745394Z[Etc/UTC]")
public class Cause {
public static final String SERIALIZED_NAME_ERROR_TYPE = "error_type";
@SerializedName(SERIALIZED_NAME_ERROR_TYPE)
private PlaidErrorType errorType;
public static final String SERIALIZED_NAME_ERROR_CODE = "error_code";
@SerializedName(SERIALIZED_NAME_ERROR_CODE)
private String errorCode;
public static final String SERIALIZED_NAME_ERROR_MESSAGE = "error_message";
@SerializedName(SERIALIZED_NAME_ERROR_MESSAGE)
private String errorMessage;
public static final String SERIALIZED_NAME_DISPLAY_MESSAGE = "display_message";
@SerializedName(SERIALIZED_NAME_DISPLAY_MESSAGE)
private String displayMessage;
public static final String SERIALIZED_NAME_REQUEST_ID = "request_id";
@SerializedName(SERIALIZED_NAME_REQUEST_ID)
private String requestId;
public static final String SERIALIZED_NAME_CAUSES = "causes";
@SerializedName(SERIALIZED_NAME_CAUSES)
private List causes = null;
public static final String SERIALIZED_NAME_STATUS = "status";
@SerializedName(SERIALIZED_NAME_STATUS)
private Integer status;
public static final String SERIALIZED_NAME_DOCUMENTATION_URL = "documentation_url";
@SerializedName(SERIALIZED_NAME_DOCUMENTATION_URL)
private String documentationUrl;
public static final String SERIALIZED_NAME_SUGGESTED_ACTION = "suggested_action";
@SerializedName(SERIALIZED_NAME_SUGGESTED_ACTION)
private String suggestedAction;
public static final String SERIALIZED_NAME_ITEM_ID = "item_id";
@SerializedName(SERIALIZED_NAME_ITEM_ID)
private String itemId;
public Cause errorType(PlaidErrorType errorType) {
this.errorType = errorType;
return this;
}
/**
* Get errorType
* @return errorType
**/
@ApiModelProperty(required = true, value = "")
public PlaidErrorType getErrorType() {
return errorType;
}
public void setErrorType(PlaidErrorType errorType) {
this.errorType = errorType;
}
public Cause errorCode(String errorCode) {
this.errorCode = errorCode;
return this;
}
/**
* The particular error code. Safe for programmatic use.
* @return errorCode
**/
@ApiModelProperty(required = true, value = "The particular error code. Safe for programmatic use.")
public String getErrorCode() {
return errorCode;
}
public void setErrorCode(String errorCode) {
this.errorCode = errorCode;
}
public Cause errorMessage(String errorMessage) {
this.errorMessage = errorMessage;
return this;
}
/**
* A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
* @return errorMessage
**/
@ApiModelProperty(required = true, value = "A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.")
public String getErrorMessage() {
return errorMessage;
}
public void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
public Cause displayMessage(String displayMessage) {
this.displayMessage = displayMessage;
return this;
}
/**
* 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.
* @return displayMessage
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "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.")
public String getDisplayMessage() {
return displayMessage;
}
public void setDisplayMessage(String displayMessage) {
this.displayMessage = displayMessage;
}
public Cause requestId(String requestId) {
this.requestId = requestId;
return this;
}
/**
* A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
* @return requestId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.")
public String getRequestId() {
return requestId;
}
public void setRequestId(String requestId) {
this.requestId = requestId;
}
public Cause causes(List causes) {
this.causes = causes;
return this;
}
public Cause addCausesItem(Object causesItem) {
if (this.causes == null) {
this.causes = new ArrayList<>();
}
this.causes.add(causesItem);
return this;
}
/**
* 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.
* @return causes
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "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.")
public List getCauses() {
return causes;
}
public void setCauses(List causes) {
this.causes = causes;
}
public Cause status(Integer status) {
this.status = status;
return this;
}
/**
* 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.
* @return status
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "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.")
public Integer getStatus() {
return status;
}
public void setStatus(Integer status) {
this.status = status;
}
public Cause documentationUrl(String documentationUrl) {
this.documentationUrl = documentationUrl;
return this;
}
/**
* The URL of a Plaid documentation page with more information about the error
* @return documentationUrl
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The URL of a Plaid documentation page with more information about the error")
public String getDocumentationUrl() {
return documentationUrl;
}
public void setDocumentationUrl(String documentationUrl) {
this.documentationUrl = documentationUrl;
}
public Cause suggestedAction(String suggestedAction) {
this.suggestedAction = suggestedAction;
return this;
}
/**
* Suggested steps for resolving the error
* @return suggestedAction
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Suggested steps for resolving the error")
public String getSuggestedAction() {
return suggestedAction;
}
public void setSuggestedAction(String suggestedAction) {
this.suggestedAction = suggestedAction;
}
public Cause itemId(String itemId) {
this.itemId = itemId;
return this;
}
/**
* The `item_id` of the Item associated with this webhook, warning, or error
* @return itemId
**/
@ApiModelProperty(required = true, value = "The `item_id` of the Item associated with this webhook, warning, or error")
public String getItemId() {
return itemId;
}
public void setItemId(String itemId) {
this.itemId = itemId;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Cause cause = (Cause) o;
return Objects.equals(this.errorType, cause.errorType) &&
Objects.equals(this.errorCode, cause.errorCode) &&
Objects.equals(this.errorMessage, cause.errorMessage) &&
Objects.equals(this.displayMessage, cause.displayMessage) &&
Objects.equals(this.requestId, cause.requestId) &&
Objects.equals(this.causes, cause.causes) &&
Objects.equals(this.status, cause.status) &&
Objects.equals(this.documentationUrl, cause.documentationUrl) &&
Objects.equals(this.suggestedAction, cause.suggestedAction) &&
Objects.equals(this.itemId, cause.itemId);
}
@Override
public int hashCode() {
return Objects.hash(errorType, errorCode, errorMessage, displayMessage, requestId, causes, status, documentationUrl, suggestedAction, itemId);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Cause {\n");
sb.append(" errorType: ").append(toIndentedString(errorType)).append("\n");
sb.append(" errorCode: ").append(toIndentedString(errorCode)).append("\n");
sb.append(" errorMessage: ").append(toIndentedString(errorMessage)).append("\n");
sb.append(" displayMessage: ").append(toIndentedString(displayMessage)).append("\n");
sb.append(" requestId: ").append(toIndentedString(requestId)).append("\n");
sb.append(" causes: ").append(toIndentedString(causes)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" documentationUrl: ").append(toIndentedString(documentationUrl)).append("\n");
sb.append(" suggestedAction: ").append(toIndentedString(suggestedAction)).append("\n");
sb.append(" itemId: ").append(toIndentedString(itemId)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}
