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
    Description
    boolean
    Deprecated.
    boolean
    The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
    Optional endpoint metadata match criteria used by the subset load balancer.
    Optional endpoint metadata match criteria used by the subset load balancer.
    Name of the upstream cluster.
    com.google.protobuf.ByteString
    Name of the upstream cluster.
    Map<String,com.google.protobuf.Struct>
    Deprecated.
    int
    Deprecated.
    Map<String,com.google.protobuf.Struct>
    Deprecated.
    com.google.protobuf.Struct
    getPerFilterConfigOrDefault(String key, com.google.protobuf.Struct defaultValue)
    Deprecated.
    com.google.protobuf.Struct
    Deprecated.
    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
    Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
    Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
    Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
    Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
    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_route.RouteAction`.
    com.google.protobuf.ByteString
    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_route.RouteAction`.
    int
    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_route.RouteAction`.
    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_route.RouteAction`.
    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
    Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
    Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
    Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
    Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
    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
    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
    Specifies a list of headers to be removed from responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
    Specifies a list of headers to be removed from responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
    Map<String,com.google.protobuf.Any>
    Deprecated.
    int
    The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
    Map<String,com.google.protobuf.Any>
    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
    The per_filter_config field can be used to provide weighted cluster-specific configurations for filters.
    com.google.protobuf.UInt32Value
    An integer between 0 and :ref:`total_weight <envoy_api_field_route.WeightedCluster.total_weight>`.
    com.google.protobuf.UInt32ValueOrBuilder
    An integer between 0 and :ref:`total_weight <envoy_api_field_route.WeightedCluster.total_weight>`.
    boolean
    Optional endpoint metadata match criteria used by the subset load balancer.
    boolean
    An integer between 0 and :ref:`total_weight <envoy_api_field_route.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 Details

    • 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) = { ... }
      Returns:
      The name.
    • 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) = { ... }
      Returns:
      The bytes for name.
    • 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, if total_weight is greater than 0.
       
      .google.protobuf.UInt32Value weight = 2;
      Returns:
      Whether the weight field is set.
    • 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, if total_weight is greater than 0.
       
      .google.protobuf.UInt32Value weight = 2;
      Returns:
      The weight.
    • 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, if total_weight is greater than 0.
       
      .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_route.RouteAction.metadata_match>`, with
       values here taking precedence. The filter name should be specified as *envoy.lb*.
       
      .envoy.api.v2.core.Metadata metadata_match = 3;
      Returns:
      Whether the metadataMatch field is set.
    • 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_route.RouteAction.metadata_match>`, with
       values here taking precedence. The filter name should be specified as *envoy.lb*.
       
      .envoy.api.v2.core.Metadata metadata_match = 3;
      Returns:
      The metadataMatch.
    • 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_route.RouteAction.metadata_match>`, with
       values here taking precedence. The filter name should be specified as *envoy.lb*.
       
      .envoy.api.v2.core.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_route.RouteAction`.
       Headers specified at this level are applied before headers from the enclosing
       :ref:`envoy_api_msg_route.Route`, :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 [(.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_route.RouteAction`.
       Headers specified at this level are applied before headers from the enclosing
       :ref:`envoy_api_msg_route.Route`, :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 [(.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_route.RouteAction`.
       Headers specified at this level are applied before headers from the enclosing
       :ref:`envoy_api_msg_route.Route`, :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 [(.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_route.RouteAction`.
       Headers specified at this level are applied before headers from the enclosing
       :ref:`envoy_api_msg_route.Route`, :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 [(.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_route.RouteAction`.
       Headers specified at this level are applied before headers from the enclosing
       :ref:`envoy_api_msg_route.Route`, :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 [(.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_route.RouteAction`.
       
      repeated string request_headers_to_remove = 9;
      Returns:
      A list containing the requestHeadersToRemove.
    • 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_route.RouteAction`.
       
      repeated string request_headers_to_remove = 9;
      Returns:
      The count of requestHeadersToRemove.
    • 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_route.RouteAction`.
       
      repeated string request_headers_to_remove = 9;
      Parameters:
      index - The index of the element to return.
      Returns:
      The requestHeadersToRemove at the given index.
    • 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_route.RouteAction`.
       
      repeated string request_headers_to_remove = 9;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the requestHeadersToRemove at the given index.
    • 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_route.RouteAction`.
       Headers specified at this level are applied before headers from the enclosing
       :ref:`envoy_api_msg_route.Route`, :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 [(.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_route.RouteAction`.
       Headers specified at this level are applied before headers from the enclosing
       :ref:`envoy_api_msg_route.Route`, :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 [(.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_route.RouteAction`.
       Headers specified at this level are applied before headers from the enclosing
       :ref:`envoy_api_msg_route.Route`, :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 [(.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_route.RouteAction`.
       Headers specified at this level are applied before headers from the enclosing
       :ref:`envoy_api_msg_route.Route`, :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 [(.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_route.RouteAction`.
       Headers specified at this level are applied before headers from the enclosing
       :ref:`envoy_api_msg_route.Route`, :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 [(.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_route.RouteAction`.
       
      repeated string response_headers_to_remove = 6;
      Returns:
      A list containing the responseHeadersToRemove.
    • 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;
      Returns:
      The count of responseHeadersToRemove.
    • 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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The responseHeadersToRemove at the given index.
    • 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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the responseHeadersToRemove at the given index.
    • getPerFilterConfigCount

      @Deprecated int getPerFilterConfigCount()
      Deprecated.
       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.Struct> per_filter_config = 8 [deprecated = true];
    • containsPerFilterConfig

      @Deprecated boolean containsPerFilterConfig(String key)
      Deprecated.
       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.Struct> per_filter_config = 8 [deprecated = true];
    • getPerFilterConfig

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

      @Deprecated Map<String,com.google.protobuf.Struct> getPerFilterConfigMap()
      Deprecated.
       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.Struct> per_filter_config = 8 [deprecated = true];
    • getPerFilterConfigOrDefault

      @Deprecated com.google.protobuf.Struct getPerFilterConfigOrDefault(String key, com.google.protobuf.Struct defaultValue)
      Deprecated.
       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.Struct> per_filter_config = 8 [deprecated = true];
    • getPerFilterConfigOrThrow

      @Deprecated com.google.protobuf.Struct getPerFilterConfigOrThrow(String key)
      Deprecated.
       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.Struct> per_filter_config = 8 [deprecated = true];
    • 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.
    • 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;