Request
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-02-27 UTC.
[null,null,["Last updated 2025-02-27 UTC."],[[["Batch requests use JSON to bundle multiple API calls into a single request, each identified by a unique `requestId`."],["Each individual request within the batch specifies the `methodName` and includes a `request` object containing the call's specific data and type information."],["The `extensions` field allows for adding application-specific metadata to individual requests within the batch."]]],["A request within a batch execution is represented in JSON. It includes a unique `requestId` to link it to its response. The `methodName` specifies the fully qualified method being called. The `request` field holds the request payload as an object with a type identifier. `extensions` carries application-specific metadata, also as an object with a type identifier. Multiple requests can share the same `requestId` for streaming methods.\n"]]