UsageLimit (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.redshift.model.UsageLimit

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UsageLimit
extends Object
implements Serializable, Cloneable
```
Describes a usage limit object for a cluster.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UsageLimit()

Constructors
Constructor and Description
`UsageLimit()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UsageLimit`	`clone()`
`boolean`	`equals(Object obj)`
`Long`	`getAmount()` The limit amount.
`String`	`getBreachAction()` The action that Amazon Redshift takes when the limit is reached.
`String`	`getClusterIdentifier()` The identifier of the cluster with a usage limit.
`String`	`getFeatureType()` The Amazon Redshift feature to which the limit applies.
`String`	`getLimitType()` The type of limit.
`String`	`getPeriod()` The time period that the amount applies to.
`List<Tag>`	`getTags()` A list of tag instances.
`String`	`getUsageLimitId()` The identifier of the usage limit.
`int`	`hashCode()`
`void`	`setAmount(Long amount)` The limit amount.
`void`	`setBreachAction(String breachAction)` The action that Amazon Redshift takes when the limit is reached.
`void`	`setClusterIdentifier(String clusterIdentifier)` The identifier of the cluster with a usage limit.
`void`	`setFeatureType(String featureType)` The Amazon Redshift feature to which the limit applies.
`void`	`setLimitType(String limitType)` The type of limit.
`void`	`setPeriod(String period)` The time period that the amount applies to.
`void`	`setTags(Collection<Tag> tags)` A list of tag instances.
`void`	`setUsageLimitId(String usageLimitId)` The identifier of the usage limit.
`String`	`toString()` Returns a string representation of this object.
`UsageLimit`	`withAmount(Long amount)` The limit amount.
`UsageLimit`	`withBreachAction(String breachAction)` The action that Amazon Redshift takes when the limit is reached.
`UsageLimit`	`withBreachAction(UsageLimitBreachAction breachAction)` The action that Amazon Redshift takes when the limit is reached.
`UsageLimit`	`withClusterIdentifier(String clusterIdentifier)` The identifier of the cluster with a usage limit.
`UsageLimit`	`withFeatureType(String featureType)` The Amazon Redshift feature to which the limit applies.
`UsageLimit`	`withFeatureType(UsageLimitFeatureType featureType)` The Amazon Redshift feature to which the limit applies.
`UsageLimit`	`withLimitType(String limitType)` The type of limit.
`UsageLimit`	`withLimitType(UsageLimitLimitType limitType)` The type of limit.
`UsageLimit`	`withPeriod(String period)` The time period that the amount applies to.
`UsageLimit`	`withPeriod(UsageLimitPeriod period)` The time period that the amount applies to.
`UsageLimit`	`withTags(Collection<Tag> tags)` A list of tag instances.
`UsageLimit`	`withTags(Tag... tags)` A list of tag instances.
`UsageLimit`	`withUsageLimitId(String usageLimitId)` The identifier of the usage limit.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UsageLimit
```
public UsageLimit()
```
- Method Detail
  - setUsageLimitId
```
public void setUsageLimitId(String usageLimitId)
```
    The identifier of the usage limit.
    
    Parameters:
    
    usageLimitId - The identifier of the usage limit.
  - getUsageLimitId
```
public String getUsageLimitId()
```
    The identifier of the usage limit.
    
    Returns:
    
    The identifier of the usage limit.
  - withUsageLimitId
```
public UsageLimit withUsageLimitId(String usageLimitId)
```
    The identifier of the usage limit.
    
    Parameters:
    
    usageLimitId - The identifier of the usage limit.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClusterIdentifier
```
public void setClusterIdentifier(String clusterIdentifier)
```
    The identifier of the cluster with a usage limit.
    
    Parameters:
    
    clusterIdentifier - The identifier of the cluster with a usage limit.
  - getClusterIdentifier
```
public String getClusterIdentifier()
```
    The identifier of the cluster with a usage limit.
    
    Returns:
    
    The identifier of the cluster with a usage limit.
  - withClusterIdentifier
```
public UsageLimit withClusterIdentifier(String clusterIdentifier)
```
    The identifier of the cluster with a usage limit.
    
    Parameters:
    
    clusterIdentifier - The identifier of the cluster with a usage limit.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFeatureType
```
public void setFeatureType(String featureType)
```
    The Amazon Redshift feature to which the limit applies.
    
    Parameters:
    
    featureType - The Amazon Redshift feature to which the limit applies.
    
    See Also:
    
    UsageLimitFeatureType
  - getFeatureType
```
public String getFeatureType()
```
    The Amazon Redshift feature to which the limit applies.
    
    Returns:
    
    The Amazon Redshift feature to which the limit applies.
    
    See Also:
    
    UsageLimitFeatureType
  - withFeatureType
```
public UsageLimit withFeatureType(String featureType)
```
    The Amazon Redshift feature to which the limit applies.
    
    Parameters:
    
    featureType - The Amazon Redshift feature to which the limit applies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsageLimitFeatureType
  - withFeatureType
```
public UsageLimit withFeatureType(UsageLimitFeatureType featureType)
```
    The Amazon Redshift feature to which the limit applies.
    
    Parameters:
    
    featureType - The Amazon Redshift feature to which the limit applies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsageLimitFeatureType
  - setLimitType
```
public void setLimitType(String limitType)
```
    The type of limit. Depending on the feature type, this can be based on a time duration or data size.
    
    Parameters:
    
    limitType - The type of limit. Depending on the feature type, this can be based on a time duration or data size.
    
    See Also:
    
    UsageLimitLimitType
  - getLimitType
```
public String getLimitType()
```
    The type of limit. Depending on the feature type, this can be based on a time duration or data size.
    
    Returns:
    
    The type of limit. Depending on the feature type, this can be based on a time duration or data size.
    
    See Also:
    
    UsageLimitLimitType
  - withLimitType
```
public UsageLimit withLimitType(String limitType)
```
    The type of limit. Depending on the feature type, this can be based on a time duration or data size.
    
    Parameters:
    
    limitType - The type of limit. Depending on the feature type, this can be based on a time duration or data size.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsageLimitLimitType
  - withLimitType
```
public UsageLimit withLimitType(UsageLimitLimitType limitType)
```
    The type of limit. Depending on the feature type, this can be based on a time duration or data size.
    
    Parameters:
    
    limitType - The type of limit. Depending on the feature type, this can be based on a time duration or data size.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsageLimitLimitType
  - setAmount
```
public void setAmount(Long amount)
```
    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
    
    Parameters:
    
    amount - The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
  - getAmount
```
public Long getAmount()
```
    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).
  - withAmount
```
public UsageLimit withAmount(Long amount)
```
    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
    
    Parameters:
    
    amount - The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPeriod
```
public void setPeriod(String period)
```
    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    
    Parameters:
    
    period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    
    See Also:
    
    UsageLimitPeriod
  - getPeriod
```
public String getPeriod()
```
    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    
    Returns:
    
    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    
    See Also:
    
    UsageLimitPeriod
  - withPeriod
```
public UsageLimit withPeriod(String period)
```
    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    
    Parameters:
    
    period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsageLimitPeriod
  - withPeriod
```
public UsageLimit withPeriod(UsageLimitPeriod period)
```
    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    
    Parameters:
    
    period - The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsageLimitPeriod
  - setBreachAction
```
public void setBreachAction(String 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.
    Parameters:
    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.
    See Also:
    
    UsageLimitBreachAction
  - getBreachAction
```
public String getBreachAction()
```
    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.
    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
  - withBreachAction
```
public UsageLimit withBreachAction(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsageLimitBreachAction
  - withBreachAction
```
public UsageLimit withBreachAction(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsageLimitBreachAction
  - getTags
```
public List<Tag> getTags()
```
    A list of tag instances.
    
    Returns:
    
    A list of tag instances.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of tag instances.
    
    Parameters:
    
    tags - A list of tag instances.
  - withTags
```
public UsageLimit withTags(Tag... tags)
```
    A list of tag instances.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - A list of tag instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public UsageLimit withTags(Collection<Tag> tags)
```
    A list of tag instances.
    
    Parameters:
    
    tags - A list of tag instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UsageLimit clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.557

Class UsageLimit

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UsageLimit

Method Detail

setUsageLimitId

getUsageLimitId

withUsageLimitId

setClusterIdentifier

getClusterIdentifier

withClusterIdentifier

setFeatureType

getFeatureType

withFeatureType

withFeatureType

setLimitType

getLimitType

withLimitType

withLimitType

setAmount

getAmount

withAmount

setPeriod

getPeriod

withPeriod

withPeriod

setBreachAction

getBreachAction

withBreachAction

withBreachAction

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone