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);
}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eHttpBody\u003c/code\u003e message represents an arbitrary HTTP body, suitable for non-JSON payload formats like raw binary or HTML.\u003c/p\u003e\n"],["\u003cp\u003eIt can be utilized in both streaming and non-streaming API methods, for requests and responses.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eHttpBody\u003c/code\u003e can be a top-level request field, allowing for parameter extraction from URLs or HTTP templates alongside access to the raw HTTP body.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eHttpBody\u003c/code\u003e message contains fields for \u003ccode\u003econtent_type\u003c/code\u003e, \u003ccode\u003edata\u003c/code\u003e (raw binary body), and \u003ccode\u003eextensions\u003c/code\u003e for application-specific metadata.\u003c/p\u003e\n"],["\u003cp\u003eUsing \u003ccode\u003eHttpBody\u003c/code\u003e only alters how request and response bodies are managed, with other API features remaining unaffected.\u003c/p\u003e\n"]]],[],null,["# Package google.api\n\nIndex\n-----\n\n- [HttpBody](/healthcare-api/docs/reference/rpc/google.api#google.api.HttpBody) (message)\n\nHttpBody\n--------\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."]]
