Interface WeightedClusterOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
WeightedCluster
,WeightedCluster.Builder
public interface WeightedClusterOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptiongetClusters
(int index) Specifies one or more upstream clusters associated with the route.int
Specifies one or more upstream clusters associated with the route.Specifies one or more upstream clusters associated with the route.getClustersOrBuilder
(int index) Specifies one or more upstream clusters associated with the route.List
<? extends WeightedCluster.ClusterWeightOrBuilder> Specifies one or more upstream clusters associated with the route.Specifies the header name that is used to look up the random value passed in the request header.com.google.protobuf.ByteString
Specifies the header name that is used to look up the random value passed in the request header.Specifies the runtime key prefix that should be used to construct the runtime keys associated with each cluster.com.google.protobuf.ByteString
Specifies the runtime key prefix that should be used to construct the runtime keys associated with each cluster.com.google.protobuf.UInt32Value
Deprecated.envoy.config.route.v3.WeightedCluster.total_weight is deprecated.com.google.protobuf.UInt32ValueOrBuilder
Deprecated.boolean
Specifies the header name that is used to look up the random value passed in the request header.boolean
Deprecated.envoy.config.route.v3.WeightedCluster.total_weight is deprecated.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getClustersList
List<WeightedCluster.ClusterWeight> getClustersList()Specifies one or more upstream clusters associated with the route.
repeated .envoy.config.route.v3.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }
-
getClusters
Specifies one or more upstream clusters associated with the route.
repeated .envoy.config.route.v3.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }
-
getClustersCount
int getClustersCount()Specifies one or more upstream clusters associated with the route.
repeated .envoy.config.route.v3.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }
-
getClustersOrBuilderList
List<? extends WeightedCluster.ClusterWeightOrBuilder> getClustersOrBuilderList()Specifies one or more upstream clusters associated with the route.
repeated .envoy.config.route.v3.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }
-
getClustersOrBuilder
Specifies one or more upstream clusters associated with the route.
repeated .envoy.config.route.v3.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }
-
hasTotalWeight
Deprecated.envoy.config.route.v3.WeightedCluster.total_weight is deprecated. See envoy/config/route/v3/route_components.proto;l=477Specifies the total weight across all clusters. The sum of all cluster weights must equal this value, if this is greater than 0. This field is now deprecated, and the client will use the sum of all cluster weights. It is up to the management server to supply the correct weights.
.google.protobuf.UInt32Value total_weight = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- Whether the totalWeight field is set.
-
getTotalWeight
Deprecated.envoy.config.route.v3.WeightedCluster.total_weight is deprecated. See envoy/config/route/v3/route_components.proto;l=477Specifies the total weight across all clusters. The sum of all cluster weights must equal this value, if this is greater than 0. This field is now deprecated, and the client will use the sum of all cluster weights. It is up to the management server to supply the correct weights.
.google.protobuf.UInt32Value total_weight = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The totalWeight.
-
getTotalWeightOrBuilder
Deprecated.Specifies the total weight across all clusters. The sum of all cluster weights must equal this value, if this is greater than 0. This field is now deprecated, and the client will use the sum of all cluster weights. It is up to the management server to supply the correct weights.
.google.protobuf.UInt32Value total_weight = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
-
getRuntimeKeyPrefix
String getRuntimeKeyPrefix()Specifies the runtime key prefix that should be used to construct the runtime keys associated with each cluster. When the ``runtime_key_prefix`` is specified, the router will look for weights associated with each upstream cluster under the key ``runtime_key_prefix`` + ``.`` + ``cluster[i].name`` where ``cluster[i]`` denotes an entry in the clusters array field. If the runtime key for the cluster does not exist, the value specified in the configuration file will be used as the default weight. See the :ref:`runtime documentation <operations_runtime>` for how key names map to the underlying implementation.
string runtime_key_prefix = 2;
- Returns:
- The runtimeKeyPrefix.
-
getRuntimeKeyPrefixBytes
com.google.protobuf.ByteString getRuntimeKeyPrefixBytes()Specifies the runtime key prefix that should be used to construct the runtime keys associated with each cluster. When the ``runtime_key_prefix`` is specified, the router will look for weights associated with each upstream cluster under the key ``runtime_key_prefix`` + ``.`` + ``cluster[i].name`` where ``cluster[i]`` denotes an entry in the clusters array field. If the runtime key for the cluster does not exist, the value specified in the configuration file will be used as the default weight. See the :ref:`runtime documentation <operations_runtime>` for how key names map to the underlying implementation.
string runtime_key_prefix = 2;
- Returns:
- The bytes for runtimeKeyPrefix.
-
hasHeaderName
boolean hasHeaderName()Specifies the header name that is used to look up the random value passed in the request header. This is used to ensure consistent cluster picking across multiple proxy levels for weighted traffic. If header is not present or invalid, Envoy will fall back to use the internally generated random value. This header is expected to be single-valued header as we only want to have one selected value throughout the process for the consistency. And the value is a unsigned number between 0 and UINT64_MAX.
string header_name = 4 [(.validate.rules) = { ... }
- Returns:
- Whether the headerName field is set.
-
getHeaderName
String getHeaderName()Specifies the header name that is used to look up the random value passed in the request header. This is used to ensure consistent cluster picking across multiple proxy levels for weighted traffic. If header is not present or invalid, Envoy will fall back to use the internally generated random value. This header is expected to be single-valued header as we only want to have one selected value throughout the process for the consistency. And the value is a unsigned number between 0 and UINT64_MAX.
string header_name = 4 [(.validate.rules) = { ... }
- Returns:
- The headerName.
-
getHeaderNameBytes
com.google.protobuf.ByteString getHeaderNameBytes()Specifies the header name that is used to look up the random value passed in the request header. This is used to ensure consistent cluster picking across multiple proxy levels for weighted traffic. If header is not present or invalid, Envoy will fall back to use the internally generated random value. This header is expected to be single-valued header as we only want to have one selected value throughout the process for the consistency. And the value is a unsigned number between 0 and UINT64_MAX.
string header_name = 4 [(.validate.rules) = { ... }
- Returns:
- The bytes for headerName.
-
getRandomValueSpecifierCase
WeightedCluster.RandomValueSpecifierCase getRandomValueSpecifierCase()
-