ApiKey (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.ApiKey

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ApiKey
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

Use API Keys

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ApiKey()

Constructors
Constructor and Description
`ApiKey()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApiKey`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedDate()` The timestamp when the API Key was created.
`String`	`getCustomerId()` An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
`String`	`getDescription()` The description of the API Key.
`Boolean`	`getEnabled()` Specifies whether the API Key can be used by callers.
`String`	`getId()` The identifier of the API Key.
`Date`	`getLastUpdatedDate()` The timestamp when the API Key was last updated.
`String`	`getName()` The name of the API Key.
`List<String>`	`getStageKeys()` A list of Stage resources that are associated with the ApiKey resource.
`String`	`getValue()` The value of the API Key.
`int`	`hashCode()`
`Boolean`	`isEnabled()` Specifies whether the API Key can be used by callers.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreatedDate(Date createdDate)` The timestamp when the API Key was created.
`void`	`setCustomerId(String customerId)` An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
`void`	`setDescription(String description)` The description of the API Key.
`void`	`setEnabled(Boolean enabled)` Specifies whether the API Key can be used by callers.
`void`	`setId(String id)` The identifier of the API Key.
`void`	`setLastUpdatedDate(Date lastUpdatedDate)` The timestamp when the API Key was last updated.
`void`	`setName(String name)` The name of the API Key.
`void`	`setStageKeys(Collection<String> stageKeys)` A list of Stage resources that are associated with the ApiKey resource.
`void`	`setValue(String value)` The value of the API Key.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ApiKey`	`withCreatedDate(Date createdDate)` The timestamp when the API Key was created.
`ApiKey`	`withCustomerId(String customerId)` An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
`ApiKey`	`withDescription(String description)` The description of the API Key.
`ApiKey`	`withEnabled(Boolean enabled)` Specifies whether the API Key can be used by callers.
`ApiKey`	`withId(String id)` The identifier of the API Key.
`ApiKey`	`withLastUpdatedDate(Date lastUpdatedDate)` The timestamp when the API Key was last updated.
`ApiKey`	`withName(String name)` The name of the API Key.
`ApiKey`	`withStageKeys(Collection<String> stageKeys)` A list of Stage resources that are associated with the ApiKey resource.
`ApiKey`	`withStageKeys(String... stageKeys)` A list of Stage resources that are associated with the ApiKey resource.
`ApiKey`	`withValue(String value)` The value of the API Key.

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

- Constructor Detail
  - ApiKey
```
public ApiKey()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier of the API Key.
    
    Parameters:
    
    id - The identifier of the API Key.
  - getId
```
public String getId()
```
    The identifier of the API Key.
    
    Returns:
    
    The identifier of the API Key.
  - withId
```
public ApiKey withId(String id)
```
    The identifier of the API Key.
    
    Parameters:
    
    id - The identifier of the API Key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValue
```
public void setValue(String value)
```
    The value of the API Key.
    
    Parameters:
    
    value - The value of the API Key.
  - getValue
```
public String getValue()
```
    The value of the API Key.
    
    Returns:
    
    The value of the API Key.
  - withValue
```
public ApiKey withValue(String value)
```
    The value of the API Key.
    
    Parameters:
    
    value - The value of the API Key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the API Key.
    
    Parameters:
    
    name - The name of the API Key.
  - getName
```
public String getName()
```
    The name of the API Key.
    
    Returns:
    
    The name of the API Key.
  - withName
```
public ApiKey withName(String name)
```
    The name of the API Key.
    
    Parameters:
    
    name - The name of the API Key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomerId
```
public void setCustomerId(String customerId)
```
    An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
    
    Parameters:
    
    customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
  - getCustomerId
```
public String getCustomerId()
```
    An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
    
    Returns:
    
    An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
  - withCustomerId
```
public ApiKey withCustomerId(String customerId)
```
    An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
    
    Parameters:
    
    customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the API Key.
    
    Parameters:
    
    description - The description of the API Key.
  - getDescription
```
public String getDescription()
```
    The description of the API Key.
    
    Returns:
    
    The description of the API Key.
  - withDescription
```
public ApiKey withDescription(String description)
```
    The description of the API Key.
    
    Parameters:
    
    description - The description of the API Key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Specifies whether the API Key can be used by callers.
    
    Parameters:
    
    enabled - Specifies whether the API Key can be used by callers.
  - getEnabled
```
public Boolean getEnabled()
```
    Specifies whether the API Key can be used by callers.
    
    Returns:
    
    Specifies whether the API Key can be used by callers.
  - withEnabled
```
public ApiKey withEnabled(Boolean enabled)
```
    Specifies whether the API Key can be used by callers.
    
    Parameters:
    
    enabled - Specifies whether the API Key can be used by callers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnabled
```
public Boolean isEnabled()
```
    Specifies whether the API Key can be used by callers.
    
    Returns:
    
    Specifies whether the API Key can be used by callers.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The timestamp when the API Key was created.
    
    Parameters:
    
    createdDate - The timestamp when the API Key was created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The timestamp when the API Key was created.
    
    Returns:
    
    The timestamp when the API Key was created.
  - withCreatedDate
```
public ApiKey withCreatedDate(Date createdDate)
```
    The timestamp when the API Key was created.
    
    Parameters:
    
    createdDate - The timestamp when the API Key was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedDate
```
public void setLastUpdatedDate(Date lastUpdatedDate)
```
    The timestamp when the API Key was last updated.
    
    Parameters:
    
    lastUpdatedDate - The timestamp when the API Key was last updated.
  - getLastUpdatedDate
```
public Date getLastUpdatedDate()
```
    The timestamp when the API Key was last updated.
    
    Returns:
    
    The timestamp when the API Key was last updated.
  - withLastUpdatedDate
```
public ApiKey withLastUpdatedDate(Date lastUpdatedDate)
```
    The timestamp when the API Key was last updated.
    
    Parameters:
    
    lastUpdatedDate - The timestamp when the API Key was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStageKeys
```
public List<String> getStageKeys()
```
    A list of Stage resources that are associated with the ApiKey resource.
    
    Returns:
    
    A list of Stage resources that are associated with the ApiKey resource.
  - setStageKeys
```
public void setStageKeys(Collection<String> stageKeys)
```
    A list of Stage resources that are associated with the ApiKey resource.
    
    Parameters:
    
    stageKeys - A list of Stage resources that are associated with the ApiKey resource.
  - withStageKeys
```
public ApiKey withStageKeys(String... stageKeys)
```
    A list of Stage resources that are associated with the ApiKey resource.
    
    NOTE: This method appends the values to the existing list (if any). Use setStageKeys(java.util.Collection) or withStageKeys(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    stageKeys - A list of Stage resources that are associated with the ApiKey resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStageKeys
```
public ApiKey withStageKeys(Collection<String> stageKeys)
```
    A list of Stage resources that are associated with the ApiKey resource.
    
    Parameters:
    
    stageKeys - A list of Stage resources that are associated with the ApiKey resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ApiKey clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ApiKey

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiKey

Method Detail

setId

getId

withId

setValue

getValue

withValue

setName

getName

withName

setCustomerId

getCustomerId

withCustomerId

setDescription

getDescription

withDescription

setEnabled

getEnabled

withEnabled

isEnabled

setCreatedDate

getCreatedDate

withCreatedDate

setLastUpdatedDate

getLastUpdatedDate

withLastUpdatedDate

getStageKeys

setStageKeys

withStageKeys

withStageKeys

toString

equals

hashCode

clone

marshall