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

Class Route

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteOrBuilder, Serializable
    public final class Route
extends com.google.protobuf.GeneratedMessageV3
implements RouteOrBuilder
     A route is both a specification of how to match a request as well as an indication of what to do
 next (e.g., redirect, forward, rewrite, etc.).
 .. attention::
   Envoy supports routing on HTTP method via :ref:`header matching
   <envoy_v3_api_msg_config.route.v3.HeaderMatcher>`.
 [#next-free-field: 20]
    Protobuf type envoy.config.route.v3.Route
    See Also:
    Serialized Form

    • Field Detail

      • DIRECT_RESPONSE_FIELD_NUMBER

        public static final int DIRECT_RESPONSE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FILTER_ACTION_FIELD_NUMBER

        public static final int FILTER_ACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NON_FORWARDING_ACTION_FIELD_NUMBER

        public static final int NON_FORWARDING_ACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TYPED_PER_FILTER_CONFIG_FIELD_NUMBER

        public static final int TYPED_PER_FILTER_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_HEADERS_TO_ADD_FIELD_NUMBER

        public static final int REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_HEADERS_TO_REMOVE_FIELD_NUMBER

        public static final int REQUEST_HEADERS_TO_REMOVE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER

        public static final int RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER

        public static final int RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PER_REQUEST_BUFFER_LIMIT_BYTES_FIELD_NUMBER

        public static final int PER_REQUEST_BUFFER_LIMIT_BYTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STAT_PREFIX_FIELD_NUMBER

        public static final int STAT_PREFIX_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Name for the route.
        string name = 14;
        Specified by:
        getName in interface RouteOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Name for the route.
        string name = 14;
        Specified by:
        getNameBytes in interface RouteOrBuilder
        Returns:
        The bytes for name.

      • hasMatch

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

      • getMatch

        public RouteMatch getMatch()
         Route matching parameters.
        .envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }
        Specified by:
        getMatch in interface RouteOrBuilder
        Returns:
        The match.

      • hasRoute

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

      • getRoute

        public RouteAction getRoute()
         Route request to some upstream cluster.
        .envoy.config.route.v3.RouteAction route = 2;
        Specified by:
        getRoute in interface RouteOrBuilder
        Returns:
        The route.

      • hasRedirect

        public boolean hasRedirect()
         Return a redirect.
        .envoy.config.route.v3.RedirectAction redirect = 3;
        Specified by:
        hasRedirect in interface RouteOrBuilder
        Returns:
        Whether the redirect field is set.

      • getRedirect

        public RedirectAction getRedirect()
         Return a redirect.
        .envoy.config.route.v3.RedirectAction redirect = 3;
        Specified by:
        getRedirect in interface RouteOrBuilder
        Returns:
        The redirect.

      • hasDirectResponse

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

      • getDirectResponse

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

      • hasFilterAction

        public 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;
        Specified by:
        hasFilterAction in interface RouteOrBuilder
        Returns:
        Whether the filterAction field is set.

      • getFilterAction

        public 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;
        Specified by:
        getFilterAction in interface RouteOrBuilder
        Returns:
        The filterAction.

      • getFilterActionOrBuilder

        public 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;
        Specified by:
        getFilterActionOrBuilder in interface RouteOrBuilder

      • hasNonForwardingAction

        public 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;
        Specified by:
        hasNonForwardingAction in interface RouteOrBuilder
        Returns:
        Whether the nonForwardingAction field is set.

      • getNonForwardingAction

        public 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;
        Specified by:
        getNonForwardingAction in interface RouteOrBuilder
        Returns:
        The nonForwardingAction.

      • getNonForwardingActionOrBuilder

        public 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;
        Specified by:
        getNonForwardingActionOrBuilder in interface RouteOrBuilder

      • hasMetadata

        public 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;
        Specified by:
        hasMetadata in interface RouteOrBuilder
        Returns:
        Whether the metadata field is set.

      • getMetadata

        public 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;
        Specified by:
        getMetadata in interface RouteOrBuilder
        Returns:
        The metadata.

      • getMetadataOrBuilder

        public 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;
        Specified by:
        getMetadataOrBuilder in interface RouteOrBuilder

      • hasDecorator

        public boolean hasDecorator()
         Decorator for the matched route.
        .envoy.config.route.v3.Decorator decorator = 5;
        Specified by:
        hasDecorator in interface RouteOrBuilder
        Returns:
        Whether the decorator field is set.

      • getDecorator

        public Decorator getDecorator()
         Decorator for the matched route.
        .envoy.config.route.v3.Decorator decorator = 5;
        Specified by:
        getDecorator in interface RouteOrBuilder
        Returns:
        The decorator.

      • getTypedPerFilterConfigCount

        public int getTypedPerFilterConfigCount()
        Description copied from interface: RouteOrBuilder
         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;
        Specified by:
        getTypedPerFilterConfigCount in interface RouteOrBuilder

      • containsTypedPerFilterConfig

        public 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;
        Specified by:
        containsTypedPerFilterConfig in interface RouteOrBuilder

      • getTypedPerFilterConfigMap

        public 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;
        Specified by:
        getTypedPerFilterConfigMap in interface RouteOrBuilder

      • getTypedPerFilterConfigOrDefault

        public 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;
        Specified by:
        getTypedPerFilterConfigOrDefault in interface RouteOrBuilder

      • getTypedPerFilterConfigOrThrow

        public 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;
        Specified by:
        getTypedPerFilterConfigOrThrow in interface RouteOrBuilder

      • getRequestHeadersToAddList

        public 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) = { ... }
        Specified by:
        getRequestHeadersToAddList in interface RouteOrBuilder

      • getRequestHeadersToAddOrBuilderList

        public 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) = { ... }
        Specified by:
        getRequestHeadersToAddOrBuilderList in interface RouteOrBuilder

      • getRequestHeadersToAddCount

        public 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) = { ... }
        Specified by:
        getRequestHeadersToAddCount in interface RouteOrBuilder

      • getRequestHeadersToAdd

        public 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) = { ... }
        Specified by:
        getRequestHeadersToAdd in interface RouteOrBuilder

      • getRequestHeadersToAddOrBuilder

        public 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) = { ... }
        Specified by:
        getRequestHeadersToAddOrBuilder in interface RouteOrBuilder

      • getRequestHeadersToRemoveList

        public com.google.protobuf.ProtocolStringList 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) = { ... }
        Specified by:
        getRequestHeadersToRemoveList in interface RouteOrBuilder
        Returns:
        A list containing the requestHeadersToRemove.

      • getRequestHeadersToRemoveCount

        public 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) = { ... }
        Specified by:
        getRequestHeadersToRemoveCount in interface RouteOrBuilder
        Returns:
        The count of requestHeadersToRemove.

      • getRequestHeadersToRemove

        public 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) = { ... }
        Specified by:
        getRequestHeadersToRemove in interface RouteOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The requestHeadersToRemove at the given index.

      • getRequestHeadersToRemoveBytes

        public 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) = { ... }
        Specified by:
        getRequestHeadersToRemoveBytes in interface RouteOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the requestHeadersToRemove at the given index.

      • getResponseHeadersToAddList

        public 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) = { ... }
        Specified by:
        getResponseHeadersToAddList in interface RouteOrBuilder

      • getResponseHeadersToAddOrBuilderList

        public 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) = { ... }
        Specified by:
        getResponseHeadersToAddOrBuilderList in interface RouteOrBuilder

      • getResponseHeadersToAddCount

        public 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) = { ... }
        Specified by:
        getResponseHeadersToAddCount in interface RouteOrBuilder

      • getResponseHeadersToAdd

        public 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) = { ... }
        Specified by:
        getResponseHeadersToAdd in interface RouteOrBuilder

      • getResponseHeadersToAddOrBuilder

        public 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) = { ... }
        Specified by:
        getResponseHeadersToAddOrBuilder in interface RouteOrBuilder

      • getResponseHeadersToRemoveList

        public com.google.protobuf.ProtocolStringList 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) = { ... }
        Specified by:
        getResponseHeadersToRemoveList in interface RouteOrBuilder
        Returns:
        A list containing the responseHeadersToRemove.

      • getResponseHeadersToRemoveCount

        public 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) = { ... }
        Specified by:
        getResponseHeadersToRemoveCount in interface RouteOrBuilder
        Returns:
        The count of responseHeadersToRemove.

      • getResponseHeadersToRemove

        public 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) = { ... }
        Specified by:
        getResponseHeadersToRemove in interface RouteOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The responseHeadersToRemove at the given index.

      • getResponseHeadersToRemoveBytes

        public 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) = { ... }
        Specified by:
        getResponseHeadersToRemoveBytes in interface RouteOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the responseHeadersToRemove at the given index.

      • hasTracing

        public 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;
        Specified by:
        hasTracing in interface RouteOrBuilder
        Returns:
        Whether the tracing field is set.

      • getTracing

        public 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;
        Specified by:
        getTracing in interface RouteOrBuilder
        Returns:
        The tracing.

      • getTracingOrBuilder

        public 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;
        Specified by:
        getTracingOrBuilder in interface RouteOrBuilder

      • hasPerRequestBufferLimitBytes

        public 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;
        Specified by:
        hasPerRequestBufferLimitBytes in interface RouteOrBuilder
        Returns:
        Whether the perRequestBufferLimitBytes field is set.

      • getPerRequestBufferLimitBytes

        public 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;
        Specified by:
        getPerRequestBufferLimitBytes in interface RouteOrBuilder
        Returns:
        The perRequestBufferLimitBytes.

      • getPerRequestBufferLimitBytesOrBuilder

        public 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;
        Specified by:
        getPerRequestBufferLimitBytesOrBuilder in interface RouteOrBuilder

      • getStatPrefix

        public 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;
        Specified by:
        getStatPrefix in interface RouteOrBuilder
        Returns:
        The statPrefix.

      • getStatPrefixBytes

        public 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;
        Specified by:
        getStatPrefixBytes in interface RouteOrBuilder
        Returns:
        The bytes for statPrefix.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Route getDefaultInstance()

      • parser

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

      • getParserForType

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