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 Summary

Modifier and Type	Method and Description
boolean	containsTypedPerFilterConfig(String key) The typed_per_filter_config field can be used to provide route-specific configurations for filters.
Route.ActionCase	getActionCase()
Decorator	getDecorator() Decorator for the matched route.
DecoratorOrBuilder	getDecoratorOrBuilder() Decorator for the matched route.
DirectResponseAction	getDirectResponse() Return an arbitrary HTTP response directly, without proxying.
DirectResponseActionOrBuilder	getDirectResponseOrBuilder() Return an arbitrary HTTP response directly, without proxying.
FilterAction	getFilterAction() [#not-implemented-hide:] If true, a filter will define the action (e.g., it could dynamically generate the RouteAction).
FilterActionOrBuilder	getFilterActionOrBuilder() [#not-implemented-hide:] If true, a filter will define the action (e.g., it could dynamically generate the RouteAction).
RouteMatch	getMatch() Route matching parameters.
RouteMatchOrBuilder	getMatchOrBuilder() Route matching parameters.
Metadata	getMetadata() The Metadata field can be used to provide additional information about the route.
MetadataOrBuilder	getMetadataOrBuilder() The Metadata field can be used to provide additional information about the route.
String	getName() Name for the route.
com.google.protobuf.ByteString	getNameBytes() Name for the route.
com.google.protobuf.UInt32Value	getPerRequestBufferLimitBytes() The maximum bytes which will be buffered for retries and shadowing.
com.google.protobuf.UInt32ValueOrBuilder	getPerRequestBufferLimitBytesOrBuilder() The maximum bytes which will be buffered for retries and shadowing.
RedirectAction	getRedirect() Return a redirect.
RedirectActionOrBuilder	getRedirectOrBuilder() Return a redirect.
HeaderValueOption	getRequestHeadersToAdd(int index) Specifies a set of headers that will be added to requests matching this route.
int	getRequestHeadersToAddCount() Specifies a set of headers that will be added to requests matching this route.
List<HeaderValueOption>	getRequestHeadersToAddList() Specifies a set of headers that will be added to requests matching this route.
HeaderValueOptionOrBuilder	getRequestHeadersToAddOrBuilder(int index) Specifies a set of headers that will be added to requests matching this route.
List<? extends HeaderValueOptionOrBuilder>	getRequestHeadersToAddOrBuilderList() Specifies a set of headers that will be added to requests matching this route.
String	getRequestHeadersToRemove(int index) Specifies a list of HTTP headers that should be removed from each request matching this route.
com.google.protobuf.ByteString	getRequestHeadersToRemoveBytes(int index) Specifies a list of HTTP headers that should be removed from each request matching this route.
int	getRequestHeadersToRemoveCount() Specifies a list of HTTP headers that should be removed from each request matching this route.
List<String>	getRequestHeadersToRemoveList() Specifies a list of HTTP headers that should be removed from each request matching this route.
HeaderValueOption	getResponseHeadersToAdd(int index) Specifies a set of headers that will be added to responses to requests matching this route.
int	getResponseHeadersToAddCount() Specifies a set of headers that will be added to responses to requests matching this route.
List<HeaderValueOption>	getResponseHeadersToAddList() Specifies a set of headers that will be added to responses to requests matching this route.
HeaderValueOptionOrBuilder	getResponseHeadersToAddOrBuilder(int index) Specifies a set of headers that will be added to responses to requests matching this route.
List<? extends HeaderValueOptionOrBuilder>	getResponseHeadersToAddOrBuilderList() Specifies a set of headers that will be added to responses to requests matching this route.
String	getResponseHeadersToRemove(int index) Specifies a list of HTTP headers that should be removed from each response to requests matching this route.
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.
int	getResponseHeadersToRemoveCount() Specifies a list of HTTP headers that should be removed from each response to requests matching this route.
List<String>	getResponseHeadersToRemoveList() Specifies a list of HTTP headers that should be removed from each response to requests matching this route.
RouteAction	getRoute() Route request to some upstream cluster.
RouteActionOrBuilder	getRouteOrBuilder() Route request to some upstream cluster.
Tracing	getTracing() Presence of the object defines whether the connection manager's tracing configuration is overridden by this route specific instance.
TracingOrBuilder	getTracingOrBuilder() Presence of the object defines whether the connection manager's tracing configuration is overridden by this route specific instance.
Map<String,com.google.protobuf.Any>	getTypedPerFilterConfig() Deprecated.
int	getTypedPerFilterConfigCount() The typed_per_filter_config field can be used to provide route-specific configurations for filters.
Map<String,com.google.protobuf.Any>	getTypedPerFilterConfigMap() The typed_per_filter_config field can be used to provide route-specific configurations for filters.
com.google.protobuf.Any	getTypedPerFilterConfigOrDefault(String key, com.google.protobuf.Any defaultValue) The typed_per_filter_config field can be used to provide route-specific configurations for filters.
com.google.protobuf.Any	getTypedPerFilterConfigOrThrow(String key) The typed_per_filter_config field can be used to provide route-specific configurations for filters.
boolean	hasDecorator() Decorator for the matched route.
boolean	hasDirectResponse() Return an arbitrary HTTP response directly, without proxying.
boolean	hasFilterAction() [#not-implemented-hide:] If true, a filter will define the action (e.g., it could dynamically generate the RouteAction).
boolean	hasMatch() Route matching parameters.
boolean	hasMetadata() The Metadata field can be used to provide additional information about the route.
boolean	hasPerRequestBufferLimitBytes() The maximum bytes which will be buffered for retries and shadowing.
boolean	hasRedirect() Return a redirect.
boolean	hasRoute() Route request to some upstream cluster.
boolean	hasTracing() Presence of the object defines whether the connection manager's tracing configuration is overridden by this route specific instance.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Name for the route.
 

string name = 14;

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Name for the route.
 

string name = 14;

hasMatch

boolean hasMatch()

 Route matching parameters.
 

.envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }

getMatch

RouteMatch getMatch()

 Route matching parameters.
 

.envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }

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;

getRoute

RouteAction getRoute()

 Route request to some upstream cluster.
 

.envoy.config.route.v3.RouteAction route = 2;

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;

getRedirect

RedirectAction getRedirect()

 Return a redirect.
 

.envoy.config.route.v3.RedirectAction redirect = 3;

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;

getDirectResponse

DirectResponseAction getDirectResponse()

 Return an arbitrary HTTP response directly, without proxying.
 

.envoy.config.route.v3.DirectResponseAction direct_response = 7;

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:]
 If true, a filter will define the 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;

getFilterAction

FilterAction getFilterAction()

 [#not-implemented-hide:]
 If true, a filter will define the 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;

getFilterActionOrBuilder

FilterActionOrBuilder getFilterActionOrBuilder()

 [#not-implemented-hide:]
 If true, a filter will define the 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;

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;

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;

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;

getDecorator

Decorator getDecorator()

 Decorator for the matched route.
 

.envoy.config.route.v3.Decorator decorator = 5;

getDecoratorOrBuilder

DecoratorOrBuilder getDecoratorOrBuilder()

 Decorator for the matched route.
 

.envoy.config.route.v3.Decorator decorator = 5;

getTypedPerFilterConfigCount

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;

containsTypedPerFilterConfig

boolean containsTypedPerFilterConfig(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;

getTypedPerFilterConfig

@Deprecated
Map<String,com.google.protobuf.Any> getTypedPerFilterConfig()

Deprecated.

Use getTypedPerFilterConfigMap() instead.

getTypedPerFilterConfigMap

Map<String,com.google.protobuf.Any> 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;

getTypedPerFilterConfigOrDefault

com.google.protobuf.Any getTypedPerFilterConfigOrDefault(String key,
                                                         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;

getTypedPerFilterConfigOrThrow

com.google.protobuf.Any getTypedPerFilterConfigOrThrow(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;

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_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) = { ... }

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_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) = { ... }

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_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) = { ... }

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_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) = { ... }

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_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) = { ... }

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) = { ... }

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) = { ... }

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) = { ... }

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) = { ... }

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_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) = { ... }

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_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) = { ... }

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_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) = { ... }

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_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) = { ... }

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_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) = { ... }

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) = { ... }

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) = { ... }

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) = { ... }

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) = { ... }

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;

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;

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;

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;

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;

getActionCase

Route.ActionCase getActionCase()