Class ScopedRouteConfiguration
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.route.v3.ScopedRouteConfiguration
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,ScopedRouteConfigurationOrBuilder
,Serializable
public final class ScopedRouteConfiguration
extends com.google.protobuf.GeneratedMessage
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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
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`.static final class
Specifies a key which is matched against the output of the :ref:`scope_key_builder<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.ScopedRoutes.scope_key_builder>` specified in the HttpConnectionManager.static interface
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private static final ScopedRouteConfiguration
private ScopedRouteConfiguration.Key
static final int
private byte
private Object
static final int
static final int
private boolean
private static final com.google.protobuf.Parser
<ScopedRouteConfiguration> static final int
static final int
private RouteConfiguration
private Object
private static final long
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
ScopedRouteConfiguration
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static ScopedRouteConfiguration
static final com.google.protobuf.Descriptors.Descriptor
getKey()
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.com.google.protobuf.Parser
<ScopedRouteConfiguration> 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.int
int
hashCode()
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
newBuilder
(ScopedRouteConfiguration prototype) protected ScopedRouteConfiguration.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static ScopedRouteConfiguration
parseDelimitedFrom
(InputStream input) static ScopedRouteConfiguration
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ScopedRouteConfiguration
parseFrom
(byte[] data) static ScopedRouteConfiguration
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ScopedRouteConfiguration
parseFrom
(com.google.protobuf.ByteString data) static ScopedRouteConfiguration
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ScopedRouteConfiguration
parseFrom
(com.google.protobuf.CodedInputStream input) static ScopedRouteConfiguration
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ScopedRouteConfiguration
parseFrom
(InputStream input) static ScopedRouteConfiguration
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ScopedRouteConfiguration
parseFrom
(ByteBuffer data) static ScopedRouteConfiguration
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<ScopedRouteConfiguration> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
ON_DEMAND_FIELD_NUMBER
public static final int ON_DEMAND_FIELD_NUMBER- See Also:
-
onDemand_
private boolean onDemand_ -
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
name_
-
ROUTE_CONFIGURATION_NAME_FIELD_NUMBER
public static final int ROUTE_CONFIGURATION_NAME_FIELD_NUMBER- See Also:
-
routeConfigurationName_
-
ROUTE_CONFIGURATION_FIELD_NUMBER
public static final int ROUTE_CONFIGURATION_FIELD_NUMBER- See Also:
-
routeConfiguration_
-
KEY_FIELD_NUMBER
public static final int KEY_FIELD_NUMBER- See Also:
-
key_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
ScopedRouteConfiguration
private ScopedRouteConfiguration(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
ScopedRouteConfiguration
private ScopedRouteConfiguration()
-
-
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
-
getOnDemand
public boolean getOnDemand()Whether the RouteConfiguration should be loaded on demand.
bool on_demand = 4;
- Specified by:
getOnDemand
in interfaceScopedRouteConfigurationOrBuilder
- Returns:
- The onDemand.
-
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.
-
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.
-
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.
-
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
-
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.
-
getKeyOrBuilder
The key to match against.
.envoy.config.route.v3.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
- Specified by:
getKeyOrBuilder
in interfaceScopedRouteConfigurationOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ScopedRouteConfiguration parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ScopedRouteConfiguration parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ScopedRouteConfiguration parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ScopedRouteConfiguration parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ScopedRouteConfiguration parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ScopedRouteConfiguration parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ScopedRouteConfiguration parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ScopedRouteConfiguration parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ScopedRouteConfiguration parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ScopedRouteConfiguration parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ScopedRouteConfiguration.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-