io.envoyproxy.envoy.config.route.v3.RouteOrBuilder Maven / Gradle / Ivy
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: envoy/config/route/v3/route_components.proto
package io.envoyproxy.envoy.config.route.v3;
public interface RouteOrBuilder extends
// @@protoc_insertion_point(interface_extends:envoy.config.route.v3.Route)
com.google.protobuf.MessageOrBuilder {
/**
*
* Name for the route.
*
*
* string name = 14;
*/
java.lang.String getName();
/**
*
* Name for the route.
*
*
* string name = 14;
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* Route matching parameters.
*
*
* .envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }
*/
boolean hasMatch();
/**
*
* Route matching parameters.
*
*
* .envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }
*/
io.envoyproxy.envoy.config.route.v3.RouteMatch getMatch();
/**
*
* Route matching parameters.
*
*
* .envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }
*/
io.envoyproxy.envoy.config.route.v3.RouteMatchOrBuilder getMatchOrBuilder();
/**
*
* Route request to some upstream cluster.
*
*
* .envoy.config.route.v3.RouteAction route = 2;
*/
boolean hasRoute();
/**
*
* Route request to some upstream cluster.
*
*
* .envoy.config.route.v3.RouteAction route = 2;
*/
io.envoyproxy.envoy.config.route.v3.RouteAction getRoute();
/**
*
* Route request to some upstream cluster.
*
*
* .envoy.config.route.v3.RouteAction route = 2;
*/
io.envoyproxy.envoy.config.route.v3.RouteActionOrBuilder getRouteOrBuilder();
/**
*
* Return a redirect.
*
*
* .envoy.config.route.v3.RedirectAction redirect = 3;
*/
boolean hasRedirect();
/**
*
* Return a redirect.
*
*
* .envoy.config.route.v3.RedirectAction redirect = 3;
*/
io.envoyproxy.envoy.config.route.v3.RedirectAction getRedirect();
/**
*
* Return a redirect.
*
*
* .envoy.config.route.v3.RedirectAction redirect = 3;
*/
io.envoyproxy.envoy.config.route.v3.RedirectActionOrBuilder getRedirectOrBuilder();
/**
*
* Return an arbitrary HTTP response directly, without proxying.
*
*
* .envoy.config.route.v3.DirectResponseAction direct_response = 7;
*/
boolean hasDirectResponse();
/**
*
* Return an arbitrary HTTP response directly, without proxying.
*
*
* .envoy.config.route.v3.DirectResponseAction direct_response = 7;
*/
io.envoyproxy.envoy.config.route.v3.DirectResponseAction getDirectResponse();
/**
*
* Return an arbitrary HTTP response directly, without proxying.
*
*
* .envoy.config.route.v3.DirectResponseAction direct_response = 7;
*/
io.envoyproxy.envoy.config.route.v3.DirectResponseActionOrBuilder getDirectResponseOrBuilder();
/**
*
* [#not-implemented-hide:]
* If true, a filter will define the action (e.g., it could dynamically generate the
* RouteAction).
*
*
* .envoy.config.route.v3.FilterAction filter_action = 17;
*/
boolean hasFilterAction();
/**
*
* [#not-implemented-hide:]
* If true, a filter will define the action (e.g., it could dynamically generate the
* RouteAction).
*
*
* .envoy.config.route.v3.FilterAction filter_action = 17;
*/
io.envoyproxy.envoy.config.route.v3.FilterAction getFilterAction();
/**
*
* [#not-implemented-hide:]
* If true, a filter will define the action (e.g., it could dynamically generate the
* RouteAction).
*
*
* .envoy.config.route.v3.FilterAction filter_action = 17;
*/
io.envoyproxy.envoy.config.route.v3.FilterActionOrBuilder getFilterActionOrBuilder();
/**
*
* 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.router*.
*
*
* .envoy.config.core.v3.Metadata metadata = 4;
*/
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.router*.
*
*
* .envoy.config.core.v3.Metadata metadata = 4;
*/
io.envoyproxy.envoy.config.core.v3.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.router*.
*
*
* .envoy.config.core.v3.Metadata metadata = 4;
*/
io.envoyproxy.envoy.config.core.v3.MetadataOrBuilder getMetadataOrBuilder();
/**
*
* Decorator for the matched route.
*
*
* .envoy.config.route.v3.Decorator decorator = 5;
*/
boolean hasDecorator();
/**
*
* Decorator for the matched route.
*
*
* .envoy.config.route.v3.Decorator decorator = 5;
*/
io.envoyproxy.envoy.config.route.v3.Decorator getDecorator();
/**
*
* Decorator for the matched route.
*
*
* .envoy.config.route.v3.Decorator decorator = 5;
*/
io.envoyproxy.envoy.config.route.v3.DecoratorOrBuilder getDecoratorOrBuilder();
/**
*
* The per_filter_config field can be used to provide route-specific
* configurations for filters. The key should match the filter name, such as
* *envoy.buffer* for the HTTP buffer filter. Use of this field is filter
* specific; see the :ref:`HTTP filter documentation <config_http_filters>` for
* if and how it is utilized.
*
*
* map<string, .google.protobuf.Any> typed_per_filter_config = 13;
*/
int getTypedPerFilterConfigCount();
/**
*
* The per_filter_config field can be used to provide route-specific
* configurations for filters. The key should match the filter name, such as
* *envoy.buffer* for the HTTP buffer filter. Use of this field is filter
* specific; see the :ref:`HTTP filter documentation <config_http_filters>` for
* if and how it is utilized.
*
*
* map<string, .google.protobuf.Any> typed_per_filter_config = 13;
*/
boolean containsTypedPerFilterConfig(
java.lang.String key);
/**
* Use {@link #getTypedPerFilterConfigMap()} instead.
*/
@java.lang.Deprecated
java.util.Map
getTypedPerFilterConfig();
/**
*
* The per_filter_config field can be used to provide route-specific
* configurations for filters. The key should match the filter name, such as
* *envoy.buffer* for the HTTP buffer filter. Use of this field is filter
* specific; see the :ref:`HTTP filter documentation <config_http_filters>` for
* if and how it is utilized.
*
*
* map<string, .google.protobuf.Any> typed_per_filter_config = 13;
*/
java.util.Map
getTypedPerFilterConfigMap();
/**
*
* The per_filter_config field can be used to provide route-specific
* configurations for filters. The key should match the filter name, such as
* *envoy.buffer* for the HTTP buffer filter. Use of this field is filter
* specific; see the :ref:`HTTP filter documentation <config_http_filters>` for
* if and how it is utilized.
*
*
* map<string, .google.protobuf.Any> typed_per_filter_config = 13;
*/
com.google.protobuf.Any getTypedPerFilterConfigOrDefault(
java.lang.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 filter name, such as
* *envoy.buffer* for the HTTP buffer filter. Use of this field is filter
* specific; see the :ref:`HTTP filter documentation <config_http_filters>` for
* if and how it is utilized.
*
*
* map<string, .google.protobuf.Any> typed_per_filter_config = 13;
*/
com.google.protobuf.Any getTypedPerFilterConfigOrThrow(
java.lang.String key);
/**
*
* 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_api_msg_config.route.v3.VirtualHost` and
* :ref:`envoy_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) = { ... }
*/
java.util.List
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_api_msg_config.route.v3.VirtualHost` and
* :ref:`envoy_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) = { ... }
*/
io.envoyproxy.envoy.config.core.v3.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_api_msg_config.route.v3.VirtualHost` and
* :ref:`envoy_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) = { ... }
*/
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_api_msg_config.route.v3.VirtualHost` and
* :ref:`envoy_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) = { ... }
*/
java.util.List
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_api_msg_config.route.v3.VirtualHost` and
* :ref:`envoy_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) = { ... }
*/
io.envoyproxy.envoy.config.core.v3.HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder(
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;
*/
java.util.List
getRequestHeadersToRemoveList();
/**
*
* Specifies a list of HTTP headers that should be removed from each request
* matching this route.
*
*
* repeated string request_headers_to_remove = 12;
*/
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;
*/
java.lang.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;
*/
com.google.protobuf.ByteString
getRequestHeadersToRemoveBytes(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_api_msg_config.route.v3.VirtualHost` and
* :ref:`envoy_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) = { ... }
*/
java.util.List
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_api_msg_config.route.v3.VirtualHost` and
* :ref:`envoy_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) = { ... }
*/
io.envoyproxy.envoy.config.core.v3.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_api_msg_config.route.v3.VirtualHost` and
* :ref:`envoy_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) = { ... }
*/
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_api_msg_config.route.v3.VirtualHost` and
* :ref:`envoy_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) = { ... }
*/
java.util.List
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_api_msg_config.route.v3.VirtualHost` and
* :ref:`envoy_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) = { ... }
*/
io.envoyproxy.envoy.config.core.v3.HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder(
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;
*/
java.util.List
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;
*/
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;
*/
java.lang.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;
*/
com.google.protobuf.ByteString
getResponseHeadersToRemoveBytes(int index);
/**
*
* 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;
*/
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;
*/
io.envoyproxy.envoy.config.route.v3.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;
*/
io.envoyproxy.envoy.config.route.v3.TracingOrBuilder getTracingOrBuilder();
/**
*
* 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;
*/
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;
*/
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;
*/
com.google.protobuf.UInt32ValueOrBuilder getPerRequestBufferLimitBytesOrBuilder();
public io.envoyproxy.envoy.config.route.v3.Route.ActionCase getActionCase();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy