Interface RateLimitInfoOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RateLimitInfo, RateLimitInfo.Builder

    public interface RateLimitInfoOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      double getFactor()
      If it has been at least one `period` since the last load adjustment, the client should multiply the current load by this value to get the new target load.
      com.google.protobuf.Duration getPeriod()
      Time that clients should wait before adjusting the target rate again.
      com.google.protobuf.DurationOrBuilder getPeriodOrBuilder()
      Time that clients should wait before adjusting the target rate again.
      boolean hasPeriod()
      Time that clients should wait before adjusting the target rate again.
      • 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

      • hasPeriod

        boolean hasPeriod()
         Time that clients should wait before adjusting the target rate again.
         If clients adjust rate too frequently, the impact of the previous
         adjustment may not have been taken into account and may
         over-throttle or under-throttle. If clients adjust rate too slowly, they
         will not be responsive to load changes on server side, and may
         over-throttle or under-throttle.
         
        .google.protobuf.Duration period = 1;
        Returns:
        Whether the period field is set.
      • getPeriod

        com.google.protobuf.Duration getPeriod()
         Time that clients should wait before adjusting the target rate again.
         If clients adjust rate too frequently, the impact of the previous
         adjustment may not have been taken into account and may
         over-throttle or under-throttle. If clients adjust rate too slowly, they
         will not be responsive to load changes on server side, and may
         over-throttle or under-throttle.
         
        .google.protobuf.Duration period = 1;
        Returns:
        The period.
      • getPeriodOrBuilder

        com.google.protobuf.DurationOrBuilder getPeriodOrBuilder()
         Time that clients should wait before adjusting the target rate again.
         If clients adjust rate too frequently, the impact of the previous
         adjustment may not have been taken into account and may
         over-throttle or under-throttle. If clients adjust rate too slowly, they
         will not be responsive to load changes on server side, and may
         over-throttle or under-throttle.
         
        .google.protobuf.Duration period = 1;
      • getFactor

        double getFactor()
         If it has been at least one `period` since the last load adjustment, the
         client should multiply the current load by this value to get the new target
         load. For example, if the current load is 100 and `factor` is 0.8, the new
         target load should be 80. After adjusting, the client should ignore
         `factor` until another `period` has passed.
        
         The client can measure its load using any unit that's comparable over time
         For example, QPS can be used as long as each request involves a similar
         amount of work.
         
        double factor = 2;
        Returns:
        The factor.