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

Class WeightedCluster

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WeightedClusterOrBuilder, Serializable
    public final class WeightedCluster
extends com.google.protobuf.GeneratedMessageV3
implements WeightedClusterOrBuilder
     Compared to the :ref:`cluster <envoy_v3_api_field_config.route.v3.RouteAction.cluster>` field that specifies a
 single upstream cluster as the target of a request, the :ref:`weighted_clusters
 <envoy_v3_api_field_config.route.v3.RouteAction.weighted_clusters>` option allows for specification of
 multiple upstream clusters along with weights that indicate the percentage of
 traffic to be forwarded to each cluster. The router selects an upstream cluster based on the
 weights.
    Protobuf type envoy.config.route.v3.WeightedCluster
    See Also:
    Serialized Form

    • Field Detail

      • TOTAL_WEIGHT_FIELD_NUMBER

        public static final int TOTAL_WEIGHT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RUNTIME_KEY_PREFIX_FIELD_NUMBER

        public static final int RUNTIME_KEY_PREFIX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HEADER_NAME_FIELD_NUMBER

        public static final int HEADER_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getClustersCount

        public int getClustersCount()
         Specifies one or more upstream clusters associated with the route.
        repeated .envoy.config.route.v3.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }
        Specified by:
        getClustersCount in interface WeightedClusterOrBuilder

      • hasTotalWeight

        public boolean hasTotalWeight()
         Specifies the total weight across all clusters. The sum of all cluster weights must equal this
 value, if this is greater than 0.
        .google.protobuf.UInt32Value total_weight = 3;
        Specified by:
        hasTotalWeight in interface WeightedClusterOrBuilder
        Returns:
        Whether the totalWeight field is set.

      • getTotalWeight

        public com.google.protobuf.UInt32Value getTotalWeight()
         Specifies the total weight across all clusters. The sum of all cluster weights must equal this
 value, if this is greater than 0.
        .google.protobuf.UInt32Value total_weight = 3;
        Specified by:
        getTotalWeight in interface WeightedClusterOrBuilder
        Returns:
        The totalWeight.

      • getTotalWeightOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getTotalWeightOrBuilder()
         Specifies the total weight across all clusters. The sum of all cluster weights must equal this
 value, if this is greater than 0.
        .google.protobuf.UInt32Value total_weight = 3;
        Specified by:
        getTotalWeightOrBuilder in interface WeightedClusterOrBuilder

      • getRuntimeKeyPrefix

        public String getRuntimeKeyPrefix()
         Specifies the runtime key prefix that should be used to construct the
 runtime keys associated with each cluster. When the ``runtime_key_prefix`` is
 specified, the router will look for weights associated with each upstream
 cluster under the key ``runtime_key_prefix`` + ``.`` + ``cluster[i].name`` where
 ``cluster[i]`` denotes an entry in the clusters array field. If the runtime
 key for the cluster does not exist, the value specified in the
 configuration file will be used as the default weight. See the :ref:`runtime documentation
 <operations_runtime>` for how key names map to the underlying implementation.
        string runtime_key_prefix = 2;
        Specified by:
        getRuntimeKeyPrefix in interface WeightedClusterOrBuilder
        Returns:
        The runtimeKeyPrefix.

      • getRuntimeKeyPrefixBytes

        public com.google.protobuf.ByteString getRuntimeKeyPrefixBytes()
         Specifies the runtime key prefix that should be used to construct the
 runtime keys associated with each cluster. When the ``runtime_key_prefix`` is
 specified, the router will look for weights associated with each upstream
 cluster under the key ``runtime_key_prefix`` + ``.`` + ``cluster[i].name`` where
 ``cluster[i]`` denotes an entry in the clusters array field. If the runtime
 key for the cluster does not exist, the value specified in the
 configuration file will be used as the default weight. See the :ref:`runtime documentation
 <operations_runtime>` for how key names map to the underlying implementation.
        string runtime_key_prefix = 2;
        Specified by:
        getRuntimeKeyPrefixBytes in interface WeightedClusterOrBuilder
        Returns:
        The bytes for runtimeKeyPrefix.

      • hasHeaderName

        public boolean hasHeaderName()
         Specifies the header name that is used to look up the random value passed in the request header.
 This is used to ensure consistent cluster picking across multiple proxy levels for weighted traffic.
 If header is not present or invalid, Envoy will fall back to use the internally generated random value.
 This header is expected to be single-valued header as we only want to have one selected value throughout
 the process for the consistency. And the value is a unsigned number between 0 and UINT64_MAX.
        string header_name = 4 [(.validate.rules) = { ... }
        Specified by:
        hasHeaderName in interface WeightedClusterOrBuilder
        Returns:
        Whether the headerName field is set.

      • getHeaderName

        public String getHeaderName()
         Specifies the header name that is used to look up the random value passed in the request header.
 This is used to ensure consistent cluster picking across multiple proxy levels for weighted traffic.
 If header is not present or invalid, Envoy will fall back to use the internally generated random value.
 This header is expected to be single-valued header as we only want to have one selected value throughout
 the process for the consistency. And the value is a unsigned number between 0 and UINT64_MAX.
        string header_name = 4 [(.validate.rules) = { ... }
        Specified by:
        getHeaderName in interface WeightedClusterOrBuilder
        Returns:
        The headerName.

      • getHeaderNameBytes

        public com.google.protobuf.ByteString getHeaderNameBytes()
         Specifies the header name that is used to look up the random value passed in the request header.
 This is used to ensure consistent cluster picking across multiple proxy levels for weighted traffic.
 If header is not present or invalid, Envoy will fall back to use the internally generated random value.
 This header is expected to be single-valued header as we only want to have one selected value throughout
 the process for the consistency. And the value is a unsigned number between 0 and UINT64_MAX.
        string header_name = 4 [(.validate.rules) = { ... }
        Specified by:
        getHeaderNameBytes in interface WeightedClusterOrBuilder
        Returns:
        The bytes for headerName.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static WeightedCluster parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WeightedCluster parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WeightedCluster parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WeightedCluster parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WeightedCluster parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WeightedCluster parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static WeightedCluster parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public WeightedCluster.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public WeightedCluster.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected WeightedCluster.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<WeightedCluster> parser()

      • getParserForType

        public com.google.protobuf.Parser<WeightedCluster> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public WeightedCluster getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder