Class: Google::Apis::MlV1::GoogleApiHttpBody
- Inherits:
-
Object
- Object
- Google::Apis::MlV1::GoogleApiHttpBody
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/ml_v1/classes.rb,
generated/google/apis/ml_v1/representations.rb,
generated/google/apis/ml_v1/representations.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
-
#content_type ⇒ String
The HTTP Content-Type header value specifying the content type of the body.
-
#data ⇒ String
The HTTP request/response body as raw binary.
-
#extensions ⇒ Array<Hash<String,Object>>
Application specific response metadata.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleApiHttpBody
constructor
A new instance of GoogleApiHttpBody.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleApiHttpBody
Returns a new instance of GoogleApiHttpBody
73 74 75 |
# File 'generated/google/apis/ml_v1/classes.rb', line 73 def initialize(**args) update!(**args) end |
Instance Attribute Details
#content_type ⇒ String
The HTTP Content-Type header value specifying the content type of the body.
Corresponds to the JSON property contentType
59 60 61 |
# File 'generated/google/apis/ml_v1/classes.rb', line 59 def content_type @content_type end |
#data ⇒ String
The HTTP request/response body as raw binary.
Corresponds to the JSON property data
NOTE: Values are automatically base64 encoded/decoded in the client library.
65 66 67 |
# File 'generated/google/apis/ml_v1/classes.rb', line 65 def data @data end |
#extensions ⇒ Array<Hash<String,Object>>
Application specific response metadata. Must be set in the first response
for streaming APIs.
Corresponds to the JSON property extensions
71 72 73 |
# File 'generated/google/apis/ml_v1/classes.rb', line 71 def extensions @extensions end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
78 79 80 81 82 |
# File 'generated/google/apis/ml_v1/classes.rb', line 78 def update!(**args) @content_type = args[:content_type] if args.key?(:content_type) @data = args[:data] if args.key?(:data) @extensions = args[:extensions] if args.key?(:extensions) end |