Class ModifyUsageLimitResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.redshift.model.RedshiftResponse
-
- software.amazon.awssdk.services.redshift.model.ModifyUsageLimitResponse
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifyUsageLimitResponse.Builder,ModifyUsageLimitResponse>
@Generated("software.amazon.awssdk:codegen") public final class ModifyUsageLimitResponse extends RedshiftResponse implements ToCopyableBuilder<ModifyUsageLimitResponse.Builder,ModifyUsageLimitResponse>
Describes a usage limit object for a cluster.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ModifyUsageLimitResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Long
amount()
The limit amount.UsageLimitBreachAction
breachAction()
The action that Amazon Redshift takes when the limit is reached.String
breachActionAsString()
The action that Amazon Redshift takes when the limit is reached.static ModifyUsageLimitResponse.Builder
builder()
String
clusterIdentifier()
The identifier of the cluster with a usage limit.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
UsageLimitFeatureType
featureType()
The Amazon Redshift feature to which the limit applies.String
featureTypeAsString()
The Amazon Redshift feature to which the limit applies.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.UsageLimitLimitType
limitType()
The type of limit.String
limitTypeAsString()
The type of limit.UsageLimitPeriod
period()
The time period that the amount applies to.String
periodAsString()
The time period that the amount applies to.List<SdkField<?>>
sdkFields()
static Class<? extends ModifyUsageLimitResponse.Builder>
serializableBuilderClass()
List<Tag>
tags()
A list of tag instances.ModifyUsageLimitResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
usageLimitId()
The identifier of the usage limit.-
Methods inherited from class software.amazon.awssdk.services.redshift.model.RedshiftResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
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 returnUsageLimitFeatureType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfeatureTypeAsString()
.- Returns:
- The Amazon Redshift feature to which the limit applies.
- See Also:
UsageLimitFeatureType
-
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 returnUsageLimitFeatureType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfeatureTypeAsString()
.- Returns:
- The Amazon Redshift feature to which the limit applies.
- See Also:
UsageLimitFeatureType
-
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 returnUsageLimitLimitType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlimitTypeAsString()
.- Returns:
- The type of limit. Depending on the feature type, this can be based on a time duration or data size.
- See Also:
UsageLimitLimitType
-
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 returnUsageLimitLimitType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlimitTypeAsString()
.- Returns:
- The type of limit. Depending on the feature type, this can be based on a time duration or data size.
- See Also:
UsageLimitLimitType
-
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 ismonthly
.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 ismonthly
. - See Also:
UsageLimitPeriod
-
periodAsString
public final String periodAsString()
The time period that the amount applies to. A
weekly
period begins on Sunday. The default ismonthly
.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 ismonthly
. - See Also:
UsageLimitPeriod
-
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 returnUsageLimitBreachAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombreachActionAsString()
.- 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:
UsageLimitBreachAction
-
-
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 returnUsageLimitBreachAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombreachActionAsString()
.- 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:
UsageLimitBreachAction
-
-
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 theisEmpty()
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 ModifyUsageLimitResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModifyUsageLimitResponse.Builder,ModifyUsageLimitResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static ModifyUsageLimitResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyUsageLimitResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkResponse
-
-