Represents the result of a service call.
| Constant | Description |
|---|---|
| ERROR: String = “ERROR” | Status indicating a general service error. |
| OK: String = “OK” | Status indicating a successful service call. |
| SERVICE_UNAVAILABLE: String = “SERVICE_UNAVAILABLE” | Status indicating the service is unavailable. |
| UNAVAILABLE_CIRCUIT_BROKEN: String = “CIRCUIT_BROKEN” | Unavailable reason: No call was made because the circuit breaker prevented it. |
| UNAVAILABLE_CONFIG_PROBLEM: String = “CONFIG_PROBLEM” | Unavailable reason: No call was made because the service was not configured correctly. |
| UNAVAILABLE_DISABLED: String = “DISABLED” | Unavailable reason: No call was made because the service is disabled. |
| UNAVAILABLE_RATE_LIMITED: String = “RATE_LIMITED” | Unavailable reason: No call was made because the rate limit was hit. |
| UNAVAILABLE_TIMEOUT: String = “TIMEOUT” | Unavailable reason: A real call was made but a timeout occurred. |
| Property | Description |
|---|---|
error: Number (read-only) | Returns an error-specific code if applicable. |
errorMessage: String (read-only) | Returns an error message on a non-OK status. |
mockResult: Boolean (read-only) | Returns the status of whether the response is the result of a “mock” service call. |
msg: String (read-only) | Returns an extra error message on failure (if any). |
object: Object (read-only) | Returns the actual object returned by the service when the status is OK. |
ok: Boolean (read-only) | Returns the status of whether the service call was successful. |
status: String (read-only) | Returns the status. |
unavailableReason: String (read-only) | Returns the reason the status is SERVICE_UNAVAILABLE. |
| Constructor | Description |
|---|---|
| Result() | Constructs a new result instance. |
| Method | Description |
|---|---|
| getError() | Returns an error-specific code if applicable. |
| getErrorMessage() | Returns an error message on a non-OK status. |
| getMsg() | Returns an extra error message on failure (if any). |
| getObject() | Returns the actual object returned by the service when the status is OK. |
| getStatus() | Returns the status. |
| getUnavailableReason() | Returns the reason the status is SERVICE_UNAVAILABLE. |
| isMockResult() | Returns the status of whether the response is the result of a “mock” service call. |
| isOk() | Returns the status of whether the service call was successful. |
| toString() | Returns a string representation of the result. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Status indicating a general service error.
Status indicating a successful service call.
Status indicating the service is unavailable. This includes timeouts, rate limits, and remote server issues.
Unavailable reason: No call was made because the circuit breaker prevented it.
Unavailable reason: No call was made because the service was not configured correctly.
Unavailable reason: No call was made because the service is disabled.
Unavailable reason: No call was made because the rate limit was hit.
Unavailable reason: A real call was made but a timeout occurred.
(read-only)Returns an error-specific code if applicable. For example, this is the HTTP response code for an HTTPService.
(read-only)Returns an error message on a non-OK status.
(read-only)Returns the status of whether the response is the result of a "mock" service call.
(read-only)Returns an extra error message on failure (if any).
(read-only)Returns the actual object returned by the service when the status is OK.
(read-only)Returns the status of whether the service call was successful.
(read-only)Returns the status. This is "OK" on success. Failure codes include "ERROR" and "SERVICE_UNAVAILABLE".
If the status is "SERVICE_UNAVAILABLE", then the unavailableReason is guaranteed to be non-null.
See Also:
(read-only)Returns the reason the status is SERVICE_UNAVAILABLE.
See Also:
Constructs a new result instance.
Returns an error-specific code if applicable. For example, this is the HTTP response code for an HTTPService.
Returns:
Returns an error message on a non-OK status.
Returns:
Returns an extra error message on failure (if any).
Returns:
Returns the actual object returned by the service when the status is OK.
Returns:
Returns the status. This is "OK" on success. Failure codes include "ERROR" and "SERVICE_UNAVAILABLE".
If the status is "SERVICE_UNAVAILABLE", then the unavailableReason is guaranteed to be non-null.
Returns:
See Also:
Returns the reason the status is SERVICE_UNAVAILABLE.
Returns:
See Also:
Returns the status of whether the response is the result of a "mock" service call.
Returns:
Returns the status of whether the service call was successful.
Returns:
Returns a string representation of the result.
Returns:
j