com.amazonaws.services.location.model

Class UpdateKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.location.model.UpdateKeyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateKeyRequest
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
UpdateKeyRequest()

Method Summary

Modifier and Type	Method and Description
UpdateKeyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() Updates the description for the API key resource.
Date	getExpireTime() Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Boolean	getForceUpdate() The boolean flag to be included for updating ExpireTime or Restrictions details.
String	getKeyName() The name of the API key resource to update.
Boolean	getNoExpiry() Whether the API key should expire.
ApiKeyRestrictions	getRestrictions() Updates the API key restrictions for the API key resource.
int	hashCode()
Boolean	isForceUpdate() The boolean flag to be included for updating ExpireTime or Restrictions details.
Boolean	isNoExpiry() Whether the API key should expire.
void	setDescription(String description) Updates the description for the API key resource.
void	setExpireTime(Date expireTime) Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
void	setForceUpdate(Boolean forceUpdate) The boolean flag to be included for updating ExpireTime or Restrictions details.
void	setKeyName(String keyName) The name of the API key resource to update.
void	setNoExpiry(Boolean noExpiry) Whether the API key should expire.
void	setRestrictions(ApiKeyRestrictions restrictions) Updates the API key restrictions for the API key resource.
String	toString() Returns a string representation of this object.
UpdateKeyRequest	withDescription(String description) Updates the description for the API key resource.
UpdateKeyRequest	withExpireTime(Date expireTime) Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
UpdateKeyRequest	withForceUpdate(Boolean forceUpdate) The boolean flag to be included for updating ExpireTime or Restrictions details.
UpdateKeyRequest	withKeyName(String keyName) The name of the API key resource to update.
UpdateKeyRequest	withNoExpiry(Boolean noExpiry) Whether the API key should expire.
UpdateKeyRequest	withRestrictions(ApiKeyRestrictions restrictions) Updates the API key restrictions for the API key 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

UpdateKeyRequest

public UpdateKeyRequest()

Method Detail

setKeyName

public void setKeyName(String keyName)

The name of the API key resource to update.

Parameters:

keyName - The name of the API key resource to update.

getKeyName

public String getKeyName()

The name of the API key resource to update.

Returns:

The name of the API key resource to update.

withKeyName

public UpdateKeyRequest withKeyName(String keyName)

The name of the API key resource to update.

Parameters:

keyName - The name of the API key resource to update.

Returns:

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

setDescription

public void setDescription(String description)

Updates the description for the API key resource.

Parameters:

description - Updates the description for the API key resource.

getDescription

public String getDescription()

Updates the description for the API key resource.

Returns:

Updates the description for the API key resource.

withDescription

public UpdateKeyRequest withDescription(String description)

Updates the description for the API key resource.

Parameters:

description - Updates the 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)

Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Parameters:

expireTime - Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

getExpireTime

public Date getExpireTime()

Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Returns:

Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

withExpireTime

public UpdateKeyRequest withExpireTime(Date expireTime)

Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Parameters:

expireTime - Updates 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.

setNoExpiry

public void setNoExpiry(Boolean noExpiry)

Whether the API key should expire. Set to true to set the API key to have no expiration time.

Parameters:

noExpiry - Whether the API key should expire. Set to true to set the API key to have no expiration time.

getNoExpiry

public Boolean getNoExpiry()

Whether the API key should expire. Set to true to set the API key to have no expiration time.

Returns:

Whether the API key should expire. Set to true to set the API key to have no expiration time.

withNoExpiry

public UpdateKeyRequest withNoExpiry(Boolean noExpiry)

Whether the API key should expire. Set to true to set the API key to have no expiration time.

Parameters:

noExpiry - Whether the API key should expire. Set to true to set the API key to have no expiration time.

Returns:

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

isNoExpiry

public Boolean isNoExpiry()

Whether the API key should expire. Set to true to set the API key to have no expiration time.

Returns:

Whether the API key should expire. Set to true to set the API key to have no expiration time.

setForceUpdate

public void setForceUpdate(Boolean forceUpdate)

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

Parameters:

forceUpdate - The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

getForceUpdate

public Boolean getForceUpdate()

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

Returns:

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

withForceUpdate

public UpdateKeyRequest withForceUpdate(Boolean forceUpdate)

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

Parameters:

forceUpdate - The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

Returns:

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

isForceUpdate

public Boolean isForceUpdate()

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

Returns:

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

setRestrictions

public void setRestrictions(ApiKeyRestrictions restrictions)

Updates the API key restrictions for the API key resource.

Parameters:

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

getRestrictions

public ApiKeyRestrictions getRestrictions()

Updates the API key restrictions for the API key resource.

Returns:

Updates the API key restrictions for the API key resource.

withRestrictions

public UpdateKeyRequest withRestrictions(ApiKeyRestrictions restrictions)

Updates the API key restrictions for the API key resource.

Parameters:

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

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 UpdateKeyRequest 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()