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.
Implements
IMessage HttpBody , IEquatable HttpBody , IDeepCloneable HttpBody , IBufferMessage , IMessageNamespace
Google.ApiAssembly
Google.Api.CommonProtos.dll
Constructors
HttpBody()
public HttpBody()
HttpBody(HttpBody)
public HttpBody(HttpBody other)
Fields
ContentTypeFieldNumber
public
const
int
ContentTypeFieldNumber
=
1
Field number for the "content_type" field.
DataFieldNumber
public
const
int
DataFieldNumber
=
2
Field number for the "data" field.
ExtensionsFieldNumber
public
const
int
ExtensionsFieldNumber
=
3
Field number for the "extensions" field.
Properties
ContentType
public string ContentType { get; set; }
The HTTP Content-Type header value specifying the content type of the body.
Data
public ByteString Data { get; set; }
The HTTP request/response body as raw binary.
Descriptor
public static MessageDescriptor Descriptor { get; }
Extensions
public RepeatedField<Any> Extensions { get; }
Application specific response metadata. Must be set in the first response for streaming APIs.
Parser
public static MessageParser<HttpBody> Parser { get; }
Methods
CalculateSize()
public int CalculateSize()
Calculates the size of this message in Protocol Buffer wire format, in bytes.
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.
Equals(HttpBody)
public bool Equals(HttpBody other)
Equals(object)
public override bool Equals(object other)
GetHashCode()
public override int GetHashCode()
MergeFrom(HttpBody)
public void MergeFrom(HttpBody other)
Merges the given message into this one.
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.
See the user guide for precise merge semantics.
ToString()
public override string ToString()
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Writes the data to the given coded output stream.
output
