com.paypal.sdk.models

Class ErrorDetails

java.lang.Object

com.paypal.sdk.models.ErrorDetails

public class ErrorDetails
extends Object

This is a model class for ErrorDetails type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorDetails.Builder Class to build instances of ErrorDetails.

Constructor Summary

Constructors

Constructor and Description
ErrorDetails() Default constructor.
ErrorDetails(String issue, String field, String value, String location, List<LinkDescription> links, String description) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Getter for Description.
String	getField() Getter for Field.
String	getIssue() Getter for Issue.
List<LinkDescription>	getLinks() Getter for Links.
String	getLocation() Getter for Location.
String	getValue() Getter for Value.
void	setDescription(String description) Setter for Description.
void	setField(String field) Setter for Field.
void	setIssue(String issue) Setter for Issue.
void	setLinks(List<LinkDescription> links) Setter for Links.
void	setLocation(String location) Setter for Location.
void	setValue(String value) Setter for Value.
ErrorDetails.Builder	toBuilder() Builds a new ErrorDetails.Builder object.
String	toString() Converts this ErrorDetails into string format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ErrorDetails

public ErrorDetails()

Default constructor.

ErrorDetails

public ErrorDetails(String issue,
                    String field,
                    String value,
                    String location,
                    List<LinkDescription> links,
                    String description)

Initialization constructor.

Parameters:

issue - String value for issue.

field - String value for field.

value - String value for value.

location - String value for location.

links - List of LinkDescription value for links.

description - String value for description.

Method Detail

getField

public String getField()

Getter for Field. The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.

Returns:

Returns the String

setField

public void setField(String field)

Setter for Field. The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.

Parameters:

field - Value for String

getValue

public String getValue()

Getter for Value. The value of the field that caused the error.

Returns:

Returns the String

setValue

public void setValue(String value)

Setter for Value. The value of the field that caused the error.

Parameters:

value - Value for String

getLocation

public String getLocation()

Getter for Location. The location of the field that caused the error. Value is `body`, `path`, or `query`.

Returns:

Returns the String

setLocation

public void setLocation(String location)

Setter for Location. The location of the field that caused the error. Value is `body`, `path`, or `query`.

Parameters:

location - Value for String

getIssue

public String getIssue()

Getter for Issue. The unique, fine-grained application-level error code.

Returns:

Returns the String

setIssue

public void setIssue(String issue)

Setter for Issue. The unique, fine-grained application-level error code.

Parameters:

issue - Value for String

getLinks

public List<LinkDescription> getLinks()

Getter for Links. An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links) that are either relevant to the issue by providing additional information or offering potential resolutions.

Returns:

Returns the List of LinkDescription

setLinks

public void setLinks(List<LinkDescription> links)

Setter for Links. An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links) that are either relevant to the issue by providing additional information or offering potential resolutions.

Parameters:

links - Value for List of LinkDescription

getDescription

public String getDescription()

Getter for Description. The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.

Returns:

Returns the String

setDescription

public void setDescription(String description)

Setter for Description. The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.

Parameters:

description - Value for String

toString

public String toString()

Converts this ErrorDetails into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ErrorDetails.Builder toBuilder()

Builds a new ErrorDetails.Builder object. Creates the instance with the state of the current model.

Returns:

a new ErrorDetails.Builder object