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

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateUsageLimitRequest.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 CreateUsageLimitRequest.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) of the Amazon Redshift Serverless resource to create the usage limit for.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUsageLimitRequest.Builder>	serializableBuilderClass()
CreateUsageLimitRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UsageLimitUsageType	usageType()	The type of Amazon Redshift Serverless usage to create a usage limit for.
String	usageTypeAsString()	The type of Amazon Redshift Serverless usage to create a usage limit for.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

UsageLimitBreachAction

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:

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

UsageLimitUsageType

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:

UsageLimitUsageType

toBuilder

public CreateUsageLimitRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUsageLimitRequest.Builder,CreateUsageLimitRequest>

Specified by:

toBuilder in class RedshiftServerlessRequest

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)

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo