HttpBody.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>
    - - com.google.api.HttpBody.Builder

All Implemented Interfaces:: HttpBodyOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:: HttpBody

public static final class HttpBody.Builder
extends GeneratedMessageV3.Builder<HttpBody.Builder>
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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpBody.Builder`	`addAllExtensions(java.lang.Iterable<? extends Any> values)` Application specific response metadata.
`HttpBody.Builder`	`addExtensions(Any.Builder builderForValue)` Application specific response metadata.
`HttpBody.Builder`	`addExtensions(Any value)` Application specific response metadata.
`HttpBody.Builder`	`addExtensions(int index, Any.Builder builderForValue)` Application specific response metadata.
`HttpBody.Builder`	`addExtensions(int index, Any value)` Application specific response metadata.
`Any.Builder`	`addExtensionsBuilder()` Application specific response metadata.
`Any.Builder`	`addExtensionsBuilder(int index)` Application specific response metadata.
`HttpBody.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`HttpBody`	`build()`
`HttpBody`	`buildPartial()`
`HttpBody.Builder`	`clear()`
`HttpBody.Builder`	`clearContentType()` The HTTP Content-Type header value specifying the content type of the body.
`HttpBody.Builder`	`clearData()` The HTTP request/response body as raw binary.
`HttpBody.Builder`	`clearExtensions()` Application specific response metadata.
`HttpBody.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`HttpBody.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`HttpBody.Builder`	`clone()`
`java.lang.String`	`getContentType()` The HTTP Content-Type header value specifying the content type of the body.
`ByteString`	`getContentTypeBytes()` The HTTP Content-Type header value specifying the content type of the body.
`ByteString`	`getData()` The HTTP request/response body as raw binary.
`HttpBody`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`Any`	`getExtensions(int index)` Application specific response metadata.
`Any.Builder`	`getExtensionsBuilder(int index)` Application specific response metadata.
`java.util.List<Any.Builder>`	`getExtensionsBuilderList()` Application specific response metadata.
`int`	`getExtensionsCount()` Application specific response metadata.
`java.util.List<Any>`	`getExtensionsList()` Application specific response metadata.
`AnyOrBuilder`	`getExtensionsOrBuilder(int index)` Application specific response metadata.
`java.util.List<? extends AnyOrBuilder>`	`getExtensionsOrBuilderList()` Application specific response metadata.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`HttpBody.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`HttpBody.Builder`	`mergeFrom(HttpBody other)`
`HttpBody.Builder`	`mergeFrom(Message other)`
`HttpBody.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`HttpBody.Builder`	`removeExtensions(int index)` Application specific response metadata.
`HttpBody.Builder`	`setContentType(java.lang.String value)` The HTTP Content-Type header value specifying the content type of the body.
`HttpBody.Builder`	`setContentTypeBytes(ByteString value)` The HTTP Content-Type header value specifying the content type of the body.
`HttpBody.Builder`	`setData(ByteString value)` The HTTP request/response body as raw binary.
`HttpBody.Builder`	`setExtensions(int index, Any.Builder builderForValue)` Application specific response metadata.
`HttpBody.Builder`	`setExtensions(int index, Any value)` Application specific response metadata.
`HttpBody.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`HttpBody.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`HttpBody.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

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

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<HttpBody.Builder>

clear
```
public HttpBody.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<HttpBody.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<HttpBody.Builder>

getDefaultInstanceForType
```
public HttpBody getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public HttpBody build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public HttpBody buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public HttpBody.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<HttpBody.Builder>

setField

public HttpBody.Builder setField(Descriptors.FieldDescriptor field,
                                 java.lang.Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<HttpBody.Builder>

clearField
```
public HttpBody.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<HttpBody.Builder>

clearOneof
```
public HttpBody.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<HttpBody.Builder>

setRepeatedField

public HttpBody.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                         int index,
                                         java.lang.Object value)

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<HttpBody.Builder>

addRepeatedField

public HttpBody.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                         java.lang.Object value)

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<HttpBody.Builder>

mergeFrom
```
public HttpBody.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<HttpBody.Builder>

mergeFrom

public HttpBody.Builder mergeFrom(HttpBody other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<HttpBody.Builder>

mergeFrom

public HttpBody.Builder mergeFrom(CodedInputStream input,
                                  ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<HttpBody.Builder>
Throws:: java.io.IOException

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 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

setContentType

public HttpBody.Builder setContentType(java.lang.String value)

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

string content_type = 1;

clearContentType

public HttpBody.Builder clearContentType()

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

string content_type = 1;

setContentTypeBytes

public HttpBody.Builder setContentTypeBytes(ByteString value)

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

string content_type = 1;

getData

public ByteString getData()

 The HTTP request/response body as raw binary.

bytes data = 2;

Specified by:: getData in interface HttpBodyOrBuilder

setData

public HttpBody.Builder setData(ByteString value)

 The HTTP request/response body as raw binary.

bytes data = 2;

clearData

public HttpBody.Builder clearData()

 The HTTP request/response body as raw binary.

bytes data = 2;