com.google.api

Class HttpBody.Builder

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, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable

Enclosing class:

HttpBody

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

Modifier and Type	Method and Description
HttpBody.Builder	addAllExtensions(java.lang.Iterable<? extends com.google.protobuf.Any> values) Application specific response metadata.
HttpBody.Builder	addExtensions(com.google.protobuf.Any.Builder builderForValue) Application specific response metadata.
HttpBody.Builder	addExtensions(com.google.protobuf.Any value) Application specific response metadata.
HttpBody.Builder	addExtensions(int index, com.google.protobuf.Any.Builder builderForValue) Application specific response metadata.
HttpBody.Builder	addExtensions(int index, com.google.protobuf.Any value) Application specific response metadata.
com.google.protobuf.Any.Builder	addExtensionsBuilder() Application specific response metadata.
com.google.protobuf.Any.Builder	addExtensionsBuilder(int index) Application specific response metadata.
HttpBody.Builder	addRepeatedField(com.google.protobuf.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(com.google.protobuf.Descriptors.FieldDescriptor field)
HttpBody.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
HttpBody.Builder	clone()
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.
HttpBody	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.Any	getExtensions(int index) Application specific response metadata.
com.google.protobuf.Any.Builder	getExtensionsBuilder(int index) Application specific response metadata.
java.util.List<com.google.protobuf.Any.Builder>	getExtensionsBuilderList() 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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
HttpBody.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
HttpBody.Builder	mergeFrom(HttpBody other)
HttpBody.Builder	mergeFrom(com.google.protobuf.Message other)
HttpBody.Builder	mergeUnknownFields(com.google.protobuf.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(com.google.protobuf.ByteString value) The HTTP Content-Type header value specifying the content type of the body.
HttpBody.Builder	setData(com.google.protobuf.ByteString value) The HTTP request/response body as raw binary.
HttpBody.Builder	setExtensions(int index, com.google.protobuf.Any.Builder builderForValue) Application specific response metadata.
HttpBody.Builder	setExtensions(int index, com.google.protobuf.Any value) Application specific response metadata.
HttpBody.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
HttpBody.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
HttpBody.Builder	setUnknownFields(com.google.protobuf.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 com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>

clear

public HttpBody.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>

getDefaultInstanceForType

public HttpBody getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public HttpBody build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public HttpBody buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public HttpBody.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>

clearField

public HttpBody.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>

clearOneof

public HttpBody.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>

mergeFrom

public HttpBody.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HttpBody.Builder>

mergeFrom

public HttpBody.Builder mergeFrom(HttpBody other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.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 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

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(com.google.protobuf.ByteString value)

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

string content_type = 1;

getData

public com.google.protobuf.ByteString getData()

 The HTTP request/response body as raw binary.
 

bytes data = 2;

Specified by:

getData in interface HttpBodyOrBuilder

setData

public HttpBody.Builder setData(com.google.protobuf.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;

getExtensionsList

public java.util.List<com.google.protobuf.Any> getExtensionsList()

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

repeated .google.protobuf.Any extensions = 3;

Specified by:

getExtensionsList in interface HttpBodyOrBuilder

getExtensionsCount

public int getExtensionsCount()

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

repeated .google.protobuf.Any extensions = 3;

Specified by:

getExtensionsCount in interface HttpBodyOrBuilder

getExtensions

public com.google.protobuf.Any getExtensions(int index)

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

repeated .google.protobuf.Any extensions = 3;

Specified by:

getExtensions in interface HttpBodyOrBuilder

setExtensions

public HttpBody.Builder setExtensions(int index,
                                      com.google.protobuf.Any value)

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

repeated .google.protobuf.Any extensions = 3;

setExtensions

public HttpBody.Builder setExtensions(int index,
                                      com.google.protobuf.Any.Builder builderForValue)

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

repeated .google.protobuf.Any extensions = 3;

addExtensions

public HttpBody.Builder addExtensions(com.google.protobuf.Any value)

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

repeated .google.protobuf.Any extensions = 3;

addExtensions

public HttpBody.Builder addExtensions(int index,
                                      com.google.protobuf.Any value)

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

repeated .google.protobuf.Any extensions = 3;

addExtensions

public HttpBody.Builder addExtensions(com.google.protobuf.Any.Builder builderForValue)

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

repeated .google.protobuf.Any extensions = 3;

addExtensions

public HttpBody.Builder addExtensions(int index,
                                      com.google.protobuf.Any.Builder builderForValue)

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

repeated .google.protobuf.Any extensions = 3;

addAllExtensions

public HttpBody.Builder addAllExtensions(java.lang.Iterable<? extends com.google.protobuf.Any> values)

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

repeated .google.protobuf.Any extensions = 3;

clearExtensions

public HttpBody.Builder clearExtensions()

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

repeated .google.protobuf.Any extensions = 3;

removeExtensions

public HttpBody.Builder removeExtensions(int index)

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

repeated .google.protobuf.Any extensions = 3;

getExtensionsBuilder

public com.google.protobuf.Any.Builder getExtensionsBuilder(int index)

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

repeated .google.protobuf.Any extensions = 3;

getExtensionsOrBuilder

public com.google.protobuf.AnyOrBuilder getExtensionsOrBuilder(int index)

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

repeated .google.protobuf.Any extensions = 3;

Specified by:

getExtensionsOrBuilder in interface HttpBodyOrBuilder

getExtensionsOrBuilderList

public java.util.List<? extends com.google.protobuf.AnyOrBuilder> getExtensionsOrBuilderList()

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

repeated .google.protobuf.Any extensions = 3;

Specified by:

getExtensionsOrBuilderList in interface HttpBodyOrBuilder

addExtensionsBuilder

public com.google.protobuf.Any.Builder addExtensionsBuilder()

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

repeated .google.protobuf.Any extensions = 3;

addExtensionsBuilder

public com.google.protobuf.Any.Builder addExtensionsBuilder(int index)

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

repeated .google.protobuf.Any extensions = 3;

getExtensionsBuilderList

public java.util.List<com.google.protobuf.Any.Builder> getExtensionsBuilderList()

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

repeated .google.protobuf.Any extensions = 3;

setUnknownFields

public final HttpBody.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>

mergeUnknownFields

public final HttpBody.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HttpBody.Builder>