Interface RouteActionOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
RouteAction,RouteAction.Builder
public interface RouteActionOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionIndicates a single upstream cluster to which the request should be routed to.com.google.protobuf.ByteStringIndicates a single upstream cluster to which the request should be routed to.Envoy will determine the cluster to route to by reading the value of the Thrift header named by cluster_header from the request headers.com.google.protobuf.ByteStringEnvoy will determine the cluster to route to by reading the value of the Thrift header named by cluster_header from the request headers.Optional endpoint metadata match criteria used by the subset load balancer.Optional endpoint metadata match criteria used by the subset load balancer.getRateLimits(int index) Specifies a set of rate limit configurations that could be applied to the route.intSpecifies a set of rate limit configurations that could be applied to the route.Specifies a set of rate limit configurations that could be applied to the route.getRateLimitsOrBuilder(int index) Specifies a set of rate limit configurations that could be applied to the route.List<? extends RateLimitOrBuilder>Specifies a set of rate limit configurations that could be applied to the route.getRequestMirrorPolicies(int index) Indicates that the route has request mirroring policies.intIndicates that the route has request mirroring policies.Indicates that the route has request mirroring policies.getRequestMirrorPoliciesOrBuilder(int index) Indicates that the route has request mirroring policies.List<? extends RouteAction.RequestMirrorPolicyOrBuilder>Indicates that the route has request mirroring policies.booleanStrip the service prefix from the method name, if there's a prefix.Multiple upstream clusters can be specified for a given route.Multiple upstream clusters can be specified for a given route.booleanIndicates a single upstream cluster to which the request should be routed to.booleanEnvoy will determine the cluster to route to by reading the value of the Thrift header named by cluster_header from the request headers.booleanOptional endpoint metadata match criteria used by the subset load balancer.booleanMultiple upstream clusters can be specified for a given route.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasCluster
boolean hasCluster()Indicates a single upstream cluster to which the request should be routed to.
string cluster = 1 [(.validate.rules) = { ... }- Returns:
- Whether the cluster field is set.
-
getCluster
String getCluster()Indicates a single upstream cluster to which the request should be routed to.
string cluster = 1 [(.validate.rules) = { ... }- Returns:
- The cluster.
-
getClusterBytes
com.google.protobuf.ByteString getClusterBytes()Indicates a single upstream cluster to which the request should be routed to.
string cluster = 1 [(.validate.rules) = { ... }- Returns:
- The bytes for cluster.
-
hasWeightedClusters
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.
.envoy.extensions.filters.network.thrift_proxy.v3.WeightedCluster weighted_clusters = 2;- Returns:
- Whether the weightedClusters field is set.
-
getWeightedClusters
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.
.envoy.extensions.filters.network.thrift_proxy.v3.WeightedCluster weighted_clusters = 2;- Returns:
- The weightedClusters.
-
getWeightedClustersOrBuilder
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.
.envoy.extensions.filters.network.thrift_proxy.v3.WeightedCluster weighted_clusters = 2; -
hasClusterHeader
boolean hasClusterHeader()Envoy will determine the cluster to route to by reading the value of the Thrift header named by cluster_header from the request headers. If the header is not found or the referenced cluster does not exist Envoy will respond with an unknown method exception or an internal error exception, respectively.
string cluster_header = 6 [(.validate.rules) = { ... }- Returns:
- Whether the clusterHeader field is set.
-
getClusterHeader
String getClusterHeader()Envoy will determine the cluster to route to by reading the value of the Thrift header named by cluster_header from the request headers. If the header is not found or the referenced cluster does not exist Envoy will respond with an unknown method exception or an internal error exception, respectively.
string cluster_header = 6 [(.validate.rules) = { ... }- Returns:
- The clusterHeader.
-
getClusterHeaderBytes
com.google.protobuf.ByteString getClusterHeaderBytes()Envoy will determine the cluster to route to by reading the value of the Thrift header named by cluster_header from the request headers. If the header is not found or the referenced cluster does not exist Envoy will respond with an unknown method exception or an internal error exception, respectively.
string cluster_header = 6 [(.validate.rules) = { ... }- Returns:
- The bytes for clusterHeader.
-
hasMetadataMatch
boolean hasMetadataMatch()Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in the upstream cluster with metadata matching what is set in this field will be considered. Note that this will be merged with what's provided in :ref:`WeightedCluster.metadata_match <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.WeightedCluster.ClusterWeight.metadata_match>`, with values there taking precedence. Keys and values should be provided under the "envoy.lb" metadata key.
.envoy.config.core.v3.Metadata metadata_match = 3;- Returns:
- Whether the metadataMatch field is set.
-
getMetadataMatch
Metadata getMetadataMatch()Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in the upstream cluster with metadata matching what is set in this field will be considered. Note that this will be merged with what's provided in :ref:`WeightedCluster.metadata_match <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.WeightedCluster.ClusterWeight.metadata_match>`, with values there taking precedence. Keys and values should be provided under the "envoy.lb" metadata key.
.envoy.config.core.v3.Metadata metadata_match = 3;- Returns:
- The metadataMatch.
-
getMetadataMatchOrBuilder
MetadataOrBuilder getMetadataMatchOrBuilder()Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in the upstream cluster with metadata matching what is set in this field will be considered. Note that this will be merged with what's provided in :ref:`WeightedCluster.metadata_match <envoy_v3_api_field_extensions.filters.network.thrift_proxy.v3.WeightedCluster.ClusterWeight.metadata_match>`, with values there taking precedence. Keys and values should be provided under the "envoy.lb" metadata key.
.envoy.config.core.v3.Metadata metadata_match = 3; -
getRateLimitsList
Specifies a set of rate limit configurations that could be applied to the route. N.B. Thrift service or method name matching can be achieved by specifying a RequestHeaders action with the header name ":method-name".
repeated .envoy.config.route.v3.RateLimit rate_limits = 4; -
getRateLimits
Specifies a set of rate limit configurations that could be applied to the route. N.B. Thrift service or method name matching can be achieved by specifying a RequestHeaders action with the header name ":method-name".
repeated .envoy.config.route.v3.RateLimit rate_limits = 4; -
getRateLimitsCount
int getRateLimitsCount()Specifies a set of rate limit configurations that could be applied to the route. N.B. Thrift service or method name matching can be achieved by specifying a RequestHeaders action with the header name ":method-name".
repeated .envoy.config.route.v3.RateLimit rate_limits = 4; -
getRateLimitsOrBuilderList
List<? extends RateLimitOrBuilder> getRateLimitsOrBuilderList()Specifies a set of rate limit configurations that could be applied to the route. N.B. Thrift service or method name matching can be achieved by specifying a RequestHeaders action with the header name ":method-name".
repeated .envoy.config.route.v3.RateLimit rate_limits = 4; -
getRateLimitsOrBuilder
Specifies a set of rate limit configurations that could be applied to the route. N.B. Thrift service or method name matching can be achieved by specifying a RequestHeaders action with the header name ":method-name".
repeated .envoy.config.route.v3.RateLimit rate_limits = 4; -
getStripServiceName
boolean getStripServiceName()Strip the service prefix from the method name, if there's a prefix. For example, the method call Service:method would end up being just method.
bool strip_service_name = 5;- Returns:
- The stripServiceName.
-
getRequestMirrorPoliciesList
List<RouteAction.RequestMirrorPolicy> getRequestMirrorPoliciesList()Indicates that the route has request mirroring policies.
repeated .envoy.extensions.filters.network.thrift_proxy.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 7; -
getRequestMirrorPolicies
Indicates that the route has request mirroring policies.
repeated .envoy.extensions.filters.network.thrift_proxy.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 7; -
getRequestMirrorPoliciesCount
int getRequestMirrorPoliciesCount()Indicates that the route has request mirroring policies.
repeated .envoy.extensions.filters.network.thrift_proxy.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 7; -
getRequestMirrorPoliciesOrBuilderList
List<? extends RouteAction.RequestMirrorPolicyOrBuilder> getRequestMirrorPoliciesOrBuilderList()Indicates that the route has request mirroring policies.
repeated .envoy.extensions.filters.network.thrift_proxy.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 7; -
getRequestMirrorPoliciesOrBuilder
Indicates that the route has request mirroring policies.
repeated .envoy.extensions.filters.network.thrift_proxy.v3.RouteAction.RequestMirrorPolicy request_mirror_policies = 7; -
getClusterSpecifierCase
RouteAction.ClusterSpecifierCase getClusterSpecifierCase()
-