Package software.amazon.awssdk.services.redshift.model

Class UsageLimit

java.lang.Object
software.amazon.awssdk.services.redshift.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>

Describes a usage limit object for a cluster.

See Also:

  • Method Details

    • usageLimitId

      public final String usageLimitId()

      The identifier of the usage limit.

      Returns:
      The identifier of the usage limit.

    • clusterIdentifier

      public final String clusterIdentifier()

      The identifier of the cluster with a usage limit.

      Returns:
      The identifier of the cluster with a usage limit.

    • featureType

      public final UsageLimitFeatureType featureType()

      The Amazon Redshift feature to which the limit applies.

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

      Returns:
      The Amazon Redshift feature to which the limit applies.
      See Also:

    • featureTypeAsString

      public final String featureTypeAsString()

      The Amazon Redshift feature to which the limit applies.

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

      Returns:
      The Amazon Redshift feature to which the limit applies.
      See Also:

    • limitType

      public final UsageLimitLimitType limitType()

      The type of limit. Depending on the feature type, this can be based on a time duration or data size.

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

      Returns:
      The type of limit. Depending on the feature type, this can be based on a time duration or data size.
      See Also:

    • limitTypeAsString

      public final String limitTypeAsString()

      The type of limit. Depending on the feature type, this can be based on a time duration or data size.

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

      Returns:
      The type of limit. Depending on the feature type, this can be based on a time duration or data size.
      See Also:

    • amount

      public final Long amount()

      The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

      Returns:
      The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

    • 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:

    • breachAction

      public final UsageLimitBreachAction breachAction()

      The action that Amazon Redshift takes when the limit is reached. Possible values are:

      • log - To log an event in a system table. The default is log.

      • emit-metric - To emit CloudWatch metrics.

      • disable - To disable the feature until the next usage period begins.

      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 takes when the limit is reached. Possible values are:

      • log - To log an event in a system table. The default is log.

      • emit-metric - To emit CloudWatch metrics.

      • disable - To disable the feature until the next usage period begins.

      See Also:

    • breachActionAsString

      public final String breachActionAsString()

      The action that Amazon Redshift takes when the limit is reached. Possible values are:

      • log - To log an event in a system table. The default is log.

      • emit-metric - To emit CloudWatch metrics.

      • disable - To disable the feature until the next usage period begins.

      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 takes when the limit is reached. Possible values are:

      • log - To log an event in a system table. The default is log.

      • emit-metric - To emit CloudWatch metrics.

      • disable - To disable the feature until the next usage period begins.

      See Also:

    • hasTags

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

    • tags

      public final List<Tag> tags()

      A list of tag instances.

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

      Returns:
      A list of tag instances.

    • 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.