io.envoyproxy.envoy.config.route.v4alpha

Interface WeightedCluster.ClusterWeightOrBuilder

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

Modifier and Type	Method and Description
boolean	containsTypedPerFilterConfig(String key) The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
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() Name of the upstream cluster.
com.google.protobuf.ByteString	getNameBytes() Name of the upstream cluster.
HeaderValueOption	getRequestHeadersToAdd(int index) Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_api_msg_config.route.v4alpha.RouteAction`.
int	getRequestHeadersToAddCount() Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_api_msg_config.route.v4alpha.RouteAction`.
List<HeaderValueOption>	getRequestHeadersToAddList() Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.RouteAction`.
int	getResponseHeadersToAddCount() Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_config.route.v4alpha.RouteAction`.
List<HeaderValueOption>	getResponseHeadersToAddList() Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.RouteAction`.
int	getResponseHeadersToRemoveCount() Specifies a list of headers to be removed from responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_config.route.v4alpha.RouteAction`.
List<String>	getResponseHeadersToRemoveList() Specifies a list of headers to be removed from responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_config.route.v4alpha.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_api_field_config.route.v4alpha.WeightedCluster.total_weight>`.
com.google.protobuf.UInt32ValueOrBuilder	getWeightOrBuilder() An integer between 0 and :ref:`total_weight <envoy_api_field_config.route.v4alpha.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_api_field_config.route.v4alpha.WeightedCluster.total_weight>`.

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

getName

String getName()

 Name of the upstream cluster. The cluster must exist in the
 :ref:`cluster manager configuration <config_cluster_manager>`.
 

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

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Name of the upstream cluster. The cluster must exist in the
 :ref:`cluster manager configuration <config_cluster_manager>`.
 

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

hasWeight

boolean hasWeight()

 An integer between 0 and :ref:`total_weight
 <envoy_api_field_config.route.v4alpha.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_api_field_config.route.v4alpha.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_api_field_config.route.v4alpha.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_api_field_config.route.v4alpha.RouteAction.metadata_match>`, with
 values here taking precedence. The filter name should be specified as *envoy.lb*.
 

.envoy.config.core.v4alpha.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_api_field_config.route.v4alpha.RouteAction.metadata_match>`, with
 values here taking precedence. The filter name should be specified as *envoy.lb*.
 

.envoy.config.core.v4alpha.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_api_field_config.route.v4alpha.RouteAction.metadata_match>`, with
 values here taking precedence. The filter name should be specified as *envoy.lb*.
 

.envoy.config.core.v4alpha.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_api_msg_config.route.v4alpha.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_config.route.v4alpha.Route`, :ref:`envoy_api_msg_config.route.v4alpha.VirtualHost`, and
 :ref:`envoy_api_msg_config.route.v4alpha.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.v4alpha.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_api_msg_config.route.v4alpha.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_config.route.v4alpha.Route`, :ref:`envoy_api_msg_config.route.v4alpha.VirtualHost`, and
 :ref:`envoy_api_msg_config.route.v4alpha.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.v4alpha.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_api_msg_config.route.v4alpha.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_config.route.v4alpha.Route`, :ref:`envoy_api_msg_config.route.v4alpha.VirtualHost`, and
 :ref:`envoy_api_msg_config.route.v4alpha.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.v4alpha.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_api_msg_config.route.v4alpha.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_config.route.v4alpha.Route`, :ref:`envoy_api_msg_config.route.v4alpha.VirtualHost`, and
 :ref:`envoy_api_msg_config.route.v4alpha.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.v4alpha.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_api_msg_config.route.v4alpha.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_config.route.v4alpha.Route`, :ref:`envoy_api_msg_config.route.v4alpha.VirtualHost`, and
 :ref:`envoy_api_msg_config.route.v4alpha.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.v4alpha.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_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.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_api_msg_config.route.v4alpha.RouteAction`.
 

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

getResponseHeadersToAddList

List<HeaderValueOption> getResponseHeadersToAddList()

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

getResponseHeadersToAdd

HeaderValueOption getResponseHeadersToAdd(int index)

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

getResponseHeadersToAddCount

int getResponseHeadersToAddCount()

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

getResponseHeadersToAddOrBuilderList

List<? extends HeaderValueOptionOrBuilder> getResponseHeadersToAddOrBuilderList()

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

getResponseHeadersToAddOrBuilder

HeaderValueOptionOrBuilder getResponseHeadersToAddOrBuilder(int index)

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

getResponseHeadersToRemoveList

List<String> getResponseHeadersToRemoveList()

 Specifies a list of headers to be removed from responses when this cluster is selected
 through the enclosing :ref:`envoy_api_msg_config.route.v4alpha.RouteAction`.
 

repeated string response_headers_to_remove = 6 [(.validate.rules) = { ... }

getResponseHeadersToRemoveCount

int getResponseHeadersToRemoveCount()

 Specifies a list of headers to be removed from responses when this cluster is selected
 through the enclosing :ref:`envoy_api_msg_config.route.v4alpha.RouteAction`.
 

repeated string response_headers_to_remove = 6 [(.validate.rules) = { ... }

getResponseHeadersToRemove

String getResponseHeadersToRemove(int index)

 Specifies a list of headers to be removed from responses when this cluster is selected
 through the enclosing :ref:`envoy_api_msg_config.route.v4alpha.RouteAction`.
 

repeated string response_headers_to_remove = 6 [(.validate.rules) = { ... }

getResponseHeadersToRemoveBytes

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_api_msg_config.route.v4alpha.RouteAction`.
 

repeated string response_headers_to_remove = 6 [(.validate.rules) = { ... }

getTypedPerFilterConfigCount

int getTypedPerFilterConfigCount()

 The per_filter_config field can be used to provide weighted cluster-specific
 configurations for filters. The key should match the filter name, such as
 *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
 specific; see the :ref:`HTTP filter documentation <config_http_filters>`
 for if and how it is utilized.
 

map<string, .google.protobuf.Any> typed_per_filter_config = 10;

containsTypedPerFilterConfig

boolean containsTypedPerFilterConfig(String key)

 The per_filter_config field can be used to provide weighted cluster-specific
 configurations for filters. The key should match the filter name, such as
 *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
 specific; see the :ref:`HTTP filter documentation <config_http_filters>`
 for if and how it is utilized.
 

map<string, .google.protobuf.Any> typed_per_filter_config = 10;

getTypedPerFilterConfig

@Deprecated
Map<String,com.google.protobuf.Any> getTypedPerFilterConfig()

Deprecated.

Use getTypedPerFilterConfigMap() instead.

getTypedPerFilterConfigMap

Map<String,com.google.protobuf.Any> getTypedPerFilterConfigMap()

 The per_filter_config field can be used to provide weighted cluster-specific
 configurations for filters. The key should match the filter name, such as
 *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
 specific; see the :ref:`HTTP filter documentation <config_http_filters>`
 for if and how it is utilized.
 

map<string, .google.protobuf.Any> typed_per_filter_config = 10;

getTypedPerFilterConfigOrDefault

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. The key should match the filter name, such as
 *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
 specific; see the :ref:`HTTP filter documentation <config_http_filters>`
 for if and how it is utilized.
 

map<string, .google.protobuf.Any> typed_per_filter_config = 10;

getTypedPerFilterConfigOrThrow

com.google.protobuf.Any getTypedPerFilterConfigOrThrow(String key)

 The per_filter_config field can be used to provide weighted cluster-specific
 configurations for filters. The key should match the filter name, such as
 *envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
 specific; see the :ref:`HTTP filter documentation <config_http_filters>`
 for if and how it is utilized.
 

map<string, .google.protobuf.Any> typed_per_filter_config = 10;