UpdateApiKeyResult (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class UpdateApiKeyResult
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 and Description

UpdateApiKeyResult()

Constructors
Constructor and Description
`UpdateApiKeyResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateApiKeyResult`	`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()` A list of Stage resources that are associated with the ApiKey resource.
`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)` A list of Stage resources that are associated with the ApiKey resource.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UpdateApiKeyResult`	`withCreatedDate(Date createdDate)` The date when the API Key was created, in ISO 8601 format.
`UpdateApiKeyResult`	`withDescription(String description)` The description of the API Key.
`UpdateApiKeyResult`	`withEnabled(Boolean enabled)` Specifies whether the API Key can be used by callers.
`UpdateApiKeyResult`	`withId(String id)` The identifier of the API Key.
`UpdateApiKeyResult`	`withLastUpdatedDate(Date lastUpdatedDate)` When the API Key was last updated, in ISO 8601 format.
`UpdateApiKeyResult`	`withName(String name)` The name of the API Key.
`UpdateApiKeyResult`	`withStageKeys(Collection<String> stageKeys)` A list of Stage resources that are associated with the ApiKey resource.
`UpdateApiKeyResult`	`withStageKeys(String... stageKeys)` A list of Stage resources that are associated with the ApiKey resource.

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

- Constructor Detail
  - UpdateApiKeyResult
```
public UpdateApiKeyResult()
```
- 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 UpdateApiKeyResult 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 UpdateApiKeyResult 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 UpdateApiKeyResult 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 UpdateApiKeyResult 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.
  - 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 UpdateApiKeyResult 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 UpdateApiKeyResult 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.
  - 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 UpdateApiKeyResult 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 UpdateApiKeyResult 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 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 UpdateApiKeyResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class UpdateApiKeyResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UpdateApiKeyResult

Method Detail

setId

getId

withId

setName

getName

withName

setDescription

getDescription

withDescription

setEnabled

getEnabled

withEnabled

isEnabled

getStageKeys

setStageKeys

withStageKeys

withStageKeys

setCreatedDate

getCreatedDate

withCreatedDate

setLastUpdatedDate

getLastUpdatedDate

withLastUpdatedDate

toString

equals

hashCode

clone