Class Http (2.9.1)

public final class Http extends GeneratedMessageV3 implements HttpOrBuilder

Defines 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

Implements

HttpOrBuilder

Static Fields

FULLY_DECODE_RESERVED_EXPANSION_FIELD_NUMBER

public static final int FULLY_DECODE_RESERVED_EXPANSION_FIELD_NUMBER
Field Value
TypeDescription
int

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Http getDefaultInstance()
Returns
TypeDescription
Http

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Http.Builder newBuilder()
Returns
TypeDescription
Http.Builder

newBuilder(Http prototype)

public static Http.Builder newBuilder(Http prototype)
Parameter
NameDescription
prototypeHttp
Returns
TypeDescription
Http.Builder

parseDelimitedFrom(InputStream input)

public static Http parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Http
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Http parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Http
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Http parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Http
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Http parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Http
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Http parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Http
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Http parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Http
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Http parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Http
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Http parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Http
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Http parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Http
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Http parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Http
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Http parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Http
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Http parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Http
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Http> parser()
Returns
TypeDescription
Parser<Http>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Http getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
boolean

The fullyDecodeReservedExpansion.

getParserForType()

public Parser<Http> getParserForType()
Returns
TypeDescription
Parser<Http>
Overrides

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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.api.HttpRuleOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Http.Builder newBuilderForType()
Returns
TypeDescription
Http.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Http.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Http.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Http.Builder toBuilder()
Returns
TypeDescription
Http.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException