envoy.api.v2.route

Interface RouteOuterClass.WeightedCluster.ClusterWeightOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

RouteOuterClass.WeightedCluster.ClusterWeight, RouteOuterClass.WeightedCluster.ClusterWeight.Builder

Enclosing class:

RouteOuterClass.WeightedCluster

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

Method Summary

Modifier and Type	Method and Description
boolean	containsPerFilterConfig(String key) The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
Base.Metadata	getMetadataMatch() Optional endpoint metadata match criteria.
Base.MetadataOrBuilder	getMetadataMatchOrBuilder() Optional endpoint metadata match criteria.
String	getName() Name of the upstream cluster.
com.google.protobuf.ByteString	getNameBytes() Name of the upstream cluster.
Map<String,com.google.protobuf.Struct>	getPerFilterConfig() Deprecated.
int	getPerFilterConfigCount() The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
Map<String,com.google.protobuf.Struct>	getPerFilterConfigMap() The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
com.google.protobuf.Struct	getPerFilterConfigOrDefault(String key, com.google.protobuf.Struct defaultValue) The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
com.google.protobuf.Struct	getPerFilterConfigOrThrow(String key) The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
Base.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_route.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_route.RouteAction`.
List<Base.HeaderValueOption>	getRequestHeadersToAddList() Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
Base.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_route.RouteAction`.
List<? extends Base.HeaderValueOptionOrBuilder>	getRequestHeadersToAddOrBuilderList() Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
Base.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_route.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_route.RouteAction`.
List<Base.HeaderValueOption>	getResponseHeadersToAddList() Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
Base.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_route.RouteAction`.
List<? extends Base.HeaderValueOptionOrBuilder>	getResponseHeadersToAddOrBuilderList() Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.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_route.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_route.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_route.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_route.RouteAction`.
com.google.protobuf.UInt32Value	getWeight() An integer between 0 and :ref:`total_weight <envoy_api_field_route.WeightedCluster.total_weight>`.
com.google.protobuf.UInt32ValueOrBuilder	getWeightOrBuilder() An integer between 0 and :ref:`total_weight <envoy_api_field_route.WeightedCluster.total_weight>`.
boolean	hasMetadataMatch() Optional endpoint metadata match criteria.
boolean	hasWeight() An integer between 0 and :ref:`total_weight <envoy_api_field_route.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_route.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_route.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_route.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. Only endpoints in the upstream
 cluster with metadata matching that set in metadata_match will be
 considered. The filter name should be specified as *envoy.lb*.
 

.envoy.api.v2.core.Metadata metadata_match = 3;

getMetadataMatch

Base.Metadata getMetadataMatch()

 Optional endpoint metadata match criteria. Only endpoints in the upstream
 cluster with metadata matching that set in metadata_match will be
 considered. The filter name should be specified as *envoy.lb*.
 

.envoy.api.v2.core.Metadata metadata_match = 3;

getMetadataMatchOrBuilder

Base.MetadataOrBuilder getMetadataMatchOrBuilder()

 Optional endpoint metadata match criteria. Only endpoints in the upstream
 cluster with metadata matching that set in metadata_match will be
 considered. The filter name should be specified as *envoy.lb*.
 

.envoy.api.v2.core.Metadata metadata_match = 3;

getRequestHeadersToAddList

List<Base.HeaderValueOption> getRequestHeadersToAddList()

 Specifies a list of headers to be added to requests when this cluster is selected
 through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_route.RouteAction`,
 :ref:`envoy_api_msg_route.VirtualHost`, and
 :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption request_headers_to_add = 4;

getRequestHeadersToAdd

Base.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_route.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_route.RouteAction`,
 :ref:`envoy_api_msg_route.VirtualHost`, and
 :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption request_headers_to_add = 4;

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_route.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_route.RouteAction`,
 :ref:`envoy_api_msg_route.VirtualHost`, and
 :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption request_headers_to_add = 4;

getRequestHeadersToAddOrBuilderList

List<? extends Base.HeaderValueOptionOrBuilder> getRequestHeadersToAddOrBuilderList()

 Specifies a list of headers to be added to requests when this cluster is selected
 through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_route.RouteAction`,
 :ref:`envoy_api_msg_route.VirtualHost`, and
 :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption request_headers_to_add = 4;

getRequestHeadersToAddOrBuilder

Base.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_route.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_route.RouteAction`,
 :ref:`envoy_api_msg_route.VirtualHost`, and
 :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption request_headers_to_add = 4;

getResponseHeadersToAddList

List<Base.HeaderValueOption> getResponseHeadersToAddList()

 Specifies a list of headers to be added to responses when this cluster is selected
 through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_route.RouteAction`,
 :ref:`envoy_api_msg_route.VirtualHost`, and
 :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption response_headers_to_add = 5;

getResponseHeadersToAdd

Base.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_route.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_route.RouteAction`,
 :ref:`envoy_api_msg_route.VirtualHost`, and
 :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption response_headers_to_add = 5;

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_route.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_route.RouteAction`,
 :ref:`envoy_api_msg_route.VirtualHost`, and
 :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption response_headers_to_add = 5;

getResponseHeadersToAddOrBuilderList

List<? extends Base.HeaderValueOptionOrBuilder> getResponseHeadersToAddOrBuilderList()

 Specifies a list of headers to be added to responses when this cluster is selected
 through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_route.RouteAction`,
 :ref:`envoy_api_msg_route.VirtualHost`, and
 :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption response_headers_to_add = 5;

getResponseHeadersToAddOrBuilder

Base.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_route.RouteAction`.
 Headers specified at this level are applied before headers from the enclosing
 :ref:`envoy_api_msg_route.RouteAction`,
 :ref:`envoy_api_msg_route.VirtualHost`, and
 :ref:`envoy_api_msg_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.api.v2.core.HeaderValueOption response_headers_to_add = 5;

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_route.RouteAction`.
 

repeated string response_headers_to_remove = 6;

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_route.RouteAction`.
 

repeated string response_headers_to_remove = 6;

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_route.RouteAction`.
 

repeated string response_headers_to_remove = 6;

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_route.RouteAction`.
 

repeated string response_headers_to_remove = 6;

getPerFilterConfigCount

int getPerFilterConfigCount()

 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.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.Struct> per_filter_config = 8;

containsPerFilterConfig

boolean containsPerFilterConfig(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.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.Struct> per_filter_config = 8;

getPerFilterConfig

@Deprecated
Map<String,com.google.protobuf.Struct> getPerFilterConfig()

Deprecated.

Use getPerFilterConfigMap() instead.

getPerFilterConfigMap

Map<String,com.google.protobuf.Struct> getPerFilterConfigMap()

 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.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.Struct> per_filter_config = 8;

getPerFilterConfigOrDefault

com.google.protobuf.Struct getPerFilterConfigOrDefault(String key,
                                                       com.google.protobuf.Struct 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.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.Struct> per_filter_config = 8;

getPerFilterConfigOrThrow

com.google.protobuf.Struct getPerFilterConfigOrThrow(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.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.Struct> per_filter_config = 8;