com.amazonaws.services.servicequotas.model.ServiceQuota Maven / Gradle / Ivy
Show all versions of aws-java-sdk-servicequotas Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.servicequotas.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Information about a quota.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ServiceQuota implements Serializable, Cloneable, StructuredPojo {
/**
*
* Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the
* ListServices operation.
*
*/
private String serviceCode;
/**
*
* Specifies the service name.
*
*/
private String serviceName;
/**
*
* The Amazon Resource Name (ARN) of the quota.
*
*/
private String quotaArn;
/**
*
* Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas
* operation, and look for the QuotaCode response in the output for the quota you want.
*
*/
private String quotaCode;
/**
*
* Specifies the quota name.
*
*/
private String quotaName;
/**
*
* The quota value.
*
*/
private Double value;
/**
*
* The unit of measurement.
*
*/
private String unit;
/**
*
* Indicates whether the quota value can be increased.
*
*/
private Boolean adjustable;
/**
*
* Indicates whether the quota is global.
*
*/
private Boolean globalQuota;
/**
*
* Information about the measurement.
*
*/
private MetricInfo usageMetric;
/**
*
* The period of time.
*
*/
private QuotaPeriod period;
/**
*
* The error code and error reason.
*
*/
private ErrorReason errorReason;
/**
*
* Specifies at which level of granularity that the quota value is applied.
*
*/
private String quotaAppliedAtLevel;
/**
*
* The context for this service quota.
*
*/
private QuotaContextInfo quotaContext;
/**
*
* Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the
* ListServices operation.
*
*
* @param serviceCode
* Specifies the service identifier. To find the service code value for an Amazon Web Services service, use
* the ListServices operation.
*/
public void setServiceCode(String serviceCode) {
this.serviceCode = serviceCode;
}
/**
*
* Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the
* ListServices operation.
*
*
* @return Specifies the service identifier. To find the service code value for an Amazon Web Services service, use
* the ListServices operation.
*/
public String getServiceCode() {
return this.serviceCode;
}
/**
*
* Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the
* ListServices operation.
*
*
* @param serviceCode
* Specifies the service identifier. To find the service code value for an Amazon Web Services service, use
* the ListServices operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withServiceCode(String serviceCode) {
setServiceCode(serviceCode);
return this;
}
/**
*
* Specifies the service name.
*
*
* @param serviceName
* Specifies the service name.
*/
public void setServiceName(String serviceName) {
this.serviceName = serviceName;
}
/**
*
* Specifies the service name.
*
*
* @return Specifies the service name.
*/
public String getServiceName() {
return this.serviceName;
}
/**
*
* Specifies the service name.
*
*
* @param serviceName
* Specifies the service name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withServiceName(String serviceName) {
setServiceName(serviceName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the quota.
*
*
* @param quotaArn
* The Amazon Resource Name (ARN) of the quota.
*/
public void setQuotaArn(String quotaArn) {
this.quotaArn = quotaArn;
}
/**
*
* The Amazon Resource Name (ARN) of the quota.
*
*
* @return The Amazon Resource Name (ARN) of the quota.
*/
public String getQuotaArn() {
return this.quotaArn;
}
/**
*
* The Amazon Resource Name (ARN) of the quota.
*
*
* @param quotaArn
* The Amazon Resource Name (ARN) of the quota.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withQuotaArn(String quotaArn) {
setQuotaArn(quotaArn);
return this;
}
/**
*
* Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas
* operation, and look for the QuotaCode response in the output for the quota you want.
*
*
* @param quotaCode
* Specifies the quota identifier. To find the quota code for a specific quota, use the
* ListServiceQuotas operation, and look for the QuotaCode response in the output for the
* quota you want.
*/
public void setQuotaCode(String quotaCode) {
this.quotaCode = quotaCode;
}
/**
*
* Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas
* operation, and look for the QuotaCode response in the output for the quota you want.
*
*
* @return Specifies the quota identifier. To find the quota code for a specific quota, use the
* ListServiceQuotas operation, and look for the QuotaCode response in the output for
* the quota you want.
*/
public String getQuotaCode() {
return this.quotaCode;
}
/**
*
* Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas
* operation, and look for the QuotaCode response in the output for the quota you want.
*
*
* @param quotaCode
* Specifies the quota identifier. To find the quota code for a specific quota, use the
* ListServiceQuotas operation, and look for the QuotaCode response in the output for the
* quota you want.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withQuotaCode(String quotaCode) {
setQuotaCode(quotaCode);
return this;
}
/**
*
* Specifies the quota name.
*
*
* @param quotaName
* Specifies the quota name.
*/
public void setQuotaName(String quotaName) {
this.quotaName = quotaName;
}
/**
*
* Specifies the quota name.
*
*
* @return Specifies the quota name.
*/
public String getQuotaName() {
return this.quotaName;
}
/**
*
* Specifies the quota name.
*
*
* @param quotaName
* Specifies the quota name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withQuotaName(String quotaName) {
setQuotaName(quotaName);
return this;
}
/**
*
* The quota value.
*
*
* @param value
* The quota value.
*/
public void setValue(Double value) {
this.value = value;
}
/**
*
* The quota value.
*
*
* @return The quota value.
*/
public Double getValue() {
return this.value;
}
/**
*
* The quota value.
*
*
* @param value
* The quota value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withValue(Double value) {
setValue(value);
return this;
}
/**
*
* The unit of measurement.
*
*
* @param unit
* The unit of measurement.
*/
public void setUnit(String unit) {
this.unit = unit;
}
/**
*
* The unit of measurement.
*
*
* @return The unit of measurement.
*/
public String getUnit() {
return this.unit;
}
/**
*
* The unit of measurement.
*
*
* @param unit
* The unit of measurement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withUnit(String unit) {
setUnit(unit);
return this;
}
/**
*
* Indicates whether the quota value can be increased.
*
*
* @param adjustable
* Indicates whether the quota value can be increased.
*/
public void setAdjustable(Boolean adjustable) {
this.adjustable = adjustable;
}
/**
*
* Indicates whether the quota value can be increased.
*
*
* @return Indicates whether the quota value can be increased.
*/
public Boolean getAdjustable() {
return this.adjustable;
}
/**
*
* Indicates whether the quota value can be increased.
*
*
* @param adjustable
* Indicates whether the quota value can be increased.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withAdjustable(Boolean adjustable) {
setAdjustable(adjustable);
return this;
}
/**
*
* Indicates whether the quota value can be increased.
*
*
* @return Indicates whether the quota value can be increased.
*/
public Boolean isAdjustable() {
return this.adjustable;
}
/**
*
* Indicates whether the quota is global.
*
*
* @param globalQuota
* Indicates whether the quota is global.
*/
public void setGlobalQuota(Boolean globalQuota) {
this.globalQuota = globalQuota;
}
/**
*
* Indicates whether the quota is global.
*
*
* @return Indicates whether the quota is global.
*/
public Boolean getGlobalQuota() {
return this.globalQuota;
}
/**
*
* Indicates whether the quota is global.
*
*
* @param globalQuota
* Indicates whether the quota is global.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withGlobalQuota(Boolean globalQuota) {
setGlobalQuota(globalQuota);
return this;
}
/**
*
* Indicates whether the quota is global.
*
*
* @return Indicates whether the quota is global.
*/
public Boolean isGlobalQuota() {
return this.globalQuota;
}
/**
*
* Information about the measurement.
*
*
* @param usageMetric
* Information about the measurement.
*/
public void setUsageMetric(MetricInfo usageMetric) {
this.usageMetric = usageMetric;
}
/**
*
* Information about the measurement.
*
*
* @return Information about the measurement.
*/
public MetricInfo getUsageMetric() {
return this.usageMetric;
}
/**
*
* Information about the measurement.
*
*
* @param usageMetric
* Information about the measurement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withUsageMetric(MetricInfo usageMetric) {
setUsageMetric(usageMetric);
return this;
}
/**
*
* The period of time.
*
*
* @param period
* The period of time.
*/
public void setPeriod(QuotaPeriod period) {
this.period = period;
}
/**
*
* The period of time.
*
*
* @return The period of time.
*/
public QuotaPeriod getPeriod() {
return this.period;
}
/**
*
* The period of time.
*
*
* @param period
* The period of time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withPeriod(QuotaPeriod period) {
setPeriod(period);
return this;
}
/**
*
* The error code and error reason.
*
*
* @param errorReason
* The error code and error reason.
*/
public void setErrorReason(ErrorReason errorReason) {
this.errorReason = errorReason;
}
/**
*
* The error code and error reason.
*
*
* @return The error code and error reason.
*/
public ErrorReason getErrorReason() {
return this.errorReason;
}
/**
*
* The error code and error reason.
*
*
* @param errorReason
* The error code and error reason.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withErrorReason(ErrorReason errorReason) {
setErrorReason(errorReason);
return this;
}
/**
*
* Specifies at which level of granularity that the quota value is applied.
*
*
* @param quotaAppliedAtLevel
* Specifies at which level of granularity that the quota value is applied.
* @see AppliedLevelEnum
*/
public void setQuotaAppliedAtLevel(String quotaAppliedAtLevel) {
this.quotaAppliedAtLevel = quotaAppliedAtLevel;
}
/**
*
* Specifies at which level of granularity that the quota value is applied.
*
*
* @return Specifies at which level of granularity that the quota value is applied.
* @see AppliedLevelEnum
*/
public String getQuotaAppliedAtLevel() {
return this.quotaAppliedAtLevel;
}
/**
*
* Specifies at which level of granularity that the quota value is applied.
*
*
* @param quotaAppliedAtLevel
* Specifies at which level of granularity that the quota value is applied.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppliedLevelEnum
*/
public ServiceQuota withQuotaAppliedAtLevel(String quotaAppliedAtLevel) {
setQuotaAppliedAtLevel(quotaAppliedAtLevel);
return this;
}
/**
*
* Specifies at which level of granularity that the quota value is applied.
*
*
* @param quotaAppliedAtLevel
* Specifies at which level of granularity that the quota value is applied.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppliedLevelEnum
*/
public ServiceQuota withQuotaAppliedAtLevel(AppliedLevelEnum quotaAppliedAtLevel) {
this.quotaAppliedAtLevel = quotaAppliedAtLevel.toString();
return this;
}
/**
*
* The context for this service quota.
*
*
* @param quotaContext
* The context for this service quota.
*/
public void setQuotaContext(QuotaContextInfo quotaContext) {
this.quotaContext = quotaContext;
}
/**
*
* The context for this service quota.
*
*
* @return The context for this service quota.
*/
public QuotaContextInfo getQuotaContext() {
return this.quotaContext;
}
/**
*
* The context for this service quota.
*
*
* @param quotaContext
* The context for this service quota.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceQuota withQuotaContext(QuotaContextInfo quotaContext) {
setQuotaContext(quotaContext);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getServiceCode() != null)
sb.append("ServiceCode: ").append(getServiceCode()).append(",");
if (getServiceName() != null)
sb.append("ServiceName: ").append(getServiceName()).append(",");
if (getQuotaArn() != null)
sb.append("QuotaArn: ").append(getQuotaArn()).append(",");
if (getQuotaCode() != null)
sb.append("QuotaCode: ").append(getQuotaCode()).append(",");
if (getQuotaName() != null)
sb.append("QuotaName: ").append(getQuotaName()).append(",");
if (getValue() != null)
sb.append("Value: ").append(getValue()).append(",");
if (getUnit() != null)
sb.append("Unit: ").append(getUnit()).append(",");
if (getAdjustable() != null)
sb.append("Adjustable: ").append(getAdjustable()).append(",");
if (getGlobalQuota() != null)
sb.append("GlobalQuota: ").append(getGlobalQuota()).append(",");
if (getUsageMetric() != null)
sb.append("UsageMetric: ").append(getUsageMetric()).append(",");
if (getPeriod() != null)
sb.append("Period: ").append(getPeriod()).append(",");
if (getErrorReason() != null)
sb.append("ErrorReason: ").append(getErrorReason()).append(",");
if (getQuotaAppliedAtLevel() != null)
sb.append("QuotaAppliedAtLevel: ").append(getQuotaAppliedAtLevel()).append(",");
if (getQuotaContext() != null)
sb.append("QuotaContext: ").append(getQuotaContext());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ServiceQuota == false)
return false;
ServiceQuota other = (ServiceQuota) obj;
if (other.getServiceCode() == null ^ this.getServiceCode() == null)
return false;
if (other.getServiceCode() != null && other.getServiceCode().equals(this.getServiceCode()) == false)
return false;
if (other.getServiceName() == null ^ this.getServiceName() == null)
return false;
if (other.getServiceName() != null && other.getServiceName().equals(this.getServiceName()) == false)
return false;
if (other.getQuotaArn() == null ^ this.getQuotaArn() == null)
return false;
if (other.getQuotaArn() != null && other.getQuotaArn().equals(this.getQuotaArn()) == false)
return false;
if (other.getQuotaCode() == null ^ this.getQuotaCode() == null)
return false;
if (other.getQuotaCode() != null && other.getQuotaCode().equals(this.getQuotaCode()) == false)
return false;
if (other.getQuotaName() == null ^ this.getQuotaName() == null)
return false;
if (other.getQuotaName() != null && other.getQuotaName().equals(this.getQuotaName()) == false)
return false;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
if (other.getUnit() == null ^ this.getUnit() == null)
return false;
if (other.getUnit() != null && other.getUnit().equals(this.getUnit()) == false)
return false;
if (other.getAdjustable() == null ^ this.getAdjustable() == null)
return false;
if (other.getAdjustable() != null && other.getAdjustable().equals(this.getAdjustable()) == false)
return false;
if (other.getGlobalQuota() == null ^ this.getGlobalQuota() == null)
return false;
if (other.getGlobalQuota() != null && other.getGlobalQuota().equals(this.getGlobalQuota()) == false)
return false;
if (other.getUsageMetric() == null ^ this.getUsageMetric() == null)
return false;
if (other.getUsageMetric() != null && other.getUsageMetric().equals(this.getUsageMetric()) == false)
return false;
if (other.getPeriod() == null ^ this.getPeriod() == null)
return false;
if (other.getPeriod() != null && other.getPeriod().equals(this.getPeriod()) == false)
return false;
if (other.getErrorReason() == null ^ this.getErrorReason() == null)
return false;
if (other.getErrorReason() != null && other.getErrorReason().equals(this.getErrorReason()) == false)
return false;
if (other.getQuotaAppliedAtLevel() == null ^ this.getQuotaAppliedAtLevel() == null)
return false;
if (other.getQuotaAppliedAtLevel() != null && other.getQuotaAppliedAtLevel().equals(this.getQuotaAppliedAtLevel()) == false)
return false;
if (other.getQuotaContext() == null ^ this.getQuotaContext() == null)
return false;
if (other.getQuotaContext() != null && other.getQuotaContext().equals(this.getQuotaContext()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getServiceCode() == null) ? 0 : getServiceCode().hashCode());
hashCode = prime * hashCode + ((getServiceName() == null) ? 0 : getServiceName().hashCode());
hashCode = prime * hashCode + ((getQuotaArn() == null) ? 0 : getQuotaArn().hashCode());
hashCode = prime * hashCode + ((getQuotaCode() == null) ? 0 : getQuotaCode().hashCode());
hashCode = prime * hashCode + ((getQuotaName() == null) ? 0 : getQuotaName().hashCode());
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
hashCode = prime * hashCode + ((getUnit() == null) ? 0 : getUnit().hashCode());
hashCode = prime * hashCode + ((getAdjustable() == null) ? 0 : getAdjustable().hashCode());
hashCode = prime * hashCode + ((getGlobalQuota() == null) ? 0 : getGlobalQuota().hashCode());
hashCode = prime * hashCode + ((getUsageMetric() == null) ? 0 : getUsageMetric().hashCode());
hashCode = prime * hashCode + ((getPeriod() == null) ? 0 : getPeriod().hashCode());
hashCode = prime * hashCode + ((getErrorReason() == null) ? 0 : getErrorReason().hashCode());
hashCode = prime * hashCode + ((getQuotaAppliedAtLevel() == null) ? 0 : getQuotaAppliedAtLevel().hashCode());
hashCode = prime * hashCode + ((getQuotaContext() == null) ? 0 : getQuotaContext().hashCode());
return hashCode;
}
@Override
public ServiceQuota clone() {
try {
return (ServiceQuota) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.servicequotas.model.transform.ServiceQuotaMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}