程序包 com.google.api
类 HttpBody
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.api.HttpBody
- 所有已实现的接口:
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- 另请参阅:
- 序列化表格
-
嵌套类概要
嵌套类从类继承的嵌套类/接口 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从类继承的嵌套类/接口 com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
字段概要
字段修饰符和类型字段说明static intstatic intstatic int从类继承的字段 com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields从类继承的字段 com.google.protobuf.AbstractMessage
memoizedSize从类继承的字段 com.google.protobuf.AbstractMessageLite
memoizedHashCode -
方法概要
修饰符和类型方法说明booleanThe HTTP Content-Type header value specifying the content type of the body.com.google.protobuf.ByteStringThe HTTP Content-Type header value specifying the content type of the body.com.google.protobuf.ByteStringgetData()The HTTP request/response body as raw binary.static HttpBodystatic com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.AnygetExtensions(int index)Application specific response metadata.intApplication specific response metadata.List<com.google.protobuf.Any>Application specific response metadata.com.google.protobuf.AnyOrBuildergetExtensionsOrBuilder(int index)Application specific response metadata.List<? extends com.google.protobuf.AnyOrBuilder>Application specific response metadata.com.google.protobuf.Parser<HttpBody>intcom.google.protobuf.UnknownFieldSetinthashCode()protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablebooleanstatic HttpBody.Builderstatic HttpBody.BuildernewBuilder(HttpBody prototype)protected HttpBody.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static HttpBodyparseDelimitedFrom(InputStream input)static HttpBodyparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static HttpBodyparseFrom(byte[] data)static HttpBodyparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static HttpBodyparseFrom(com.google.protobuf.ByteString data)static HttpBodyparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static HttpBodyparseFrom(com.google.protobuf.CodedInputStream input)static HttpBodyparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static HttpBodyparseFrom(InputStream input)static HttpBodyparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static HttpBodyparseFrom(ByteBuffer data)static HttpBodyparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<HttpBody>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output)从类继承的方法 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从类继承的方法 com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString从类继承的方法 com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo从接口继承的方法 com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo从接口继承的方法 com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
-
字段详细资料
-
方法详细资料
-
newInstance
- 覆盖:
newInstance在类中com.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()- 指定者:
getUnknownFields在接口中com.google.protobuf.MessageOrBuilder- 覆盖:
getUnknownFields在类中com.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- 指定者:
internalGetFieldAccessorTable在类中com.google.protobuf.GeneratedMessageV3
-
getContentType
The HTTP Content-Type header value specifying the content type of the body.
string content_type = 1;- 指定者:
getContentType在接口中HttpBodyOrBuilder- 返回:
- 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;- 指定者:
getContentTypeBytes在接口中HttpBodyOrBuilder- 返回:
- The bytes for contentType.
-
getData
public com.google.protobuf.ByteString getData()The HTTP request/response body as raw binary.
bytes data = 2;- 指定者:
getData在接口中HttpBodyOrBuilder- 返回:
- The data.
-
getExtensionsList
Application specific response metadata. Must be set in the first response for streaming APIs.
repeated .google.protobuf.Any extensions = 3;- 指定者:
getExtensionsList在接口中HttpBodyOrBuilder
-
getExtensionsOrBuilderList
Application specific response metadata. Must be set in the first response for streaming APIs.
repeated .google.protobuf.Any extensions = 3;- 指定者:
getExtensionsOrBuilderList在接口中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;- 指定者:
getExtensionsCount在接口中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;- 指定者:
getExtensions在接口中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;- 指定者:
getExtensionsOrBuilder在接口中HttpBodyOrBuilder
-
isInitialized
public final boolean isInitialized()- 指定者:
isInitialized在接口中com.google.protobuf.MessageLiteOrBuilder- 覆盖:
isInitialized在类中com.google.protobuf.GeneratedMessageV3
-
writeTo
- 指定者:
writeTo在接口中com.google.protobuf.MessageLite- 覆盖:
writeTo在类中com.google.protobuf.GeneratedMessageV3- 抛出:
IOException
-
getSerializedSize
public int getSerializedSize()- 指定者:
getSerializedSize在接口中com.google.protobuf.MessageLite- 覆盖:
getSerializedSize在类中com.google.protobuf.GeneratedMessageV3
-
equals
- 指定者:
equals在接口中com.google.protobuf.Message- 覆盖:
equals在类中com.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- 指定者:
hashCode在接口中com.google.protobuf.Message- 覆盖:
hashCode在类中com.google.protobuf.AbstractMessage
-
parseFrom
public static HttpBody parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException- 抛出:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HttpBody parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException- 抛出:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HttpBody parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException- 抛出:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HttpBody parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException- 抛出:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HttpBody parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException- 抛出:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HttpBody parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException- 抛出:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- 抛出:
IOException
-
parseFrom
public static HttpBody parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException- 抛出:
IOException
-
parseDelimitedFrom
- 抛出:
IOException
-
parseDelimitedFrom
public static HttpBody parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException- 抛出:
IOException
-
parseFrom
- 抛出:
IOException
-
parseFrom
public static HttpBody parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException- 抛出:
IOException
-
newBuilderForType
- 指定者:
newBuilderForType在接口中com.google.protobuf.Message- 指定者:
newBuilderForType在接口中com.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- 指定者:
toBuilder在接口中com.google.protobuf.Message- 指定者:
toBuilder在接口中com.google.protobuf.MessageLite
-
newBuilderForType
protected HttpBody.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)- 指定者:
newBuilderForType在类中com.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- 指定者:
getParserForType在接口中com.google.protobuf.Message- 指定者:
getParserForType在接口中com.google.protobuf.MessageLite- 覆盖:
getParserForType在类中com.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- 指定者:
getDefaultInstanceForType在接口中com.google.protobuf.MessageLiteOrBuilder- 指定者:
getDefaultInstanceForType在接口中com.google.protobuf.MessageOrBuilder
-