public static final class Http.Builder extends GeneratedMessageV3.Builder<Http.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Http.BuilderImplements
HttpOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.api.HttpRule> |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Http.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
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 | |
|---|---|
| Name | Description |
value | HttpRule |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | HttpRule.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
value | HttpRule |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
builderForValue | HttpRule.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
HttpRule.Builder | |
build()
public Http build()| Returns | |
|---|---|
| Type | Description |
Http | |
buildPartial()
public Http buildPartial()| Returns | |
|---|---|
| Type | Description |
Http | |
clear()
public Http.Builder clear()| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
clearField(Descriptors.FieldDescriptor field)
public Http.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
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 | |
|---|---|
| Type | Description |
Http.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Http.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
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 | |
|---|---|
| Type | Description |
Http.Builder | |
clone()
public Http.Builder clone()| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
getDefaultInstanceForType()
public Http getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Http | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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> | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(Http other)
public Http.Builder mergeFrom(Http other)| Parameter | |
|---|---|
| Name | Description |
other | Http |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Http.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Http.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Http.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public Http.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
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 | booleanThe fullyDecodeReservedExpansion to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
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 | |
|---|---|
| Name | Description |
index | int |
value | HttpRule |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
builderForValue | HttpRule.Builder |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Http.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Http.Builder | |