public class GetApiKeyResult
extends java.lang.Object
implements java.io.Serializable, java.lang.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.
Modifier and Type | Field and Description |
---|---|
private java.util.Date |
createdDate
The date when the API Key was created, in ISO 8601 format.
|
private java.lang.String |
description
The description of the API Key.
|
private java.lang.Boolean |
enabled
Specifies whether the API Key can be used by callers.
|
private java.lang.String |
id
The identifier of the API Key.
|
private java.util.Date |
lastUpdatedDate
When the API Key was last updated, in ISO 8601 format.
|
private java.lang.String |
name
The name of the API Key.
|
private java.util.List<java.lang.String> |
stageKeys
|
Constructor and Description |
---|
GetApiKeyResult() |
Modifier and Type | Method and Description |
---|---|
GetApiKeyResult |
clone() |
boolean |
equals(java.lang.Object obj) |
java.util.Date |
getCreatedDate()
The date when the API Key was created, in ISO 8601 format.
|
java.lang.String |
getDescription()
The description of the API Key.
|
java.lang.Boolean |
getEnabled()
Specifies whether the API Key can be used by callers.
|
java.lang.String |
getId()
The identifier of the API Key.
|
java.util.Date |
getLastUpdatedDate()
When the API Key was last updated, in ISO 8601 format.
|
java.lang.String |
getName()
The name of the API Key.
|
java.util.List<java.lang.String> |
getStageKeys()
|
int |
hashCode() |
java.lang.Boolean |
isEnabled()
Specifies whether the API Key can be used by callers.
|
void |
setCreatedDate(java.util.Date createdDate)
The date when the API Key was created, in ISO 8601 format.
|
void |
setDescription(java.lang.String description)
The description of the API Key.
|
void |
setEnabled(java.lang.Boolean enabled)
Specifies whether the API Key can be used by callers.
|
void |
setId(java.lang.String id)
The identifier of the API Key.
|
void |
setLastUpdatedDate(java.util.Date lastUpdatedDate)
When the API Key was last updated, in ISO 8601 format.
|
void |
setName(java.lang.String name)
The name of the API Key.
|
void |
setStageKeys(java.util.Collection<java.lang.String> stageKeys)
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GetApiKeyResult |
withCreatedDate(java.util.Date createdDate)
The date when the API Key was created, in ISO 8601 format.
|
GetApiKeyResult |
withDescription(java.lang.String description)
The description of the API Key.
|
GetApiKeyResult |
withEnabled(java.lang.Boolean enabled)
Specifies whether the API Key can be used by callers.
|
GetApiKeyResult |
withId(java.lang.String id)
The identifier of the API Key.
|
GetApiKeyResult |
withLastUpdatedDate(java.util.Date lastUpdatedDate)
When the API Key was last updated, in ISO 8601 format.
|
GetApiKeyResult |
withName(java.lang.String name)
The name of the API Key.
|
GetApiKeyResult |
withStageKeys(java.util.Collection<java.lang.String> stageKeys)
|
GetApiKeyResult |
withStageKeys(java.lang.String... stageKeys)
|
private java.lang.String id
The identifier of the API Key.
private java.lang.String name
The name of the API Key.
private java.lang.String description
The description of the API Key.
private java.lang.Boolean enabled
Specifies whether the API Key can be used by callers.
private java.util.List<java.lang.String> stageKeys
private java.util.Date createdDate
The date when the API Key was created, in ISO 8601 format.
private java.util.Date lastUpdatedDate
When the API Key was last updated, in ISO 8601 format.
public void setId(java.lang.String id)
The identifier of the API Key.
id
- The identifier of the API Key.public java.lang.String getId()
The identifier of the API Key.
public GetApiKeyResult withId(java.lang.String id)
The identifier of the API Key.
id
- The identifier of the API Key.public void setName(java.lang.String name)
The name of the API Key.
name
- The name of the API Key.public java.lang.String getName()
The name of the API Key.
public GetApiKeyResult withName(java.lang.String name)
The name of the API Key.
name
- The name of the API Key.public void setDescription(java.lang.String description)
The description of the API Key.
description
- The description of the API Key.public java.lang.String getDescription()
The description of the API Key.
public GetApiKeyResult withDescription(java.lang.String description)
The description of the API Key.
description
- The description of the API Key.public void setEnabled(java.lang.Boolean enabled)
Specifies whether the API Key can be used by callers.
enabled
- Specifies whether the API Key can be used by callers.public java.lang.Boolean getEnabled()
Specifies whether the API Key can be used by callers.
public GetApiKeyResult withEnabled(java.lang.Boolean enabled)
Specifies whether the API Key can be used by callers.
enabled
- Specifies whether the API Key can be used by callers.public java.lang.Boolean isEnabled()
Specifies whether the API Key can be used by callers.
public java.util.List<java.lang.String> getStageKeys()
public void setStageKeys(java.util.Collection<java.lang.String> stageKeys)
public GetApiKeyResult withStageKeys(java.lang.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.
public GetApiKeyResult withStageKeys(java.util.Collection<java.lang.String> stageKeys)
public void setCreatedDate(java.util.Date createdDate)
The date when the API Key was created, in ISO 8601 format.
createdDate
- The date when the API Key was created, in ISO 8601 format.public java.util.Date getCreatedDate()
The date when the API Key was created, in ISO 8601 format.
public GetApiKeyResult withCreatedDate(java.util.Date createdDate)
The date when the API Key was created, in ISO 8601 format.
createdDate
- The date when the API Key was created, in ISO 8601 format.public void setLastUpdatedDate(java.util.Date lastUpdatedDate)
When the API Key was last updated, in ISO 8601 format.
lastUpdatedDate
- When the API Key was last updated, in ISO 8601 format.public java.util.Date getLastUpdatedDate()
When the API Key was last updated, in ISO 8601 format.
public GetApiKeyResult withLastUpdatedDate(java.util.Date lastUpdatedDate)
When the API Key was last updated, in ISO 8601 format.
lastUpdatedDate
- When the API Key was last updated, in ISO 8601 format.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public GetApiKeyResult clone()
clone
in class java.lang.Object