io.envoyproxy.envoy.extensions.filters.network.thrift_proxy.v3

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 Type	Method and Description
String	getCluster() Indicates a single upstream cluster to which the request should be routed to.
com.google.protobuf.ByteString	getClusterBytes() Indicates a single 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 Thrift 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 Thrift header named by cluster_header from the request headers.
RouteAction.ClusterSpecifierCase	getClusterSpecifierCase()
Metadata	getMetadataMatch() Optional endpoint metadata match criteria used by the subset load balancer.
MetadataOrBuilder	getMetadataMatchOrBuilder() Optional endpoint metadata match criteria used by the subset load balancer.
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<RateLimit>	getRateLimitsList() Specifies a set of rate limit configurations that could be applied to the route.
RateLimitOrBuilder	getRateLimitsOrBuilder(int index) Specifies a set of rate limit configurations that could be applied to the route.
List<? extends RateLimitOrBuilder>	getRateLimitsOrBuilderList() Specifies a set of rate limit configurations that could be applied to the route.
boolean	getStripServiceName() Strip the service prefix from the method name, if there's a prefix.
WeightedCluster	getWeightedClusters() Multiple upstream clusters can be specified for a given route.
WeightedClusterOrBuilder	getWeightedClustersOrBuilder() Multiple upstream clusters can be specified for a given route.
boolean	hasMetadataMatch() Optional endpoint metadata match criteria used by the subset load balancer.
boolean	hasWeightedClusters() Multiple upstream clusters can be specified for a given route.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getCluster

String getCluster()

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

string cluster = 1 [(.validate.rules) = { ... }

getClusterBytes

com.google.protobuf.ByteString getClusterBytes()

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

string cluster = 1 [(.validate.rules) = { ... }

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;

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;

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;

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

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

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_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;

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_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;

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_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

List<RateLimit> 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

RateLimit getRateLimits(int index)

 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

RateLimitOrBuilder getRateLimitsOrBuilder(int index)

 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;

getClusterSpecifierCase

RouteAction.ClusterSpecifierCase getClusterSpecifierCase()