Package com.ringcentral.definitions

Class ApiErrorWithParameter

java.lang.Object

com.ringcentral.definitions.ApiErrorWithParameter

public class ApiErrorWithParameter
extends Object

Generalized API error structure suitable for any error type

Field Summary

Fields

Modifier and Type	Field	Description
String	errorCode	Logical error code (typically, 3 letters followed with number, dash separated) Required Example: XXX-123
String	message	User-friendly error message Required Example: Something went wrong
String	parameterName	The name of the API parameter/attribute which caused the error
String	parameterValue	The value of the API parameter/attribute which caused the error

Constructor Summary

Constructors

Constructor	Description
ApiErrorWithParameter()

Method Summary

Modifier and Type	Method	Description
ApiErrorWithParameter	errorCode(String errorCode)
ApiErrorWithParameter	message(String message)
ApiErrorWithParameter	parameterName(String parameterName)
ApiErrorWithParameter	parameterValue(String parameterValue)

Methods inherited from class java.lang.Object

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

Field Details

errorCode

public String errorCode

Logical error code (typically, 3 letters followed with number, dash separated) Required Example: XXX-123

message

public String message

User-friendly error message Required Example: Something went wrong

parameterName

public String parameterName

The name of the API parameter/attribute which caused the error

parameterValue

public String parameterValue

The value of the API parameter/attribute which caused the error

Constructor Details

ApiErrorWithParameter

public ApiErrorWithParameter()

Method Details

errorCode

public ApiErrorWithParameter errorCode(String errorCode)

message

public ApiErrorWithParameter message(String message)

parameterName

public ApiErrorWithParameter parameterName(String parameterName)

parameterValue

public ApiErrorWithParameter parameterValue(String parameterValue)