Class QuotaSettings

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

Quotas configured for a usage plan.

See Also:

  • Method Details

    • limit

      public final Integer limit()

      The target maximum number of requests that can be made in a given time period.

      Returns:
      The target maximum number of requests that can be made in a given time period.

    • offset

      public final Integer offset()

      The number of requests subtracted from the given limit in the initial time period.

      Returns:
      The number of requests subtracted from the given limit in the initial time period.

    • period

      public final QuotaPeriodType period()

      The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

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

      Returns:
      The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
      See Also:

    • periodAsString

      public final String periodAsString()

      The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

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

      Returns:
      The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
      See Also:

    • toBuilder

      public QuotaSettings.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<QuotaSettings.Builder,QuotaSettings>
      Returns:
      a builder for type T

    • builder

      public static QuotaSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends QuotaSettings.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.