Class WeightedCluster

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.route.v3.WeightedCluster
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WeightedClusterOrBuilder, Serializable
@Generated public final class WeightedCluster extends com.google.protobuf.GeneratedMessage 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:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • randomValueSpecifierCase_

      private int randomValueSpecifierCase_

    • randomValueSpecifier_

      private Object randomValueSpecifier_

    • CLUSTERS_FIELD_NUMBER

      public static final int CLUSTERS_FIELD_NUMBER
      See Also:

    • clusters_

      private List<WeightedCluster.ClusterWeight> clusters_

    • TOTAL_WEIGHT_FIELD_NUMBER

      public static final int TOTAL_WEIGHT_FIELD_NUMBER
      See Also:

    • totalWeight_

      private com.google.protobuf.UInt32Value totalWeight_

    • RUNTIME_KEY_PREFIX_FIELD_NUMBER

      public static final int RUNTIME_KEY_PREFIX_FIELD_NUMBER
      See Also:

    • runtimeKeyPrefix_

      private volatile Object runtimeKeyPrefix_

    • HEADER_NAME_FIELD_NUMBER

      public static final int HEADER_NAME_FIELD_NUMBER
      See Also:

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final WeightedCluster DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<WeightedCluster> PARSER

  • Constructor Details

    • WeightedCluster

      private WeightedCluster(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • WeightedCluster

      private WeightedCluster()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getRandomValueSpecifierCase

      public WeightedCluster.RandomValueSpecifierCase getRandomValueSpecifierCase()
      Specified by:
      getRandomValueSpecifierCase in interface WeightedClusterOrBuilder

    • getClustersList

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

    • getClustersOrBuilderList

      public List<? extends WeightedCluster.ClusterWeightOrBuilder> getClustersOrBuilderList()
      Specifies one or more upstream clusters associated with the route.
      repeated .envoy.config.route.v3.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }
      Specified by:
      getClustersOrBuilderList in interface WeightedClusterOrBuilder

    • 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

    • getClusters

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

    • getClustersOrBuilder

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

    • hasTotalWeight

      @Deprecated public boolean hasTotalWeight()
      Deprecated.
      envoy.config.route.v3.WeightedCluster.total_weight is deprecated. See envoy/config/route/v3/route_components.proto;l=477
      Specifies the total weight across all clusters. The sum of all cluster weights must equal this
value, if this is greater than 0.
This field is now deprecated, and the client will use the sum of all
cluster weights. It is up to the management server to supply the correct weights.
      .google.protobuf.UInt32Value total_weight = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      hasTotalWeight in interface WeightedClusterOrBuilder
      Returns:
      Whether the totalWeight field is set.

    • getTotalWeight

      @Deprecated public com.google.protobuf.UInt32Value getTotalWeight()
      Deprecated.
      envoy.config.route.v3.WeightedCluster.total_weight is deprecated. See envoy/config/route/v3/route_components.proto;l=477
      Specifies the total weight across all clusters. The sum of all cluster weights must equal this
value, if this is greater than 0.
This field is now deprecated, and the client will use the sum of all
cluster weights. It is up to the management server to supply the correct weights.
      .google.protobuf.UInt32Value total_weight = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getTotalWeight in interface WeightedClusterOrBuilder
      Returns:
      The totalWeight.

    • getTotalWeightOrBuilder

      @Deprecated public com.google.protobuf.UInt32ValueOrBuilder getTotalWeightOrBuilder()
      Deprecated.
      Specifies the total weight across all clusters. The sum of all cluster weights must equal this
value, if this is greater than 0.
This field is now deprecated, and the client will use the sum of all
cluster weights. It is up to the management server to supply the correct weights.
      .google.protobuf.UInt32Value total_weight = 3 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static WeightedCluster parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static WeightedCluster parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static WeightedCluster.Builder newBuilder()

    • newBuilder

      public static WeightedCluster.Builder newBuilder(WeightedCluster prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static WeightedCluster getDefaultInstance()

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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