Class ServiceQuota

java.lang.Object
software.amazon.awssdk.services.servicequotas.model.ServiceQuota
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ServiceQuota.Builder,ServiceQuota>
@Generated("software.amazon.awssdk:codegen") public final class ServiceQuota extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ServiceQuota.Builder,ServiceQuota>

Information about a quota.

See Also:

  • Method Details

    • serviceCode

      public final String serviceCode()

      Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.

      Returns:
      Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.

    • serviceName

      public final String serviceName()

      Specifies the service name.

      Returns:
      Specifies the service name.

    • quotaArn

      public final String quotaArn()

      The Amazon Resource Name (ARN) of the quota.

      Returns:
      The Amazon Resource Name (ARN) of the quota.

    • quotaCode

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

      Returns:
      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.

    • quotaName

      public final String quotaName()

      Specifies the quota name.

      Returns:
      Specifies the quota name.

    • value

      public final Double value()

      The quota value.

      Returns:
      The quota value.

    • unit

      public final String unit()

      The unit of measurement.

      Returns:
      The unit of measurement.

    • adjustable

      public final Boolean adjustable()

      Indicates whether the quota value can be increased.

      Returns:
      Indicates whether the quota value can be increased.

    • globalQuota

      public final Boolean globalQuota()

      Indicates whether the quota is global.

      Returns:
      Indicates whether the quota is global.

    • usageMetric

      public final MetricInfo usageMetric()

      Information about the measurement.

      Returns:
      Information about the measurement.

    • period

      public final QuotaPeriod period()

      The period of time.

      Returns:
      The period of time.

    • errorReason

      public final ErrorReason errorReason()

      The error code and error reason.

      Returns:
      The error code and error reason.

    • quotaAppliedAtLevel

      public final AppliedLevelEnum quotaAppliedAtLevel()

      Specifies at which level of granularity that the quota value is applied.

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

      Returns:
      Specifies at which level of granularity that the quota value is applied.
      See Also:

    • quotaAppliedAtLevelAsString

      public final String quotaAppliedAtLevelAsString()

      Specifies at which level of granularity that the quota value is applied.

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

      Returns:
      Specifies at which level of granularity that the quota value is applied.
      See Also:

    • quotaContext

      public final QuotaContextInfo quotaContext()

      The context for this service quota.

      Returns:
      The context for this service quota.

    • toBuilder

      public ServiceQuota.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<ServiceQuota.Builder,ServiceQuota>
      Returns:
      a builder for type T

    • builder

      public static ServiceQuota.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ServiceQuota.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.