Package google.api

  • HttpBody is a message type used to represent arbitrary HTTP request or response bodies, especially for non-JSON formats like raw binary or HTML.

  • It can be used with both streaming and non-streaming API methods, enabling flexibility in data transmission.

  • HttpBody allows developers to access raw HTTP data while still using structured fields for other request parameters.

  • It includes fields for specifying the content type (content_type), raw data (data), and any application-specific metadata (extensions).

Index

HttpBody

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.

Fields
content_type

string

The HTTP Content-Type header value specifying the content type of the body.
data

bytes

The HTTP request/response body as raw binary.
extensions[]

Any

Application specific response metadata. Must be set in the first response for streaming APIs.