Class ModifyUsageLimitResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifyUsageLimitResponse.Builder,
ModifyUsageLimitResponse>
Describes a usage limit object for a cluster.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Long
amount()
The limit amount.final UsageLimitBreachAction
The action that Amazon Redshift takes when the limit is reached.final String
The action that Amazon Redshift takes when the limit is reached.builder()
final String
The identifier of the cluster with a usage limit.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final UsageLimitFeatureType
The Amazon Redshift feature to which the limit applies.final String
The Amazon Redshift feature to which the limit applies.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final UsageLimitLimitType
The type of limit.final String
The type of limit.final UsageLimitPeriod
period()
The time period that the amount applies to.final String
The time period that the amount applies to.static Class
<? extends ModifyUsageLimitResponse.Builder> tags()
A list of tag instances.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 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
usageLimitId
The identifier of the usage limit.
- Returns:
- The identifier of the usage limit.
-
clusterIdentifier
The identifier of the cluster with a usage limit.
- Returns:
- The identifier of the cluster with a usage limit.
-
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:
-
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:
-
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:
-
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:
-
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
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:
-
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:
-
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:
-
-
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:
-
-
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
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
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<ModifyUsageLimitResponse.Builder,
ModifyUsageLimitResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-