com.amazonaws.services.location.model

Class DeleteKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.location.model.DeleteKeyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
DeleteKeyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getForceDelete() ForceDelete bypasses an API key's expiry conditions and deletes the key.
String	getKeyName() The name of the API key to delete.
int	hashCode()
Boolean	isForceDelete() ForceDelete bypasses an API key's expiry conditions and deletes the key.
void	setForceDelete(Boolean forceDelete) ForceDelete bypasses an API key's expiry conditions and deletes the key.
void	setKeyName(String keyName) The name of the API key to delete.
String	toString() Returns a string representation of this object.
DeleteKeyRequest	withForceDelete(Boolean forceDelete) ForceDelete bypasses an API key's expiry conditions and deletes the key.
DeleteKeyRequest	withKeyName(String keyName) The name of the API key to delete.

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

DeleteKeyRequest

public DeleteKeyRequest()

Method Detail

setKeyName

public void setKeyName(String keyName)

The name of the API key to delete.

Parameters:

keyName - The name of the API key to delete.

getKeyName

public String getKeyName()

The name of the API key to delete.

Returns:

The name of the API key to delete.

withKeyName

public DeleteKeyRequest withKeyName(String keyName)

The name of the API key to delete.

Parameters:

keyName - The name of the API key to delete.

Returns:

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

setForceDelete

public void setForceDelete(Boolean forceDelete)

ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

Parameters:

forceDelete - ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

getForceDelete

public Boolean getForceDelete()

ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

Returns:

ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

withForceDelete

public DeleteKeyRequest withForceDelete(Boolean forceDelete)

ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

Parameters:

forceDelete - ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

Returns:

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

isForceDelete

public Boolean isForceDelete()

ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

Returns:

ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true, or false.

Required: No

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

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