RouteOuterClass.RouteAction (api 0.1.4 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - envoy.api.v2.route.RouteOuterClass.RouteAction

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteOuterClass.RouteActionOrBuilder, Serializable

Enclosing class:

RouteOuterClass
```
public static final class RouteOuterClass.RouteAction
extends com.google.protobuf.GeneratedMessageV3
implements RouteOuterClass.RouteActionOrBuilder
```
Protobuf type envoy.api.v2.route.RouteAction

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RouteOuterClass.RouteAction.Builder` Protobuf type `envoy.api.v2.route.RouteAction`
`static class`	`RouteOuterClass.RouteAction.ClusterNotFoundResponseCode` Protobuf enum `envoy.api.v2.route.RouteAction.ClusterNotFoundResponseCode`
`static class`	`RouteOuterClass.RouteAction.ClusterSpecifierCase`
`static class`	`RouteOuterClass.RouteAction.HashPolicy` Specifies the route's hashing policy if the upstream cluster uses a hashing :ref:`load balancer <arch_overview_load_balancing_types>`.
`static interface`	`RouteOuterClass.RouteAction.HashPolicyOrBuilder`
`static class`	`RouteOuterClass.RouteAction.HostRewriteSpecifierCase`
`static class`	`RouteOuterClass.RouteAction.RequestMirrorPolicy` The router is capable of shadowing traffic from one cluster to another.
`static interface`	`RouteOuterClass.RouteAction.RequestMirrorPolicyOrBuilder`
`static class`	`RouteOuterClass.RouteAction.RetryPolicy` HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.
`static interface`	`RouteOuterClass.RouteAction.RetryPolicyOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AUTO_HOST_REWRITE_FIELD_NUMBER`
`static int`	`CLUSTER_FIELD_NUMBER`
`static int`	`CLUSTER_HEADER_FIELD_NUMBER`
`static int`	`CLUSTER_NOT_FOUND_RESPONSE_CODE_FIELD_NUMBER`
`static int`	`CORS_FIELD_NUMBER`
`static int`	`HASH_POLICY_FIELD_NUMBER`
`static int`	`HOST_REWRITE_FIELD_NUMBER`
`static int`	`INCLUDE_VH_RATE_LIMITS_FIELD_NUMBER`
`static int`	`METADATA_MATCH_FIELD_NUMBER`
`static int`	`PREFIX_REWRITE_FIELD_NUMBER`
`static int`	`PRIORITY_FIELD_NUMBER`
`static int`	`RATE_LIMITS_FIELD_NUMBER`
`static int`	`REQUEST_HEADERS_TO_ADD_FIELD_NUMBER`
`static int`	`REQUEST_MIRROR_POLICY_FIELD_NUMBER`
`static int`	`RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER`
`static int`	`RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER`
`static int`	`RETRY_POLICY_FIELD_NUMBER`
`static int`	`TIMEOUT_FIELD_NUMBER`
`static int`	`USE_WEBSOCKET_FIELD_NUMBER`
`static int`	`WEIGHTED_CLUSTERS_FIELD_NUMBER`

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

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`com.google.protobuf.BoolValue`	`getAutoHostRewrite()` Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.
`com.google.protobuf.BoolValueOrBuilder`	`getAutoHostRewriteOrBuilder()` Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.
`String`	`getCluster()` Indicates the upstream cluster to which the request should be routed to.
`com.google.protobuf.ByteString`	`getClusterBytes()` Indicates the upstream cluster to which the request should be routed to.
`String`	`getClusterHeader()` Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers.
`com.google.protobuf.ByteString`	`getClusterHeaderBytes()` Envoy will determine the cluster to route to by reading the value of the HTTP header named by cluster_header from the request headers.
`RouteOuterClass.RouteAction.ClusterNotFoundResponseCode`	`getClusterNotFoundResponseCode()` The HTTP status code to use when configured cluster is not found.
`int`	`getClusterNotFoundResponseCodeValue()` The HTTP status code to use when configured cluster is not found.
`RouteOuterClass.RouteAction.ClusterSpecifierCase`	`getClusterSpecifierCase()`
`RouteOuterClass.CorsPolicy`	`getCors()` Indicates that the route has a CORS policy.
`RouteOuterClass.CorsPolicyOrBuilder`	`getCorsOrBuilder()` Indicates that the route has a CORS policy.
`static RouteOuterClass.RouteAction`	`getDefaultInstance()`
`RouteOuterClass.RouteAction`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`RouteOuterClass.RouteAction.HashPolicy`	`getHashPolicy(int index)` Specifies a list of hash policies to use for ring hash load balancing.
`int`	`getHashPolicyCount()` Specifies a list of hash policies to use for ring hash load balancing.
`List<RouteOuterClass.RouteAction.HashPolicy>`	`getHashPolicyList()` Specifies a list of hash policies to use for ring hash load balancing.
`RouteOuterClass.RouteAction.HashPolicyOrBuilder`	`getHashPolicyOrBuilder(int index)` Specifies a list of hash policies to use for ring hash load balancing.
`List<? extends RouteOuterClass.RouteAction.HashPolicyOrBuilder>`	`getHashPolicyOrBuilderList()` Specifies a list of hash policies to use for ring hash load balancing.
`String`	`getHostRewrite()` Indicates that during forwarding, the host header will be swapped with this value.
`com.google.protobuf.ByteString`	`getHostRewriteBytes()` Indicates that during forwarding, the host header will be swapped with this value.
`RouteOuterClass.RouteAction.HostRewriteSpecifierCase`	`getHostRewriteSpecifierCase()`
`com.google.protobuf.BoolValue`	`getIncludeVhRateLimits()` Specifies if the rate limit filter should include the virtual host rate limits.
`com.google.protobuf.BoolValueOrBuilder`	`getIncludeVhRateLimitsOrBuilder()` Specifies if the rate limit filter should include the virtual host rate limits.
`Base.Metadata`	`getMetadataMatch()` Optional endpoint metadata match criteria.
`Base.MetadataOrBuilder`	`getMetadataMatchOrBuilder()` Optional endpoint metadata match criteria.
`com.google.protobuf.Parser<RouteOuterClass.RouteAction>`	`getParserForType()`
`String`	`getPrefixRewrite()` Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.
`com.google.protobuf.ByteString`	`getPrefixRewriteBytes()` Indicates that during forwarding, the matched prefix (or path) should be swapped with this value.
`Base.RoutingPriority`	`getPriority()` Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
`int`	`getPriorityValue()` Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
`RouteOuterClass.RateLimit`	`getRateLimits(int index)` Specifies a set of rate limit configurations that could be applied to the route.
`int`	`getRateLimitsCount()` Specifies a set of rate limit configurations that could be applied to the route.
`List<RouteOuterClass.RateLimit>`	`getRateLimitsList()` Specifies a set of rate limit configurations that could be applied to the route.
`RouteOuterClass.RateLimitOrBuilder`	`getRateLimitsOrBuilder(int index)` Specifies a set of rate limit configurations that could be applied to the route.
`List<? extends RouteOuterClass.RateLimitOrBuilder>`	`getRateLimitsOrBuilderList()` Specifies a set of rate limit configurations that could be applied to the route.
`Base.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<Base.HeaderValueOption>`	`getRequestHeadersToAddList()` Specifies a set of headers that will be added to requests matching this route.
`Base.HeaderValueOptionOrBuilder`	`getRequestHeadersToAddOrBuilder(int index)` Specifies a set of headers that will be added to requests matching this route.
`List<? extends Base.HeaderValueOptionOrBuilder>`	`getRequestHeadersToAddOrBuilderList()` Specifies a set of headers that will be added to requests matching this route.
`RouteOuterClass.RouteAction.RequestMirrorPolicy`	`getRequestMirrorPolicy()` Indicates that the route has a request mirroring policy.
`RouteOuterClass.RouteAction.RequestMirrorPolicyOrBuilder`	`getRequestMirrorPolicyOrBuilder()` Indicates that the route has a request mirroring policy.
`Base.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<Base.HeaderValueOption>`	`getResponseHeadersToAddList()` Specifies a set of headers that will be added to responses to requests matching this route.
`Base.HeaderValueOptionOrBuilder`	`getResponseHeadersToAddOrBuilder(int index)` Specifies a set of headers that will be added to responses to requests matching this route.
`List<? extends Base.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.
`com.google.protobuf.ProtocolStringList`	`getResponseHeadersToRemoveList()` Specifies a list of HTTP headers that should be removed from each response to requests matching this route.
`RouteOuterClass.RouteAction.RetryPolicy`	`getRetryPolicy()` Indicates that the route has a retry policy.
`RouteOuterClass.RouteAction.RetryPolicyOrBuilder`	`getRetryPolicyOrBuilder()` Indicates that the route has a retry policy.
`int`	`getSerializedSize()`
`com.google.protobuf.Duration`	`getTimeout()` Specifies the timeout for the route.
`com.google.protobuf.DurationOrBuilder`	`getTimeoutOrBuilder()` Specifies the timeout for the route.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`com.google.protobuf.BoolValue`	`getUseWebsocket()` Indicates that a HTTP/1.1 client connection to this particular route should be allowed (and expected) to upgrade to a WebSocket connection.
`com.google.protobuf.BoolValueOrBuilder`	`getUseWebsocketOrBuilder()` Indicates that a HTTP/1.1 client connection to this particular route should be allowed (and expected) to upgrade to a WebSocket connection.
`RouteOuterClass.WeightedCluster`	`getWeightedClusters()` Multiple upstream clusters can be specified for a given route.
`RouteOuterClass.WeightedClusterOrBuilder`	`getWeightedClustersOrBuilder()` Multiple upstream clusters can be specified for a given route.
`boolean`	`hasAutoHostRewrite()` Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster manager.
`boolean`	`hasCors()` Indicates that the route has a CORS policy.
`int`	`hashCode()`
`boolean`	`hasIncludeVhRateLimits()` Specifies if the rate limit filter should include the virtual host rate limits.
`boolean`	`hasMetadataMatch()` Optional endpoint metadata match criteria.
`boolean`	`hasRequestMirrorPolicy()` Indicates that the route has a request mirroring policy.
`boolean`	`hasRetryPolicy()` Indicates that the route has a retry policy.
`boolean`	`hasTimeout()` Specifies the timeout for the route.
`boolean`	`hasUseWebsocket()` Indicates that a HTTP/1.1 client connection to this particular route should be allowed (and expected) to upgrade to a WebSocket connection.
`boolean`	`hasWeightedClusters()` Multiple upstream clusters can be specified for a given route.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static RouteOuterClass.RouteAction.Builder`	`newBuilder()`
`static RouteOuterClass.RouteAction.Builder`	`newBuilder(RouteOuterClass.RouteAction prototype)`
`RouteOuterClass.RouteAction.Builder`	`newBuilderForType()`
`protected RouteOuterClass.RouteAction.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static RouteOuterClass.RouteAction`	`parseDelimitedFrom(InputStream input)`
`static RouteOuterClass.RouteAction`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteAction`	`parseFrom(byte[] data)`
`static RouteOuterClass.RouteAction`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteAction`	`parseFrom(ByteBuffer data)`
`static RouteOuterClass.RouteAction`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteAction`	`parseFrom(com.google.protobuf.ByteString data)`
`static RouteOuterClass.RouteAction`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteAction`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static RouteOuterClass.RouteAction`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static RouteOuterClass.RouteAction`	`parseFrom(InputStream input)`
`static RouteOuterClass.RouteAction`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<RouteOuterClass.RouteAction>`	`parser()`
`RouteOuterClass.RouteAction.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, 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.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

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

Field Detail
- CLUSTER_FIELD_NUMBER
```
public static final int CLUSTER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CLUSTER_HEADER_FIELD_NUMBER
```
public static final int CLUSTER_HEADER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- WEIGHTED_CLUSTERS_FIELD_NUMBER
```
public static final int WEIGHTED_CLUSTERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CLUSTER_NOT_FOUND_RESPONSE_CODE_FIELD_NUMBER
```
public static final int CLUSTER_NOT_FOUND_RESPONSE_CODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- METADATA_MATCH_FIELD_NUMBER
```
public static final int METADATA_MATCH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PREFIX_REWRITE_FIELD_NUMBER
```
public static final int PREFIX_REWRITE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HOST_REWRITE_FIELD_NUMBER
```
public static final int HOST_REWRITE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- AUTO_HOST_REWRITE_FIELD_NUMBER
```
public static final int AUTO_HOST_REWRITE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TIMEOUT_FIELD_NUMBER
```
public static final int TIMEOUT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RETRY_POLICY_FIELD_NUMBER
```
public static final int RETRY_POLICY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REQUEST_MIRROR_POLICY_FIELD_NUMBER
```
public static final int REQUEST_MIRROR_POLICY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PRIORITY_FIELD_NUMBER
```
public static final int PRIORITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
```
public static final int REQUEST_HEADERS_TO_ADD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER
```
public static final int RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER
```
public static final int RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RATE_LIMITS_FIELD_NUMBER
```
public static final int RATE_LIMITS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INCLUDE_VH_RATE_LIMITS_FIELD_NUMBER
```
public static final int INCLUDE_VH_RATE_LIMITS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HASH_POLICY_FIELD_NUMBER
```
public static final int HASH_POLICY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USE_WEBSOCKET_FIELD_NUMBER
```
public static final int USE_WEBSOCKET_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CORS_FIELD_NUMBER
```
public static final int CORS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

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

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getClusterSpecifierCase
```
public RouteOuterClass.RouteAction.ClusterSpecifierCase getClusterSpecifierCase()
```
Specified by:

getClusterSpecifierCase in interface RouteOuterClass.RouteActionOrBuilder

getHostRewriteSpecifierCase
```
public RouteOuterClass.RouteAction.HostRewriteSpecifierCase getHostRewriteSpecifierCase()
```
Specified by:

getHostRewriteSpecifierCase in interface RouteOuterClass.RouteActionOrBuilder

getCluster

public String getCluster()

 Indicates the upstream cluster to which the request should be routed
 to.

string cluster = 1;

Specified by:: getCluster in interface RouteOuterClass.RouteActionOrBuilder

getClusterBytes

public com.google.protobuf.ByteString getClusterBytes()

 Indicates the upstream cluster to which the request should be routed
 to.

string cluster = 1;

Specified by:: getClusterBytes in interface RouteOuterClass.RouteActionOrBuilder

getClusterHeader

public String getClusterHeader()

 Envoy will determine the cluster to route to by reading the value of the
 HTTP header named by cluster_header from the request headers. If the
 header is not found or the referenced cluster does not exist, Envoy will
 return a 404 response.
 .. attention::
   Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1
   *Host* header. Thus, if attempting to match on *Host*, match on *:authority* instead.

string cluster_header = 2;

Specified by:: getClusterHeader in interface RouteOuterClass.RouteActionOrBuilder

getClusterHeaderBytes

public com.google.protobuf.ByteString getClusterHeaderBytes()

 Envoy will determine the cluster to route to by reading the value of the
 HTTP header named by cluster_header from the request headers. If the
 header is not found or the referenced cluster does not exist, Envoy will
 return a 404 response.
 .. attention::
   Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1
   *Host* header. Thus, if attempting to match on *Host*, match on *:authority* instead.

string cluster_header = 2;

Specified by:: getClusterHeaderBytes in interface RouteOuterClass.RouteActionOrBuilder

hasWeightedClusters

public boolean hasWeightedClusters()

 Multiple upstream clusters can be specified for a given route. The
 request is routed to one of the upstream clusters based on weights
 assigned to each cluster. See
 :ref:`traffic splitting <config_http_conn_man_route_table_traffic_splitting_split>`
 for additional documentation.

.envoy.api.v2.route.WeightedCluster weighted_clusters = 3;

Specified by:: hasWeightedClusters in interface RouteOuterClass.RouteActionOrBuilder

getWeightedClusters

public RouteOuterClass.WeightedCluster getWeightedClusters()

 Multiple upstream clusters can be specified for a given route. The
 request is routed to one of the upstream clusters based on weights
 assigned to each cluster. See
 :ref:`traffic splitting <config_http_conn_man_route_table_traffic_splitting_split>`
 for additional documentation.

.envoy.api.v2.route.WeightedCluster weighted_clusters = 3;

Specified by:: getWeightedClusters in interface RouteOuterClass.RouteActionOrBuilder

getWeightedClustersOrBuilder

public RouteOuterClass.WeightedClusterOrBuilder getWeightedClustersOrBuilder()

 Multiple upstream clusters can be specified for a given route. The
 request is routed to one of the upstream clusters based on weights
 assigned to each cluster. See
 :ref:`traffic splitting <config_http_conn_man_route_table_traffic_splitting_split>`
 for additional documentation.

.envoy.api.v2.route.WeightedCluster weighted_clusters = 3;

Specified by:: getWeightedClustersOrBuilder in interface RouteOuterClass.RouteActionOrBuilder

getClusterNotFoundResponseCodeValue
```
public int getClusterNotFoundResponseCodeValue()
```
```
 The HTTP status code to use when configured cluster is not found.
 The default response code is 503 Service Unavailable.
 
```
.envoy.api.v2.route.RouteAction.ClusterNotFoundResponseCode cluster_not_found_response_code = 20 [(.validate.rules) = { ... }
Specified by:

getClusterNotFoundResponseCodeValue in interface RouteOuterClass.RouteActionOrBuilder

getClusterNotFoundResponseCode
```
public RouteOuterClass.RouteAction.ClusterNotFoundResponseCode getClusterNotFoundResponseCode()
```
```
 The HTTP status code to use when configured cluster is not found.
 The default response code is 503 Service Unavailable.
 
```
.envoy.api.v2.route.RouteAction.ClusterNotFoundResponseCode cluster_not_found_response_code = 20 [(.validate.rules) = { ... }
Specified by:

getClusterNotFoundResponseCode in interface RouteOuterClass.RouteActionOrBuilder

hasMetadataMatch

public boolean hasMetadataMatch()

 Optional endpoint metadata match criteria. Only endpoints in the upstream
 cluster with metadata matching that set in metadata_match will be
 considered. The filter name should be specified as *envoy.lb*.

.envoy.api.v2.core.Metadata metadata_match = 4;

Specified by:: hasMetadataMatch in interface RouteOuterClass.RouteActionOrBuilder

getMetadataMatch

public Base.Metadata getMetadataMatch()

 Optional endpoint metadata match criteria. Only endpoints in the upstream
 cluster with metadata matching that set in metadata_match will be
 considered. The filter name should be specified as *envoy.lb*.

.envoy.api.v2.core.Metadata metadata_match = 4;

Specified by:: getMetadataMatch in interface RouteOuterClass.RouteActionOrBuilder

getMetadataMatchOrBuilder

public Base.MetadataOrBuilder getMetadataMatchOrBuilder()

 Optional endpoint metadata match criteria. Only endpoints in the upstream
 cluster with metadata matching that set in metadata_match will be
 considered. The filter name should be specified as *envoy.lb*.

.envoy.api.v2.core.Metadata metadata_match = 4;

Specified by:: getMetadataMatchOrBuilder in interface RouteOuterClass.RouteActionOrBuilder

getPrefixRewrite

public String getPrefixRewrite()

 Indicates that during forwarding, the matched prefix (or path) should be
 swapped with this value. This option allows application URLs to be rooted
 at a different path from those exposed at the reverse proxy layer.

string prefix_rewrite = 5;

Specified by:: getPrefixRewrite in interface RouteOuterClass.RouteActionOrBuilder

getPrefixRewriteBytes

public com.google.protobuf.ByteString getPrefixRewriteBytes()

 Indicates that during forwarding, the matched prefix (or path) should be
 swapped with this value. This option allows application URLs to be rooted
 at a different path from those exposed at the reverse proxy layer.

string prefix_rewrite = 5;

Specified by:: getPrefixRewriteBytes in interface RouteOuterClass.RouteActionOrBuilder

getHostRewrite

public String getHostRewrite()

 Indicates that during forwarding, the host header will be swapped with
 this value.

string host_rewrite = 6;

Specified by:: getHostRewrite in interface RouteOuterClass.RouteActionOrBuilder

getHostRewriteBytes

public com.google.protobuf.ByteString getHostRewriteBytes()

 Indicates that during forwarding, the host header will be swapped with
 this value.

string host_rewrite = 6;

Specified by:: getHostRewriteBytes in interface RouteOuterClass.RouteActionOrBuilder

hasAutoHostRewrite

public boolean hasAutoHostRewrite()

 Indicates that during forwarding, the host header will be swapped with
 the hostname of the upstream host chosen by the cluster manager. This
 option is applicable only when the destination cluster for a route is of
 type *strict_dns* or *logical_dns*. Setting this to true with other cluster
 types has no effect.

.google.protobuf.BoolValue auto_host_rewrite = 7;

Specified by:: hasAutoHostRewrite in interface RouteOuterClass.RouteActionOrBuilder

getAutoHostRewrite

public com.google.protobuf.BoolValue getAutoHostRewrite()

 Indicates that during forwarding, the host header will be swapped with
 the hostname of the upstream host chosen by the cluster manager. This
 option is applicable only when the destination cluster for a route is of
 type *strict_dns* or *logical_dns*. Setting this to true with other cluster
 types has no effect.

.google.protobuf.BoolValue auto_host_rewrite = 7;

Specified by:: getAutoHostRewrite in interface RouteOuterClass.RouteActionOrBuilder

getAutoHostRewriteOrBuilder

public com.google.protobuf.BoolValueOrBuilder getAutoHostRewriteOrBuilder()

 Indicates that during forwarding, the host header will be swapped with
 the hostname of the upstream host chosen by the cluster manager. This
 option is applicable only when the destination cluster for a route is of
 type *strict_dns* or *logical_dns*. Setting this to true with other cluster
 types has no effect.

.google.protobuf.BoolValue auto_host_rewrite = 7;

Specified by:: getAutoHostRewriteOrBuilder in interface RouteOuterClass.RouteActionOrBuilder

hasTimeout

public boolean hasTimeout()

 Specifies the timeout for the route. If not specified, the default is 15s.
 .. note::
   This timeout includes all retries. See also
   :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`,
   :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`, and the
   :ref:`retry overview <arch_overview_http_routing_retry>`.

.google.protobuf.Duration timeout = 8 [(.gogoproto.stdduration) = true];

Specified by:: hasTimeout in interface RouteOuterClass.RouteActionOrBuilder

getTimeout

public com.google.protobuf.Duration getTimeout()

 Specifies the timeout for the route. If not specified, the default is 15s.
 .. note::
   This timeout includes all retries. See also
   :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`,
   :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`, and the
   :ref:`retry overview <arch_overview_http_routing_retry>`.

.google.protobuf.Duration timeout = 8 [(.gogoproto.stdduration) = true];

Specified by:: getTimeout in interface RouteOuterClass.RouteActionOrBuilder

getTimeoutOrBuilder

public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()

 Specifies the timeout for the route. If not specified, the default is 15s.
 .. note::
   This timeout includes all retries. See also
   :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`,
   :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`, and the
   :ref:`retry overview <arch_overview_http_routing_retry>`.

.google.protobuf.Duration timeout = 8 [(.gogoproto.stdduration) = true];

Specified by:: getTimeoutOrBuilder in interface RouteOuterClass.RouteActionOrBuilder

hasRetryPolicy
```
public boolean hasRetryPolicy()
```
```
 Indicates that the route has a retry policy.
 
```
.envoy.api.v2.route.RouteAction.RetryPolicy retry_policy = 9;
Specified by:

hasRetryPolicy in interface RouteOuterClass.RouteActionOrBuilder

getRetryPolicy
```
public RouteOuterClass.RouteAction.RetryPolicy getRetryPolicy()
```
```
 Indicates that the route has a retry policy.
 
```
.envoy.api.v2.route.RouteAction.RetryPolicy retry_policy = 9;
Specified by:

getRetryPolicy in interface RouteOuterClass.RouteActionOrBuilder

getRetryPolicyOrBuilder
```
public RouteOuterClass.RouteAction.RetryPolicyOrBuilder getRetryPolicyOrBuilder()
```
```
 Indicates that the route has a retry policy.
 
```
.envoy.api.v2.route.RouteAction.RetryPolicy retry_policy = 9;
Specified by:

getRetryPolicyOrBuilder in interface RouteOuterClass.RouteActionOrBuilder

hasRequestMirrorPolicy
```
public boolean hasRequestMirrorPolicy()
```
```
 Indicates that the route has a request mirroring policy.
 
```
.envoy.api.v2.route.RouteAction.RequestMirrorPolicy request_mirror_policy = 10;
Specified by:

hasRequestMirrorPolicy in interface RouteOuterClass.RouteActionOrBuilder

getRequestMirrorPolicy
```
public RouteOuterClass.RouteAction.RequestMirrorPolicy getRequestMirrorPolicy()
```
```
 Indicates that the route has a request mirroring policy.
 
```
.envoy.api.v2.route.RouteAction.RequestMirrorPolicy request_mirror_policy = 10;
Specified by:

getRequestMirrorPolicy in interface RouteOuterClass.RouteActionOrBuilder

getRequestMirrorPolicyOrBuilder
```
public RouteOuterClass.RouteAction.RequestMirrorPolicyOrBuilder getRequestMirrorPolicyOrBuilder()
```
```
 Indicates that the route has a request mirroring policy.
 
```
.envoy.api.v2.route.RouteAction.RequestMirrorPolicy request_mirror_policy = 10;
Specified by:

getRequestMirrorPolicyOrBuilder in interface RouteOuterClass.RouteActionOrBuilder

getPriorityValue

public int getPriorityValue()

 Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
 [#comment:TODO(htuch): add (validate.rules).enum.defined_only = true once
 https://github.com/lyft/protoc-gen-validate/issues/42 is resolved.]

.envoy.api.v2.core.RoutingPriority priority = 11;

Specified by:: getPriorityValue in interface RouteOuterClass.RouteActionOrBuilder

getPriority

public Base.RoutingPriority getPriority()

 Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
 [#comment:TODO(htuch): add (validate.rules).enum.defined_only = true once
 https://github.com/lyft/protoc-gen-validate/issues/42 is resolved.]

.envoy.api.v2.core.RoutingPriority priority = 11;

Specified by:: getPriority in interface RouteOuterClass.RouteActionOrBuilder