Class UpdateApiKeyResult
- All Implemented Interfaces:
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:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The date when the API Key was created, in ISO 8601 format.The description of the API Key.Specifies whether the API Key can be used by callers.getId()
The identifier of the API Key.When the API Key was last updated, in ISO 8601 format.getName()
The name of the API Key.int
hashCode()
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
The identifier of the API Key.void
setLastUpdatedDate
(Date lastUpdatedDate) When the API Key was last updated, in ISO 8601 format.void
The name of the API Key.void
setStageKeys
(Collection<String> stageKeys) toString()
Returns a string representation of this object; useful for testing and debugging.withCreatedDate
(Date createdDate) The date when the API Key was created, in ISO 8601 format.withDescription
(String description) The description of the API Key.withEnabled
(Boolean enabled) Specifies whether the API Key can be used by callers.The identifier of the API Key.withLastUpdatedDate
(Date lastUpdatedDate) When the API Key was last updated, in ISO 8601 format.The name of the API Key.withStageKeys
(String... stageKeys) withStageKeys
(Collection<String> stageKeys)
-
Constructor Details
-
UpdateApiKeyResult
public UpdateApiKeyResult()
-
-
Method Details
-
setId
The identifier of the API Key.
- Parameters:
id
- The identifier of the API Key.
-
getId
The identifier of the API Key.
- Returns:
- The identifier of the API Key.
-
withId
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
The name of the API Key.
- Parameters:
name
- The name of the API Key.
-
getName
The name of the API Key.
- Returns:
- The name of the API Key.
-
withName
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
The description of the API Key.
- Parameters:
description
- The description of the API Key.
-
getDescription
The description of the API Key.
- Returns:
- The description of the API Key.
-
withDescription
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
Specifies whether the API Key can be used by callers.
- Parameters:
enabled
- Specifies whether the API Key can be used by callers.
-
getEnabled
Specifies whether the API Key can be used by callers.
- Returns:
- Specifies whether the API Key can be used by callers.
-
withEnabled
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
Specifies whether the API Key can be used by callers.
- Returns:
- Specifies whether the API Key can be used by callers.
-
getStageKeys
-
setStageKeys
-
withStageKeys
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
-
setCreatedDate
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
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
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
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
When the API Key was last updated, in ISO 8601 format.
- Returns:
- When the API Key was last updated, in ISO 8601 format.
-
withLastUpdatedDate
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-