io.envoyproxy.envoy.api.v2.route.WeightedClusterOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of envoy-api Show documentation
envoy-api
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/api/v2/route/route_components.proto

package io.envoyproxy.envoy.api.v2.route;

public interface WeightedClusterOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.api.v2.route.WeightedCluster)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Specifies one or more upstream clusters associated with the route.
   * 
   *
   * repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }
   */
  java.util.List 
      getClustersList();
  /**
   *    * Specifies one or more upstream clusters associated with the route.
   * 
   *
   * repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }
   */
  io.envoyproxy.envoy.api.v2.route.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) = { ... }
   */
  int getClustersCount();
  /**
   *    * Specifies one or more upstream clusters associated with the route.
   * 
   *
   * repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }
   */
  java.util.List 
      getClustersOrBuilderList();
  /**
   *    * Specifies one or more upstream clusters associated with the route.
   * 
   *
   * repeated .envoy.api.v2.route.WeightedCluster.ClusterWeight clusters = 1 [(.validate.rules) = { ... }
   */
  io.envoyproxy.envoy.api.v2.route.WeightedCluster.ClusterWeightOrBuilder getClustersOrBuilder(
      int index);

  /**
   *    * 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) = { ... }
   * @return Whether the totalWeight field is set.
   */
  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) = { ... }
   * @return The totalWeight.
   */
  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) = { ... }
   */
  com.google.protobuf.UInt32ValueOrBuilder getTotalWeightOrBuilder();

  /**
   *    * 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;
   * @return The runtimeKeyPrefix.
   */
  java.lang.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;
   * @return The bytes for runtimeKeyPrefix.
   */
  com.google.protobuf.ByteString
      getRuntimeKeyPrefixBytes();
}