Package io.envoyproxy.envoy.api.v2

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 Detail

      • getName

        String getName()
         The name of the route configuration. For example, it might match
 :ref:`route_config_name
 <envoy_api_field_config.filter.network.http_connection_manager.v2.Rds.route_config_name>` in
 :ref:`envoy_api_msg_config.filter.network.http_connection_manager.v2.Rds`.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The name of the route configuration. For example, it might match
 :ref:`route_config_name
 <envoy_api_field_config.filter.network.http_connection_manager.v2.Rds.route_config_name>` in
 :ref:`envoy_api_msg_config.filter.network.http_connection_manager.v2.Rds`.
        string name = 1;
        Returns:
        The bytes for name.

      • getVirtualHostsList

        List<VirtualHost> getVirtualHostsList()
         An array of virtual hosts that make up the route table.
        repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;

      • getVirtualHosts

        VirtualHost getVirtualHosts​(int index)
         An array of virtual hosts that make up the route table.
        repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;

      • getVirtualHostsCount

        int getVirtualHostsCount()
         An array of virtual hosts that make up the route table.
        repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;

      • getVirtualHostsOrBuilderList

        List<? extends VirtualHostOrBuilder> getVirtualHostsOrBuilderList()
         An array of virtual hosts that make up the route table.
        repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;

      • getVirtualHostsOrBuilder

        VirtualHostOrBuilder getVirtualHostsOrBuilder​(int index)
         An array of virtual hosts that make up the route table.
        repeated .envoy.api.v2.route.VirtualHost virtual_hosts = 2;

      • hasVhds

        boolean hasVhds()
         An array of virtual hosts will be dynamically loaded via the VHDS API.
 Both *virtual_hosts* and *vhds* fields will be used when present. *virtual_hosts* can be used
 for a base routing table or for infrequently changing virtual hosts. *vhds* is used for
 on-demand discovery of virtual hosts. The contents of these two fields will be merged to
 generate a routing table for a given RouteConfiguration, with *vhds* derived configuration
 taking precedence.
        .envoy.api.v2.Vhds vhds = 9;
        Returns:
        Whether the vhds field is set.

      • getVhds

        Vhds getVhds()
         An array of virtual hosts will be dynamically loaded via the VHDS API.
 Both *virtual_hosts* and *vhds* fields will be used when present. *virtual_hosts* can be used
 for a base routing table or for infrequently changing virtual hosts. *vhds* is used for
 on-demand discovery of virtual hosts. The contents of these two fields will be merged to
 generate a routing table for a given RouteConfiguration, with *vhds* derived configuration
 taking precedence.
        .envoy.api.v2.Vhds vhds = 9;
        Returns:
        The vhds.

      • getVhdsOrBuilder

        VhdsOrBuilder getVhdsOrBuilder()
         An array of virtual hosts will be dynamically loaded via the VHDS API.
 Both *virtual_hosts* and *vhds* fields will be used when present. *virtual_hosts* can be used
 for a base routing table or for infrequently changing virtual hosts. *vhds* is used for
 on-demand discovery of virtual hosts. The contents of these two fields will be merged to
 generate a routing table for a given RouteConfiguration, with *vhds* derived configuration
 taking precedence.
        .envoy.api.v2.Vhds vhds = 9;

      • getInternalOnlyHeadersList

        List<String> getInternalOnlyHeadersList()
         Optionally specifies a list of HTTP headers that the connection manager
 will consider to be internal only. If they are found on external requests they will be cleaned
 prior to filter invocation. See :ref:`config_http_conn_man_headers_x-envoy-internal` for more
 information.
        repeated string internal_only_headers = 3 [(.validate.rules) = { ... }
        Returns:
        A list containing the internalOnlyHeaders.

      • getInternalOnlyHeadersCount

        int getInternalOnlyHeadersCount()
         Optionally specifies a list of HTTP headers that the connection manager
 will consider to be internal only. If they are found on external requests they will be cleaned
 prior to filter invocation. See :ref:`config_http_conn_man_headers_x-envoy-internal` for more
 information.
        repeated string internal_only_headers = 3 [(.validate.rules) = { ... }
        Returns:
        The count of internalOnlyHeaders.

      • getInternalOnlyHeaders

        String getInternalOnlyHeaders​(int index)
         Optionally specifies a list of HTTP headers that the connection manager
 will consider to be internal only. If they are found on external requests they will be cleaned
 prior to filter invocation. See :ref:`config_http_conn_man_headers_x-envoy-internal` for more
 information.
        repeated string internal_only_headers = 3 [(.validate.rules) = { ... }
        Parameters:
        index - The index of the element to return.
        Returns:
        The internalOnlyHeaders at the given index.

      • getInternalOnlyHeadersBytes

        com.google.protobuf.ByteString getInternalOnlyHeadersBytes​(int index)
         Optionally specifies a list of HTTP headers that the connection manager
 will consider to be internal only. If they are found on external requests they will be cleaned
 prior to filter invocation. See :ref:`config_http_conn_man_headers_x-envoy-internal` for more
 information.
        repeated string internal_only_headers = 3 [(.validate.rules) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the internalOnlyHeaders at the given index.

      • getResponseHeadersToAddList

        List<HeaderValueOption> getResponseHeadersToAddList()
         Specifies a list of HTTP headers that should be added to each response that
 the connection manager encodes. Headers specified at this level are applied
 after headers from any enclosed :ref:`envoy_api_msg_route.VirtualHost` or
 :ref:`envoy_api_msg_route.RouteAction`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }

      • getResponseHeadersToAdd

        HeaderValueOption getResponseHeadersToAdd​(int index)
         Specifies a list of HTTP headers that should be added to each response that
 the connection manager encodes. Headers specified at this level are applied
 after headers from any enclosed :ref:`envoy_api_msg_route.VirtualHost` or
 :ref:`envoy_api_msg_route.RouteAction`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }

      • getResponseHeadersToAddCount

        int getResponseHeadersToAddCount()
         Specifies a list of HTTP headers that should be added to each response that
 the connection manager encodes. Headers specified at this level are applied
 after headers from any enclosed :ref:`envoy_api_msg_route.VirtualHost` or
 :ref:`envoy_api_msg_route.RouteAction`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }

      • getResponseHeadersToAddOrBuilderList

        List<? extends HeaderValueOptionOrBuilder> getResponseHeadersToAddOrBuilderList()
         Specifies a list of HTTP headers that should be added to each response that
 the connection manager encodes. Headers specified at this level are applied
 after headers from any enclosed :ref:`envoy_api_msg_route.VirtualHost` or
 :ref:`envoy_api_msg_route.RouteAction`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }

      • getResponseHeadersToAddOrBuilder

        HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder​(int index)
         Specifies a list of HTTP headers that should be added to each response that
 the connection manager encodes. Headers specified at this level are applied
 after headers from any enclosed :ref:`envoy_api_msg_route.VirtualHost` or
 :ref:`envoy_api_msg_route.RouteAction`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.api.v2.core.HeaderValueOption response_headers_to_add = 4 [(.validate.rules) = { ... }

      • getResponseHeadersToRemoveList

        List<String> getResponseHeadersToRemoveList()
         Specifies a list of HTTP headers that should be removed from each response
 that the connection manager encodes.
        repeated string response_headers_to_remove = 5 [(.validate.rules) = { ... }
        Returns:
        A list containing the responseHeadersToRemove.

      • getResponseHeadersToRemoveCount

        int getResponseHeadersToRemoveCount()
         Specifies a list of HTTP headers that should be removed from each response
 that the connection manager encodes.
        repeated string response_headers_to_remove = 5 [(.validate.rules) = { ... }
        Returns:
        The count of responseHeadersToRemove.

      • getResponseHeadersToRemove

        String getResponseHeadersToRemove​(int index)
         Specifies a list of HTTP headers that should be removed from each response
 that the connection manager encodes.
        repeated string response_headers_to_remove = 5 [(.validate.rules) = { ... }
        Parameters:
        index - The index of the element to return.
        Returns:
        The responseHeadersToRemove at the given index.

      • getResponseHeadersToRemoveBytes

        com.google.protobuf.ByteString getResponseHeadersToRemoveBytes​(int index)
         Specifies a list of HTTP headers that should be removed from each response
 that the connection manager encodes.
        repeated string response_headers_to_remove = 5 [(.validate.rules) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the responseHeadersToRemove at the given index.

      • getRequestHeadersToAddList

        List<HeaderValueOption> getRequestHeadersToAddList()
         Specifies a list of HTTP headers that should be added to each request
 routed by the HTTP connection manager. Headers specified at this level are
 applied after headers from any enclosed :ref:`envoy_api_msg_route.VirtualHost` or
 :ref:`envoy_api_msg_route.RouteAction`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }

      • getRequestHeadersToAdd

        HeaderValueOption getRequestHeadersToAdd​(int index)
         Specifies a list of HTTP headers that should be added to each request
 routed by the HTTP connection manager. Headers specified at this level are
 applied after headers from any enclosed :ref:`envoy_api_msg_route.VirtualHost` or
 :ref:`envoy_api_msg_route.RouteAction`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }

      • getRequestHeadersToAddCount

        int getRequestHeadersToAddCount()
         Specifies a list of HTTP headers that should be added to each request
 routed by the HTTP connection manager. Headers specified at this level are
 applied after headers from any enclosed :ref:`envoy_api_msg_route.VirtualHost` or
 :ref:`envoy_api_msg_route.RouteAction`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }

      • getRequestHeadersToAddOrBuilderList

        List<? extends HeaderValueOptionOrBuilder> getRequestHeadersToAddOrBuilderList()
         Specifies a list of HTTP headers that should be added to each request
 routed by the HTTP connection manager. Headers specified at this level are
 applied after headers from any enclosed :ref:`envoy_api_msg_route.VirtualHost` or
 :ref:`envoy_api_msg_route.RouteAction`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }

      • getRequestHeadersToAddOrBuilder

        HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder​(int index)
         Specifies a list of HTTP headers that should be added to each request
 routed by the HTTP connection manager. Headers specified at this level are
 applied after headers from any enclosed :ref:`envoy_api_msg_route.VirtualHost` or
 :ref:`envoy_api_msg_route.RouteAction`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
        repeated .envoy.api.v2.core.HeaderValueOption request_headers_to_add = 6 [(.validate.rules) = { ... }

      • getRequestHeadersToRemoveList

        List<String> getRequestHeadersToRemoveList()
         Specifies a list of HTTP headers that should be removed from each request
 routed by the HTTP connection manager.
        repeated string request_headers_to_remove = 8 [(.validate.rules) = { ... }
        Returns:
        A list containing the requestHeadersToRemove.

      • getRequestHeadersToRemoveCount

        int getRequestHeadersToRemoveCount()
         Specifies a list of HTTP headers that should be removed from each request
 routed by the HTTP connection manager.
        repeated string request_headers_to_remove = 8 [(.validate.rules) = { ... }
        Returns:
        The count of requestHeadersToRemove.

      • getRequestHeadersToRemove

        String getRequestHeadersToRemove​(int index)
         Specifies a list of HTTP headers that should be removed from each request
 routed by the HTTP connection manager.
        repeated string request_headers_to_remove = 8 [(.validate.rules) = { ... }
        Parameters:
        index - The index of the element to return.
        Returns:
        The requestHeadersToRemove at the given index.

      • getRequestHeadersToRemoveBytes

        com.google.protobuf.ByteString getRequestHeadersToRemoveBytes​(int index)
         Specifies a list of HTTP headers that should be removed from each request
 routed by the HTTP connection manager.
        repeated string request_headers_to_remove = 8 [(.validate.rules) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the requestHeadersToRemove at the given index.

      • getMostSpecificHeaderMutationsWins

        boolean getMostSpecificHeaderMutationsWins()
         By default, headers that should be added/removed are evaluated from most to least specific:
 * route level
 * virtual host level
 * connection manager level
 To allow setting overrides at the route or virtual host level, this order can be reversed
 by setting this option to true. Defaults to false.
 [#next-major-version: In the v3 API, this will default to true.]
        bool most_specific_header_mutations_wins = 10;
        Returns:
        The mostSpecificHeaderMutationsWins.

      • 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 404 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_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.route_config>`
 option. This setting default to false if the route table is loaded dynamically via the
 :ref:`rds
 <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.rds>`
 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 = 7;
        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 404 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_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.route_config>`
 option. This setting default to false if the route table is loaded dynamically via the
 :ref:`rds
 <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.rds>`
 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 = 7;
        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 404 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_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.route_config>`
 option. This setting default to false if the route table is loaded dynamically via the
 :ref:`rds
 <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.rds>`
 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 = 7;