DescribeKeyResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.location.model.DescribeKeyResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeKeyResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeKeyResult()

Constructors
Constructor and Description
`DescribeKeyResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeKeyResult`	`addTagsEntry(String key, String value)` Add a single Tags entry
`DescribeKeyResult`	`clearTagsEntries()` Removes all the entries added into Tags.
`DescribeKeyResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreateTime()` The timestamp for when the API key resource was created in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`String`	`getDescription()` The optional description for the API key resource.
`Date`	`getExpireTime()` The timestamp for when the API key resource will expire in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`String`	`getKey()` The key value/string of an API key.
`String`	`getKeyArn()` The Amazon Resource Name (ARN) for the API key resource.
`String`	`getKeyName()` The name of the API key resource.
`ApiKeyRestrictions`	`getRestrictions()`
`Map<String,String>`	`getTags()` Tags associated with the API key resource.
`Date`	`getUpdateTime()` The timestamp for when the API key resource was last updated in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`int`	`hashCode()`
`void`	`setCreateTime(Date createTime)` The timestamp for when the API key resource was created in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`void`	`setDescription(String description)` The optional description for the API key resource.
`void`	`setExpireTime(Date expireTime)` The timestamp for when the API key resource will expire in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`void`	`setKey(String key)` The key value/string of an API key.
`void`	`setKeyArn(String keyArn)` The Amazon Resource Name (ARN) for the API key resource.
`void`	`setKeyName(String keyName)` The name of the API key resource.
`void`	`setRestrictions(ApiKeyRestrictions restrictions)`
`void`	`setTags(Map<String,String> tags)` Tags associated with the API key resource.
`void`	`setUpdateTime(Date updateTime)` The timestamp for when the API key resource was last updated in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`String`	`toString()` Returns a string representation of this object.
`DescribeKeyResult`	`withCreateTime(Date createTime)` The timestamp for when the API key resource was created in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`DescribeKeyResult`	`withDescription(String description)` The optional description for the API key resource.
`DescribeKeyResult`	`withExpireTime(Date expireTime)` The timestamp for when the API key resource will expire in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
`DescribeKeyResult`	`withKey(String key)` The key value/string of an API key.
`DescribeKeyResult`	`withKeyArn(String keyArn)` The Amazon Resource Name (ARN) for the API key resource.
`DescribeKeyResult`	`withKeyName(String keyName)` The name of the API key resource.
`DescribeKeyResult`	`withRestrictions(ApiKeyRestrictions restrictions)`
`DescribeKeyResult`	`withTags(Map<String,String> tags)` Tags associated with the API key resource.
`DescribeKeyResult`	`withUpdateTime(Date updateTime)` The timestamp for when the API key resource was last updated in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DescribeKeyResult
```
public DescribeKeyResult()
```
- Method Detail
  - setKey
```
public void setKey(String key)
```
    The key value/string of an API key.
    
    Parameters:
    
    key - The key value/string of an API key.
  - getKey
```
public String getKey()
```
    The key value/string of an API key.
    
    Returns:
    
    The key value/string of an API key.
  - withKey
```
public DescribeKeyResult withKey(String key)
```
    The key value/string of an API key.
    
    Parameters:
    
    key - The key value/string of an API key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyArn
```
public void setKeyArn(String keyArn)
```
    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
    - Format example: arn:aws:geo:region:account-id:key/ExampleKey
    Parameters:
    keyArn - The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
    
    Format example: arn:aws:geo:region:account-id:key/ExampleKey
  - getKeyArn
```
public String getKeyArn()
```
    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
    - Format example: arn:aws:geo:region:account-id:key/ExampleKey
    Returns:
    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
    
    Format example: arn:aws:geo:region:account-id:key/ExampleKey
  - withKeyArn
```
public DescribeKeyResult withKeyArn(String keyArn)
```
    The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
    - Format example: arn:aws:geo:region:account-id:key/ExampleKey
    Parameters:
    keyArn - The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all Amazon Web Services.
    
    Format example: arn:aws:geo:region:account-id:key/ExampleKey
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyName
```
public void setKeyName(String keyName)
```
    The name of the API key resource.
    
    Parameters:
    
    keyName - The name of the API key resource.
  - getKeyName
```
public String getKeyName()
```
    The name of the API key resource.
    
    Returns:
    
    The name of the API key resource.
  - withKeyName
```
public DescribeKeyResult withKeyName(String keyName)
```
    The name of the API key resource.
    
    Parameters:
    
    keyName - The name of the API key resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRestrictions
```
public void setRestrictions(ApiKeyRestrictions restrictions)
```
    Parameters:
    
    restrictions -
  - getRestrictions
```
public ApiKeyRestrictions getRestrictions()
```
    Returns:
  - withRestrictions
```
public DescribeKeyResult withRestrictions(ApiKeyRestrictions restrictions)
```
    Parameters:
    
    restrictions -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Parameters:
    
    createTime - The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - getCreateTime
```
public Date getCreateTime()
```
    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - withCreateTime
```
public DescribeKeyResult withCreateTime(Date createTime)
```
    The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Parameters:
    
    createTime - The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpireTime
```
public void setExpireTime(Date expireTime)
```
    The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Parameters:
    
    expireTime - The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - getExpireTime
```
public Date getExpireTime()
```
    The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - withExpireTime
```
public DescribeKeyResult withExpireTime(Date expireTime)
```
    The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Parameters:
    
    expireTime - The timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdateTime
```
public void setUpdateTime(Date updateTime)
```
    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Parameters:
    
    updateTime - The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - getUpdateTime
```
public Date getUpdateTime()
```
    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
  - withUpdateTime
```
public DescribeKeyResult withUpdateTime(Date updateTime)
```
    The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Parameters:
    
    updateTime - The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The optional description for the API key resource.
    
    Parameters:
    
    description - The optional description for the API key resource.
  - getDescription
```
public String getDescription()
```
    The optional description for the API key resource.
    
    Returns:
    
    The optional description for the API key resource.
  - withDescription
```
public DescribeKeyResult withDescription(String description)
```
    The optional description for the API key resource.
    
    Parameters:
    
    description - The optional description for the API key resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    Tags associated with the API key resource.
    
    Returns:
    
    Tags associated with the API key resource.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Tags associated with the API key resource.
    
    Parameters:
    
    tags - Tags associated with the API key resource.
  - withTags
```
public DescribeKeyResult withTags(Map<String,String> tags)
```
    Tags associated with the API key resource.
    
    Parameters:
    
    tags - Tags associated with the API key resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public DescribeKeyResult addTagsEntry(String key,
                                      String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public DescribeKeyResult clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 DescribeKeyResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.772

Class DescribeKeyResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeKeyResult

Method Detail

setKey

getKey

withKey

setKeyArn

getKeyArn

withKeyArn

setKeyName

getKeyName

withKeyName

setRestrictions

getRestrictions

withRestrictions

setCreateTime

getCreateTime

withCreateTime

setExpireTime

getExpireTime

withExpireTime

setUpdateTime

getUpdateTime

withUpdateTime

setDescription

getDescription

withDescription

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone