Package io.envoyproxy.envoy.extensions.filters.network.generic_proxy.v3

Class RouteConfiguration

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.network.generic_proxy.v3.RouteConfiguration
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteConfigurationOrBuilder, Serializable
public final class RouteConfiguration extends com.google.protobuf.GeneratedMessageV3 implements RouteConfigurationOrBuilder
 The generic proxy makes use of the xDS matching API for routing configurations.

 In the below example, we combine a top level tree matcher with a linear matcher to match
 the incoming requests, and send the matching requests to v1 of the upstream service.

 .. code-block:: yaml

   name: example
   routes:
     matcher_tree:
       input:
         name: request-service
         typed_config:
           "@type": type.googleapis.com/envoy.extensions.filters.network.generic_proxy.matcher.v3.ServiceMatchInput
       exact_match_map:
         map:
           service_name_0:
             matcher:
               matcher_list:
                 matchers:
                 - predicate:
                     and_matcher:
                       predicate:
                       - single_predicate:
                           input:
                             name: request-properties
                             typed_config:
                               "@type": type.googleapis.com/envoy.extensions.filters.network.generic_proxy.matcher.v3.PropertyMatchInput
                               property_name: version
                           value_match:
                             exact: v1
                       - single_predicate:
                           input:
                             name: request-properties
                             typed_config:
                               "@type": type.googleapis.com/envoy.extensions.filters.network.generic_proxy.matcher.v3.PropertyMatchInput
                               property_name: user
                           value_match:
                             exact: john
                   on_match:
                     action:
                       name: route
                       typed_config:
                         "@type": type.googleapis.com/envoy.extensions.filters.network.generic_proxy.action.v3.routeAction
                         cluster: cluster_0
Protobuf type envoy.extensions.filters.network.generic_proxy.v3.RouteConfiguration
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RouteConfiguration.Builder
    The generic proxy makes use of the xDS matching API for routing configurations.

    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
    NAME_FIELD_NUMBER
     
    static final int
    ROUTES_FIELD_NUMBER
     
    static final int
    VIRTUAL_HOSTS_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 RouteConfiguration
    getDefaultInstance()
     
    RouteConfiguration
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    The name of the route configuration.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the route configuration.
    com.google.protobuf.Parser<RouteConfiguration>
    getParserForType()
     
    Matcher
    getRoutes()
    The match tree to use when resolving route actions for incoming requests.
    MatcherOrBuilder
    getRoutesOrBuilder()
    The match tree to use when resolving route actions for incoming requests.
    int
    getSerializedSize()
     
    VirtualHost
    getVirtualHosts(int index)
    An array of virtual hosts that make up the route table.
    int
    getVirtualHostsCount()
    An array of virtual hosts that make up the route table.
    List<VirtualHost>
    getVirtualHostsList()
    An array of virtual hosts that make up the route table.
    VirtualHostOrBuilder
    getVirtualHostsOrBuilder(int index)
    An array of virtual hosts that make up the route table.
    List<? extends VirtualHostOrBuilder>
    getVirtualHostsOrBuilderList()
    An array of virtual hosts that make up the route table.
    int
    hashCode()
     
    boolean
    hasRoutes()
    The match tree to use when resolving route actions for incoming requests.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RouteConfiguration.Builder
    newBuilder()
     
    static RouteConfiguration.Builder
    newBuilder(RouteConfiguration prototype)
     
    RouteConfiguration.Builder
    newBuilderForType()
     
    protected RouteConfiguration.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static RouteConfiguration
    parseDelimitedFrom(InputStream input)
     
    static RouteConfiguration
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteConfiguration
    parseFrom(byte[] data)
     
    static RouteConfiguration
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteConfiguration
    parseFrom(com.google.protobuf.ByteString data)
     
    static RouteConfiguration
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteConfiguration
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RouteConfiguration
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteConfiguration
    parseFrom(InputStream input)
     
    static RouteConfiguration
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RouteConfiguration
    parseFrom(ByteBuffer data)
     
    static RouteConfiguration
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RouteConfiguration>
    parser()
     
    RouteConfiguration.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

  • 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 of the route configuration. For example, it might match route_config_name in
 envoy.extensions.filters.network.generic_proxy.v3.Rds.
      string name = 1 [(.validate.rules) = { ... }
      Specified by:
      getName in interface RouteConfigurationOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The name of the route configuration. For example, it might match route_config_name in
 envoy.extensions.filters.network.generic_proxy.v3.Rds.
      string name = 1 [(.validate.rules) = { ... }
      Specified by:
      getNameBytes in interface RouteConfigurationOrBuilder
      Returns:
      The bytes for name.

    • hasRoutes

      public boolean hasRoutes()
       The match tree to use when resolving route actions for incoming requests.
 If no any virtual host is configured in the ``virtual_hosts`` field or no special wildcard
 virtual host is configured, the ``routes`` field will be used as the default route table.
 If both the wildcard virtual host and ``routes`` are configured, the configuration will fail
 to load.
      .xds.type.matcher.v3.Matcher routes = 2;
      Specified by:
      hasRoutes in interface RouteConfigurationOrBuilder
      Returns:
      Whether the routes field is set.

    • getRoutes

      public Matcher getRoutes()
       The match tree to use when resolving route actions for incoming requests.
 If no any virtual host is configured in the ``virtual_hosts`` field or no special wildcard
 virtual host is configured, the ``routes`` field will be used as the default route table.
 If both the wildcard virtual host and ``routes`` are configured, the configuration will fail
 to load.
      .xds.type.matcher.v3.Matcher routes = 2;
      Specified by:
      getRoutes in interface RouteConfigurationOrBuilder
      Returns:
      The routes.

    • getRoutesOrBuilder

      public MatcherOrBuilder getRoutesOrBuilder()
       The match tree to use when resolving route actions for incoming requests.
 If no any virtual host is configured in the ``virtual_hosts`` field or no special wildcard
 virtual host is configured, the ``routes`` field will be used as the default route table.
 If both the wildcard virtual host and ``routes`` are configured, the configuration will fail
 to load.
      .xds.type.matcher.v3.Matcher routes = 2;
      Specified by:
      getRoutesOrBuilder in interface RouteConfigurationOrBuilder

    • getVirtualHostsList

      public List<VirtualHost> getVirtualHostsList()
       An array of virtual hosts that make up the route table.
      repeated .envoy.extensions.filters.network.generic_proxy.v3.VirtualHost virtual_hosts = 3;
      Specified by:
      getVirtualHostsList in interface RouteConfigurationOrBuilder

    • getVirtualHostsOrBuilderList

      public List<? extends VirtualHostOrBuilder> getVirtualHostsOrBuilderList()
       An array of virtual hosts that make up the route table.
      repeated .envoy.extensions.filters.network.generic_proxy.v3.VirtualHost virtual_hosts = 3;
      Specified by:
      getVirtualHostsOrBuilderList in interface RouteConfigurationOrBuilder

    • getVirtualHostsCount

      public int getVirtualHostsCount()
       An array of virtual hosts that make up the route table.
      repeated .envoy.extensions.filters.network.generic_proxy.v3.VirtualHost virtual_hosts = 3;
      Specified by:
      getVirtualHostsCount in interface RouteConfigurationOrBuilder

    • getVirtualHosts

      public VirtualHost getVirtualHosts(int index)
       An array of virtual hosts that make up the route table.
      repeated .envoy.extensions.filters.network.generic_proxy.v3.VirtualHost virtual_hosts = 3;
      Specified by:
      getVirtualHosts in interface RouteConfigurationOrBuilder

    • getVirtualHostsOrBuilder

      public VirtualHostOrBuilder getVirtualHostsOrBuilder(int index)
       An array of virtual hosts that make up the route table.
      repeated .envoy.extensions.filters.network.generic_proxy.v3.VirtualHost virtual_hosts = 3;
      Specified by:
      getVirtualHostsOrBuilder in interface RouteConfigurationOrBuilder

    • 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 RouteConfiguration parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RouteConfiguration parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RouteConfiguration parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RouteConfiguration parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RouteConfiguration parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RouteConfiguration parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

      public static RouteConfiguration parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static RouteConfiguration parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RouteConfiguration.Builder newBuilder()

    • newBuilder

      public static RouteConfiguration.Builder newBuilder(RouteConfiguration prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RouteConfiguration getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RouteConfiguration> 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 RouteConfiguration getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder