Class DebugError
Stay organized with collections
Save and categorize content based on your preferences.
DebugError
An error that is only visible to admins of the connector.
const cc = DataStudioApp.createCommunityConnector();
cc.newDebugError().setText('This is the debug error text.').throwException();
Detailed documentation
printJson()
Prints the JSON representation of this object. This is for debugging only.
Return
String
setText(text)
Sets the text of the debug error, which is only shown to admins.
Parameters
| Name | Type | Description |
text | String | The error text. |
Return
DebugError — This object, for chaining.
throwException()
Triggers this exception to be thrown.
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-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eDebugError\u003c/code\u003e is an error type visible only to connector admins, used for debugging purposes.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to set error text (\u003ccode\u003esetText\u003c/code\u003e), print the error as JSON (\u003ccode\u003eprintJson\u003c/code\u003e), and trigger the error (\u003ccode\u003ethrowException\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eAdmins can utilize \u003ccode\u003eDebugError\u003c/code\u003e to identify and resolve issues within the connector without exposing them to end-users.\u003c/p\u003e\n"]]],[],null,["# Class DebugError\n\nDebugError\n\nAn error that is only visible to admins of the connector.\n\n```javascript\nconst cc = DataStudioApp.createCommunityConnector();\n\ncc.newDebugError().setText('This is the debug error text.').throwException();\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------|-----------------|------------------------------------------------------------------|\n| [printJson()](#printJson()) | `String` | Prints the JSON representation of this object. |\n| [setText(text)](#setText(String)) | [DebugError](#) | Sets the text of the debug error, which is only shown to admins. |\n| [throwException()](#throwException()) | `void` | Triggers this exception to be thrown. |\n\nDetailed documentation\n----------------------\n\n### `print``Json()`\n\nPrints the JSON representation of this object. This is for debugging only.\n\n#### Return\n\n\n`String`\n\n*** ** * ** ***\n\n### `set``Text(text)`\n\nSets the text of the debug error, which is only shown to admins.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------|----------|-----------------|\n| `text` | `String` | The error text. |\n\n#### Return\n\n\n[DebugError](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `throw``Exception()`\n\nTriggers this exception to be thrown."]]
