HttpBody (common-protos-java 1.14.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.api.HttpBody

All Implemented Interfaces:: HttpBodyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class HttpBody
extends com.google.protobuf.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

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HttpBody.Builder
Message that represents an arbitrary HTTP body.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpBody.Builder` Message that represents an arbitrary HTTP body.

Field Summary

Fields
Modifier and Type Field and Description

static int CONTENT_TYPE_FIELD_NUMBER

static int DATA_FIELD_NUMBER

static int EXTENSIONS_FIELD_NUMBER
- Fields inherited from class com.google.protobuf.GeneratedMessageV3
  alwaysUseFieldBuilders, unknownFields
- Fields inherited from class com.google.protobuf.AbstractMessage
  memoizedSize
- Fields inherited from class com.google.protobuf.AbstractMessageLite
  memoizedHashCode

Fields
Modifier and Type	Field and Description
`static int`	`CONTENT_TYPE_FIELD_NUMBER`
`static int`	`DATA_FIELD_NUMBER`
`static int`	`EXTENSIONS_FIELD_NUMBER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getContentType()` The HTTP Content-Type header value specifying the content type of the body.
`com.google.protobuf.ByteString`	`getContentTypeBytes()` The HTTP Content-Type header value specifying the content type of the body.
`com.google.protobuf.ByteString`	`getData()` The HTTP request/response body as raw binary.
`static HttpBody`	`getDefaultInstance()`
`HttpBody`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Any`	`getExtensions(int index)` Application specific response metadata.
`int`	`getExtensionsCount()` Application specific response metadata.
`java.util.List<com.google.protobuf.Any>`	`getExtensionsList()` Application specific response metadata.
`com.google.protobuf.AnyOrBuilder`	`getExtensionsOrBuilder(int index)` Application specific response metadata.
`java.util.List<? extends com.google.protobuf.AnyOrBuilder>`	`getExtensionsOrBuilderList()` Application specific response metadata.
`com.google.protobuf.Parser<HttpBody>`	`getParserForType()`
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static HttpBody.Builder`	`newBuilder()`
`static HttpBody.Builder`	`newBuilder(HttpBody prototype)`
`HttpBody.Builder`	`newBuilderForType()`
`protected HttpBody.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static HttpBody`	`parseDelimitedFrom(java.io.InputStream input)`
`static HttpBody`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static HttpBody`	`parseFrom(byte[] data)`
`static HttpBody`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static HttpBody`	`parseFrom(java.nio.ByteBuffer data)`
`static HttpBody`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static HttpBody`	`parseFrom(com.google.protobuf.ByteString data)`
`static HttpBody`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static HttpBody`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static HttpBody`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static HttpBody`	`parseFrom(java.io.InputStream input)`
`static HttpBody`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<HttpBody>`	`parser()`
`HttpBody.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- CONTENT_TYPE_FIELD_NUMBER
```
public static final int CONTENT_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DATA_FIELD_NUMBER
```
public static final int DATA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXTENSIONS_FIELD_NUMBER
```
public static final int EXTENSIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getContentType

public java.lang.String getContentType()

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

string content_type = 1;

Specified by:: getContentType in interface HttpBodyOrBuilder

getContentTypeBytes

public com.google.protobuf.ByteString getContentTypeBytes()

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

string content_type = 1;

Specified by:: getContentTypeBytes in interface HttpBodyOrBuilder

getData

public com.google.protobuf.ByteString getData()

 The HTTP request/response body as raw binary.

bytes data = 2;

Specified by:: getData in interface HttpBodyOrBuilder