software.amazon.awssdk.services.apigateway.model.QuotaSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of apigateway Show documentation
Show all versions of apigateway Show documentation
The AWS Java SDK for Amazon API Gateway module holds the client classes that are used for communicating
with Amazon API
Gateway
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.apigateway.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Quotas configured for a usage plan.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class QuotaSettings implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField LIMIT_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("limit")
.getter(getter(QuotaSettings::limit)).setter(setter(Builder::limit))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("limit").build()).build();
private static final SdkField OFFSET_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("offset").getter(getter(QuotaSettings::offset)).setter(setter(Builder::offset))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("offset").build()).build();
private static final SdkField PERIOD_FIELD = SdkField. builder(MarshallingType.STRING).memberName("period")
.getter(getter(QuotaSettings::periodAsString)).setter(setter(Builder::period))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("period").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(LIMIT_FIELD, OFFSET_FIELD,
PERIOD_FIELD));
private static final long serialVersionUID = 1L;
private final Integer limit;
private final Integer offset;
private final String period;
private QuotaSettings(BuilderImpl builder) {
this.limit = builder.limit;
this.offset = builder.offset;
this.period = builder.period;
}
/**
*
* The target maximum number of requests that can be made in a given time period.
*
*
* @return The target maximum number of requests that can be made in a given time period.
*/
public final Integer limit() {
return limit;
}
/**
*
* The number of requests subtracted from the given limit in the initial time period.
*
*
* @return The number of requests subtracted from the given limit in the initial time period.
*/
public final Integer offset() {
return offset;
}
/**
*
* 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, {@link #period} will
* return {@link QuotaPeriodType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #periodAsString}.
*
*
* @return The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
* @see QuotaPeriodType
*/
public final QuotaPeriodType period() {
return QuotaPeriodType.fromValue(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, {@link #period} will
* return {@link QuotaPeriodType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #periodAsString}.
*
*
* @return The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
* @see QuotaPeriodType
*/
public final String periodAsString() {
return period;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(limit());
hashCode = 31 * hashCode + Objects.hashCode(offset());
hashCode = 31 * hashCode + Objects.hashCode(periodAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof QuotaSettings)) {
return false;
}
QuotaSettings other = (QuotaSettings) obj;
return Objects.equals(limit(), other.limit()) && Objects.equals(offset(), other.offset())
&& Objects.equals(periodAsString(), other.periodAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("QuotaSettings").add("Limit", limit()).add("Offset", offset()).add("Period", periodAsString())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "limit":
return Optional.ofNullable(clazz.cast(limit()));
case "offset":
return Optional.ofNullable(clazz.cast(offset()));
case "period":
return Optional.ofNullable(clazz.cast(periodAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((QuotaSettings) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The target maximum number of requests that can be made in a given time period.
*
*
* @param limit
* The target maximum number of requests that can be made in a given time period.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder limit(Integer limit);
/**
*
* The number of requests subtracted from the given limit in the initial time period.
*
*
* @param offset
* The number of requests subtracted from the given limit in the initial time period.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder offset(Integer offset);
/**
*
* The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
*
*
* @param period
* The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
* @see QuotaPeriodType
* @return Returns a reference to this object so that method calls can be chained together.
* @see QuotaPeriodType
*/
Builder period(String period);
/**
*
* The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
*
*
* @param period
* The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
* @see QuotaPeriodType
* @return Returns a reference to this object so that method calls can be chained together.
* @see QuotaPeriodType
*/
Builder period(QuotaPeriodType period);
}
static final class BuilderImpl implements Builder {
private Integer limit;
private Integer offset;
private String period;
private BuilderImpl() {
}
private BuilderImpl(QuotaSettings model) {
limit(model.limit);
offset(model.offset);
period(model.period);
}
public final Integer getLimit() {
return limit;
}
public final void setLimit(Integer limit) {
this.limit = limit;
}
@Override
public final Builder limit(Integer limit) {
this.limit = limit;
return this;
}
public final Integer getOffset() {
return offset;
}
public final void setOffset(Integer offset) {
this.offset = offset;
}
@Override
public final Builder offset(Integer offset) {
this.offset = offset;
return this;
}
public final String getPeriod() {
return period;
}
public final void setPeriod(String period) {
this.period = period;
}
@Override
public final Builder period(String period) {
this.period = period;
return this;
}
@Override
public final Builder period(QuotaPeriodType period) {
this.period(period == null ? null : period.toString());
return this;
}
@Override
public QuotaSettings build() {
return new QuotaSettings(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}