com.amazonaws.services.apigateway.model

Class QuotaSettings

java.lang.Object

com.amazonaws.services.apigateway.model.QuotaSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Quotas configured for a usage plan.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QuotaSettings()

Method Summary

Modifier and Type	Method and Description
QuotaSettings	clone()
boolean	equals(Object obj)
Integer	getLimit() The maximum number of requests that can be made in a given time period.
Integer	getOffset() The day that a time period starts.
String	getPeriod() The time period in which the limit applies.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setLimit(Integer limit) The maximum number of requests that can be made in a given time period.
void	setOffset(Integer offset) The day that a time period starts.
void	setPeriod(QuotaPeriodType period) The time period in which the limit applies.
void	setPeriod(String period) The time period in which the limit applies.
String	toString() Returns a string representation of this object.
QuotaSettings	withLimit(Integer limit) The maximum number of requests that can be made in a given time period.
QuotaSettings	withOffset(Integer offset) The day that a time period starts.
QuotaSettings	withPeriod(QuotaPeriodType period) The time period in which the limit applies.
QuotaSettings	withPeriod(String period) The time period in which the limit applies.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QuotaSettings

public QuotaSettings()

Method Detail

setLimit

public void setLimit(Integer limit)

The maximum number of requests that can be made in a given time period.

Parameters:

limit - The maximum number of requests that can be made in a given time period.

getLimit

public Integer getLimit()

The maximum number of requests that can be made in a given time period.

Returns:

The maximum number of requests that can be made in a given time period.

withLimit

public QuotaSettings withLimit(Integer limit)

The maximum number of requests that can be made in a given time period.

Parameters:

limit - The maximum number of requests that can be made in a given time period.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOffset

public void setOffset(Integer offset)

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

Parameters:

offset - The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

getOffset

public Integer getOffset()

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

Returns:

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

withOffset

public QuotaSettings withOffset(Integer offset)

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

Parameters:

offset - The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPeriod

public void setPeriod(String period)

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Parameters:

period - The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

See Also:

QuotaPeriodType

getPeriod

public String getPeriod()

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Returns:

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

See Also:

QuotaPeriodType

withPeriod

public QuotaSettings withPeriod(String period)

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Parameters:

period - The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QuotaPeriodType

setPeriod

public void setPeriod(QuotaPeriodType period)

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Parameters:

period - The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

See Also:

QuotaPeriodType

withPeriod

public QuotaSettings withPeriod(QuotaPeriodType period)

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Parameters:

period - The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QuotaPeriodType

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 QuotaSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo