Class RateConfig

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.RateConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RateConfig.Builder,RateConfig>
@Generated("software.amazon.awssdk:codegen") public final class RateConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RateConfig.Builder,RateConfig>

Contains the rate configuration for a rate limit metric, specifying the allowed rate and time period.

See Also:

  • Method Details

    • rate

      public final Double rate()

      The rate value for the limit. For request limits, this is the number of requests allowed per period. For token limits, this is the number of tokens allowed per period. For connection limits, this is the number of concurrent connections allowed.

      Returns:
      The rate value for the limit. For request limits, this is the number of requests allowed per period. For token limits, this is the number of tokens allowed per period. For connection limits, this is the number of concurrent connections allowed.

    • period

      public final Period period()

      The time period for the rate limit. Valid values:

      • second—Measures the rate limit over a one-second window.

      • minute—Measures the rate limit over a one-minute window.

      If the service returns an enum value that is not available in the current SDK version, period will return Period.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from periodAsString().

      Returns:
      The time period for the rate limit. Valid values:

      • second—Measures the rate limit over a one-second window.

      • minute—Measures the rate limit over a one-minute window.

      See Also:

    • periodAsString

      public final String periodAsString()

      The time period for the rate limit. Valid values:

      • second—Measures the rate limit over a one-second window.

      • minute—Measures the rate limit over a one-minute window.

      If the service returns an enum value that is not available in the current SDK version, period will return Period.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from periodAsString().

      Returns:
      The time period for the rate limit. Valid values:

      • second—Measures the rate limit over a one-second window.

      • minute—Measures the rate limit over a one-minute window.

      See Also:

    • toBuilder

      public RateConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RateConfig.Builder,RateConfig>
      Returns:
      a builder for type T

    • builder

      public static RateConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RateConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.