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>

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DeleteInventoryRequest.Builder,DeleteInventoryRequest>
      Specified by:
      toBuilder in class SsmRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.