Class: Google::Api::HttpBody

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/httpbody.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#content_type ⇒ ::String

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

Returns:

  • (::String) —

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



75
76
77
78
 
# File 'proto_docs/google/api/httpbody.rb', line 75

class HttpBody
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#data ⇒ ::String

Returns The HTTP request/response body as raw binary.

Returns:

  • (::String) —

    The HTTP request/response body as raw binary.



75
76
77
78
 
# File 'proto_docs/google/api/httpbody.rb', line 75

class HttpBody
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#extensions ⇒ ::Array<::Google::Protobuf::Any>

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

Returns:

  • (::Array<::Google::Protobuf::Any>) —

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



75
76
77
78
 
# File 'proto_docs/google/api/httpbody.rb', line 75

class HttpBody
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end