All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.envoyproxy.envoy.api.v2.route.RouteOrBuilder Maven / Gradle / Ivy

The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/api/v2/route/route_components.proto

package io.envoyproxy.envoy.api.v2.route;

public interface RouteOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.api.v2.route.Route)
    com.google.protobuf.MessageOrBuilder {

  /**
   * 
   * Name for the route.
   * 
* * string name = 14; * @return The name. */ java.lang.String getName(); /** *
   * Name for the route.
   * 
* * string name = 14; * @return The bytes for name. */ com.google.protobuf.ByteString getNameBytes(); /** *
   * Route matching parameters.
   * 
* * .envoy.api.v2.route.RouteMatch match = 1 [(.validate.rules) = { ... } * @return Whether the match field is set. */ boolean hasMatch(); /** *
   * Route matching parameters.
   * 
* * .envoy.api.v2.route.RouteMatch match = 1 [(.validate.rules) = { ... } * @return The match. */ io.envoyproxy.envoy.api.v2.route.RouteMatch getMatch(); /** *
   * Route matching parameters.
   * 
* * .envoy.api.v2.route.RouteMatch match = 1 [(.validate.rules) = { ... } */ io.envoyproxy.envoy.api.v2.route.RouteMatchOrBuilder getMatchOrBuilder(); /** *
   * Route request to some upstream cluster.
   * 
* * .envoy.api.v2.route.RouteAction route = 2; * @return Whether the route field is set. */ boolean hasRoute(); /** *
   * Route request to some upstream cluster.
   * 
* * .envoy.api.v2.route.RouteAction route = 2; * @return The route. */ io.envoyproxy.envoy.api.v2.route.RouteAction getRoute(); /** *
   * Route request to some upstream cluster.
   * 
* * .envoy.api.v2.route.RouteAction route = 2; */ io.envoyproxy.envoy.api.v2.route.RouteActionOrBuilder getRouteOrBuilder(); /** *
   * Return a redirect.
   * 
* * .envoy.api.v2.route.RedirectAction redirect = 3; * @return Whether the redirect field is set. */ boolean hasRedirect(); /** *
   * Return a redirect.
   * 
* * .envoy.api.v2.route.RedirectAction redirect = 3; * @return The redirect. */ io.envoyproxy.envoy.api.v2.route.RedirectAction getRedirect(); /** *
   * Return a redirect.
   * 
* * .envoy.api.v2.route.RedirectAction redirect = 3; */ io.envoyproxy.envoy.api.v2.route.RedirectActionOrBuilder getRedirectOrBuilder(); /** *
   * Return an arbitrary HTTP response directly, without proxying.
   * 
* * .envoy.api.v2.route.DirectResponseAction direct_response = 7; * @return Whether the directResponse field is set. */ boolean hasDirectResponse(); /** *
   * Return an arbitrary HTTP response directly, without proxying.
   * 
* * .envoy.api.v2.route.DirectResponseAction direct_response = 7; * @return The directResponse. */ io.envoyproxy.envoy.api.v2.route.DirectResponseAction getDirectResponse(); /** *
   * Return an arbitrary HTTP response directly, without proxying.
   * 
* * .envoy.api.v2.route.DirectResponseAction direct_response = 7; */ io.envoyproxy.envoy.api.v2.route.DirectResponseActionOrBuilder getDirectResponseOrBuilder(); /** *
   * [#not-implemented-hide:]
   * If true, a filter will define the action (e.g., it could dynamically generate the
   * RouteAction).
   * 
* * .envoy.api.v2.route.FilterAction filter_action = 17; * @return Whether the filterAction field is set. */ boolean hasFilterAction(); /** *
   * [#not-implemented-hide:]
   * If true, a filter will define the action (e.g., it could dynamically generate the
   * RouteAction).
   * 
* * .envoy.api.v2.route.FilterAction filter_action = 17; * @return The filterAction. */ io.envoyproxy.envoy.api.v2.route.FilterAction getFilterAction(); /** *
   * [#not-implemented-hide:]
   * If true, a filter will define the action (e.g., it could dynamically generate the
   * RouteAction).
   * 
* * .envoy.api.v2.route.FilterAction filter_action = 17; */ io.envoyproxy.envoy.api.v2.route.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.filters.http.router*.
   * 
* * .envoy.api.v2.core.Metadata metadata = 4; * @return Whether the metadata field is set. */ 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.api.v2.core.Metadata metadata = 4; * @return The metadata. */ io.envoyproxy.envoy.api.v2.core.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.api.v2.core.Metadata metadata = 4; */ io.envoyproxy.envoy.api.v2.core.MetadataOrBuilder getMetadataOrBuilder(); /** *
   * Decorator for the matched route.
   * 
* * .envoy.api.v2.route.Decorator decorator = 5; * @return Whether the decorator field is set. */ boolean hasDecorator(); /** *
   * Decorator for the matched route.
   * 
* * .envoy.api.v2.route.Decorator decorator = 5; * @return The decorator. */ io.envoyproxy.envoy.api.v2.route.Decorator getDecorator(); /** *
   * Decorator for the matched route.
   * 
* * .envoy.api.v2.route.Decorator decorator = 5; */ io.envoyproxy.envoy.api.v2.route.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.filters.http.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.Struct> per_filter_config = 8 [deprecated = true]; */ @java.lang.Deprecated int getPerFilterConfigCount(); /** *
   * 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.filters.http.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.Struct> per_filter_config = 8 [deprecated = true]; */ @java.lang.Deprecated boolean containsPerFilterConfig( java.lang.String key); /** * Use {@link #getPerFilterConfigMap()} instead. */ @java.lang.Deprecated java.util.Map getPerFilterConfig(); /** *
   * 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.filters.http.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.Struct> per_filter_config = 8 [deprecated = true]; */ @java.lang.Deprecated java.util.Map getPerFilterConfigMap(); /** *
   * 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.filters.http.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.Struct> per_filter_config = 8 [deprecated = true]; */ @java.lang.Deprecated /* nullable */ com.google.protobuf.Struct getPerFilterConfigOrDefault( java.lang.String key, /* nullable */ com.google.protobuf.Struct 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.filters.http.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.Struct> per_filter_config = 8 [deprecated = true]; */ @java.lang.Deprecated com.google.protobuf.Struct getPerFilterConfigOrThrow( java.lang.String key); /** *
   * The typed_per_filter_config field can be used to provide route-specific
   * configurations for filters. The key should match the filter name, such as
   * *envoy.filters.http.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 typed_per_filter_config field can be used to provide route-specific
   * configurations for filters. The key should match the filter name, such as
   * *envoy.filters.http.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 typed_per_filter_config field can be used to provide route-specific
   * configurations for filters. The key should match the filter name, such as
   * *envoy.filters.http.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 typed_per_filter_config field can be used to provide route-specific
   * configurations for filters. The key should match the filter name, such as
   * *envoy.filters.http.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; */ /* nullable */ com.google.protobuf.Any getTypedPerFilterConfigOrDefault( java.lang.String key, /* nullable */ com.google.protobuf.Any defaultValue); /** *
   * The typed_per_filter_config field can be used to provide route-specific
   * configurations for filters. The key should match the filter name, such as
   * *envoy.filters.http.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_route.VirtualHost` and
   * :ref:`envoy_api_msg_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.api.v2.core.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_route.VirtualHost` and
   * :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption request_headers_to_add = 9 [(.validate.rules) = { ... } */ io.envoyproxy.envoy.api.v2.core.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_route.VirtualHost` and
   * :ref:`envoy_api_msg_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.api.v2.core.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_route.VirtualHost` and
   * :ref:`envoy_api_msg_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.api.v2.core.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_route.VirtualHost` and
   * :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption request_headers_to_add = 9 [(.validate.rules) = { ... } */ io.envoyproxy.envoy.api.v2.core.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; * @return A list containing the requestHeadersToRemove. */ 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; * @return The count of requestHeadersToRemove. */ 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; * @param index The index of the element to return. * @return The requestHeadersToRemove at the given index. */ 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; * @param index The index of the value to return. * @return The bytes of the requestHeadersToRemove at the given index. */ 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_route.VirtualHost` and
   * :ref:`envoy_api_msg_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.api.v2.core.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_route.VirtualHost` and
   * :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... } */ io.envoyproxy.envoy.api.v2.core.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_route.VirtualHost` and
   * :ref:`envoy_api_msg_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.api.v2.core.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_route.VirtualHost` and
   * :ref:`envoy_api_msg_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.api.v2.core.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_route.VirtualHost` and
   * :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption response_headers_to_add = 10 [(.validate.rules) = { ... } */ io.envoyproxy.envoy.api.v2.core.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; * @return A list containing the responseHeadersToRemove. */ 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; * @return The count of responseHeadersToRemove. */ 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; * @param index The index of the element to return. * @return The responseHeadersToRemove at the given index. */ 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; * @param index The index of the value to return. * @return The bytes of the responseHeadersToRemove at the given index. */ 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.api.v2.route.Tracing tracing = 15; * @return Whether the tracing field is set. */ boolean hasTracing(); /** *
   * Presence of the object defines whether the connection manager's tracing configuration
   * is overridden by this route specific instance.
   * 
* * .envoy.api.v2.route.Tracing tracing = 15; * @return The tracing. */ io.envoyproxy.envoy.api.v2.route.Tracing getTracing(); /** *
   * Presence of the object defines whether the connection manager's tracing configuration
   * is overridden by this route specific instance.
   * 
* * .envoy.api.v2.route.Tracing tracing = 15; */ io.envoyproxy.envoy.api.v2.route.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; * @return Whether the perRequestBufferLimitBytes field is set. */ 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; * @return The perRequestBufferLimitBytes. */ 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.api.v2.route.Route.ActionCase getActionCase(); }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy