Response
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-02-27 UTC.
[null,null,["Last updated 2025-02-27 UTC."],[[["The JSON response to a Request includes a request ID, continuation status, application-specific metadata, and a result field."],["The `result` field indicates either an error with a status object or a successful response payload."],["Both `extensions` and `response` fields use a flexible structure with an `@type` field to specify data types."],["If `continued` is true, expect additional responses in the same stream."]]],["A JSON response contains a `requestId` string matching the initial request. The `continued` boolean indicates if more responses will follow. `extensions` holds application-specific metadata. The `result` field, a union type, can hold either an `error` object (if the request failed) or a successful `response` object, both containing an `@type` identifier and additional fields. This describes a structure to send response messages back to the users.\n"]]
