UsageLimit (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UsageLimit
extends Object
implements Serializable, Cloneable, StructuredPojo

The usage limit object.

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 Serverless takes when the limit is reached.
`String`	`getPeriod()` The time period that the amount applies to.
`String`	`getResourceArn()` The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
`String`	`getUsageLimitArn()` The Amazon Resource Name (ARN) of the resource associated with the usage limit.
`String`	`getUsageLimitId()` The identifier of the usage limit.
`String`	`getUsageType()` The Amazon Redshift Serverless feature to limit.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAmount(Long amount)` The limit amount.
`void`	`setBreachAction(String breachAction)` The action that Amazon Redshift Serverless takes when the limit is reached.
`void`	`setPeriod(String period)` The time period that the amount applies to.
`void`	`setResourceArn(String resourceArn)` The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
`void`	`setUsageLimitArn(String usageLimitArn)` The Amazon Resource Name (ARN) of the resource associated with the usage limit.
`void`	`setUsageLimitId(String usageLimitId)` The identifier of the usage limit.
`void`	`setUsageType(String usageType)` The Amazon Redshift Serverless feature to 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 Serverless takes when the limit is reached.
`UsageLimit`	`withBreachAction(UsageLimitBreachAction breachAction)` The action that Amazon Redshift Serverless takes when the limit is reached.
`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`	`withResourceArn(String resourceArn)` The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
`UsageLimit`	`withUsageLimitArn(String usageLimitArn)` The Amazon Resource Name (ARN) of the resource associated with the usage limit.
`UsageLimit`	`withUsageLimitId(String usageLimitId)` The identifier of the usage limit.
`UsageLimit`	`withUsageType(String usageType)` The Amazon Redshift Serverless feature to limit.
`UsageLimit`	`withUsageType(UsageLimitUsageType usageType)` The Amazon Redshift Serverless feature to limit.

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

- Constructor Detail
  - UsageLimit
```
public UsageLimit()
```
- Method Detail
  - setAmount
```
public void setAmount(Long 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.
    
    Parameters:
    
    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.
  - getAmount
```
public Long getAmount()
```
    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.
  - withAmount
```
public UsageLimit withAmount(Long 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBreachAction
```
public void setBreachAction(String breachAction)
```
    The action that Amazon Redshift Serverless takes when the limit is reached.
    
    Parameters:
    
    breachAction - The action that Amazon Redshift Serverless takes when the limit is reached.
    
    See Also:
    
    UsageLimitBreachAction
  - getBreachAction
```
public String getBreachAction()
```
    The action that Amazon Redshift Serverless takes when the limit is reached.
    
    Returns:
    
    The action that Amazon Redshift Serverless takes when the limit is reached.
    
    See Also:
    
    UsageLimitBreachAction
  - withBreachAction
```
public UsageLimit withBreachAction(String breachAction)
```
    The action that Amazon Redshift Serverless takes when the limit is reached.
    
    Parameters:
    
    breachAction - The action that Amazon Redshift Serverless takes when the limit is reached.
    
    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 Serverless takes when the limit is reached.
    
    Parameters:
    
    breachAction - The action that Amazon Redshift Serverless takes when the limit is reached.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsageLimitBreachAction
  - 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
  - setResourceArn
```
public void setResourceArn(String resourceArn)
```
    The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
    
    Parameters:
    
    resourceArn - The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
  - getResourceArn
```
public String getResourceArn()
```
    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.
  - withResourceArn
```
public UsageLimit withResourceArn(String resourceArn)
```
    The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
    
    Parameters:
    
    resourceArn - The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsageLimitArn
```
public void setUsageLimitArn(String usageLimitArn)
```
    The Amazon Resource Name (ARN) of the resource associated with the usage limit.
    
    Parameters:
    
    usageLimitArn - The Amazon Resource Name (ARN) of the resource associated with the usage limit.
  - getUsageLimitArn
```
public String getUsageLimitArn()
```
    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.
  - withUsageLimitArn
```
public UsageLimit withUsageLimitArn(String usageLimitArn)
```
    The Amazon Resource Name (ARN) of the resource associated with the usage limit.
    
    Parameters:
    
    usageLimitArn - The Amazon Resource Name (ARN) of the resource associated with the usage limit.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - setUsageType
```
public void setUsageType(String usageType)
```
    The Amazon Redshift Serverless feature to limit.
    
    Parameters:
    
    usageType - The Amazon Redshift Serverless feature to limit.
    
    See Also:
    
    UsageLimitUsageType
  - getUsageType
```
public String getUsageType()
```
    The Amazon Redshift Serverless feature to limit.
    
    Returns:
    
    The Amazon Redshift Serverless feature to limit.
    
    See Also:
    
    UsageLimitUsageType
  - withUsageType
```
public UsageLimit withUsageType(String usageType)
```
    The Amazon Redshift Serverless feature to limit.
    
    Parameters:
    
    usageType - The Amazon Redshift Serverless feature to limit.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsageLimitUsageType
  - withUsageType
```
public UsageLimit withUsageType(UsageLimitUsageType usageType)
```
    The Amazon Redshift Serverless feature to limit.
    
    Parameters:
    
    usageType - The Amazon Redshift Serverless feature to limit.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UsageLimitUsageType
  - 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
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class UsageLimit

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UsageLimit

Method Detail

setAmount

getAmount

withAmount

setBreachAction

getBreachAction

withBreachAction

withBreachAction

setPeriod

getPeriod

withPeriod

withPeriod

setResourceArn

getResourceArn

withResourceArn

setUsageLimitArn

getUsageLimitArn

withUsageLimitArn

setUsageLimitId

getUsageLimitId

withUsageLimitId

setUsageType

getUsageType

withUsageType

withUsageType

toString

equals

hashCode

clone

marshall