ApiKey (AWS Java SDK :: Services :: Amazon API Gateway 2.20.133 API)

java.lang.Object
- software.amazon.awssdk.services.apigateway.model.ApiKey

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ApiKey.Builder,ApiKey>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ApiKey.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ApiKey.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ApiKey.Builder`	`builder()`
`Instant`	`createdDate()` The timestamp when the API Key was created.
`String`	`customerId()` An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
`String`	`description()` The description of the API Key.
`Boolean`	`enabled()` Specifies whether the API Key can be used by callers.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasStageKeys()` For responses, this returns true if the service returned a value for the StageKeys property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`id()` The identifier of the API Key.
`Instant`	`lastUpdatedDate()` The timestamp when the API Key was last updated.
`String`	`name()` The name of the API Key.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ApiKey.Builder>`	`serializableBuilderClass()`
`List<String>`	`stageKeys()` A list of Stage resources that are associated with the ApiKey resource.
`Map<String,String>`	`tags()` The collection of tags.
`ApiKey.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`value()` The value of the API Key.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ApiKey.Builder,ApiKey>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ApiKey

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

value

name

customerId

description

enabled

createdDate

lastUpdatedDate

hasStageKeys

stageKeys

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields