Class Http.Builder (2.9.1)

public static final class Http.Builder extends GeneratedMessageV3.Builder<Http.Builder> 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 Methods

getDescriptor()

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

Methods

addAllRules(Iterable<? extends HttpRule> values)

public Http.Builder addAllRules(Iterable<? extends HttpRule> values)

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
valuesIterable<? extends com.google.api.HttpRule>
Returns
TypeDescription
Http.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Http.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Http.Builder
Overrides

addRules(HttpRule value)

public Http.Builder addRules(HttpRule value)

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
valueHttpRule
Returns
TypeDescription
Http.Builder

addRules(HttpRule.Builder builderForValue)

public Http.Builder addRules(HttpRule.Builder builderForValue)

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
builderForValueHttpRule.Builder
Returns
TypeDescription
Http.Builder

addRules(int index, HttpRule value)

public Http.Builder addRules(int index, HttpRule value)

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;

Parameters
NameDescription
indexint
valueHttpRule
Returns
TypeDescription
Http.Builder

addRules(int index, HttpRule.Builder builderForValue)

public Http.Builder addRules(int index, HttpRule.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueHttpRule.Builder
Returns
TypeDescription
Http.Builder

addRulesBuilder()

public HttpRule.Builder addRulesBuilder()

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
HttpRule.Builder

addRulesBuilder(int index)

public HttpRule.Builder addRulesBuilder(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.Builder

build()

public Http build()
Returns
TypeDescription
Http

buildPartial()

public Http buildPartial()
Returns
TypeDescription
Http

clear()

public Http.Builder clear()
Returns
TypeDescription
Http.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Http.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Http.Builder
Overrides

clearFullyDecodeReservedExpansion()

public Http.Builder clearFullyDecodeReservedExpansion()

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
Http.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Http.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Http.Builder
Overrides

clearRules()

public Http.Builder clearRules()

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
Http.Builder

clone()

public Http.Builder clone()
Returns
TypeDescription
Http.Builder
Overrides

getDefaultInstanceForType()

public Http getDefaultInstanceForType()
Returns
TypeDescription
Http

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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

getRulesBuilder(int index)

public HttpRule.Builder getRulesBuilder(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.Builder

getRulesBuilderList()

public List<HttpRule.Builder> getRulesBuilderList()

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<Builder>

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>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Http other)

public Http.Builder mergeFrom(Http other)
Parameter
NameDescription
otherHttp
Returns
TypeDescription
Http.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Http.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Http.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Http.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Http.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Http.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Http.Builder
Overrides

removeRules(int index)

public Http.Builder removeRules(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
Http.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Http.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Http.Builder
Overrides

setFullyDecodeReservedExpansion(boolean value)

public Http.Builder setFullyDecodeReservedExpansion(boolean value)

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;

Parameter
NameDescription
valueboolean

The fullyDecodeReservedExpansion to set.

Returns
TypeDescription
Http.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Http.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Http.Builder
Overrides

setRules(int index, HttpRule value)

public Http.Builder setRules(int index, HttpRule value)

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;

Parameters
NameDescription
indexint
valueHttpRule
Returns
TypeDescription
Http.Builder

setRules(int index, HttpRule.Builder builderForValue)

public Http.Builder setRules(int index, HttpRule.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueHttpRule.Builder
Returns
TypeDescription
Http.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Http.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Http.Builder
Overrides