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

Class DeleteInventoryRequest

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.DeleteInventoryRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteInventoryRequest.Builder,DeleteInventoryRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteInventoryRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DeleteInventoryRequest.Builder	builder()
String	clientToken()	User-provided idempotency token.
Boolean	dryRun()	Use this option to view a summary of the deletion request without deleting any data or the data type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InventorySchemaDeleteOption	schemaDeleteOption()	Use the SchemaDeleteOption to delete a custom inventory type (schema).
String	schemaDeleteOptionAsString()	Use the SchemaDeleteOption to delete a custom inventory type (schema).
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteInventoryRequest.Builder>	serializableBuilderClass()
DeleteInventoryRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	typeName()	The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

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

typeName

public final String typeName()

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

Returns:

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

schemaDeleteOption

public final InventorySchemaDeleteOption schemaDeleteOption()

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory operation for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

If the service returns an enum value that is not available in the current SDK version, schemaDeleteOption will return InventorySchemaDeleteOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from schemaDeleteOptionAsString().

Returns:

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory operation for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

See Also:

InventorySchemaDeleteOption

schemaDeleteOptionAsString

public final String schemaDeleteOptionAsString()

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory operation for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

If the service returns an enum value that is not available in the current SDK version, schemaDeleteOption will return InventorySchemaDeleteOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from schemaDeleteOptionAsString().

Returns:

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory operation for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

See Also:

InventorySchemaDeleteOption

dryRun

public final Boolean dryRun()

Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

Returns:

Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

clientToken

public final String clientToken()

User-provided idempotency token.

Returns:

User-provided idempotency token.

toBuilder

public DeleteInventoryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteInventoryRequest.Builder,DeleteInventoryRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static DeleteInventoryRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteInventoryRequest.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