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

Interface RouteConfigurationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RouteConfiguration, RouteConfiguration.Builder
public interface RouteConfigurationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    The name of the route configuration.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the route configuration.
    Route
    getRoutes(int index)
    The list of routes that will be matched, in order, against incoming requests.
    int
    getRoutesCount()
    The list of routes that will be matched, in order, against incoming requests.
    List<Route>
    getRoutesList()
    The list of routes that will be matched, in order, against incoming requests.
    RouteOrBuilder
    getRoutesOrBuilder(int index)
    The list of routes that will be matched, in order, against incoming requests.
    List<? extends RouteOrBuilder>
    getRoutesOrBuilderList()
    The list of routes that will be matched, in order, against incoming requests.
    com.google.protobuf.BoolValue
    getValidateClusters()
    An optional boolean that specifies whether the clusters that the route table refers to will be validated by the cluster manager.
    com.google.protobuf.BoolValueOrBuilder
    getValidateClustersOrBuilder()
    An optional boolean that specifies whether the clusters that the route table refers to will be validated by the cluster manager.
    boolean
    hasValidateClusters()
    An optional boolean that specifies whether the clusters that the route table refers to will be validated by the cluster manager.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       The name of the route configuration. This name is used in asynchronous route discovery.
 For example, it might match
 :ref:`route_config_name
 <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.Trds.route_config_name>` in
 :ref:`envoy_v3_api_msg_extensions.filters.network.thrift_proxy.v3.Trds`.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the route configuration. This name is used in asynchronous route discovery.
 For example, it might match
 :ref:`route_config_name
 <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.Trds.route_config_name>` in
 :ref:`envoy_v3_api_msg_extensions.filters.network.thrift_proxy.v3.Trds`.
      string name = 1;
      Returns:
      The bytes for name.

    • getRoutesList

      List<Route> getRoutesList()
       The list of routes that will be matched, in order, against incoming requests. The first route
 that matches will be used.
      repeated .envoy.extensions.filters.network.thrift_proxy.v3.Route routes = 2;

    • getRoutes

      Route getRoutes(int index)
       The list of routes that will be matched, in order, against incoming requests. The first route
 that matches will be used.
      repeated .envoy.extensions.filters.network.thrift_proxy.v3.Route routes = 2;

    • getRoutesCount

      int getRoutesCount()
       The list of routes that will be matched, in order, against incoming requests. The first route
 that matches will be used.
      repeated .envoy.extensions.filters.network.thrift_proxy.v3.Route routes = 2;

    • getRoutesOrBuilderList

      List<? extends RouteOrBuilder> getRoutesOrBuilderList()
       The list of routes that will be matched, in order, against incoming requests. The first route
 that matches will be used.
      repeated .envoy.extensions.filters.network.thrift_proxy.v3.Route routes = 2;

    • getRoutesOrBuilder

      RouteOrBuilder getRoutesOrBuilder(int index)
       The list of routes that will be matched, in order, against incoming requests. The first route
 that matches will be used.
      repeated .envoy.extensions.filters.network.thrift_proxy.v3.Route routes = 2;

    • hasValidateClusters

      boolean hasValidateClusters()
       An optional boolean that specifies whether the clusters that the route
 table refers to will be validated by the cluster manager. If set to true
 and a route refers to a non-existent cluster, the route table will not
 load. If set to false and a route refers to a non-existent cluster, the
 route table will load and the router filter will return a INTERNAL_ERROR
 if the route is selected at runtime. This setting defaults to true if the route table
 is statically defined via the :ref:`route_config
 <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.ThriftProxy.route_config>`
 option. This setting default to false if the route table is loaded dynamically via the
 :ref:`trds
 <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.ThriftProxy.trds>`
 option. Users may wish to override the default behavior in certain cases (for example when
 using CDS with a static route table).
      .google.protobuf.BoolValue validate_clusters = 3;
      Returns:
      Whether the validateClusters field is set.

    • getValidateClusters

      com.google.protobuf.BoolValue getValidateClusters()
       An optional boolean that specifies whether the clusters that the route
 table refers to will be validated by the cluster manager. If set to true
 and a route refers to a non-existent cluster, the route table will not
 load. If set to false and a route refers to a non-existent cluster, the
 route table will load and the router filter will return a INTERNAL_ERROR
 if the route is selected at runtime. This setting defaults to true if the route table
 is statically defined via the :ref:`route_config
 <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.ThriftProxy.route_config>`
 option. This setting default to false if the route table is loaded dynamically via the
 :ref:`trds
 <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.ThriftProxy.trds>`
 option. Users may wish to override the default behavior in certain cases (for example when
 using CDS with a static route table).
      .google.protobuf.BoolValue validate_clusters = 3;
      Returns:
      The validateClusters.

    • getValidateClustersOrBuilder

      com.google.protobuf.BoolValueOrBuilder getValidateClustersOrBuilder()
       An optional boolean that specifies whether the clusters that the route
 table refers to will be validated by the cluster manager. If set to true
 and a route refers to a non-existent cluster, the route table will not
 load. If set to false and a route refers to a non-existent cluster, the
 route table will load and the router filter will return a INTERNAL_ERROR
 if the route is selected at runtime. This setting defaults to true if the route table
 is statically defined via the :ref:`route_config
 <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.ThriftProxy.route_config>`
 option. This setting default to false if the route table is loaded dynamically via the
 :ref:`trds
 <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.ThriftProxy.trds>`
 option. Users may wish to override the default behavior in certain cases (for example when
 using CDS with a static route table).
      .google.protobuf.BoolValue validate_clusters = 3;