Class HttpBody (2.17.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

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

HttpBody()

 public HttpBody() 

HttpBody(HttpBody)

 public HttpBody(HttpBody other) 
Parameter
Name
Description
other

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

Data

 public ByteString Data { get; set; } 

The HTTP request/response body as raw binary.

Property Value
Type
Description

Descriptor

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

Extensions

 public RepeatedField<Any> Extensions { get; } 

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

Property Value
Type
Description

Parser

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

Methods

CalculateSize()

 public int CalculateSize() 
Returns
Type
Description
int

Clone()

 public HttpBody Clone() 
Returns
Type
Description

Equals(HttpBody)

 public bool Equals(HttpBody other) 
Parameter
Name
Description
other
Returns
Type
Description

Equals(object)

 public override bool Equals(object other) 
Parameter
Name
Description
other
Returns
Type
Description
Overrides

GetHashCode()

 public override int GetHashCode() 
Returns
Type
Description
int
Overrides

MergeFrom(HttpBody)

 public void MergeFrom(HttpBody other) 
Parameter
Name
Description
other

MergeFrom(CodedInputStream)

 public void MergeFrom(CodedInputStream input) 
Parameter
Name
Description

ToString()

 public override string ToString() 
Returns
Type
Description
Overrides

WriteTo(CodedOutputStream)

 public void WriteTo(CodedOutputStream output) 
Parameter
Name
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: