All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

WeightedCluster.ClusterWeight, WeightedCluster.ClusterWeight.Builder

Enclosing class:

WeightedCluster
```
public static interface WeightedCluster.ClusterWeightOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`containsTypedPerFilterConfig(String key)`	The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
`String`	`getClusterHeader()`	Only one of name and cluster_header may be specified.
`com.google.protobuf.ByteString`	`getClusterHeaderBytes()`	Only one of name and cluster_header may be specified.
`String`	`getHostRewriteLiteral()`	Indicates that during forwarding, the host header will be swapped with this value.
`com.google.protobuf.ByteString`	`getHostRewriteLiteralBytes()`	Indicates that during forwarding, the host header will be swapped with this value.
`WeightedCluster.ClusterWeight.HostRewriteSpecifierCase`	`getHostRewriteSpecifierCase()`
`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.
`String`	`getName()`	Only one of name and cluster_header may be specified.
`com.google.protobuf.ByteString`	`getNameBytes()`	Only one of name and cluster_header may be specified.
`HeaderValueOption`	`getRequestHeadersToAdd(int index)`	Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`int`	`getRequestHeadersToAddCount()`	Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`List<HeaderValueOption>`	`getRequestHeadersToAddList()`	Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`HeaderValueOptionOrBuilder`	`getRequestHeadersToAddOrBuilder(int index)`	Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`List<? extends HeaderValueOptionOrBuilder>`	`getRequestHeadersToAddOrBuilderList()`	Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`String`	`getRequestHeadersToRemove(int index)`	Specifies a list of HTTP headers that should be removed from each request when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`com.google.protobuf.ByteString`	`getRequestHeadersToRemoveBytes(int index)`	Specifies a list of HTTP headers that should be removed from each request when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`int`	`getRequestHeadersToRemoveCount()`	Specifies a list of HTTP headers that should be removed from each request when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`List<String>`	`getRequestHeadersToRemoveList()`	Specifies a list of HTTP headers that should be removed from each request when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`HeaderValueOption`	`getResponseHeadersToAdd(int index)`	Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`int`	`getResponseHeadersToAddCount()`	Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`List<HeaderValueOption>`	`getResponseHeadersToAddList()`	Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`HeaderValueOptionOrBuilder`	`getResponseHeadersToAddOrBuilder(int index)`	Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`List<? extends HeaderValueOptionOrBuilder>`	`getResponseHeadersToAddOrBuilderList()`	Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`String`	`getResponseHeadersToRemove(int index)`	Specifies a list of headers to be removed from responses when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`com.google.protobuf.ByteString`	`getResponseHeadersToRemoveBytes(int index)`	Specifies a list of headers to be removed from responses when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`int`	`getResponseHeadersToRemoveCount()`	Specifies a list of headers to be removed from responses when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`List<String>`	`getResponseHeadersToRemoveList()`	Specifies a list of headers to be removed from responses when this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
`Map<String,com.google.protobuf.Any>`	`getTypedPerFilterConfig()`	Deprecated.
`int`	`getTypedPerFilterConfigCount()`	The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
`Map<String,com.google.protobuf.Any>`	`getTypedPerFilterConfigMap()`	The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
`com.google.protobuf.Any`	`getTypedPerFilterConfigOrDefault(String key, com.google.protobuf.Any defaultValue)`	The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
`com.google.protobuf.Any`	`getTypedPerFilterConfigOrThrow(String key)`	The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
`com.google.protobuf.UInt32Value`	`getWeight()`	An integer between 0 and :ref:`total_weight <envoy_v3_api_field_config.route.v3.WeightedCluster.total_weight>`.
`com.google.protobuf.UInt32ValueOrBuilder`	`getWeightOrBuilder()`	An integer between 0 and :ref:`total_weight <envoy_v3_api_field_config.route.v3.WeightedCluster.total_weight>`.
`boolean`	`hasMetadataMatch()`	Optional endpoint metadata match criteria used by the subset load balancer.
`boolean`	`hasWeight()`	An integer between 0 and :ref:`total_weight <envoy_v3_api_field_config.route.v3.WeightedCluster.total_weight>`.

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 Detail

getName

String getName()

 Only one of *name* and *cluster_header* may be specified.
 [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1}]
 Name of the upstream cluster. The cluster must exist in the
 :ref:`cluster manager configuration <config_cluster_manager>`.

string name = 1 [(.udpa.annotations.field_migrate) = { ... }

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Only one of *name* and *cluster_header* may be specified.
 [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1}]
 Name of the upstream cluster. The cluster must exist in the
 :ref:`cluster manager configuration <config_cluster_manager>`.

string name = 1 [(.udpa.annotations.field_migrate) = { ... }

getClusterHeader

String getClusterHeader()

 Only one of *name* and *cluster_header* may be specified.
 [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1 }]
 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.
 .. note::
   If the header appears multiple times only the first value is used.

string cluster_header = 12 [(.validate.rules) = { ... }

getClusterHeaderBytes

com.google.protobuf.ByteString getClusterHeaderBytes()

 Only one of *name* and *cluster_header* may be specified.
 [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1 }]
 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.
 .. note::
   If the header appears multiple times only the first value is used.

string cluster_header = 12 [(.validate.rules) = { ... }

hasWeight

boolean hasWeight()

 An integer between 0 and :ref:`total_weight
 <envoy_v3_api_field_config.route.v3.WeightedCluster.total_weight>`. When a request matches the route,
 the choice of an upstream cluster is determined by its weight. The sum of weights across all
 entries in the clusters array must add up to the total_weight, which defaults to 100.

.google.protobuf.UInt32Value weight = 2;

getWeight

com.google.protobuf.UInt32Value getWeight()

 An integer between 0 and :ref:`total_weight
 <envoy_v3_api_field_config.route.v3.WeightedCluster.total_weight>`. When a request matches the route,
 the choice of an upstream cluster is determined by its weight. The sum of weights across all
 entries in the clusters array must add up to the total_weight, which defaults to 100.

.google.protobuf.UInt32Value weight = 2;

getWeightOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getWeightOrBuilder()

 An integer between 0 and :ref:`total_weight
 <envoy_v3_api_field_config.route.v3.WeightedCluster.total_weight>`. When a request matches the route,
 the choice of an upstream cluster is determined by its weight. The sum of weights across all
 entries in the clusters array must add up to the total_weight, which defaults to 100.

.google.protobuf.UInt32Value weight = 2;

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 for
 load balancing. Note that this will be merged with what's provided in
 :ref:`RouteAction.metadata_match <envoy_v3_api_field_config.route.v3.RouteAction.metadata_match>`, with
 values here taking precedence. The filter name should be specified as *envoy.lb*.

.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 for
 load balancing. Note that this will be merged with what's provided in
 :ref:`RouteAction.metadata_match <envoy_v3_api_field_config.route.v3.RouteAction.metadata_match>`, with
 values here taking precedence. The filter name should be specified as *envoy.lb*.

.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 for
 load balancing. Note that this will be merged with what's provided in
 :ref:`RouteAction.metadata_match <envoy_v3_api_field_config.route.v3.RouteAction.metadata_match>`, with
 values here taking precedence. The filter name should be specified as *envoy.lb*.

.envoy.config.core.v3.Metadata metadata_match = 3;

getRequestHeadersToAddList

List<HeaderValueOption> getRequestHeadersToAddList()

 Specifies a list of headers to be added to requests when this cluster is selected
 through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_v3_api_msg_config.route.v3.Route`, :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 = 4 [(.validate.rules) = { ... }

getRequestHeadersToAdd

HeaderValueOption getRequestHeadersToAdd(int index)

 Specifies a list of headers to be added to requests when this cluster is selected
 through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_v3_api_msg_config.route.v3.Route`, :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 = 4 [(.validate.rules) = { ... }

getRequestHeadersToAddCount

int getRequestHeadersToAddCount()

 Specifies a list of headers to be added to requests when this cluster is selected
 through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_v3_api_msg_config.route.v3.Route`, :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 = 4 [(.validate.rules) = { ... }

getRequestHeadersToAddOrBuilderList

List<? extends HeaderValueOptionOrBuilder> getRequestHeadersToAddOrBuilderList()

 Specifies a list of headers to be added to requests when this cluster is selected
 through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_v3_api_msg_config.route.v3.Route`, :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 = 4 [(.validate.rules) = { ... }

getRequestHeadersToAddOrBuilder

HeaderValueOptionOrBuilder getRequestHeadersToAddOrBuilder(int index)

 Specifies a list of headers to be added to requests when this cluster is selected
 through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_v3_api_msg_config.route.v3.Route`, :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 = 4 [(.validate.rules) = { ... }

getRequestHeadersToRemoveList

List<String> getRequestHeadersToRemoveList()

 Specifies a list of HTTP headers that should be removed from each request when
 this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.

repeated string request_headers_to_remove = 9 [(.validate.rules) = { ... }

getRequestHeadersToRemoveCount

int getRequestHeadersToRemoveCount()

 Specifies a list of HTTP headers that should be removed from each request when
 this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.

repeated string request_headers_to_remove = 9 [(.validate.rules) = { ... }

getRequestHeadersToRemove

String getRequestHeadersToRemove(int index)

 Specifies a list of HTTP headers that should be removed from each request when
 this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.

repeated string request_headers_to_remove = 9 [(.validate.rules) = { ... }

getRequestHeadersToRemoveBytes

com.google.protobuf.ByteString getRequestHeadersToRemoveBytes(int index)

 Specifies a list of HTTP headers that should be removed from each request when
 this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.

repeated string request_headers_to_remove = 9 [(.validate.rules) = { ... }