Class QuotaSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<QuotaSettings.Builder,
QuotaSettings>
Quotas configured for a usage plan.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic QuotaSettings.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
limit()
The target maximum number of requests that can be made in a given time period.final Integer
offset()
The number of requests subtracted from the given limit in the initial time period.final QuotaPeriodType
period()
The time period in which the limit applies.final String
The time period in which the limit applies.static Class
<? extends QuotaSettings.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 returnQuotaPeriodType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromperiodAsString()
.- Returns:
- The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
- See Also:
-
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 returnQuotaPeriodType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromperiodAsString()
.- Returns:
- The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
- See Also:
-
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 interfaceToCopyableBuilder<QuotaSettings.Builder,
QuotaSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-