Package com.ringcentral.definitions

Class ApiError

java.lang.Object

com.ringcentral.definitions.ApiError

public class ApiError
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

Constructor Summary

Constructors

Constructor	Description
ApiError()

Method Summary

Modifier and Type	Method	Description
ApiError	errorCode(String errorCode)
ApiError	message(String message)

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

Constructor Details

ApiError

public ApiError()

Method Details

errorCode

public ApiError errorCode(String errorCode)

message

public ApiError message(String message)