Class EffectiveLimit

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

The effective limit for a resource type that applies to a user, considering all applicable profile assignments and inheritance rules.

See Also:

  • Method Details

    • resourceType

      public final ResourceType resourceType()

      The type of resource that the limit applies to.

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

      Returns:
      The type of resource that the limit applies to.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of resource that the limit applies to.

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

      Returns:
      The type of resource that the limit applies to.
      See Also:

    • limitValue

      public final Long limitValue()

      The maximum allowed value for the resource.

      Returns:
      The maximum allowed value for the resource.

    • limitUnit

      public final LimitUnit limitUnit()

      The unit of measurement for the limit.

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

      Returns:
      The unit of measurement for the limit.
      See Also:

    • limitUnitAsString

      public final String limitUnitAsString()

      The unit of measurement for the limit.

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

      Returns:
      The unit of measurement for the limit.
      See Also:

    • source

      public final LimitSource source()

      The source from which this limit was inherited. Possible values:

      • DIRECT_USER – The limit comes from a profile directly assigned to the user.

      • GROUP – The limit comes from a profile assigned to a group the user belongs to.

      • ROLE – The limit comes from a profile assigned to a role the user has.

      • ACCOUNT – The limit comes from the account-level default profile.

      • SYSTEM_DEFAULT – The limit comes from the built-in system default.

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

      Returns:
      The source from which this limit was inherited. Possible values:

      • DIRECT_USER – The limit comes from a profile directly assigned to the user.

      • GROUP – The limit comes from a profile assigned to a group the user belongs to.

      • ROLE – The limit comes from a profile assigned to a role the user has.

      • ACCOUNT – The limit comes from the account-level default profile.

      • SYSTEM_DEFAULT – The limit comes from the built-in system default.

      See Also:

    • sourceAsString

      public final String sourceAsString()

      The source from which this limit was inherited. Possible values:

      • DIRECT_USER – The limit comes from a profile directly assigned to the user.

      • GROUP – The limit comes from a profile assigned to a group the user belongs to.

      • ROLE – The limit comes from a profile assigned to a role the user has.

      • ACCOUNT – The limit comes from the account-level default profile.

      • SYSTEM_DEFAULT – The limit comes from the built-in system default.

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

      Returns:
      The source from which this limit was inherited. Possible values:

      • DIRECT_USER – The limit comes from a profile directly assigned to the user.

      • GROUP – The limit comes from a profile assigned to a group the user belongs to.

      • ROLE – The limit comes from a profile assigned to a role the user has.

      • ACCOUNT – The limit comes from the account-level default profile.

      • SYSTEM_DEFAULT – The limit comes from the built-in system default.

      See Also:

    • profileId

      public final String profileId()

      The identifier of the limits profile that defines this limit.

      Returns:
      The identifier of the limits profile that defines this limit.

    • toBuilder

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

    • builder

      public static EffectiveLimit.Builder builder()

    • serializableBuilderClass

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