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 type envoy.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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field	Description
`private java.lang.Object`	`action_`
`private int`	`actionCase_`
`private int`	`bitField0_`
`private Decorator`	`decorator_`
`static int`	`DECORATOR_FIELD_NUMBER`
`private static Route`	`DEFAULT_INSTANCE`
`static int`	`DIRECT_RESPONSE_FIELD_NUMBER`
`static int`	`FILTER_ACTION_FIELD_NUMBER`
`private RouteMatch`	`match_`
`static int`	`MATCH_FIELD_NUMBER`
`private byte`	`memoizedIsInitialized`
`private Metadata`	`metadata_`
`static int`	`METADATA_FIELD_NUMBER`
`private java.lang.Object`	`name_`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`NON_FORWARDING_ACTION_FIELD_NUMBER`
`private static com.google.protobuf.Parser<Route>`	`PARSER`
`static int`	`PER_REQUEST_BUFFER_LIMIT_BYTES_FIELD_NUMBER`
`private com.google.protobuf.UInt32Value`	`perRequestBufferLimitBytes_`
`static int`	`REDIRECT_FIELD_NUMBER`
`static int`	`REQUEST_HEADERS_TO_ADD_FIELD_NUMBER`
`static int`	`REQUEST_HEADERS_TO_REMOVE_FIELD_NUMBER`
`private java.util.List<HeaderValueOption>`	`requestHeadersToAdd_`
`private com.google.protobuf.LazyStringArrayList`	`requestHeadersToRemove_`
`static int`	`RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER`
`static int`	`RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER`
`private java.util.List<HeaderValueOption>`	`responseHeadersToAdd_`
`private com.google.protobuf.LazyStringArrayList`	`responseHeadersToRemove_`
`static int`	`ROUTE_FIELD_NUMBER`
`private static long`	`serialVersionUID`
`static int`	`STAT_PREFIX_FIELD_NUMBER`
`private java.lang.Object`	`statPrefix_`
`private Tracing`	`tracing_`
`static int`	`TRACING_FIELD_NUMBER`
`static int`	`TYPED_PER_FILTER_CONFIG_FIELD_NUMBER`
`private com.google.protobuf.MapField<java.lang.String,com.google.protobuf.Any>`	`typedPerFilterConfig_`

Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Constructor Summary

Constructors
Modifier Constructor Description

private Route()

private Route(com.google.protobuf.GeneratedMessage.Builder<?> builder)

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

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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

Constructor Detail

Route

private Route(com.google.protobuf.GeneratedMessage.Builder<?> builder)

Route
```
private Route()
```

Method Detail

getDescriptor

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

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getActionCase
```
public Route.ActionCase getActionCase()
```
Specified by:

getActionCase in interface RouteOrBuilder

getName
```
public java.lang.String getName()
```
```
 Name for the route.
 
```
string name = 14;
Specified by:

getName in interface RouteOrBuilder

Returns:

The name.

getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 Name for the route.
 
```
string name = 14;
Specified by:

getNameBytes in interface RouteOrBuilder

Returns:

The bytes for name.

hasMatch
```
public boolean hasMatch()
```
```
 Route matching parameters.
 
```
.envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }
Specified by:

hasMatch in interface RouteOrBuilder

Returns:

Whether the match field is set.

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

getMatch in interface RouteOrBuilder

Returns:

The match.

getMatchOrBuilder
```
public RouteMatchOrBuilder getMatchOrBuilder()
```
```
 Route matching parameters.
 
```
.envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }
Specified by:

getMatchOrBuilder in interface RouteOrBuilder

hasRoute
```
public boolean hasRoute()
```
```
 Route request to some upstream cluster.
 
```
.envoy.config.route.v3.RouteAction route = 2;
Specified by:

hasRoute in interface RouteOrBuilder

Returns:

Whether the route field is set.

getRoute
```
public RouteAction getRoute()
```
```
 Route request to some upstream cluster.
 
```
.envoy.config.route.v3.RouteAction route = 2;
Specified by:

getRoute in interface RouteOrBuilder

Returns:

The route.

getRouteOrBuilder
```
public RouteActionOrBuilder getRouteOrBuilder()
```
```
 Route request to some upstream cluster.
 
```
.envoy.config.route.v3.RouteAction route = 2;
Specified by:

getRouteOrBuilder in interface RouteOrBuilder

hasRedirect
```
public boolean hasRedirect()
```
```
 Return a redirect.
 
```
.envoy.config.route.v3.RedirectAction redirect = 3;
Specified by:

hasRedirect in interface RouteOrBuilder

Returns:

Whether the redirect field is set.

getRedirect
```
public RedirectAction getRedirect()
```
```
 Return a redirect.
 
```
.envoy.config.route.v3.RedirectAction redirect = 3;
Specified by:

getRedirect in interface RouteOrBuilder

Returns:

The redirect.

getRedirectOrBuilder
```
public RedirectActionOrBuilder getRedirectOrBuilder()
```
```
 Return a redirect.
 
```
.envoy.config.route.v3.RedirectAction redirect = 3;
Specified by:

getRedirectOrBuilder in interface RouteOrBuilder

hasDirectResponse
```
public boolean hasDirectResponse()
```
```
 Return an arbitrary HTTP response directly, without proxying.
 
```
.envoy.config.route.v3.DirectResponseAction direct_response = 7;
Specified by:

hasDirectResponse in interface RouteOrBuilder

Returns:

Whether the directResponse field is set.

getDirectResponse
```
public DirectResponseAction getDirectResponse()
```
```
 Return an arbitrary HTTP response directly, without proxying.
 
```
.envoy.config.route.v3.DirectResponseAction direct_response = 7;
Specified by:

getDirectResponse in interface RouteOrBuilder

Returns:

The directResponse.

getDirectResponseOrBuilder
```
public DirectResponseActionOrBuilder getDirectResponseOrBuilder()
```
```
 Return an arbitrary HTTP response directly, without proxying.
 
```
.envoy.config.route.v3.DirectResponseAction direct_response = 7;
Specified by:

getDirectResponseOrBuilder in interface RouteOrBuilder

hasFilterAction

public boolean hasFilterAction()

 [#not-implemented-hide:]
 A filter-defined action (e.g., it could dynamically generate the RouteAction).
 [#comment: TODO(samflattery): Remove cleanup in route_fuzz_test.cc when
 implemented]

.envoy.config.route.v3.FilterAction filter_action = 17;

Specified by:: hasFilterAction in interface RouteOrBuilder
Returns:: Whether the filterAction field is set.

getFilterAction

public FilterAction getFilterAction()

 [#not-implemented-hide:]
 A filter-defined action (e.g., it could dynamically generate the RouteAction).
 [#comment: TODO(samflattery): Remove cleanup in route_fuzz_test.cc when
 implemented]

.envoy.config.route.v3.FilterAction filter_action = 17;

Specified by:: getFilterAction in interface RouteOrBuilder
Returns:: The filterAction.

getFilterActionOrBuilder

public FilterActionOrBuilder getFilterActionOrBuilder()

 [#not-implemented-hide:]
 A filter-defined action (e.g., it could dynamically generate the RouteAction).
 [#comment: TODO(samflattery): Remove cleanup in route_fuzz_test.cc when
 implemented]

.envoy.config.route.v3.FilterAction filter_action = 17;

Specified by:: getFilterActionOrBuilder in interface RouteOrBuilder

hasNonForwardingAction

public boolean hasNonForwardingAction()

 [#not-implemented-hide:]
 An action used when the route will generate a response directly,
 without forwarding to an upstream host. This will be used in non-proxy
 xDS clients like the gRPC server. It could also be used in the future
 in Envoy for a filter that directly generates responses for requests.

.envoy.config.route.v3.NonForwardingAction non_forwarding_action = 18;

Specified by:: hasNonForwardingAction in interface RouteOrBuilder
Returns:: Whether the nonForwardingAction field is set.

getNonForwardingAction

public NonForwardingAction getNonForwardingAction()

 [#not-implemented-hide:]
 An action used when the route will generate a response directly,
 without forwarding to an upstream host. This will be used in non-proxy
 xDS clients like the gRPC server. It could also be used in the future
 in Envoy for a filter that directly generates responses for requests.

.envoy.config.route.v3.NonForwardingAction non_forwarding_action = 18;

Specified by:: getNonForwardingAction in interface RouteOrBuilder
Returns:: The nonForwardingAction.

getNonForwardingActionOrBuilder

public NonForwardingActionOrBuilder getNonForwardingActionOrBuilder()

 [#not-implemented-hide:]
 An action used when the route will generate a response directly,
 without forwarding to an upstream host. This will be used in non-proxy
 xDS clients like the gRPC server. It could also be used in the future
 in Envoy for a filter that directly generates responses for requests.

.envoy.config.route.v3.NonForwardingAction non_forwarding_action = 18;

Specified by:: getNonForwardingActionOrBuilder in interface RouteOrBuilder

hasMetadata

public boolean hasMetadata()

 The Metadata field can be used to provide additional information
 about the route. It can be used for configuration, stats, and logging.
 The metadata should go under the filter namespace that will need it.
 For instance, if the metadata is intended for the Router filter,
 the filter name should be specified as ``envoy.filters.http.router``.

.envoy.config.core.v3.Metadata metadata = 4;

Specified by:: hasMetadata in interface RouteOrBuilder
Returns:: Whether the metadata field is set.

getMetadata

public Metadata getMetadata()

 The Metadata field can be used to provide additional information
 about the route. It can be used for configuration, stats, and logging.
 The metadata should go under the filter namespace that will need it.
 For instance, if the metadata is intended for the Router filter,
 the filter name should be specified as ``envoy.filters.http.router``.

.envoy.config.core.v3.Metadata metadata = 4;

Specified by:: getMetadata in interface RouteOrBuilder
Returns:: The metadata.

getMetadataOrBuilder

public MetadataOrBuilder getMetadataOrBuilder()

 The Metadata field can be used to provide additional information
 about the route. It can be used for configuration, stats, and logging.
 The metadata should go under the filter namespace that will need it.
 For instance, if the metadata is intended for the Router filter,
 the filter name should be specified as ``envoy.filters.http.router``.

.envoy.config.core.v3.Metadata metadata = 4;

Specified by:: getMetadataOrBuilder in interface RouteOrBuilder

hasDecorator
```
public boolean hasDecorator()
```
```
 Decorator for the matched route.
 
```
.envoy.config.route.v3.Decorator decorator = 5;
Specified by:

hasDecorator in interface RouteOrBuilder

Returns:

Whether the decorator field is set.

getDecorator
```
public Decorator getDecorator()
```
```
 Decorator for the matched route.
 
```
.envoy.config.route.v3.Decorator decorator = 5;
Specified by:

getDecorator in interface RouteOrBuilder

Returns:

The decorator.

getDecoratorOrBuilder
```
public DecoratorOrBuilder getDecoratorOrBuilder()
```
```
 Decorator for the matched route.
 
```
.envoy.config.route.v3.Decorator decorator = 5;
Specified by:

getDecoratorOrBuilder in interface RouteOrBuilder

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 interface RouteOrBuilder

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 interface RouteOrBuilder

getTypedPerFilterConfig
```
@Deprecated
public java.util.Map<java.lang.String,com.google.protobuf.Any> getTypedPerFilterConfig()
```
Deprecated.

Use getTypedPerFilterConfigMap() instead.

Specified by:

getTypedPerFilterConfig in interface RouteOrBuilder

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 interface RouteOrBuilder

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 interface RouteOrBuilder

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 interface RouteOrBuilder

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 interface RouteOrBuilder

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 interface RouteOrBuilder

getRequestHeadersToAddCount

public int getRequestHeadersToAddCount()

 Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.

repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 9 [(.validate.rules) = { ... }

Specified by:: getRequestHeadersToAddCount in interface RouteOrBuilder

getRequestHeadersToAdd

public HeaderValueOption getRequestHeadersToAdd(int index)

 Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.

repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 9 [(.validate.rules) = { ... }

Specified by:: getRequestHeadersToAdd in interface RouteOrBuilder

getRequestHeadersToAddOrBuilder

public HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder(int index)

 Specifies a set of headers that will be added to requests matching this
 route. Headers specified at this level are applied before headers from the
 enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
 :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including details on
 header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.

repeated .envoy.config.core.v3.HeaderValueOption request_headers_to_add = 9 [(.validate.rules) = { ... }

Specified by:: getRequestHeadersToAddOrBuilder in interface RouteOrBuilder

getRequestHeadersToRemoveList
```
public com.google.protobuf.ProtocolStringList getRequestHeadersToRemoveList()
```
```
 Specifies a list of HTTP headers that should be removed from each request
 matching this route.
 
```
repeated string request_headers_to_remove = 12 [(.validate.rules) = { ... }
Specified by:

getRequestHeadersToRemoveList in interface RouteOrBuilder

Returns:

A list containing the requestHeadersToRemove.

getRequestHeadersToRemoveCount
```
public int getRequestHeadersToRemoveCount()
```
```
 Specifies a list of HTTP headers that should be removed from each request
 matching this route.
 
```
repeated string request_headers_to_remove = 12 [(.validate.rules) = { ... }
Specified by:

getRequestHeadersToRemoveCount in interface RouteOrBuilder

Returns:

The count of requestHeadersToRemove.

getRequestHeadersToRemove
```
public 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 interface RouteOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The requestHeadersToRemove at the given index.

getRequestHeadersToRemoveBytes
```
public com.google.protobuf.ByteString getRequestHeadersToRemoveBytes(int index)
```
```
 Specifies a list of HTTP headers that should be removed from each request
 matching this route.
 
```
repeated string request_headers_to_remove = 12 [(.validate.rules) = { ... }
Specified by:

getRequestHeadersToRemoveBytes in interface RouteOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the requestHeadersToRemove at the given index.