Package software.amazon.awssdk.services.apigateway.model

Class QuotaSettings

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<QuotaSettings.Builder,QuotaSettings>

@Generated("software.amazon.awssdk:codegen")
public final class QuotaSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<QuotaSettings.Builder,QuotaSettings>

Quotas configured for a usage plan.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QuotaSettings.Builder

Method Summary

Modifier and Type	Method	Description
static QuotaSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit()	The target maximum number of requests that can be made in a given time period.
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends QuotaSettings.Builder>	serializableBuilderClass()
QuotaSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

limit

public final Integer limit()

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

Returns:

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

offset

public final 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 final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<QuotaSettings.Builder,QuotaSettings>

builder

public static QuotaSettings.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo