Class HttpBody (2.15.0)

public sealed class HttpBody : IMessage<HttpBody>, IEquatable<HttpBody>, IDeepCloneable<HttpBody>, IBufferMessage, IMessage

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

IMessage HttpBody, IEquatable HttpBody, IDeepCloneable HttpBody, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

HttpBody()

public HttpBody()

HttpBody(HttpBody)

public HttpBody(HttpBody other)

Parameter
Name	Description
`other`	`HttpBody`

Fields

ContentTypeFieldNumber

public const int ContentTypeFieldNumber = 1

Field number for the "content_type" field.

Field Value
Type	Description
`int`

DataFieldNumber

public const int DataFieldNumber = 2

Field number for the "data" field.

Field Value
Type	Description
`int`

ExtensionsFieldNumber

public const int ExtensionsFieldNumber = 3

Field number for the "extensions" field.

Field Value
Type	Description
`int`

Properties

ContentType

public string ContentType { get; set; }

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

Property Value
Type	Description
`string`

Data

public ByteString Data { get; set; }

The HTTP request/response body as raw binary.

Property Value
Type	Description
`ByteString`

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`MessageDescriptor`

Extensions

public RepeatedField<Any> Extensions { get; }

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

Property Value
Type	Description
`RepeatedFieldAny`

Parser

public static MessageParser<HttpBody> Parser { get; }

Property Value
Type	Description
`MessageParserHttpBody`

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type	Description
`int`	The number of bytes required to write this message to a coded output stream.

Clone()

public HttpBody Clone()

Creates a deep clone of this object.

Returns
Type	Description
`HttpBody`	A deep clone of this object.

Equals(HttpBody)

public bool Equals(HttpBody other)

Parameter
Name	Description
`other`	`HttpBody`

Returns
Type	Description
`bool`

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`object`

Returns
Type	Description
`bool`

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

MergeFrom(HttpBody)

public void MergeFrom(HttpBody other)

Merges the given message into this one.

Parameter
Name	Description
`other`	`HttpBody`

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name	Description
`input`	`CodedInputStream`

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name	Description
`output`	`CodedOutputStream` Coded output stream to write the data to. Must not be null.