Class ApiKey
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ApiKey.Builder
builder()
final Instant
The timestamp when the API Key was created.final String
An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.final String
The description of the API Key.final Boolean
enabled()
Specifies whether the API Key can be used by callers.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StageKeys property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
id()
The identifier of the API Key.final Instant
The timestamp when the API Key was last updated.final String
name()
The name of the API Key.static Class
<? extends ApiKey.Builder> A list of Stage resources that are associated with the ApiKey resource.tags()
The collection of tags.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
value()
The value of the API Key.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The identifier of the API Key.
- Returns:
- The identifier of the API Key.
-
value
The value of the API Key.
- Returns:
- The value of the API Key.
-
name
The name of the API Key.
- Returns:
- The name of the API Key.
-
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
The description of the API Key.
- Returns:
- The description of the API Key.
-
enabled
Specifies whether the API Key can be used by callers.
- Returns:
- Specifies whether the API Key can be used by callers.
-
createdDate
The timestamp when the API Key was created.
- Returns:
- The timestamp when the API Key was created.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<ApiKey.Builder,
ApiKey> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-