Class LimitsProfile

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

A limits profile that defines resource usage limits for Amazon Quick Sight users. Limits profiles can be assigned to users, groups, or roles to control resource consumption.

See Also:

  • Method Details

    • profileId

      public final String profileId()

      The unique identifier for the limits profile.

      Returns:
      The unique identifier for the limits profile.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the limits profile.

      Returns:
      The Amazon Resource Name (ARN) of the limits profile.

    • accountId

      public final String accountId()

      The ID of the Amazon Web Services account that contains the limits profile.

      Returns:
      The ID of the Amazon Web Services account that contains the limits profile.

    • profileName

      public final String profileName()

      The display name of the limits profile.

      Returns:
      The display name of the limits profile.

    • description

      public final String description()

      The description of the limits profile.

      Returns:
      The description of the limits profile.

    • resourceLimits

      public final Map<ResourceType,ProfileLimitValue> resourceLimits()

      A map of resource types to their limit values.

      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 hasResourceLimits() method.

      Returns:
      A map of resource types to their limit values.

    • hasResourceLimits

      public final boolean hasResourceLimits()
      For responses, this returns true if the service returned a value for the ResourceLimits 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.

    • resourceLimitsAsStrings

      public final Map<String,ProfileLimitValue> resourceLimitsAsStrings()

      A map of resource types to their limit values.

      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 hasResourceLimits() method.

      Returns:
      A map of resource types to their limit values.

    • createdAt

      public final Instant createdAt()

      The date and time that the limits profile was created.

      Returns:
      The date and time that the limits profile was created.

    • updatedAt

      public final Instant updatedAt()

      The date and time that the limits profile was last updated.

      Returns:
      The date and time that the limits profile was last updated.

    • toBuilder

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

    • builder

      public static LimitsProfile.Builder builder()

    • serializableBuilderClass

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