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 string representing the content type of the body.
-
#data ⇒ String
HTTP body binary data.
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
1085 1086 1087 |
# File 'generated/google/apis/ml_v1/classes.rb', line 1085 def initialize(**args) update!(**args) end |
Instance Attribute Details
#content_type ⇒ String
The HTTP Content-Type string representing the content type of the body.
Corresponds to the JSON property contentType
1083 1084 1085 |
# File 'generated/google/apis/ml_v1/classes.rb', line 1083 def content_type @content_type end |
#data ⇒ String
HTTP body binary data.
Corresponds to the JSON property data
NOTE: Values are automatically base64 encoded/decoded in the client library.
1078 1079 1080 |
# File 'generated/google/apis/ml_v1/classes.rb', line 1078 def data @data end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1090 1091 1092 1093 |
# File 'generated/google/apis/ml_v1/classes.rb', line 1090 def update!(**args) @data = args[:data] if args.key?(:data) @content_type = args[:content_type] if args.key?(:content_type) end |