HttpBody
Stay organized with collections
Save and categorize content based on your preferences.
Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.
This message can be used both in streaming and non-streaming API methods in the request as well as the response.
It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.
Example:
message GetResourceRequest {
// A unique request id.
string request_id = 1;
// The raw HTTP body is bound to this field.
google.api.HttpBody http_body = 2;
}
service ResourceService {
rpc GetResource(GetResourceRequest)
returns (google.api.HttpBody);
rpc UpdateResource(google.api.HttpBody)
returns (google.protobuf.Empty);
}
Example with streaming methods:
service CaldavService {
rpc GetCalendar(stream google.api.HttpBody)
returns (stream google.api.HttpBody);
rpc UpdateCalendar(stream google.api.HttpBody)
returns (stream google.api.HttpBody);
}
Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
| JSON representation |
{
"contentType": string,
"data": string,
"extensions": [
{
"@type": string,
field1: ...,
...
}
]
} |
| Fields |
contentType |
string
The HTTP Content-Type header value specifying the content type of the body.
|
data |
string (bytes format)
The HTTP request/response body as raw binary. A base64-encoded string.
|
extensions[] |
object
Application specific response metadata. Must be set in the first response for streaming APIs. 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-28 UTC.
[null,null,["Last updated 2025-02-28 UTC."],[[["\u003cp\u003e\u003ccode\u003egoogle.api.HttpBody\u003c/code\u003e represents arbitrary HTTP request or response bodies, ideal for non-JSON formats like raw binary or HTML.\u003c/p\u003e\n"],["\u003cp\u003eIt can be used with both streaming and non-streaming API methods, allowing flexibility in data transmission.\u003c/p\u003e\n"],["\u003cp\u003eThis message type enables you to access raw HTTP body content while still utilizing other API features.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of \u003ccode\u003egoogle.api.HttpBody\u003c/code\u003e includes \u003ccode\u003econtentType\u003c/code\u003e, \u003ccode\u003edata\u003c/code\u003e, and \u003ccode\u003eextensions\u003c/code\u003e fields to structure the body content and metadata.\u003c/p\u003e\n"]]],["The `google.api.HttpBody` message represents an arbitrary HTTP body for non-JSON formats like raw binary or HTML. It's used in both streaming and non-streaming API methods, for requests and responses. Requests can include it as a top-level field, useful for accessing both the raw body and URL parameters. Key actions include binding the raw HTTP body to a designated field, defining content type, sending binary data (base64-encoded), and include metadata.\n"],null,["# HttpBody\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nMessage that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.\n\nThis message can be used both in streaming and non-streaming API methods in the request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.\n\nExample: \n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest)\n returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody)\n returns (google.protobuf.Empty);\n\n }\n\nExample with streaming methods: \n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n\n }\n\nUse of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------|\n| ``` { \"contentType\": string, \"data\": string, \"extensions\": [ { \"@type\": string, field1: ..., ... } ] } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `contentType` | `string` The HTTP Content-Type header value specifying the content type of the body. |\n| `data` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` The HTTP request/response body as raw binary. A base64-encoded string. |\n| `extensions[]` | `object` Application specific response metadata. Must be set in the first response for streaming APIs. 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\" }`. |"]]
