Class Route
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessage
-
- io.envoyproxy.envoy.config.route.v3.Route
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RouteOrBuilder
,java.io.Serializable
public final class Route extends com.google.protobuf.GeneratedMessage 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 typeenvoy.config.route.v3.Route
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Route.ActionCase
static class
Route.Builder
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.).private static class
Route.TypedPerFilterConfigDefaultEntryHolder
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
containsTypedPerFilterConfig(java.lang.String key)
This field can be used to provide route specific per filter config.boolean
equals(java.lang.Object obj)
Route.ActionCase
getActionCase()
Decorator
getDecorator()
Decorator for the matched route.DecoratorOrBuilder
getDecoratorOrBuilder()
Decorator for the matched route.static Route
getDefaultInstance()
Route
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
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:] A filter-defined action (e.g., it could dynamically generate the RouteAction).FilterActionOrBuilder
getFilterActionOrBuilder()
[#not-implemented-hide:] A filter-defined 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.java.lang.String
getName()
Name for the route.com.google.protobuf.ByteString
getNameBytes()
Name for the route.NonForwardingAction
getNonForwardingAction()
[#not-implemented-hide:] An action used when the route will generate a response directly, without forwarding to an upstream host.NonForwardingActionOrBuilder
getNonForwardingActionOrBuilder()
[#not-implemented-hide:] An action used when the route will generate a response directly, without forwarding to an upstream host.com.google.protobuf.Parser<Route>
getParserForType()
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.java.util.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.java.util.List<? extends HeaderValueOptionOrBuilder>
getRequestHeadersToAddOrBuilderList()
Specifies a set of headers that will be added to requests matching this route.java.lang.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.com.google.protobuf.ProtocolStringList
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.java.util.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.java.util.List<? extends HeaderValueOptionOrBuilder>
getResponseHeadersToAddOrBuilderList()
Specifies a set of headers that will be added to responses to requests matching this route.java.lang.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.com.google.protobuf.ProtocolStringList
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.int
getSerializedSize()
java.lang.String
getStatPrefix()
The human readable prefix to use when emitting statistics for this endpoint.com.google.protobuf.ByteString
getStatPrefixBytes()
The human readable prefix to use when emitting statistics for this endpoint.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.java.util.Map<java.lang.String,com.google.protobuf.Any>
getTypedPerFilterConfig()
Deprecated.int
getTypedPerFilterConfigCount()
This field can be used to provide route specific per filter config.java.util.Map<java.lang.String,com.google.protobuf.Any>
getTypedPerFilterConfigMap()
This field can be used to provide route specific per filter config.com.google.protobuf.Any
getTypedPerFilterConfigOrDefault(java.lang.String key, com.google.protobuf.Any defaultValue)
This field can be used to provide route specific per filter config.com.google.protobuf.Any
getTypedPerFilterConfigOrThrow(java.lang.String key)
This field can be used to provide route specific per filter config.boolean
hasDecorator()
Decorator for the matched route.boolean
hasDirectResponse()
Return an arbitrary HTTP response directly, without proxying.boolean
hasFilterAction()
[#not-implemented-hide:] A filter-defined action (e.g., it could dynamically generate the RouteAction).int
hashCode()
boolean
hasMatch()
Route matching parameters.boolean
hasMetadata()
The Metadata field can be used to provide additional information about the route.boolean
hasNonForwardingAction()
[#not-implemented-hide:] An action used when the route will generate a response directly, without forwarding to an upstream host.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.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor
internalGetMapFieldReflection(int number)
private com.google.protobuf.MapField<java.lang.String,com.google.protobuf.Any>
internalGetTypedPerFilterConfig()
boolean
isInitialized()
static Route.Builder
newBuilder()
static Route.Builder
newBuilder(Route prototype)
Route.Builder
newBuilderForType()
protected Route.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Route
parseDelimitedFrom(java.io.InputStream input)
static Route
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Route
parseFrom(byte[] data)
static Route
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Route
parseFrom(com.google.protobuf.ByteString data)
static Route
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Route
parseFrom(com.google.protobuf.CodedInputStream input)
static Route
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Route
parseFrom(java.io.InputStream input)
static Route
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Route
parseFrom(java.nio.ByteBuffer data)
static Route
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Route>
parser()
Route.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
bitField0_
private int bitField0_
-
actionCase_
private int actionCase_
-
action_
private java.lang.Object action_
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
name_
private volatile java.lang.Object name_
-
MATCH_FIELD_NUMBER
public static final int MATCH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
match_
private RouteMatch match_
-
ROUTE_FIELD_NUMBER
public static final int ROUTE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
REDIRECT_FIELD_NUMBER
public static final int REDIRECT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
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
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
- See Also:
- Constant Field Values
-
metadata_
private Metadata metadata_
-
DECORATOR_FIELD_NUMBER
public static final int DECORATOR_FIELD_NUMBER
- See Also:
- Constant Field Values
-
decorator_
private Decorator decorator_
-
TYPED_PER_FILTER_CONFIG_FIELD_NUMBER
public static final int TYPED_PER_FILTER_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
typedPerFilterConfig_
private com.google.protobuf.MapField<java.lang.String,com.google.protobuf.Any> typedPerFilterConfig_
-
REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
public static final int REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
- See Also:
- Constant Field Values
-
requestHeadersToAdd_
private java.util.List<HeaderValueOption> requestHeadersToAdd_
-
REQUEST_HEADERS_TO_REMOVE_FIELD_NUMBER
public static final int REQUEST_HEADERS_TO_REMOVE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
requestHeadersToRemove_
private com.google.protobuf.LazyStringArrayList requestHeadersToRemove_
-
RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER
public static final int RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER
- See Also:
- Constant Field Values
-
responseHeadersToAdd_
private java.util.List<HeaderValueOption> responseHeadersToAdd_
-
RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER
public static final int RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
responseHeadersToRemove_
private com.google.protobuf.LazyStringArrayList responseHeadersToRemove_
-
TRACING_FIELD_NUMBER
public static final int TRACING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
tracing_
private Tracing tracing_
-
PER_REQUEST_BUFFER_LIMIT_BYTES_FIELD_NUMBER
public static final int PER_REQUEST_BUFFER_LIMIT_BYTES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
perRequestBufferLimitBytes_
private com.google.protobuf.UInt32Value perRequestBufferLimitBytes_
-
STAT_PREFIX_FIELD_NUMBER
public static final int STAT_PREFIX_FIELD_NUMBER
- See Also:
- Constant Field Values
-
statPrefix_
private volatile java.lang.Object statPrefix_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final Route DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<Route> PARSER
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
- Overrides:
internalGetMapFieldReflection
in classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getActionCase
public Route.ActionCase getActionCase()
- Specified by:
getActionCase
in interfaceRouteOrBuilder
-
getName
public java.lang.String getName()
Name for the route.
string name = 14;
- Specified by:
getName
in interfaceRouteOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
Name for the route.
string name = 14;
- Specified by:
getNameBytes
in interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- Returns:
- The match.
-
getMatchOrBuilder
public RouteMatchOrBuilder getMatchOrBuilder()
Route matching parameters.
.envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }
- Specified by:
getMatchOrBuilder
in interfaceRouteOrBuilder
-
hasRoute
public boolean hasRoute()
Route request to some upstream cluster.
.envoy.config.route.v3.RouteAction route = 2;
- Specified by:
hasRoute
in interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- Returns:
- The route.
-
getRouteOrBuilder
public RouteActionOrBuilder getRouteOrBuilder()
Route request to some upstream cluster.
.envoy.config.route.v3.RouteAction route = 2;
- Specified by:
getRouteOrBuilder
in interfaceRouteOrBuilder
-
hasRedirect
public boolean hasRedirect()
Return a redirect.
.envoy.config.route.v3.RedirectAction redirect = 3;
- Specified by:
hasRedirect
in interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- Returns:
- The redirect.
-
getRedirectOrBuilder
public RedirectActionOrBuilder getRedirectOrBuilder()
Return a redirect.
.envoy.config.route.v3.RedirectAction redirect = 3;
- Specified by:
getRedirectOrBuilder
in interfaceRouteOrBuilder
-
hasDirectResponse
public boolean hasDirectResponse()
Return an arbitrary HTTP response directly, without proxying.
.envoy.config.route.v3.DirectResponseAction direct_response = 7;
- Specified by:
hasDirectResponse
in interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- Returns:
- The directResponse.
-
getDirectResponseOrBuilder
public DirectResponseActionOrBuilder getDirectResponseOrBuilder()
Return an arbitrary HTTP response directly, without proxying.
.envoy.config.route.v3.DirectResponseAction direct_response = 7;
- Specified by:
getDirectResponseOrBuilder
in interfaceRouteOrBuilder
-
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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
-
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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
-
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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
-
hasDecorator
public boolean hasDecorator()
Decorator for the matched route.
.envoy.config.route.v3.Decorator decorator = 5;
- Specified by:
hasDecorator
in interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- Returns:
- The decorator.
-
getDecoratorOrBuilder
public DecoratorOrBuilder getDecoratorOrBuilder()
Decorator for the matched route.
.envoy.config.route.v3.Decorator decorator = 5;
- Specified by:
getDecoratorOrBuilder
in interfaceRouteOrBuilder
-
internalGetTypedPerFilterConfig
private com.google.protobuf.MapField<java.lang.String,com.google.protobuf.Any> internalGetTypedPerFilterConfig()
-
getTypedPerFilterConfigCount
public int getTypedPerFilterConfigCount()
Description copied from interface:RouteOrBuilder
This field can be used to provide route specific per filter config. The key should match the :ref:`filter config name <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`. See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>` for details. [#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 interfaceRouteOrBuilder
-
containsTypedPerFilterConfig
public boolean containsTypedPerFilterConfig(java.lang.String key)
This field can be used to provide route specific per filter config. The key should match the :ref:`filter config name <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`. See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>` for details. [#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 interfaceRouteOrBuilder
-
getTypedPerFilterConfig
@Deprecated public java.util.Map<java.lang.String,com.google.protobuf.Any> getTypedPerFilterConfig()
Deprecated.UsegetTypedPerFilterConfigMap()
instead.- Specified by:
getTypedPerFilterConfig
in interfaceRouteOrBuilder
-
getTypedPerFilterConfigMap
public java.util.Map<java.lang.String,com.google.protobuf.Any> getTypedPerFilterConfigMap()
This field can be used to provide route specific per filter config. The key should match the :ref:`filter config name <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`. See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>` for details. [#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 interfaceRouteOrBuilder
-
getTypedPerFilterConfigOrDefault
public com.google.protobuf.Any getTypedPerFilterConfigOrDefault(java.lang.String key, com.google.protobuf.Any defaultValue)
This field can be used to provide route specific per filter config. The key should match the :ref:`filter config name <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`. See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>` for details. [#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 interfaceRouteOrBuilder
-
getTypedPerFilterConfigOrThrow
public com.google.protobuf.Any getTypedPerFilterConfigOrThrow(java.lang.String key)
This field can be used to provide route specific per filter config. The key should match the :ref:`filter config name <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`. See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>` for details. [#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 interfaceRouteOrBuilder
-
getRequestHeadersToAddList
public java.util.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 interfaceRouteOrBuilder
-
getRequestHeadersToAddOrBuilderList
public java.util.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 interfaceRouteOrBuilder
-
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 interfaceRouteOrBuilder
-
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 interfaceRouteOrBuilder
-
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 interfaceRouteOrBuilder
-
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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- Returns:
- The count of requestHeadersToRemove.
-
getRequestHeadersToRemove
public 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 [(.validate.rules) = { ... }
- Specified by:
getRequestHeadersToRemove
in interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the requestHeadersToRemove at the given index.
-
getResponseHeadersToAddList
public java.util.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 interfaceRouteOrBuilder
-
getResponseHeadersToAddOrBuilderList
public java.util.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 interfaceRouteOrBuilder
-
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 interfaceRouteOrBuilder
-
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 interfaceRouteOrBuilder
-
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 interfaceRouteOrBuilder
-
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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- Returns:
- The count of responseHeadersToRemove.
-
getResponseHeadersToRemove
public 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 [(.validate.rules) = { ... }
- Specified by:
getResponseHeadersToRemove
in interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
-
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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
-
getStatPrefix
public java.lang.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 interfaceRouteOrBuilder
- 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 interfaceRouteOrBuilder
- Returns:
- The bytes for statPrefix.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Route parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Route parseFrom(java.nio.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(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Route parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Route parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Route parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Route parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Route parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public Route.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Route.Builder newBuilder()
-
newBuilder
public static Route.Builder newBuilder(Route prototype)
-
toBuilder
public Route.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Route.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
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 interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
public Route getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-