Struct HttpBody

pub struct HttpBody {
    pub content_type: Option<String>,
    pub data: Option<Vec<u8>>,
    pub extensions: Option<Vec<HashMap<String, Value>>>,
}

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.

This type is not used in any activity, and only used as part of another schema.

Fields

content_type: Option<String>

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

data: Option<Vec<u8>>

The HTTP request/response body as raw binary.

extensions: Option<Vec<HashMap<String, Value>>>

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

Trait Implementations

impl Clone for HttpBody

fn clone(&self) -> HttpBody

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpBody

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HttpBody

fn default() -> HttpBody

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HttpBody

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HttpBody

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for HttpBody