Package com.google.api
Class Http.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<Http.Builder>
-
- com.google.api.Http.Builder
-
- All Implemented Interfaces:
HttpOrBuilder
,com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.lang.Cloneable
- Enclosing class:
- Http
public static final class Http.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Http.Builder> implements HttpOrBuilder
Defines the HTTP configuration for an API service. It contains a list of [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method to one or more HTTP REST API methods.
Protobuf typegoogle.api.Http
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Http.Builder
addAllRules(java.lang.Iterable<? extends HttpRule> values)
A list of HTTP configuration rules that apply to individual API methods.Http.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Http.Builder
addRules(int index, HttpRule value)
A list of HTTP configuration rules that apply to individual API methods.Http.Builder
addRules(int index, HttpRule.Builder builderForValue)
A list of HTTP configuration rules that apply to individual API methods.Http.Builder
addRules(HttpRule value)
A list of HTTP configuration rules that apply to individual API methods.Http.Builder
addRules(HttpRule.Builder builderForValue)
A list of HTTP configuration rules that apply to individual API methods.HttpRule.Builder
addRulesBuilder()
A list of HTTP configuration rules that apply to individual API methods.HttpRule.Builder
addRulesBuilder(int index)
A list of HTTP configuration rules that apply to individual API methods.Http
build()
Http
buildPartial()
Http.Builder
clear()
Http.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
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.Http.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Http.Builder
clearRules()
A list of HTTP configuration rules that apply to individual API methods.Http.Builder
clone()
Http
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
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.HttpRule
getRules(int index)
A list of HTTP configuration rules that apply to individual API methods.HttpRule.Builder
getRulesBuilder(int index)
A list of HTTP configuration rules that apply to individual API methods.java.util.List<HttpRule.Builder>
getRulesBuilderList()
A list of HTTP configuration rules that apply to individual API methods.int
getRulesCount()
A list of HTTP configuration rules that apply to individual API methods.java.util.List<HttpRule>
getRulesList()
A list of HTTP configuration rules that apply to individual API methods.HttpRuleOrBuilder
getRulesOrBuilder(int index)
A list of HTTP configuration rules that apply to individual API methods.java.util.List<? extends HttpRuleOrBuilder>
getRulesOrBuilderList()
A list of HTTP configuration rules that apply to individual API methods.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
Http.Builder
mergeFrom(Http other)
Http.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Http.Builder
mergeFrom(com.google.protobuf.Message other)
Http.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Http.Builder
removeRules(int index)
A list of HTTP configuration rules that apply to individual API methods.Http.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
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.Http.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Http.Builder
setRules(int index, HttpRule value)
A list of HTTP configuration rules that apply to individual API methods.Http.Builder
setRules(int index, HttpRule.Builder builderForValue)
A list of HTTP configuration rules that apply to individual API methods.Http.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
-
Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableBuilder
addExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtensionCount, getField, getFieldBuilder, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, hasExtension, hasField, mergeExtensionFields, newBuilderForField, parseUnknownField, setExtension, setExtension
-
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
getOneofFieldDescriptor, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Overrides:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<Http.Builder>
-
clear
public Http.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<Http.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<Http.Builder>
-
getDefaultInstanceForType
public Http getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public Http build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public Http buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public Http.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<Http.Builder>
-
setField
public Http.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Http.Builder>
-
clearField
public Http.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Http.Builder>
-
clearOneof
public Http.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<Http.Builder>
-
setRepeatedField
public Http.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Http.Builder>
-
addRepeatedField
public Http.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Http.Builder>
-
mergeFrom
public Http.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Http.Builder>
-
mergeFrom
public Http.Builder mergeFrom(Http other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,Http.Builder>
-
mergeFrom
public Http.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Http.Builder>
- Throws:
java.io.IOException
-
getRulesList
public java.util.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;
- Specified by:
getRulesList
in interfaceHttpOrBuilder
-
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;
- Specified by:
getRulesCount
in interfaceHttpOrBuilder
-
getRules
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;
- Specified by:
getRules
in interfaceHttpOrBuilder
-
setRules
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;
-
setRules
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;
-
addRules
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;
-
addRules
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;
-
addRules
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;
-
addRules
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;
-
addAllRules
public Http.Builder addAllRules(java.lang.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;
-
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;
-
removeRules
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;
-
getRulesBuilder
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;
-
getRulesOrBuilder
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;
- Specified by:
getRulesOrBuilder
in interfaceHttpOrBuilder
-
getRulesOrBuilderList
public java.util.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;
- Specified by:
getRulesOrBuilderList
in interfaceHttpOrBuilder
-
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;
-
addRulesBuilder
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;
-
getRulesBuilderList
public java.util.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;
-
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;
- Specified by:
getFullyDecodeReservedExpansion
in interfaceHttpOrBuilder
- Returns:
- The fullyDecodeReservedExpansion.
-
setFullyDecodeReservedExpansion
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;
- Parameters:
value
- The fullyDecodeReservedExpansion to set.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
setUnknownFields
public final Http.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Http.Builder>
-
mergeUnknownFields
public final Http.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Http.Builder>
-
-