Cloud Build V1 API - Class Google::Api::HttpBody (v0.21.0) Stay organized with collections Save and categorize content based on your preferences.
Reference documentation and code samples for the Cloud Build V1 API class Google::Api::HttpBody.
Message that represents an arbitrary HTTP body. It should only be used forpayload formats that can't be represented as JSON, such as raw binary oran HTML page.
This message can be used both in streaming and non-streaming API methods inthe request as well as the response.
It can be used as a top-level request field, which is convenient if onewants to extract parameters from either the URL or HTTP template into therequest 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 arehandled, all other features will continue to work unchanged.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#content_type
defcontent_type()->::String- (::String) — The HTTP Content-Type header value specifying the content type of the body.
#content_type=
defcontent_type=(value)->::String- value (::String) — The HTTP Content-Type header value specifying the content type of the body.
- (::String) — The HTTP Content-Type header value specifying the content type of the body.
#data
defdata()->::String- (::String) — The HTTP request/response body as raw binary.
#data=
defdata=(value)->::String- value (::String) — The HTTP request/response body as raw binary.
- (::String) — The HTTP request/response body as raw binary.
#extensions
defextensions()->::Array<::Google::Protobuf::Any>- (::Array<::Google::Protobuf::Any>) — Application specific response metadata. Must be set in the first responsefor streaming APIs.
#extensions=
defextensions=(value)->::Array<::Google::Protobuf::Any>- value (::Array<::Google::Protobuf::Any>) — Application specific response metadata. Must be set in the first responsefor streaming APIs.
- (::Array<::Google::Protobuf::Any>) — Application specific response metadata. Must be set in the first responsefor streaming APIs.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.