Class ApiKey

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

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the API Key.

      Returns:
      The identifier of the API Key.

    • value

      public final String value()

      The value of the API Key.

      Returns:
      The value of the API Key.

    • name

      public final String name()

      The name of the API Key.

      Returns:
      The name of the API Key.

    • customerId

      public final String customerId()

      An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

      Returns:
      An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

    • description

      public final String description()

      The description of the API Key.

      Returns:
      The description of the API Key.

    • enabled

      public final Boolean enabled()

      Specifies whether the API Key can be used by callers.

      Returns:
      Specifies whether the API Key can be used by callers.

    • createdDate

      public final Instant createdDate()

      The timestamp when the API Key was created.

      Returns:
      The timestamp when the API Key was created.

    • lastUpdatedDate

      public final Instant lastUpdatedDate()

      The timestamp when the API Key was last updated.

      Returns:
      The timestamp when the API Key was last updated.

    • hasStageKeys

      public final boolean hasStageKeys()
      For responses, this returns true if the service returned a value for the StageKeys 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.

    • stageKeys

      public final List<String> stageKeys()

      A list of Stage resources that are associated with the ApiKey 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 hasStageKeys() method.

      Returns:
      A list of Stage resources that are associated with the ApiKey resource.

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

    • builder

      public static ApiKey.Builder builder()

    • serializableBuilderClass

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