Package io.envoyproxy.envoy.api.v2

Class ScopedRouteConfiguration

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.api.v2.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.GeneratedMessageV3 implements ScopedRouteConfigurationOrBuilder
 Specifies a routing scope, which associates a
 :ref:`Key<envoy_api_msg_ScopedRouteConfiguration.Key>` to a
 :ref:`envoy_api_msg_RouteConfiguration` (identified by its resource name).

 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_api_field_config.filter.network.http_connection_manager.v2.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_api_field_config.filter.network.http_connection_manager.v2.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.
Protobuf type envoy.api.v2.ScopedRouteConfiguration
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ScopedRouteConfiguration.Builder
    Specifies a routing scope, which associates a :ref:`Key<envoy_api_msg_ScopedRouteConfiguration.Key>` to a :ref:`envoy_api_msg_RouteConfiguration` (identified by its resource name).
    static final class 
    ScopedRouteConfiguration.Key
    Specifies a key which is matched against the output of the :ref:`scope_key_builder<envoy_api_field_config.filter.network.http_connection_manager.v2.ScopedRoutes.scope_key_builder>` specified in the HttpConnectionManager.
    static interface 
    ScopedRouteConfiguration.KeyOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    KEY_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    ROUTE_CONFIGURATION_NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ScopedRouteConfiguration
    getDefaultInstance()
     
    ScopedRouteConfiguration
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    ScopedRouteConfiguration.Key
    getKey()
    The key to match against.
    ScopedRouteConfiguration.KeyOrBuilder
    getKeyOrBuilder()
    The key to match against.
    String
    getName()
    The name assigned to the routing scope.
    com.google.protobuf.ByteString
    getNameBytes()
    The name assigned to the routing scope.
    com.google.protobuf.Parser<ScopedRouteConfiguration>
    getParserForType()
     
    String
    getRouteConfigurationName()
    The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated with this scope.
    com.google.protobuf.ByteString
    getRouteConfigurationNameBytes()
    The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated with this scope.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasKey()
    The key to match against.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ScopedRouteConfiguration.Builder
    newBuilder()
     
    static ScopedRouteConfiguration.Builder
    newBuilder(ScopedRouteConfiguration prototype)
     
    ScopedRouteConfiguration.Builder
    newBuilderForType()
     
    protected ScopedRouteConfiguration.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    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()
     
    ScopedRouteConfiguration.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, 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

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • ROUTE_CONFIGURATION_NAME_FIELD_NUMBER

      public static final int ROUTE_CONFIGURATION_NAME_FIELD_NUMBER
      See Also:

    • KEY_FIELD_NUMBER

      public static final int KEY_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getName

      public String getName()
       The name assigned to the routing scope.
      string name = 1 [(.validate.rules) = { ... }
      Specified by:
      getName in interface ScopedRouteConfigurationOrBuilder
      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 interface ScopedRouteConfigurationOrBuilder
      Returns:
      The bytes for name.

    • getRouteConfigurationName

      public String getRouteConfigurationName()
       The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an
 RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated
 with this scope.
      string route_configuration_name = 2 [(.validate.rules) = { ... }
      Specified by:
      getRouteConfigurationName in interface ScopedRouteConfigurationOrBuilder
      Returns:
      The routeConfigurationName.

    • getRouteConfigurationNameBytes

      public com.google.protobuf.ByteString getRouteConfigurationNameBytes()
       The resource name to use for a :ref:`envoy_api_msg_DiscoveryRequest` to an
 RDS server to fetch the :ref:`envoy_api_msg_RouteConfiguration` associated
 with this scope.
      string route_configuration_name = 2 [(.validate.rules) = { ... }
      Specified by:
      getRouteConfigurationNameBytes in interface ScopedRouteConfigurationOrBuilder
      Returns:
      The bytes for routeConfigurationName.

    • hasKey

      public boolean hasKey()
       The key to match against.
      .envoy.api.v2.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
      Specified by:
      hasKey in interface ScopedRouteConfigurationOrBuilder
      Returns:
      Whether the key field is set.

    • getKey

      public ScopedRouteConfiguration.Key getKey()
       The key to match against.
      .envoy.api.v2.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
      Specified by:
      getKey in interface ScopedRouteConfigurationOrBuilder
      Returns:
      The key.

    • getKeyOrBuilder

      public ScopedRouteConfiguration.KeyOrBuilder getKeyOrBuilder()
       The key to match against.
      .envoy.api.v2.ScopedRouteConfiguration.Key key = 3 [(.validate.rules) = { ... }
      Specified by:
      getKeyOrBuilder in interface ScopedRouteConfigurationOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.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

      public static ScopedRouteConfiguration parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ScopedRouteConfiguration parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ScopedRouteConfiguration parseDelimitedFrom(InputStream input) throws IOException
      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

      public ScopedRouteConfiguration.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ScopedRouteConfiguration.Builder newBuilder()

    • newBuilder

      public static ScopedRouteConfiguration.Builder newBuilder(ScopedRouteConfiguration prototype)

    • toBuilder

      public ScopedRouteConfiguration.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ScopedRouteConfiguration.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ScopedRouteConfiguration getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ScopedRouteConfiguration> parser()

    • getParserForType

      public com.google.protobuf.Parser<ScopedRouteConfiguration> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ScopedRouteConfiguration getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder