Class UsagePlan

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

Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of a UsagePlan resource.

      Returns:
      The identifier of a UsagePlan resource.

    • name

      public final String name()

      The name of a usage plan.

      Returns:
      The name of a usage plan.

    • description

      public final String description()

      The description of a usage plan.

      Returns:
      The description of a usage plan.

    • hasApiStages

      public final boolean hasApiStages()
      For responses, this returns true if the service returned a value for the ApiStages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • apiStages

      public final List<ApiStage> apiStages()

      The associated API stages of a usage plan.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasApiStages() method.

      Returns:
      The associated API stages of a usage plan.

    • throttle

      public final ThrottleSettings throttle()

      A map containing method level throttling information for API stage in a usage plan.

      Returns:
      A map containing method level throttling information for API stage in a usage plan.

    • quota

      public final QuotaSettings quota()

      The target maximum number of permitted requests per a given unit time interval.

      Returns:
      The target maximum number of permitted requests per a given unit time interval.

    • productCode

      public final String productCode()

      The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.

      Returns:
      The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The collection of tags. Each tag element is associated with a given resource.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The collection of tags. Each tag element is associated with a given resource.

    • toBuilder

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

    • builder

      public static UsagePlan.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UsagePlan.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.