io.envoyproxy.envoy.config.route.v3.RateLimitOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
There is a newer version: 1.0.47
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/config/route/v3/route_components.proto

package io.envoyproxy.envoy.config.route.v3;

public interface RateLimitOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.config.route.v3.RateLimit)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Refers to the stage set in the filter. The rate limit configuration only
   * applies to filters with the same stage number. The default stage number is
   * 0.
   * .. note::
   *   The filter supports a range of 0 - 10 inclusively for stage numbers.
   * 
   *
   * .google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }
   */
  boolean hasStage();
  /**
   *    * Refers to the stage set in the filter. The rate limit configuration only
   * applies to filters with the same stage number. The default stage number is
   * 0.
   * .. note::
   *   The filter supports a range of 0 - 10 inclusively for stage numbers.
   * 
   *
   * .google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }
   */
  com.google.protobuf.UInt32Value getStage();
  /**
   *    * Refers to the stage set in the filter. The rate limit configuration only
   * applies to filters with the same stage number. The default stage number is
   * 0.
   * .. note::
   *   The filter supports a range of 0 - 10 inclusively for stage numbers.
   * 
   *
   * .google.protobuf.UInt32Value stage = 1 [(.validate.rules) = { ... }
   */
  com.google.protobuf.UInt32ValueOrBuilder getStageOrBuilder();

  /**
   *    * The key to be set in runtime to disable this rate limit configuration.
   * 
   *
   * string disable_key = 2;
   */
  java.lang.String getDisableKey();
  /**
   *    * The key to be set in runtime to disable this rate limit configuration.
   * 
   *
   * string disable_key = 2;
   */
  com.google.protobuf.ByteString
      getDisableKeyBytes();

  /**
   *    * A list of actions that are to be applied for this rate limit configuration.
   * Order matters as the actions are processed sequentially and the descriptor
   * is composed by appending descriptor entries in that sequence. If an action
   * cannot append a descriptor entry, no descriptor is generated for the
   * configuration. See :ref:`composing actions
   * <config_http_filters_rate_limit_composing_actions>` for additional documentation.
   * 
   *
   * repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
   */
  java.util.List 
      getActionsList();
  /**
   *    * A list of actions that are to be applied for this rate limit configuration.
   * Order matters as the actions are processed sequentially and the descriptor
   * is composed by appending descriptor entries in that sequence. If an action
   * cannot append a descriptor entry, no descriptor is generated for the
   * configuration. See :ref:`composing actions
   * <config_http_filters_rate_limit_composing_actions>` for additional documentation.
   * 
   *
   * repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
   */
  io.envoyproxy.envoy.config.route.v3.RateLimit.Action getActions(int index);
  /**
   *    * A list of actions that are to be applied for this rate limit configuration.
   * Order matters as the actions are processed sequentially and the descriptor
   * is composed by appending descriptor entries in that sequence. If an action
   * cannot append a descriptor entry, no descriptor is generated for the
   * configuration. See :ref:`composing actions
   * <config_http_filters_rate_limit_composing_actions>` for additional documentation.
   * 
   *
   * repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
   */
  int getActionsCount();
  /**
   *    * A list of actions that are to be applied for this rate limit configuration.
   * Order matters as the actions are processed sequentially and the descriptor
   * is composed by appending descriptor entries in that sequence. If an action
   * cannot append a descriptor entry, no descriptor is generated for the
   * configuration. See :ref:`composing actions
   * <config_http_filters_rate_limit_composing_actions>` for additional documentation.
   * 
   *
   * repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
   */
  java.util.List 
      getActionsOrBuilderList();
  /**
   *    * A list of actions that are to be applied for this rate limit configuration.
   * Order matters as the actions are processed sequentially and the descriptor
   * is composed by appending descriptor entries in that sequence. If an action
   * cannot append a descriptor entry, no descriptor is generated for the
   * configuration. See :ref:`composing actions
   * <config_http_filters_rate_limit_composing_actions>` for additional documentation.
   * 
   *
   * repeated .envoy.config.route.v3.RateLimit.Action actions = 3 [(.validate.rules) = { ... }
   */
  io.envoyproxy.envoy.config.route.v3.RateLimit.ActionOrBuilder getActionsOrBuilder(
      int index);
}