Request
Stay organized with collections
Save and categorize content based on your preferences.
A request message sent as part of a batch execution.
| JSON representation |
{
"requestId": string,
"methodName": string,
"request": {
"@type": string,
field1: ...,
...
},
"extensions": [
{
"@type": string,
field1: ...,
...
}
]
} |
| Fields |
requestId |
string
Unique id of this request within the batch. The Response message with a matching requestId is the response to this request. For request-streaming methods, the same requestId may be used multiple times to pass all request messages that are part of a single method. For response-streaming methods, the same requestId may show up in multiple Response messages.
|
methodName |
string
The method being called. Must be a fully qualified method name. Example: google.rpc.batch.Batch.Execute
|
request |
object
The request payload. 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" }.
|
extensions[] |
object
Application specific request 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" }.
|
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,["# Request\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nA request message sent as part of a batch execution.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestId\": string, \"methodName\": string, \"request\": { \"@type\": string, field1: ..., ... }, \"extensions\": [ { \"@type\": string, field1: ..., ... } ] } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestId` | `string` Unique id of this request within the batch. The Response message with a matching `requestId` is the response to this request. For request-streaming methods, the same `requestId` may be used multiple times to pass all request messages that are part of a single method. For response-streaming methods, the same `requestId` may show up in multiple Response messages. |\n| `methodName` | `string` The method being called. Must be a fully qualified method name. Example: google.rpc.batch.Batch.Execute |\n| `request` | `object` The request payload. 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| `extensions[]` | `object` Application specific request 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\" }`. |"]]
