Class ApiKey
- java.lang.Object
-
- com.amazonaws.services.apigateway.model.ApiKey
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class ApiKey extends Object implements Serializable, Cloneable
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
-
-
Constructor Summary
Constructors Constructor Description ApiKey()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiKey
clone()
boolean
equals(Object obj)
Date
getCreatedDate()
The date when the API Key was created, in ISO 8601 format.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()
When the API Key was last updated, in ISO 8601 format.String
getName()
The name of the API Key.List<String>
getStageKeys()
int
hashCode()
Boolean
isEnabled()
Specifies whether the API Key can be used by callers.void
setCreatedDate(Date createdDate)
The date when the API Key was created, in ISO 8601 format.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)
When the API Key was last updated, in ISO 8601 format.void
setName(String name)
The name of the API Key.void
setStageKeys(Collection<String> stageKeys)
String
toString()
Returns a string representation of this object; useful for testing and debugging.ApiKey
withCreatedDate(Date createdDate)
The date when the API Key was created, in ISO 8601 format.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)
When the API Key was last updated, in ISO 8601 format.ApiKey
withName(String name)
The name of the API Key.ApiKey
withStageKeys(String... stageKeys)
ApiKey
withStageKeys(Collection<String> stageKeys)
-
-
-
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.
-
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.
-
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.
-
setStageKeys
public void setStageKeys(Collection<String> stageKeys)
-
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)
orwithStageKeys(java.util.Collection)
if you want to override the existing values.
-
withStageKeys
public ApiKey withStageKeys(Collection<String> stageKeys)
-
setCreatedDate
public void setCreatedDate(Date createdDate)
The date when the API Key was created, in ISO 8601 format.
- Parameters:
createdDate
- The date when the API Key was created, in ISO 8601 format.
-
getCreatedDate
public Date getCreatedDate()
The date when the API Key was created, in ISO 8601 format.
- Returns:
- The date when the API Key was created, in ISO 8601 format.
-
withCreatedDate
public ApiKey withCreatedDate(Date createdDate)
The date when the API Key was created, in ISO 8601 format.
- Parameters:
createdDate
- The date when the API Key was created, in ISO 8601 format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLastUpdatedDate
public void setLastUpdatedDate(Date lastUpdatedDate)
When the API Key was last updated, in ISO 8601 format.
- Parameters:
lastUpdatedDate
- When the API Key was last updated, in ISO 8601 format.
-
getLastUpdatedDate
public Date getLastUpdatedDate()
When the API Key was last updated, in ISO 8601 format.
- Returns:
- When the API Key was last updated, in ISO 8601 format.
-
withLastUpdatedDate
public ApiKey withLastUpdatedDate(Date lastUpdatedDate)
When the API Key was last updated, in ISO 8601 format.
- Parameters:
lastUpdatedDate
- When the API Key was last updated, in ISO 8601 format.- 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
-