Custom error.
| JSON representation | |
|---|---|
{
"code": enum ( |
|
| Fields | |
|---|---|
code |
The custom error code. |
message |
The error message. |
CustomError
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-07 UTC.
[null,null,["Last updated 2024-08-07 UTC."],[[["\u003cp\u003eThe provided content describes a custom error structure using a JSON representation.\u003c/p\u003e\n"],["\u003cp\u003eThe error structure includes a \u003ccode\u003ecode\u003c/code\u003e field, which is an enumeration of \u003ccode\u003eCustomErrorCode\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe error structure also includes a \u003ccode\u003emessage\u003c/code\u003e field, which is a string containing the error description.\u003c/p\u003e\n"],["\u003cp\u003eThe schema representation is provided within the context of a table that shows the JSON representation as well as a separate table for the fields.\u003c/p\u003e\n"]]],["The JSON representation for a custom error includes two fields: `code` and `message`. The `code` field is an enumerated value from `CustomErrorCode`, representing a specific error type. The `message` field is a string providing a detailed description of the error. This structure is used to communicate custom error information, utilizing a defined error code and an accompanying message.\n"],null,["# CustomError\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nCustom error.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------|---|\n| ``` { \"code\": enum (/zero-touch/reference/reseller/rest/v1/CustomErrorCode), \"message\": string } ``` |\n\n| Fields ||\n|-----------|-------------------------------------------------------------------------------------------------------------|\n| `code` | `enum (`[CustomErrorCode](/zero-touch/reference/reseller/rest/v1/CustomErrorCode)`)` The custom error code. |\n| `message` | `string` The error message. |"]]