Class Http (2.63.2)
- 2.63.2 (latest)
- 2.63.1
- 2.62.0
- 2.61.3
- 2.60.0
- 2.59.2
- 2.58.0
- 2.57.0
- 2.56.0
- 2.54.1
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.1
- 2.49.0
- 2.48.0
- 2.46.0
- 2.45.1
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.1
- 2.38.0
- 2.37.1
- 2.36.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.1
- 2.24.0
- 2.23.1
- 2.22.1
- 2.21.1
- 2.15.0
- 2.14.3
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.6
- 2.8.4
- 2.7.4
publicfinalclassHttpextendsGeneratedMessageV3implementsHttpOrBuilderDefines the HTTP configuration for an API service. It contains a list ofHttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.
Protobuf typegoogle.api.Http
Inheritance
Object >AbstractMessageLite<MessageType,BuilderType> >AbstractMessage >GeneratedMessageV3 >HttpImplements
HttpOrBuilderInherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FULLY_DECODE_RESERVED_EXPANSION_FIELD_NUMBER
publicstaticfinalintFULLY_DECODE_RESERVED_EXPANSION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
RULES_FIELD_NUMBER
publicstaticfinalintRULES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
publicstaticHttpgetDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Http | |
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
newBuilder()
publicstaticHttp.BuildernewBuilder()| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
newBuilder(Http prototype)
publicstaticHttp.BuildernewBuilder(Httpprototype)| Parameter | |
|---|---|
| Name | Description |
prototype | Http |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
parseDelimitedFrom(InputStream input)
publicstaticHttpparseDelimitedFrom(InputStreaminput)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
Http | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticHttpparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(byte[] data)
publicstaticHttpparseFrom(byte[]data)| Parameter | |
|---|---|
| Name | Description |
data | byte[] |
| Returns | |
|---|---|
| Type | Description |
Http | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticHttpparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data)
publicstaticHttpparseFrom(ByteStringdata)| Parameter | |
|---|---|
| Name | Description |
data | ByteString |
| Returns | |
|---|---|
| Type | Description |
Http | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticHttpparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(CodedInputStream input)
publicstaticHttpparseFrom(CodedInputStreaminput)| Parameter | |
|---|---|
| Name | Description |
input | CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Http | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticHttpparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input)
publicstaticHttpparseFrom(InputStreaminput)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
Http | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticHttpparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(ByteBuffer data)
publicstaticHttpparseFrom(ByteBufferdata)| Parameter | |
|---|---|
| Name | Description |
data | ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Http | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticHttpparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parser()
publicstaticParser<Http>parser()| Returns | |
|---|---|
| Type | Description |
Parser<Http> | |
Methods
equals(Object obj)
publicbooleanequals(Objectobj)| Parameter | |
|---|---|
| Name | Description |
obj | Object |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getDefaultInstanceForType()
publicHttpgetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Http | |
getFullyDecodeReservedExpansion()
publicbooleangetFullyDecodeReservedExpansion()When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded.
The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.
bool fully_decode_reserved_expansion = 2;
| Returns | |
|---|---|
| Type | Description |
boolean | The fullyDecodeReservedExpansion. |
getParserForType()
publicParser<Http>getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Http> | |
getRules(int index)
publicHttpRulegetRules(intindex)A list of HTTP configuration rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
repeated .google.api.HttpRule rules = 1;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
HttpRule | |
getRulesCount()
publicintgetRulesCount()A list of HTTP configuration rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
repeated .google.api.HttpRule rules = 1;
| Returns | |
|---|---|
| Type | Description |
int | |
getRulesList()
publicList<HttpRule>getRulesList()A list of HTTP configuration rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
repeated .google.api.HttpRule rules = 1;
| Returns | |
|---|---|
| Type | Description |
List<HttpRule> | |
getRulesOrBuilder(int index)
publicHttpRuleOrBuildergetRulesOrBuilder(intindex)A list of HTTP configuration rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
repeated .google.api.HttpRule rules = 1;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
HttpRuleOrBuilder | |
getRulesOrBuilderList()
publicList<?extendsHttpRuleOrBuilder>getRulesOrBuilderList()A list of HTTP configuration rules that apply to individual API methods.
NOTE: All service configuration rules follow "last one wins" order.
repeated .google.api.HttpRule rules = 1;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.api.HttpRuleOrBuilder> | |
getSerializedSize()
publicintgetSerializedSize()| Returns | |
|---|---|
| Type | Description |
int | |
hashCode()
publicinthashCode()| Returns | |
|---|---|
| Type | Description |
int | |
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
newBuilderForType()
publicHttp.BuildernewBuilderForType()| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedHttp.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)| Parameter | |
|---|---|
| Name | Description |
parent | BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)| Parameter | |
|---|---|
| Name | Description |
unused | UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object | |
toBuilder()
publicHttp.BuildertoBuilder()| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)| Parameter | |
|---|---|
| Name | Description |
output | CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-17 UTC.