Package io.envoyproxy.envoy.config.route.v3

Interface RouteOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Route, Route.Builder
    public interface RouteOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Name for the route.
        string name = 14;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Name for the route.
        string name = 14;
        Returns:
        The bytes for name.

      • hasMatch

        boolean hasMatch()
         Route matching parameters.
        .envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }
        Returns:
        Whether the match field is set.

      • getMatch

        RouteMatch getMatch()
         Route matching parameters.
        .envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }
        Returns:
        The match.

      • getMatchOrBuilder

        RouteMatchOrBuilder getMatchOrBuilder()
         Route matching parameters.
        .envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }

      • hasRoute

        boolean hasRoute()
         Route request to some upstream cluster.
        .envoy.config.route.v3.RouteAction route = 2;
        Returns:
        Whether the route field is set.

      • getRoute

        RouteAction getRoute()
         Route request to some upstream cluster.
        .envoy.config.route.v3.RouteAction route = 2;
        Returns:
        The route.

      • getRouteOrBuilder

        RouteActionOrBuilder getRouteOrBuilder()
         Route request to some upstream cluster.
        .envoy.config.route.v3.RouteAction route = 2;

      • hasRedirect

        boolean hasRedirect()
         Return a redirect.
        .envoy.config.route.v3.RedirectAction redirect = 3;
        Returns:
        Whether the redirect field is set.

      • getRedirect

        RedirectAction getRedirect()
         Return a redirect.
        .envoy.config.route.v3.RedirectAction redirect = 3;
        Returns:
        The redirect.

      • getRedirectOrBuilder

        RedirectActionOrBuilder getRedirectOrBuilder()
         Return a redirect.
        .envoy.config.route.v3.RedirectAction redirect = 3;

      • hasDirectResponse

        boolean hasDirectResponse()
         Return an arbitrary HTTP response directly, without proxying.
        .envoy.config.route.v3.DirectResponseAction direct_response = 7;
        Returns:
        Whether the directResponse field is set.

      • getDirectResponse

        DirectResponseAction getDirectResponse()
         Return an arbitrary HTTP response directly, without proxying.
        .envoy.config.route.v3.DirectResponseAction direct_response = 7;
        Returns:
        The directResponse.

      • getDirectResponseOrBuilder

        DirectResponseActionOrBuilder getDirectResponseOrBuilder()
         Return an arbitrary HTTP response directly, without proxying.
        .envoy.config.route.v3.DirectResponseAction direct_response = 7;

      • hasFilterAction

        boolean hasFilterAction()
         [#not-implemented-hide:]
 A filter-defined action (e.g., it could dynamically generate the RouteAction).
 [#comment: TODO(samflattery): Remove cleanup in route_fuzz_test.cc when
 implemented]
        .envoy.config.route.v3.FilterAction filter_action = 17;
        Returns:
        Whether the filterAction field is set.

      • getFilterAction

        FilterAction getFilterAction()
         [#not-implemented-hide:]
 A filter-defined action (e.g., it could dynamically generate the RouteAction).
 [#comment: TODO(samflattery): Remove cleanup in route_fuzz_test.cc when
 implemented]
        .envoy.config.route.v3.FilterAction filter_action = 17;
        Returns:
        The filterAction.

      • getFilterActionOrBuilder

        FilterActionOrBuilder getFilterActionOrBuilder()
         [#not-implemented-hide:]
 A filter-defined action (e.g., it could dynamically generate the RouteAction).
 [#comment: TODO(samflattery): Remove cleanup in route_fuzz_test.cc when
 implemented]
        .envoy.config.route.v3.FilterAction filter_action = 17;

      • hasNonForwardingAction

        boolean hasNonForwardingAction()
         [#not-implemented-hide:]
 An action used when the route will generate a response directly,
 without forwarding to an upstream host. This will be used in non-proxy
 xDS clients like the gRPC server. It could also be used in the future
 in Envoy for a filter that directly generates responses for requests.
        .envoy.config.route.v3.NonForwardingAction non_forwarding_action = 18;
        Returns:
        Whether the nonForwardingAction field is set.

      • getNonForwardingAction

        NonForwardingAction getNonForwardingAction()
         [#not-implemented-hide:]
 An action used when the route will generate a response directly,
 without forwarding to an upstream host. This will be used in non-proxy
 xDS clients like the gRPC server. It could also be used in the future
 in Envoy for a filter that directly generates responses for requests.
        .envoy.config.route.v3.NonForwardingAction non_forwarding_action = 18;
        Returns:
        The nonForwardingAction.

      • getNonForwardingActionOrBuilder

        NonForwardingActionOrBuilder getNonForwardingActionOrBuilder()
         [#not-implemented-hide:]
 An action used when the route will generate a response directly,
 without forwarding to an upstream host. This will be used in non-proxy
 xDS clients like the gRPC server. It could also be used in the future
 in Envoy for a filter that directly generates responses for requests.
        .envoy.config.route.v3.NonForwardingAction non_forwarding_action = 18;

      • hasMetadata

        boolean hasMetadata()
         The Metadata field can be used to provide additional information
 about the route. It can be used for configuration, stats, and logging.
 The metadata should go under the filter namespace that will need it.
 For instance, if the metadata is intended for the Router filter,
 the filter name should be specified as ``envoy.filters.http.router``.
        .envoy.config.core.v3.Metadata metadata = 4;
        Returns:
        Whether the metadata field is set.

      • getMetadata

        Metadata getMetadata()
         The Metadata field can be used to provide additional information
 about the route. It can be used for configuration, stats, and logging.
 The metadata should go under the filter namespace that will need it.
 For instance, if the metadata is intended for the Router filter,
 the filter name should be specified as ``envoy.filters.http.router``.
        .envoy.config.core.v3.Metadata metadata = 4;
        Returns:
        The metadata.

      • getMetadataOrBuilder

        MetadataOrBuilder getMetadataOrBuilder()
         The Metadata field can be used to provide additional information
 about the route. It can be used for configuration, stats, and logging.
 The metadata should go under the filter namespace that will need it.
 For instance, if the metadata is intended for the Router filter,
 the filter name should be specified as ``envoy.filters.http.router``.
        .envoy.config.core.v3.Metadata metadata = 4;

      • hasDecorator

        boolean hasDecorator()
         Decorator for the matched route.
        .envoy.config.route.v3.Decorator decorator = 5;
        Returns:
        Whether the decorator field is set.

      • getDecorator

        Decorator getDecorator()
         Decorator for the matched route.
        .envoy.config.route.v3.Decorator decorator = 5;
        Returns:
        The decorator.

      • getDecoratorOrBuilder

        DecoratorOrBuilder getDecoratorOrBuilder()
         Decorator for the matched route.
        .envoy.config.route.v3.Decorator decorator = 5;

      • getTypedPerFilterConfigCount

        int getTypedPerFilterConfigCount()
         The per_filter_config field can be used to provide route-specific configurations for filters.
 The key should match the :ref:`filter config name
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
 The canonical filter name (e.g., ``envoy.filters.http.buffer`` for the HTTP buffer filter) can also
 be used for the backwards compatibility. If there is no entry referred by the filter config name, the
 entry referred by the canonical filter name will be provided to the filters as fallback.
 Use of this field is filter specific;
 see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
 [#comment: An entry's value may be wrapped in a
 :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
 message to specify additional options.]
        map<string, .google.protobuf.Any> typed_per_filter_config = 13;

      • containsTypedPerFilterConfig

        boolean containsTypedPerFilterConfig​(String key)
         The per_filter_config field can be used to provide route-specific configurations for filters.
 The key should match the :ref:`filter config name
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
 The canonical filter name (e.g., ``envoy.filters.http.buffer`` for the HTTP buffer filter) can also
 be used for the backwards compatibility. If there is no entry referred by the filter config name, the
 entry referred by the canonical filter name will be provided to the filters as fallback.
 Use of this field is filter specific;
 see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
 [#comment: An entry's value may be wrapped in a
 :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
 message to specify additional options.]
        map<string, .google.protobuf.Any> typed_per_filter_config = 13;

      • getTypedPerFilterConfigMap

        Map<String,​com.google.protobuf.Any> getTypedPerFilterConfigMap()
         The per_filter_config field can be used to provide route-specific configurations for filters.
 The key should match the :ref:`filter config name
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
 The canonical filter name (e.g., ``envoy.filters.http.buffer`` for the HTTP buffer filter) can also
 be used for the backwards compatibility. If there is no entry referred by the filter config name, the
 entry referred by the canonical filter name will be provided to the filters as fallback.
 Use of this field is filter specific;
 see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
 [#comment: An entry's value may be wrapped in a
 :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
 message to specify additional options.]
        map<string, .google.protobuf.Any> typed_per_filter_config = 13;

      • getTypedPerFilterConfigOrDefault

        com.google.protobuf.Any getTypedPerFilterConfigOrDefault​(String key,
                                                         com.google.protobuf.Any defaultValue)
         The per_filter_config field can be used to provide route-specific configurations for filters.
 The key should match the :ref:`filter config name
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
 The canonical filter name (e.g., ``envoy.filters.http.buffer`` for the HTTP buffer filter) can also
 be used for the backwards compatibility. If there is no entry referred by the filter config name, the
 entry referred by the canonical filter name will be provided to the filters as fallback.
 Use of this field is filter specific;
 see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
 [#comment: An entry's value may be wrapped in a
 :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
 message to specify additional options.]
        map<string, .google.protobuf.Any> typed_per_filter_config = 13;

      • getTypedPerFilterConfigOrThrow

        com.google.protobuf.Any getTypedPerFilterConfigOrThrow​(String key)
         The per_filter_config field can be used to provide route-specific configurations for filters.
 The key should match the :ref:`filter config name
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
 The canonical filter name (e.g., ``envoy.filters.http.buffer`` for the HTTP buffer filter) can also
 be used for the backwards compatibility. If there is no entry referred by the filter config name, the
 entry referred by the canonical filter name will be provided to the filters as fallback.
 Use of this field is filter specific;
 see the :ref:`HTTP filter documentation <config_http_filters>` for if and how it is utilized.
 [#comment: An entry's value may be wrapped in a
 :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
 message to specify additional options.]
        map<string, .google.protobuf.Any> typed_per_filter_config = 13;

      • getRequestHeadersToAddList

        List<HeaderValueOption> getRequestHeadersToAddList()
         Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. 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.config.core.v3.HeaderValueOption request_headers_to_add = 9 [(.validate.rules) = { ... }

      • getRequestHeadersToAdd

        HeaderValueOption getRequestHeadersToAdd​(int index)
         Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. 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.config.core.v3.HeaderValueOption request_headers_to_add = 9 [(.validate.rules) = { ... }

      • getRequestHeadersToAddCount

        int getRequestHeadersToAddCount()
         Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. 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.config.core.v3.HeaderValueOption request_headers_to_add = 9 [(.validate.rules) = { ... }

      • getRequestHeadersToAddOrBuilderList

        List<? extends HeaderValueOptionOrBuilder> getRequestHeadersToAddOrBuilderList()
         Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. 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.config.core.v3.HeaderValueOption request_headers_to_add = 9 [(.validate.rules) = { ... }

      • getRequestHeadersToAddOrBuilder

        HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder​(int index)
         Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. 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.config.core.v3.HeaderValueOption request_headers_to_add = 9 [(.validate.rules) = { ... }

      • getRequestHeadersToRemoveList

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

      • getRequestHeadersToRemoveCount

        int getRequestHeadersToRemoveCount()
         Specifies a list of HTTP headers that should be removed from each request
 matching this route.
        repeated string request_headers_to_remove = 12 [(.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
 matching this route.
        repeated string request_headers_to_remove = 12 [(.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
 matching this route.
        repeated string request_headers_to_remove = 12 [(.validate.rules) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the requestHeadersToRemove at the given index.

      • getResponseHeadersToAddList

        List<HeaderValueOption> getResponseHeadersToAddList()
         Specifies a set of headers that will be added to responses to requests
 matching this route. Headers specified at this level are applied before
 headers from the enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. 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.config.core.v3.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }

      • getResponseHeadersToAdd

        HeaderValueOption getResponseHeadersToAdd​(int index)
         Specifies a set of headers that will be added to responses to requests
 matching this route. Headers specified at this level are applied before
 headers from the enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. 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.config.core.v3.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }

      • getResponseHeadersToAddCount

        int getResponseHeadersToAddCount()
         Specifies a set of headers that will be added to responses to requests
 matching this route. Headers specified at this level are applied before
 headers from the enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. 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.config.core.v3.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }

      • getResponseHeadersToAddOrBuilderList

        List<? extends HeaderValueOptionOrBuilder> getResponseHeadersToAddOrBuilderList()
         Specifies a set of headers that will be added to responses to requests
 matching this route. Headers specified at this level are applied before
 headers from the enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. 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.config.core.v3.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }

      • getResponseHeadersToAddOrBuilder

        HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder​(int index)
         Specifies a set of headers that will be added to responses to requests
 matching this route. Headers specified at this level are applied before
 headers from the enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. 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.config.core.v3.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... }

      • getResponseHeadersToRemoveList

        List<String> getResponseHeadersToRemoveList()
         Specifies a list of HTTP headers that should be removed from each response
 to requests matching this route.
        repeated string response_headers_to_remove = 11 [(.validate.rules) = { ... }
        Returns:
        A list containing the responseHeadersToRemove.

      • getResponseHeadersToRemoveCount

        int getResponseHeadersToRemoveCount()
         Specifies a list of HTTP headers that should be removed from each response
 to requests matching this route.
        repeated string response_headers_to_remove = 11 [(.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
 to requests matching this route.
        repeated string response_headers_to_remove = 11 [(.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
 to requests matching this route.
        repeated string response_headers_to_remove = 11 [(.validate.rules) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the responseHeadersToRemove at the given index.

      • hasTracing

        boolean hasTracing()
         Presence of the object defines whether the connection manager's tracing configuration
 is overridden by this route specific instance.
        .envoy.config.route.v3.Tracing tracing = 15;
        Returns:
        Whether the tracing field is set.

      • getTracing

        Tracing getTracing()
         Presence of the object defines whether the connection manager's tracing configuration
 is overridden by this route specific instance.
        .envoy.config.route.v3.Tracing tracing = 15;
        Returns:
        The tracing.

      • getTracingOrBuilder

        TracingOrBuilder getTracingOrBuilder()
         Presence of the object defines whether the connection manager's tracing configuration
 is overridden by this route specific instance.
        .envoy.config.route.v3.Tracing tracing = 15;

      • hasPerRequestBufferLimitBytes

        boolean hasPerRequestBufferLimitBytes()
         The maximum bytes which will be buffered for retries and shadowing.
 If set, the bytes actually buffered will be the minimum value of this and the
 listener per_connection_buffer_limit_bytes.
        .google.protobuf.UInt32Value per_request_buffer_limit_bytes = 16;
        Returns:
        Whether the perRequestBufferLimitBytes field is set.

      • getPerRequestBufferLimitBytes

        com.google.protobuf.UInt32Value getPerRequestBufferLimitBytes()
         The maximum bytes which will be buffered for retries and shadowing.
 If set, the bytes actually buffered will be the minimum value of this and the
 listener per_connection_buffer_limit_bytes.
        .google.protobuf.UInt32Value per_request_buffer_limit_bytes = 16;
        Returns:
        The perRequestBufferLimitBytes.

      • getPerRequestBufferLimitBytesOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getPerRequestBufferLimitBytesOrBuilder()
         The maximum bytes which will be buffered for retries and shadowing.
 If set, the bytes actually buffered will be the minimum value of this and the
 listener per_connection_buffer_limit_bytes.
        .google.protobuf.UInt32Value per_request_buffer_limit_bytes = 16;

      • getStatPrefix

        String getStatPrefix()
         The human readable prefix to use when emitting statistics for this endpoint.
 The statistics are rooted at vhost.<virtual host name>.route.<stat_prefix>.
 This should be set for highly critical
 endpoints that one wishes to get “per-route” statistics on.
 If not set, endpoint statistics are not generated.
 The emitted statistics are the same as those documented for :ref:`virtual clusters <config_http_filters_router_vcluster_stats>`.
 .. warning::
    We do not recommend setting up a stat prefix for
    every application endpoint. This is both not easily maintainable and
    statistics use a non-trivial amount of memory(approximately 1KiB per route).
        string stat_prefix = 19;
        Returns:
        The statPrefix.

      • getStatPrefixBytes

        com.google.protobuf.ByteString getStatPrefixBytes()
         The human readable prefix to use when emitting statistics for this endpoint.
 The statistics are rooted at vhost.<virtual host name>.route.<stat_prefix>.
 This should be set for highly critical
 endpoints that one wishes to get “per-route” statistics on.
 If not set, endpoint statistics are not generated.
 The emitted statistics are the same as those documented for :ref:`virtual clusters <config_http_filters_router_vcluster_stats>`.
 .. warning::
    We do not recommend setting up a stat prefix for
    every application endpoint. This is both not easily maintainable and
    statistics use a non-trivial amount of memory(approximately 1KiB per route).
        string stat_prefix = 19;
        Returns:
        The bytes for statPrefix.