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
System.Object
HttpBody
Implements
System.IEquatable<HttpBody>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Api
Assembly: Google.Api.CommonProtos.dll
Syntax
public sealed class HttpBody : IMessage<HttpBody>, IMessage, IEquatable<HttpBody>, IDeepCloneable<HttpBody>

Constructors

HttpBody()

Declaration
public HttpBody()

HttpBody(HttpBody)

Declaration
public HttpBody(HttpBody other)
Parameters
Type Name Description
HttpBody other

Fields

ContentTypeFieldNumber

Field number for the "content_type" field.

Declaration
public const int ContentTypeFieldNumber = 1
Field Value
Type Description
System.Int32

DataFieldNumber

Field number for the "data" field.

Declaration
public const int DataFieldNumber = 2
Field Value
Type Description
System.Int32

ExtensionsFieldNumber

Field number for the "extensions" field.

Declaration
public const int ExtensionsFieldNumber = 3
Field Value
Type Description
System.Int32

Properties

ContentType

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

Declaration
public string ContentType { get; set; }
Property Value
Type Description
System.String

Data

The HTTP request/response body as raw binary.

Declaration
public ByteString Data { get; set; }
Property Value
Type Description
ByteString

Descriptor

Declaration
public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

Extensions

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

Declaration
public RepeatedField<Any> Extensions { get; }
Property Value
Type Description
RepeatedField<Any>

Parser

Declaration
public static MessageParser<HttpBody> Parser { get; }
Property Value
Type Description
MessageParser<HttpBody>

Methods

CalculateSize()

Declaration
public int CalculateSize()
Returns
Type Description
System.Int32
Implements

Clone()

Declaration
public HttpBody Clone()
Returns
Type Description
HttpBody
Implements

Equals(HttpBody)

Declaration
public bool Equals(HttpBody other)
Parameters
Type Name Description
HttpBody other
Returns
Type Description
System.Boolean
Implements
System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
System.Object other
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

MergeFrom(HttpBody)

Declaration
public void MergeFrom(HttpBody other)
Parameters
Type Name Description
HttpBody other
Implements

MergeFrom(CodedInputStream)

Declaration
public void MergeFrom(CodedInputStream input)
Parameters
Type Name Description
CodedInputStream input
Implements

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

WriteTo(CodedOutputStream)

Declaration
public void WriteTo(CodedOutputStream output)
Parameters
Type Name Description
CodedOutputStream output
Implements

Explicit Interface Implementations

IMessage.Descriptor

Declaration
MessageDescriptor IMessage.Descriptor { get; }
Returns
Type Description
MessageDescriptor
Implements