com.amazonaws.services.simplesystemsmanagement.model

Class DeleteDocumentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.DeleteDocumentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
DeleteDocumentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDocumentVersion() The version of the document that you want to delete.
Boolean	getForce() Some SSM document types require that you specify a Force flag before you can delete the document.
String	getName() The name of the document.
String	getVersionName() The version name of the document that you want to delete.
int	hashCode()
Boolean	isForce() Some SSM document types require that you specify a Force flag before you can delete the document.
void	setDocumentVersion(String documentVersion) The version of the document that you want to delete.
void	setForce(Boolean force) Some SSM document types require that you specify a Force flag before you can delete the document.
void	setName(String name) The name of the document.
void	setVersionName(String versionName) The version name of the document that you want to delete.
String	toString() Returns a string representation of this object.
DeleteDocumentRequest	withDocumentVersion(String documentVersion) The version of the document that you want to delete.
DeleteDocumentRequest	withForce(Boolean force) Some SSM document types require that you specify a Force flag before you can delete the document.
DeleteDocumentRequest	withName(String name) The name of the document.
DeleteDocumentRequest	withVersionName(String versionName) The version name of the document that you want 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

DeleteDocumentRequest

public DeleteDocumentRequest()

Method Detail

setName

public void setName(String name)

The name of the document.

Parameters:

name - The name of the document.

getName

public String getName()

The name of the document.

Returns:

The name of the document.

withName

public DeleteDocumentRequest withName(String name)

The name of the document.

Parameters:

name - The name of the document.

Returns:

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

setDocumentVersion

public void setDocumentVersion(String documentVersion)

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Parameters:

documentVersion - The version of the document that you want to delete. If not provided, all versions of the document are deleted.

getDocumentVersion

public String getDocumentVersion()

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Returns:

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

withDocumentVersion

public DeleteDocumentRequest withDocumentVersion(String documentVersion)

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Parameters:

documentVersion - The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Returns:

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

setVersionName

public void setVersionName(String versionName)

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Parameters:

versionName - The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

getVersionName

public String getVersionName()

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Returns:

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

withVersionName

public DeleteDocumentRequest withVersionName(String versionName)

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Parameters:

versionName - The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Returns:

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

setForce

public void setForce(Boolean force)

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

Parameters:

force - Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

getForce

public Boolean getForce()

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

Returns:

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

withForce

public DeleteDocumentRequest withForce(Boolean force)

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

Parameters:

force - Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

Returns:

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

isForce

public Boolean isForce()

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

Returns:

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

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