software.amazon.awssdk.services.apigateway.model

Class QuotaSettings

java.lang.Object

software.amazon.awssdk.services.apigateway.model.QuotaSettings

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<QuotaSettings.Builder,QuotaSettings>

@Generated(value="software.amazon.awssdk:codegen")
public class QuotaSettings
extends Object
implements StructuredPojo, ToCopyableBuilder<QuotaSettings.Builder,QuotaSettings>

Quotas configured for a usage plan.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QuotaSettings.Builder

Method Summary

Modifier and Type	Method and Description
static QuotaSettings.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit() The maximum number of requests that can be made in a given time period.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
Integer	offset() The number of requests subtracted from the given limit in the initial time period.
QuotaPeriodType	period() The time period in which the limit applies.
String	periodAsString() The time period in which the limit applies.
static Class<? extends QuotaSettings.Builder>	serializableBuilderClass()
QuotaSettings.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

limit

public Integer limit()

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.

offset

public Integer offset()

The number of requests subtracted from the given limit in the initial time period.

Returns:

The number of requests subtracted from the given limit in the initial time period.

period

public QuotaPeriodType period()

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

If the service returns an enum value that is not available in the current SDK version, period will return QuotaPeriodType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from periodAsString().

Returns:

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

See Also:

QuotaPeriodType

periodAsString

public String periodAsString()

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

If the service returns an enum value that is not available in the current SDK version, period will return QuotaPeriodType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from periodAsString().

Returns:

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

See Also:

QuotaPeriodType

toBuilder

public QuotaSettings.Builder 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 interface ToCopyableBuilder<QuotaSettings.Builder,QuotaSettings>

Returns:

a builder for type T

builder

public static QuotaSettings.Builder builder()

serializableBuilderClass

public static Class<? extends QuotaSettings.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

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.