Interface RateLimitQuotaResponse.BucketAction.QuotaAssignmentActionOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.Duration getAssignmentTimeToLive()
      A duration after which the assignment is be considered ``expired``.
      com.google.protobuf.DurationOrBuilder getAssignmentTimeToLiveOrBuilder()
      A duration after which the assignment is be considered ``expired``.
      RateLimitStrategy getRateLimitStrategy()
      Configures the local rate limiter for the request matched to the bucket.
      RateLimitStrategyOrBuilder getRateLimitStrategyOrBuilder()
      Configures the local rate limiter for the request matched to the bucket.
      boolean hasAssignmentTimeToLive()
      A duration after which the assignment is be considered ``expired``.
      boolean hasRateLimitStrategy()
      Configures the local rate limiter for the request matched to the bucket.
      • 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 Detail

      • hasAssignmentTimeToLive

        boolean hasAssignmentTimeToLive()
         A duration after which the assignment is be considered ``expired``. The process of the
         expiration is described :ref:`above
         <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction>`.
        
         * If unset, the assignment has no expiration date.
         * If set to ``0``, the assignment expires immediately, forcing the client into the
         :ref:`"expired assignment"
         <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
         state. This may be used by the RLQS server in cases when it needs clients to proactively
         fall back to the pre-configured :ref:`ExpiredAssignmentBehavior
         <envoy_v3_api_msg_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior>`,
         f.e. before the server going into restart.
        
         .. attention::
         Note that :ref:`expiring
         <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction>`
         the assignment is not the same as :ref:`abandoning
         <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
         the assignment. While expiring the assignment just transitions the bucket to
         the "expired assignment" state; abandoning the assignment completely erases
         the bucket from the data plane memory, and stops the usage reports.
         
        .google.protobuf.Duration assignment_time_to_live = 2 [(.validate.rules) = { ... }
        Returns:
        Whether the assignmentTimeToLive field is set.
      • getAssignmentTimeToLive

        com.google.protobuf.Duration getAssignmentTimeToLive()
         A duration after which the assignment is be considered ``expired``. The process of the
         expiration is described :ref:`above
         <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction>`.
        
         * If unset, the assignment has no expiration date.
         * If set to ``0``, the assignment expires immediately, forcing the client into the
         :ref:`"expired assignment"
         <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
         state. This may be used by the RLQS server in cases when it needs clients to proactively
         fall back to the pre-configured :ref:`ExpiredAssignmentBehavior
         <envoy_v3_api_msg_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior>`,
         f.e. before the server going into restart.
        
         .. attention::
         Note that :ref:`expiring
         <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction>`
         the assignment is not the same as :ref:`abandoning
         <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
         the assignment. While expiring the assignment just transitions the bucket to
         the "expired assignment" state; abandoning the assignment completely erases
         the bucket from the data plane memory, and stops the usage reports.
         
        .google.protobuf.Duration assignment_time_to_live = 2 [(.validate.rules) = { ... }
        Returns:
        The assignmentTimeToLive.
      • getAssignmentTimeToLiveOrBuilder

        com.google.protobuf.DurationOrBuilder getAssignmentTimeToLiveOrBuilder()
         A duration after which the assignment is be considered ``expired``. The process of the
         expiration is described :ref:`above
         <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction>`.
        
         * If unset, the assignment has no expiration date.
         * If set to ``0``, the assignment expires immediately, forcing the client into the
         :ref:`"expired assignment"
         <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior.expired_assignment_behavior_timeout>`
         state. This may be used by the RLQS server in cases when it needs clients to proactively
         fall back to the pre-configured :ref:`ExpiredAssignmentBehavior
         <envoy_v3_api_msg_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.ExpiredAssignmentBehavior>`,
         f.e. before the server going into restart.
        
         .. attention::
         Note that :ref:`expiring
         <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction>`
         the assignment is not the same as :ref:`abandoning
         <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.AbandonAction>`
         the assignment. While expiring the assignment just transitions the bucket to
         the "expired assignment" state; abandoning the assignment completely erases
         the bucket from the data plane memory, and stops the usage reports.
         
        .google.protobuf.Duration assignment_time_to_live = 2 [(.validate.rules) = { ... }
      • hasRateLimitStrategy

        boolean hasRateLimitStrategy()
         Configures the local rate limiter for the request matched to the bucket.
         If not set, allow all requests.
         
        .envoy.type.v3.RateLimitStrategy rate_limit_strategy = 3;
        Returns:
        Whether the rateLimitStrategy field is set.
      • getRateLimitStrategy

        RateLimitStrategy getRateLimitStrategy()
         Configures the local rate limiter for the request matched to the bucket.
         If not set, allow all requests.
         
        .envoy.type.v3.RateLimitStrategy rate_limit_strategy = 3;
        Returns:
        The rateLimitStrategy.
      • getRateLimitStrategyOrBuilder

        RateLimitStrategyOrBuilder getRateLimitStrategyOrBuilder()
         Configures the local rate limiter for the request matched to the bucket.
         If not set, allow all requests.
         
        .envoy.type.v3.RateLimitStrategy rate_limit_strategy = 3;