Class ApiError (5.0.2)
Stay organized with collections
Save and categorize content based on your preferences.
Custom error type for API errors.
Inheritance
Error
>
ApiError
Package
@google-cloud/common
Constructors
(constructor)(errorMessage)
constructor(errorMessage: string);
Constructs a new instance of the ApiError
class
Parameter |
---|
Name | Description |
errorMessage |
string
|
(constructor)(errorBody)
constructor(errorBody: GoogleErrorBody);
Constructs a new instance of the ApiError
class
Parameter |
---|
Name | Description |
errorBody |
GoogleErrorBody
|
Properties
code
errors
errors?: GoogleInnerError[];
response
Methods
createMultiErrorMessage(err, errors)
static createMultiErrorMessage(err: GoogleErrorBody, errors?: GoogleInnerError[]): string;
Pieces together an error message by combining all unique error messages returned from a single GoogleError
Parameters |
---|
Name | Description |
err |
GoogleErrorBody
The original error.
|
errors |
GoogleInnerError[]
Inner errors, if any.
|
Returns |
---|
Type | Description |
string | {string}
|
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-10-01 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-10-01 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-01 UTC."]]