Send feedback
Class HttpBody (2.2.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.2.0 keyboard_arrow_down
public sealed class HttpBody : Protobuf.IMessage<HttpBody>, Protobuf.IBufferMessage
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.
Namespace
Google.Api
Assembly
Google.Api.CommonProtos.dll
Constructors
HttpBody()
HttpBody(HttpBody)
public HttpBody(HttpBody other)
Fields
ContentTypeFieldNumber
public const int ContentTypeFieldNumber = 1
Field number for the "content_type" field.
Field Value Type Description Int32
DataFieldNumber
public const int DataFieldNumber = 2
Field number for the "data" field.
Field Value Type Description Int32
ExtensionsFieldNumber
public const int ExtensionsFieldNumber = 3
Field number for the "extensions" field.
Field Value Type Description Int32
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 Protobuf.ByteString Data { get; set; }
The HTTP request/response body as raw binary.
Descriptor
public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Extensions
public Protobuf.Collections.RepeatedField<Protobuf.WellKnownTypes.Any> Extensions { get; }
Application specific response metadata. Must be set in the first response
for streaming APIs.
Parser
public static Protobuf.MessageParser<HttpBody> Parser { get; }
Methods
CalculateSize()
public int CalculateSize()
Returns Type Description Int32
Clone()
Equals(HttpBody)
public bool Equals(HttpBody other)
Equals(Object)
public override bool Equals(object other)
Parameter Name Description other
Object
GetHashCode()
public override int GetHashCode()
Returns Type Description Int32
MergeFrom(HttpBody)
public void MergeFrom(HttpBody other)
MergeFrom(Protobuf.CodedInputStream)
public void MergeFrom(Protobuf.CodedInputStream input)
ToString()
public override string ToString()
WriteTo(Protobuf.CodedOutputStream)
public void WriteTo(Protobuf.CodedOutputStream output)
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-19 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-09-19 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-19 UTC."]]