com.amazonaws.services.location.model

Class CreateKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.location.model.CreateKeyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateKeyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateKeyRequest()

Method Summary

Modifier and Type	Method and Description
CreateKeyRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateKeyRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateKeyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() An optional description for the API key resource.
Date	getExpireTime() The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
String	getKeyName() A custom name for the API key resource.
Boolean	getNoExpiry() Optionally set to true to set no expiration time for the API key.
ApiKeyRestrictions	getRestrictions() The API key restrictions for the API key resource.
Map<String,String>	getTags() Applies one or more tags to the map resource.
int	hashCode()
Boolean	isNoExpiry() Optionally set to true to set no expiration time for the API key.
void	setDescription(String description) An optional description for the API key resource.
void	setExpireTime(Date expireTime) The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
void	setKeyName(String keyName) A custom name for the API key resource.
void	setNoExpiry(Boolean noExpiry) Optionally set to true to set no expiration time for the API key.
void	setRestrictions(ApiKeyRestrictions restrictions) The API key restrictions for the API key resource.
void	setTags(Map<String,String> tags) Applies one or more tags to the map resource.
String	toString() Returns a string representation of this object.
CreateKeyRequest	withDescription(String description) An optional description for the API key resource.
CreateKeyRequest	withExpireTime(Date expireTime) The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
CreateKeyRequest	withKeyName(String keyName) A custom name for the API key resource.
CreateKeyRequest	withNoExpiry(Boolean noExpiry) Optionally set to true to set no expiration time for the API key.
CreateKeyRequest	withRestrictions(ApiKeyRestrictions restrictions) The API key restrictions for the API key resource.
CreateKeyRequest	withTags(Map<String,String> tags) Applies one or more tags to the map resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateKeyRequest

public CreateKeyRequest()

Method Detail

setKeyName

public void setKeyName(String keyName)

A custom name for the API key resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique API key name.

• No spaces allowed. For example, ExampleAPIKey.

Parameters:

keyName - A custom name for the API key resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique API key name.

• No spaces allowed. For example, ExampleAPIKey.

getKeyName

public String getKeyName()

A custom name for the API key resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique API key name.

• No spaces allowed. For example, ExampleAPIKey.

Returns:

A custom name for the API key resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique API key name.

• No spaces allowed. For example, ExampleAPIKey.

withKeyName

public CreateKeyRequest withKeyName(String keyName)

A custom name for the API key resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique API key name.

• No spaces allowed. For example, ExampleAPIKey.

Parameters:

keyName - A custom name for the API key resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique API key name.

• No spaces allowed. For example, ExampleAPIKey.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRestrictions

public void setRestrictions(ApiKeyRestrictions restrictions)

The API key restrictions for the API key resource.

Parameters:

restrictions - The API key restrictions for the API key resource.

getRestrictions

public ApiKeyRestrictions getRestrictions()

The API key restrictions for the API key resource.

Returns:

The API key restrictions for the API key resource.

withRestrictions

public CreateKeyRequest withRestrictions(ApiKeyRestrictions restrictions)

The API key restrictions for the API key resource.

Parameters:

restrictions - The API key restrictions for the API key resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

An optional description for the API key resource.

Parameters:

description - An optional description for the API key resource.

getDescription

public String getDescription()

An optional description for the API key resource.

Returns:

An optional description for the API key resource.

withDescription

public CreateKeyRequest withDescription(String description)

An optional description for the API key resource.

Parameters:

description - An optional description for the API key resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExpireTime

public void setExpireTime(Date expireTime)

The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

Parameters:

expireTime - The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

getExpireTime

public Date getExpireTime()

The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

Returns:

The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

withExpireTime

public CreateKeyRequest withExpireTime(Date expireTime)

The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

Parameters:

expireTime - The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNoExpiry

public void setNoExpiry(Boolean noExpiry)

Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

Parameters:

noExpiry - Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

getNoExpiry

public Boolean getNoExpiry()

Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

Returns:

Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

withNoExpiry

public CreateKeyRequest withNoExpiry(Boolean noExpiry)

Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

Parameters:

noExpiry - Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

Returns:

Returns a reference to this object so that method calls can be chained together.

isNoExpiry

public Boolean isNoExpiry()

Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

Returns:

Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

getTags

public Map<String,String> getTags()

Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

Returns:

Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

setTags

public void setTags(Map<String,String> tags)

Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

Parameters:

tags - Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

withTags

public CreateKeyRequest withTags(Map<String,String> tags)

Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

Parameters:

tags - Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateKeyRequest addTagsEntry(String key,
                                     String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateKeyRequest 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 CreateKeyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()