Class CreateUsageLimitRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.redshiftserverless.model.RedshiftServerlessRequest
software.amazon.awssdk.services.redshiftserverless.model.CreateUsageLimitRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateUsageLimitRequest.Builder,CreateUsageLimitRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateUsageLimitRequest extends RedshiftServerlessRequest implements ToCopyableBuilder<CreateUsageLimitRequest.Builder,CreateUsageLimitRequest>

  • Method Details

    • amount

      public final Long amount()

      The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.

      Returns:
      The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.

    • breachAction

      public final UsageLimitBreachAction breachAction()

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

      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. The default is log.
      See Also:

    • breachActionAsString

      public final String breachActionAsString()

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

      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. The default is log.
      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) of the Amazon Redshift Serverless resource to create the usage limit for.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.

    • usageType

      public final UsageLimitUsageType usageType()

      The type of Amazon Redshift Serverless usage to create a usage limit for.

      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 type of Amazon Redshift Serverless usage to create a usage limit for.
      See Also:

    • usageTypeAsString

      public final String usageTypeAsString()

      The type of Amazon Redshift Serverless usage to create a usage limit for.

      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 type of Amazon Redshift Serverless usage to create a usage limit for.
      See Also:

    • toBuilder

      public CreateUsageLimitRequest.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<CreateUsageLimitRequest.Builder,CreateUsageLimitRequest>
      Specified by:
      toBuilder in class RedshiftServerlessRequest
      Returns:
      a builder for type T

    • builder

      public static CreateUsageLimitRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateUsageLimitRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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