Class UsageLimit

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

The usage limit object.

See Also:

  • Method Details

    • amount

      public final Long amount()

      The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

      Returns:
      The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

    • breachAction

      public final UsageLimitBreachAction breachAction()

      The action that Amazon Redshift Serverless takes when the limit is reached.

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

      Returns:
      The action that Amazon Redshift Serverless takes when the limit is reached.
      See Also:

    • breachActionAsString

      public final String breachActionAsString()

      The action that Amazon Redshift Serverless takes when the limit is reached.

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

      Returns:
      The action that Amazon Redshift Serverless takes when the limit is reached.
      See Also:

    • period

      public final UsageLimitPeriod period()

      The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

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

      Returns:
      The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
      See Also:

    • periodAsString

      public final String periodAsString()

      The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

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

      Returns:
      The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
      See Also:

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

      Returns:
      The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

    • usageLimitArn

      public final String usageLimitArn()

      The Amazon Resource Name (ARN) of the resource associated with the usage limit.

      Returns:
      The Amazon Resource Name (ARN) of the resource associated with the usage limit.

    • usageLimitId

      public final String usageLimitId()

      The identifier of the usage limit.

      Returns:
      The identifier of the usage limit.

    • usageType

      public final UsageLimitUsageType usageType()

      The Amazon Redshift Serverless feature to limit.

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

      Returns:
      The Amazon Redshift Serverless feature to limit.
      See Also:

    • usageTypeAsString

      public final String usageTypeAsString()

      The Amazon Redshift Serverless feature to limit.

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

      Returns:
      The Amazon Redshift Serverless feature to limit.
      See Also:

    • toBuilder

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

    • builder

      public static UsageLimit.Builder builder()

    • serializableBuilderClass

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