Package com.google.api

Class HttpBody

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONTENT_TYPE_FIELD_NUMBER
     
    static final int
    DATA_FIELD_NUMBER
     
    static final 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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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 final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Any
    getExtensions(int index)
    Application specific response metadata.
    int
    getExtensionsCount()
    Application specific response metadata.
    List<com.google.protobuf.Any>
    getExtensionsList()
    Application specific response metadata.
    com.google.protobuf.AnyOrBuilder
    getExtensionsOrBuilder(int index)
    Application specific response metadata.
    List<? extends com.google.protobuf.AnyOrBuilder>
    getExtensionsOrBuilderList()
    Application specific response metadata.
    com.google.protobuf.Parser<HttpBody>
    getParserForType()
     
    int
    getSerializedSize()
     
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final 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)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static HttpBody
    parseDelimitedFrom(InputStream input)
     
    static HttpBody
    parseDelimitedFrom(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(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(InputStream input)
     
    static HttpBody
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpBody
    parseFrom(ByteBuffer data)
     
    static HttpBody
    parseFrom(ByteBuffer data, 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, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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 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
      Returns:
      The contentType.

    • 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
      Returns:
      The bytes for contentType.

    • getData

      public com.google.protobuf.ByteString getData()
       The HTTP request/response body as raw binary.
      bytes data = 2;
      Specified by:
      getData in interface HttpBodyOrBuilder
      Returns:
      The data.

    • getExtensionsList

      public 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

    • getExtensionsOrBuilderList

      public 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

    • 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

    • 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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static HttpBody parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HttpBody parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HttpBody parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HttpBody parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HttpBody parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HttpBody parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HttpBody parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HttpBody parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HttpBody parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HttpBody parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HttpBody parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HttpBody parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public HttpBody.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static HttpBody.Builder newBuilder()

    • newBuilder

      public static HttpBody.Builder newBuilder(HttpBody prototype)

    • toBuilder

      public HttpBody.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected HttpBody.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static HttpBody getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<HttpBody> parser()

    • getParserForType

      public com.google.protobuf.Parser<HttpBody> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public HttpBody getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder