Class UsageLimit
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UsageLimit.Builder,
UsageLimit>
The usage limit object.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Long
amount()
The limit amount.final UsageLimitBreachAction
The action that Amazon Redshift Serverless takes when the limit is reached.final String
The action that Amazon Redshift Serverless takes when the limit is reached.static UsageLimit.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final UsageLimitPeriod
period()
The time period that the amount applies to.final String
The time period that the amount applies to.final String
The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.static Class
<? extends UsageLimit.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The Amazon Resource Name (ARN) of the resource associated with the usage limit.final String
The identifier of the usage limit.final UsageLimitUsageType
The Amazon Redshift Serverless feature to limit.final String
The Amazon Redshift Serverless feature to limit.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnUsageLimitBreachAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombreachActionAsString()
.- Returns:
- The action that Amazon Redshift Serverless takes when the limit is reached.
- See Also:
-
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 returnUsageLimitBreachAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombreachActionAsString()
.- Returns:
- The action that Amazon Redshift Serverless takes when the limit is reached.
- See Also:
-
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 returnUsageLimitPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromperiodAsString()
.- Returns:
- The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
- See Also:
-
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 returnUsageLimitPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromperiodAsString()
.- Returns:
- The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
- See Also:
-
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
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
The identifier of the usage limit.
- Returns:
- The identifier of the usage limit.
-
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 returnUsageLimitUsageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromusageTypeAsString()
.- Returns:
- The Amazon Redshift Serverless feature to limit.
- See Also:
-
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 returnUsageLimitUsageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromusageTypeAsString()
.- Returns:
- The Amazon Redshift Serverless feature to limit.
- See Also:
-
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 interfaceToCopyableBuilder<UsageLimit.Builder,
UsageLimit> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-