Class HttpBody (2.11.0)

public final class HttpBody extends GeneratedMessageV3 implements HttpBodyOrBuilder

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.

Protobuf type google.api.HttpBody

Implements

HttpBodyOrBuilder

Static Fields

CONTENT_TYPE_FIELD_NUMBER

public static final int CONTENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DATA_FIELD_NUMBER

public static final int DATA_FIELD_NUMBER
Field Value
Type Description
int

EXTENSIONS_FIELD_NUMBER

public static final int EXTENSIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HttpBody getDefaultInstance()
Returns
Type Description
HttpBody

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static HttpBody.Builder newBuilder()
Returns
Type Description
HttpBody.Builder

newBuilder(HttpBody prototype)

public static HttpBody.Builder newBuilder(HttpBody prototype)
Parameter
Name Description
prototype HttpBody
Returns
Type Description
HttpBody.Builder

parseDelimitedFrom(InputStream input)

public static HttpBody parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpBody
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpBody parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpBody
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HttpBody parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HttpBody
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HttpBody parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpBody
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HttpBody parseFrom(ByteString data)
Parameter
Name Description
data