Response
Stay organized with collections
Save and categorize content based on your preferences.
A response to a single Request.
| JSON representation |
{
"requestId": string,
"continued": boolean,
"extensions": [
{
"@type": string,
field1: ...,
...
}
],
// Union field result can be only one of the following:
"error": {
object (Status)
},
"response": {
"@type": string,
field1: ...,
...
}
// End of list of possible types for union field result.
} |
| Fields |
requestId |
string
The requestId of the Request this message is in response to.
|
continued |
boolean
If true, this Response is followed by additional responses that are in the same response stream as this Response.
|
extensions[] |
object
Application specific response metadata. An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.
|
Union field result. The response result, which can be either an error or a valid response. result can be only one of the following: |
error |
object (Status)
The error result if there was an error processing the request.
|
response |
object
The response payload if the call was a success. An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.
|
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 2025-03-13 UTC.
[null,null,["Last updated 2025-03-13 UTC."],[],[],null,["# Response\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nA response to a single Request.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestId\": string, \"continued\": boolean, \"extensions\": [ { \"@type\": string, field1: ..., ... } ], // Union field `result` can be only one of the following: \"error\": { object (/workspace/tasks/reference/rest/v1/Status) }, \"response\": { \"@type\": string, field1: ..., ... } // End of list of possible types for union field `result`. } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestId` | `string` The requestId of the Request this message is in response to. |\n| `continued` | `boolean` If true, this Response is followed by additional responses that are in the same response stream as this Response. |\n| `extensions[]` | `object` Application specific response metadata. An object containing fields of an arbitrary type. An additional field `\"@type\"` contains a URI identifying the type. Example: `{ \"id\": 1234, \"@type\": \"types.example.com/standard/id\" }`. |\n| Union field `result`. The response result, which can be either an `error` or a valid `response`. `result` can be only one of the following: ||\n| `error` | `object (`[Status](/workspace/tasks/reference/rest/v1/Status)`)` The error result if there was an error processing the request. |\n| `response` | `object` The response payload if the call was a success. An object containing fields of an arbitrary type. An additional field `\"@type\"` contains a URI identifying the type. Example: `{ \"id\": 1234, \"@type\": \"types.example.com/standard/id\" }`. |"]]
