Show / Hide Table of Contents

Class 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.

Inheritance
object
HttpBody
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudTasks.v2beta2.Data
Assembly: Google.Apis.CloudTasks.v2beta2.dll
Syntax
public class HttpBody : IDirectResponseSchema

Properties

ContentType

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

Declaration
[JsonProperty("contentType")]
public virtual string ContentType { get; set; }
Property Value
Type Description
string

Data

The HTTP request/response body as raw binary.

Declaration
[JsonProperty("data")]
public virtual string Data { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Extensions

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

Declaration
[JsonProperty("extensions")]
public virtual IList<IDictionary<string, object>> Extensions { get; set; }
Property Value
Type Description
IList<IDictionary<string, object>>

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX