Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class LimitDefinitionType

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

The class and attributes that identify a specific limit at the account level.

See Also:

  • Method Details

    • limitClass

      public final LimitClass limitClass()

      The class of the limit. For API rate limits, this is API_CATEGORY.

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

      Returns:
      The class of the limit. For API rate limits, this is API_CATEGORY.
      See Also:

    • limitClassAsString

      public final String limitClassAsString()

      The class of the limit. For API rate limits, this is API_CATEGORY.

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

      Returns:
      The class of the limit. For API rate limits, this is API_CATEGORY.
      See Also:

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • attributes

      public final Map<String,String> attributes()

      The attributes that identify the specific limit. For API rate limits, specify the Category key with a value like UserAuthentication or UserCreation.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

      Returns:
      The attributes that identify the specific limit. For API rate limits, specify the Category key with a value like UserAuthentication or UserCreation.

    • toBuilder

      public LimitDefinitionType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<LimitDefinitionType.Builder,LimitDefinitionType>

    • builder

      public static LimitDefinitionType.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LimitDefinitionType.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo