public final class Http extends GeneratedMessageV3 implements HttpOrBuilderDefines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.
Protobuf type google.api.Http
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HttpImplements
HttpOrBuilderStatic Fields
FULLY_DECODE_RESERVED_EXPANSION_FIELD_NUMBER
public static final int FULLY_DECODE_RESERVED_EXPANSION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Http getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Http |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Http.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Http.Builder |
|
newBuilder(Http prototype)
public static Http.Builder newBuilder(Http prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Http |
| Returns | |
|---|---|
| Type | Description |
Http.Builder |
|
parseDelimitedFrom(InputStream input)
public static Http parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Http |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Http parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Http parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Http |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Http parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Http parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Http |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Http parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Http parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Http |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Http parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Http parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Http |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Http parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Http parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Http |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Http parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Http> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Http> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public Http getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Http |
|
getFullyDecodeReservedExpansion()
public boolean getFullyDecodeReservedExpansion()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()
public Parser<Http> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Http> |
|
getRules(int index)
public HttpRule getRules(int index)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()
public int getRulesCount()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()
public List<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)
public HttpRuleOrBuilder getRulesOrBuilder(int index)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()
public List<? extends HttpRuleOrBuilder> 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()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Http.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Http.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Http.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Http.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public Http.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Http.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|