Package io.envoyproxy.envoy.api.v2.route

Interface WeightedClusterOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
WeightedCluster, WeightedCluster.Builder
public interface WeightedClusterOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    WeightedCluster.ClusterWeight
    getClusters(int index)
    Specifies one or more upstream clusters associated with the route.
    int
    getClustersCount()
    Specifies one or more upstream clusters associated with the route.
    List<WeightedCluster.ClusterWeight>
    getClustersList()
    Specifies one or more upstream clusters associated with the route.
    WeightedCluster.ClusterWeightOrBuilder
    getClustersOrBuilder(int index)
    Specifies one or more upstream clusters associated with the route.
    List<? extends WeightedCluster.ClusterWeightOrBuilder>
    getClustersOrBuilderList()
    Specifies one or more upstream clusters associated with the route.
    String
    getRuntimeKeyPrefix()
    Specifies the runtime key prefix that should be used to construct the runtime keys associated with each cluster.
    com.google.protobuf.ByteString
    getRuntimeKeyPrefixBytes()
    Specifies the runtime key prefix that should be used to construct the runtime keys associated with each cluster.
    com.google.protobuf.UInt32Value
    getTotalWeight()
    Specifies the total weight across all clusters.
    com.google.protobuf.UInt32ValueOrBuilder
    getTotalWeightOrBuilder()
    Specifies the total weight across all clusters.
    boolean
    hasTotalWeight()
    Specifies the total weight across all clusters.

    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

    • getClustersList

      List<WeightedCluster.ClusterWeight> getClustersList()
       Specifies one or more upstream clusters associated with the route.
      repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }

    • getClusters

      WeightedCluster.ClusterWeight getClusters(int index)
       Specifies one or more upstream clusters associated with the route.
      repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }

    • getClustersCount

      int getClustersCount()
       Specifies one or more upstream clusters associated with the route.
      repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }

    • getClustersOrBuilderList

      List<? extends WeightedCluster.ClusterWeightOrBuilder> getClustersOrBuilderList()
       Specifies one or more upstream clusters associated with the route.
      repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }

    • getClustersOrBuilder

      WeightedCluster.ClusterWeightOrBuilder getClustersOrBuilder(int index)
       Specifies one or more upstream clusters associated with the route.
      repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }

    • hasTotalWeight

      boolean hasTotalWeight()
       Specifies the total weight across all clusters. The sum of all cluster weights must equal this
 value, which must be greater than 0. Defaults to 100.
      .google.protobuf.UInt32Value total_weight = 3 [(.validate.rules) = { ... }
      Returns:
      Whether the totalWeight field is set.

    • getTotalWeight

      com.google.protobuf.UInt32Value getTotalWeight()
       Specifies the total weight across all clusters. The sum of all cluster weights must equal this
 value, which must be greater than 0. Defaults to 100.
      .google.protobuf.UInt32Value total_weight = 3 [(.validate.rules) = { ... }
      Returns:
      The totalWeight.

    • getTotalWeightOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getTotalWeightOrBuilder()
       Specifies the total weight across all clusters. The sum of all cluster weights must equal this
 value, which must be greater than 0. Defaults to 100.
      .google.protobuf.UInt32Value total_weight = 3 [(.validate.rules) = { ... }

    • getRuntimeKeyPrefix

      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;
      Returns:
      The runtimeKeyPrefix.

    • getRuntimeKeyPrefixBytes

      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;
      Returns:
      The bytes for runtimeKeyPrefix.