Package io.envoyproxy.envoy.config.route.v3

Interface WeightedCluster.ClusterWeightOrBuilder

    • 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) = { ... }
        Returns:
        The name.

      • 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) = { ... }
        Returns:
        The bytes for name.

      • 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) = { ... }
        Returns:
        The clusterHeader.

      • 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) = { ... }
        Returns:
        The bytes for clusterHeader.

      • hasWeight

        boolean hasWeight()
         The weight of the cluster. This value is relative to the other clusters'
 weights. 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 be greater than 0, and must not exceed
 uint32_t maximal value (4294967295).
        .google.protobuf.UInt32Value weight = 2;
        Returns:
        Whether the weight field is set.

      • getWeight

        com.google.protobuf.UInt32Value getWeight()
         The weight of the cluster. This value is relative to the other clusters'
 weights. 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 be greater than 0, and must not exceed
 uint32_t maximal value (4294967295).
        .google.protobuf.UInt32Value weight = 2;
        Returns:
        The weight.

      • getWeightOrBuilder

        com.google.protobuf.UInt32ValueOrBuilder getWeightOrBuilder()
         The weight of the cluster. This value is relative to the other clusters'
 weights. 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 be greater than 0, and must not exceed
 uint32_t maximal value (4294967295).
        .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;
        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_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;
        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_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) = { ... }
        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_v3_api_msg_config.route.v3.RouteAction`.
        repeated string request_headers_to_remove = 9 [(.validate.rules) = { ... }
        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_v3_api_msg_config.route.v3.RouteAction`.
        repeated string request_headers_to_remove = 9 [(.validate.rules) = { ... }
        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_v3_api_msg_config.route.v3.RouteAction`.
        repeated string request_headers_to_remove = 9 [(.validate.rules) = { ... }
        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_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 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_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 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_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 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_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 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_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 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_v3_api_msg_config.route.v3.RouteAction`.
        repeated string response_headers_to_remove = 6 [(.validate.rules) = { ... }
        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_v3_api_msg_config.route.v3.RouteAction`.
        repeated string response_headers_to_remove = 6 [(.validate.rules) = { ... }
        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_v3_api_msg_config.route.v3.RouteAction`.
        repeated string response_headers_to_remove = 6 [(.validate.rules) = { ... }
        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_v3_api_msg_config.route.v3.RouteAction`.
        repeated string response_headers_to_remove = 6 [(.validate.rules) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the responseHeadersToRemove at the given index.

      • getTypedPerFilterConfigCount

        int getTypedPerFilterConfigCount()
         This field can be used to provide weighted cluster specific per filter config. The key should match the
 :ref:`filter config name
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
 See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>`
 for details.
 [#comment: An entry's value may be wrapped in a
 :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
 message to specify additional options.]
        map<string, .google.protobuf.Any> typed_per_filter_config = 10;

      • containsTypedPerFilterConfig

        boolean containsTypedPerFilterConfig​(String key)
         This field can be used to provide weighted cluster specific per filter config. The key should match the
 :ref:`filter config name
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
 See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>`
 for details.
 [#comment: An entry's value may be wrapped in a
 :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
 message to specify additional options.]
        map<string, .google.protobuf.Any> typed_per_filter_config = 10;

      • getTypedPerFilterConfigMap

        Map<String,​com.google.protobuf.Any> getTypedPerFilterConfigMap()
         This field can be used to provide weighted cluster specific per filter config. The key should match the
 :ref:`filter config name
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
 See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>`
 for details.
 [#comment: An entry's value may be wrapped in a
 :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
 message to specify additional options.]
        map<string, .google.protobuf.Any> typed_per_filter_config = 10;

      • getTypedPerFilterConfigOrDefault

        com.google.protobuf.Any getTypedPerFilterConfigOrDefault​(String key,
                                                         com.google.protobuf.Any defaultValue)
         This field can be used to provide weighted cluster specific per filter config. The key should match the
 :ref:`filter config name
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
 See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>`
 for details.
 [#comment: An entry's value may be wrapped in a
 :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
 message to specify additional options.]
        map<string, .google.protobuf.Any> typed_per_filter_config = 10;

      • getTypedPerFilterConfigOrThrow

        com.google.protobuf.Any getTypedPerFilterConfigOrThrow​(String key)
         This field can be used to provide weighted cluster specific per filter config. The key should match the
 :ref:`filter config name
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpFilter.name>`.
 See :ref:`Http filter route specific config <arch_overview_http_filters_per_filter_config>`
 for details.
 [#comment: An entry's value may be wrapped in a
 :ref:`FilterConfig<envoy_v3_api_msg_config.route.v3.FilterConfig>`
 message to specify additional options.]
        map<string, .google.protobuf.Any> typed_per_filter_config = 10;

      • hasHostRewriteLiteral

        boolean hasHostRewriteLiteral()
         Indicates that during forwarding, the host header will be swapped with
 this value.
        string host_rewrite_literal = 11 [(.validate.rules) = { ... }
        Returns:
        Whether the hostRewriteLiteral field is set.

      • getHostRewriteLiteral

        String getHostRewriteLiteral()
         Indicates that during forwarding, the host header will be swapped with
 this value.
        string host_rewrite_literal = 11 [(.validate.rules) = { ... }
        Returns:
        The hostRewriteLiteral.

      • getHostRewriteLiteralBytes

        com.google.protobuf.ByteString getHostRewriteLiteralBytes()
         Indicates that during forwarding, the host header will be swapped with
 this value.
        string host_rewrite_literal = 11 [(.validate.rules) = { ... }
        Returns:
        The bytes for hostRewriteLiteral.