Package software.amazon.awssdk.services.ssm.model

Class DeleteDocumentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.DeleteDocumentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteDocumentRequest.Builder,DeleteDocumentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DeleteDocumentRequest
extends SsmRequest
implements ToCopyableBuilder<DeleteDocumentRequest.Builder,DeleteDocumentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteDocumentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DeleteDocumentRequest.Builder	builder()
String	documentVersion()	The version of the document that you want to delete.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	force()	Some SSM document types require that you specify a Force flag before you can delete the document.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the document.
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteDocumentRequest.Builder>	serializableBuilderClass()
DeleteDocumentRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	versionName()	The version name of the document that you want to delete.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the document.

Returns:

The name of the document.

documentVersion

public final String documentVersion()

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.

versionName

public final String versionName()

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.

force

public final 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 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 Identity and Access Management (IAM) policy.

toBuilder

public DeleteDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteDocumentRequest.Builder,DeleteDocumentRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static DeleteDocumentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteDocumentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo