Package software.amazon.awssdk.services.redshiftserverless.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UsageLimit.Builder

Method Summary

Modifier and Type	Method	Description
Long	amount()	The limit amount.
UsageLimitBreachAction	breachAction()	The action that Amazon Redshift Serverless takes when the limit is reached.
String	breachActionAsString()	The action that Amazon Redshift Serverless takes when the limit is reached.
static UsageLimit.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
UsageLimitPeriod	period()	The time period that the amount applies to.
String	periodAsString()	The time period that the amount applies to.
String	resourceArn()	The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
List<SdkField<?>>	sdkFields()
static Class<? extends UsageLimit.Builder>	serializableBuilderClass()
UsageLimit.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	usageLimitArn()	The Amazon Resource Name (ARN) of the resource associated with the usage limit.
String	usageLimitId()	The identifier of the usage limit.
UsageLimitUsageType	usageType()	The Amazon Redshift Serverless feature to limit.
String	usageTypeAsString()	The Amazon Redshift Serverless feature to limit.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

UsageLimitBreachAction

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:

UsageLimitBreachAction

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:

UsageLimitPeriod

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:

UsageLimitPeriod

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:

UsageLimitUsageType

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:

UsageLimitUsageType

toBuilder

public UsageLimit.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UsageLimit.Builder,UsageLimit>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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