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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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
Name | Description |
values | Iterable<? extends com.google.api.HttpRule>
|
Returns
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Http.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
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
Returns
build()
Returns
buildPartial()
public Http buildPartial()
Returns
clear()
public Http.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public Http.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
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
clearOneof(Descriptors.OneofDescriptor oneof)
public Http.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
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
clone()
public Http.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public Http getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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
Type | Description |
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
Returns
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
Returns
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
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
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
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
Returns
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> | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Http other)
public Http.Builder mergeFrom(Http other)
Parameter
Returns
public Http.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Http.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Http.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public Http.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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
Name | Description |
value | boolean
The fullyDecodeReservedExpansion to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Http.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
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
Returns
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
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final Http.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides