Class ScopedRouteConfiguration.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<ScopedRouteConfiguration.Builder>
com.google.protobuf.GeneratedMessage.Builder<ScopedRouteConfiguration.Builder>
io.envoyproxy.envoy.config.route.v3.ScopedRouteConfiguration.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,ScopedRouteConfigurationOrBuilder
,Cloneable
- Enclosing class:
ScopedRouteConfiguration
public static final class ScopedRouteConfiguration.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ScopedRouteConfiguration.Builder>
implements ScopedRouteConfigurationOrBuilder
Specifies a routing scope, which associates a :ref:`Key<envoy_v3_api_msg_config.route.v3.ScopedRouteConfiguration.Key>` to a :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` can be obtained dynamically via RDS (:ref:`route_configuration_name<envoy_v3_api_field_config.route.v3.ScopedRouteConfiguration.route_configuration_name>`) or specified inline (:ref:`route_configuration<envoy_v3_api_field_config.route.v3.ScopedRouteConfiguration.route_configuration>`). The HTTP connection manager builds up a table consisting of these Key to RouteConfiguration mappings, and looks up the RouteConfiguration to use per request according to the algorithm specified in the :ref:`scope_key_builder<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.ScopedRoutes.scope_key_builder>` assigned to the HttpConnectionManager. For example, with the following configurations (in YAML): HttpConnectionManager config: .. code:: ... scoped_routes: name: foo-scoped-routes scope_key_builder: fragments: - header_value_extractor: name: X-Route-Selector element_separator: "," element: separator: = key: vip ScopedRouteConfiguration resources (specified statically via :ref:`scoped_route_configurations_list<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.ScopedRoutes.scoped_route_configurations_list>` or obtained dynamically via SRDS): .. code:: (1) name: route-scope1 route_configuration_name: route-config1 key: fragments: - string_key: 172.10.10.20 (2) name: route-scope2 route_configuration_name: route-config2 key: fragments: - string_key: 172.20.20.30 A request from a client such as: .. code:: GET / HTTP/1.1 Host: foo.com X-Route-Selector: vip=172.10.10.20 would result in the routing table defined by the ``route-config1`` RouteConfiguration being assigned to the HTTP request/stream. [#next-free-field: 6]Protobuf type
envoy.config.route.v3.ScopedRouteConfiguration
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private ScopedRouteConfiguration.Key
private com.google.protobuf.SingleFieldBuilder
<ScopedRouteConfiguration.Key, ScopedRouteConfiguration.Key.Builder, ScopedRouteConfiguration.KeyOrBuilder> private Object
private boolean
private RouteConfiguration
private com.google.protobuf.SingleFieldBuilder
<RouteConfiguration, RouteConfiguration.Builder, RouteConfigurationOrBuilder> private Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
private void
clear()
clearKey()
The key to match against.The name assigned to the routing scope.Whether the RouteConfiguration should be loaded on demand.The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.The resource name to use for a :ref:`envoy_v3_api_msg_service.discovery.v3.DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with this scope.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
getKey()
The key to match against.The key to match against.private com.google.protobuf.SingleFieldBuilder
<ScopedRouteConfiguration.Key, ScopedRouteConfiguration.Key.Builder, ScopedRouteConfiguration.KeyOrBuilder> The key to match against.The key to match against.getName()
The name assigned to the routing scope.com.google.protobuf.ByteString
The name assigned to the routing scope.boolean
Whether the RouteConfiguration should be loaded on demand.The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.private com.google.protobuf.SingleFieldBuilder
<RouteConfiguration, RouteConfiguration.Builder, RouteConfigurationOrBuilder> The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.The resource name to use for a :ref:`envoy_v3_api_msg_service.discovery.v3.DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with this scope.com.google.protobuf.ByteString
The resource name to use for a :ref:`envoy_v3_api_msg_service.discovery.v3.DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with this scope.The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.boolean
hasKey()
The key to match against.boolean
The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
private void
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) The key to match against.The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.The key to match against.setKey
(ScopedRouteConfiguration.Key.Builder builderForValue) The key to match against.The name assigned to the routing scope.setNameBytes
(com.google.protobuf.ByteString value) The name assigned to the routing scope.setOnDemand
(boolean value) Whether the RouteConfiguration should be loaded on demand.The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.setRouteConfiguration
(RouteConfiguration.Builder builderForValue) The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.setRouteConfigurationName
(String value) The resource name to use for a :ref:`envoy_v3_api_msg_service.discovery.v3.DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with this scope.setRouteConfigurationNameBytes
(com.google.protobuf.ByteString value) The resource name to use for a :ref:`envoy_v3_api_msg_service.discovery.v3.DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with this scope.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
bitField0_
private int bitField0_ -
onDemand_
private boolean onDemand_ -
name_
-
routeConfigurationName_
-
routeConfiguration_
-
routeConfigurationBuilder_
private com.google.protobuf.SingleFieldBuilder<RouteConfiguration,RouteConfiguration.Builder, routeConfigurationBuilder_RouteConfigurationOrBuilder> -
key_
-
keyBuilder_
private com.google.protobuf.SingleFieldBuilder<ScopedRouteConfiguration.Key,ScopedRouteConfiguration.Key.Builder, keyBuilder_ScopedRouteConfiguration.KeyOrBuilder>
-
-
Constructor Details
-
Builder
private Builder() -
Builder
private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage.Builder<ScopedRouteConfiguration.Builder>
-
maybeForceBuilderInitialization
private void maybeForceBuilderInitialization() -
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.GeneratedMessage.Builder<ScopedRouteConfiguration.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<ScopedRouteConfiguration.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial0
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<ScopedRouteConfiguration.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<ScopedRouteConfiguration.Builder>
-
mergeFrom
public ScopedRouteConfiguration.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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<ScopedRouteConfiguration.Builder>
- Throws:
IOException
-
getOnDemand
public boolean getOnDemand()Whether the RouteConfiguration should be loaded on demand.
bool on_demand = 4;
- Specified by:
getOnDemand
in interfaceScopedRouteConfigurationOrBuilder
- Returns:
- The onDemand.
-
setOnDemand
Whether the RouteConfiguration should be loaded on demand.
bool on_demand = 4;
- Parameters:
value
- The onDemand to set.- Returns:
- This builder for chaining.
-
clearOnDemand
Whether the RouteConfiguration should be loaded on demand.
bool on_demand = 4;
- Returns:
- This builder for chaining.
-
getName
The name assigned to the routing scope.
string name = 1 [(.validate.rules) = { ... }
- Specified by:
getName
in interfaceScopedRouteConfigurationOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()The name assigned to the routing scope.
string name = 1 [(.validate.rules) = { ... }
- Specified by:
getNameBytes
in interfaceScopedRouteConfigurationOrBuilder
- Returns:
- The bytes for name.
-
setName
The name assigned to the routing scope.
string name = 1 [(.validate.rules) = { ... }
- Parameters:
value
- The name to set.- Returns:
- This builder for chaining.
-
clearName
The name assigned to the routing scope.
string name = 1 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
setNameBytes
The name assigned to the routing scope.
string name = 1 [(.validate.rules) = { ... }
- Parameters:
value
- The bytes for name to set.- Returns:
- This builder for chaining.
-
getRouteConfigurationName
The resource name to use for a :ref:`envoy_v3_api_msg_service.discovery.v3.DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with this scope.
string route_configuration_name = 2 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
getRouteConfigurationName
in interfaceScopedRouteConfigurationOrBuilder
- Returns:
- The routeConfigurationName.
-
getRouteConfigurationNameBytes
public com.google.protobuf.ByteString getRouteConfigurationNameBytes()The resource name to use for a :ref:`envoy_v3_api_msg_service.discovery.v3.DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with this scope.
string route_configuration_name = 2 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
getRouteConfigurationNameBytes
in interfaceScopedRouteConfigurationOrBuilder
- Returns:
- The bytes for routeConfigurationName.
-
setRouteConfigurationName
The resource name to use for a :ref:`envoy_v3_api_msg_service.discovery.v3.DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with this scope.
string route_configuration_name = 2 [(.udpa.annotations.field_migrate) = { ... }
- Parameters:
value
- The routeConfigurationName to set.- Returns:
- This builder for chaining.
-
clearRouteConfigurationName
The resource name to use for a :ref:`envoy_v3_api_msg_service.discovery.v3.DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with this scope.
string route_configuration_name = 2 [(.udpa.annotations.field_migrate) = { ... }
- Returns:
- This builder for chaining.
-
setRouteConfigurationNameBytes
public ScopedRouteConfiguration.Builder setRouteConfigurationNameBytes(com.google.protobuf.ByteString value) The resource name to use for a :ref:`envoy_v3_api_msg_service.discovery.v3.DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with this scope.
string route_configuration_name = 2 [(.udpa.annotations.field_migrate) = { ... }
- Parameters:
value
- The bytes for routeConfigurationName to set.- Returns:
- This builder for chaining.
-
hasRouteConfiguration
public boolean hasRouteConfiguration()The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.
.envoy.config.route.v3.RouteConfiguration route_configuration = 5 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
hasRouteConfiguration
in interfaceScopedRouteConfigurationOrBuilder
- Returns:
- Whether the routeConfiguration field is set.
-
getRouteConfiguration
The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.
.envoy.config.route.v3.RouteConfiguration route_configuration = 5 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
getRouteConfiguration
in interfaceScopedRouteConfigurationOrBuilder
- Returns:
- The routeConfiguration.
-
setRouteConfiguration
The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.
.envoy.config.route.v3.RouteConfiguration route_configuration = 5 [(.udpa.annotations.field_migrate) = { ... }
-
setRouteConfiguration
public ScopedRouteConfiguration.Builder setRouteConfiguration(RouteConfiguration.Builder builderForValue) The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.
.envoy.config.route.v3.RouteConfiguration route_configuration = 5 [(.udpa.annotations.field_migrate) = { ... }
-
mergeRouteConfiguration
The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.
.envoy.config.route.v3.RouteConfiguration route_configuration = 5 [(.udpa.annotations.field_migrate) = { ... }
-
clearRouteConfiguration
The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.
.envoy.config.route.v3.RouteConfiguration route_configuration = 5 [(.udpa.annotations.field_migrate) = { ... }
-
getRouteConfigurationBuilder
The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.
.envoy.config.route.v3.RouteConfiguration route_configuration = 5 [(.udpa.annotations.field_migrate) = { ... }
-
getRouteConfigurationOrBuilder
The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.
.envoy.config.route.v3.RouteConfiguration route_configuration = 5 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
getRouteConfigurationOrBuilder
in interfaceScopedRouteConfigurationOrBuilder
-
getRouteConfigurationFieldBuilder
private com.google.protobuf.SingleFieldBuilder<RouteConfiguration,RouteConfiguration.Builder, getRouteConfigurationFieldBuilder()RouteConfigurationOrBuilder> The :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` associated with the scope.
.envoy.config.route.v3.RouteConfiguration route_configuration = 5 [(.udpa.annotations.field_migrate) = { ... }
-
hasKey
public boolean hasKey()The key to match against.
.envoy.config.route.v3.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
- Specified by:
hasKey
in interfaceScopedRouteConfigurationOrBuilder
- Returns:
- Whether the key field is set.
-
getKey
The key to match against.
.envoy.config.route.v3.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
- Specified by:
getKey
in interfaceScopedRouteConfigurationOrBuilder
- Returns:
- The key.
-
setKey
The key to match against.
.envoy.config.route.v3.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
-
setKey
public ScopedRouteConfiguration.Builder setKey(ScopedRouteConfiguration.Key.Builder builderForValue) The key to match against.
.envoy.config.route.v3.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
-
mergeKey
The key to match against.
.envoy.config.route.v3.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
-
clearKey
The key to match against.
.envoy.config.route.v3.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
-
getKeyBuilder
The key to match against.
.envoy.config.route.v3.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
-
getKeyOrBuilder
The key to match against.
.envoy.config.route.v3.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
- Specified by:
getKeyOrBuilder
in interfaceScopedRouteConfigurationOrBuilder
-
getKeyFieldBuilder
private com.google.protobuf.SingleFieldBuilder<ScopedRouteConfiguration.Key,ScopedRouteConfiguration.Key.Builder, getKeyFieldBuilder()ScopedRouteConfiguration.KeyOrBuilder> The key to match against.
.envoy.config.route.v3.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
-