Class BatchDeleteConfigurationTask
- java.lang.Object
-
- software.amazon.awssdk.services.applicationdiscovery.model.BatchDeleteConfigurationTask
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<BatchDeleteConfigurationTask.Builder,BatchDeleteConfigurationTask>
@Generated("software.amazon.awssdk:codegen") public final class BatchDeleteConfigurationTask extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BatchDeleteConfigurationTask.Builder,BatchDeleteConfigurationTask>
A metadata object that represents the deletion task being executed.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceBatchDeleteConfigurationTask.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static BatchDeleteConfigurationTask.Builderbuilder()DeletionConfigurationItemTypeconfigurationType()The type of configuration item to delete.StringconfigurationTypeAsString()The type of configuration item to delete.List<String>deletedConfigurations()The list of configuration IDs that were successfully deleted by the deletion task.List<DeletionWarning>deletionWarnings()A list of configuration IDs that produced warnings regarding their deletion, paired with a warning message.InstantendTime()An epoch seconds timestamp (UTC) of when the deletion task was completed or failed.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<FailedConfiguration>failedConfigurations()A list of configuration IDs that failed to delete during the deletion task, each paired with an error message.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDeletedConfigurations()For responses, this returns true if the service returned a value for the DeletedConfigurations property.booleanhasDeletionWarnings()For responses, this returns true if the service returned a value for the DeletionWarnings property.booleanhasFailedConfigurations()For responses, this returns true if the service returned a value for the FailedConfigurations property.inthashCode()booleanhasRequestedConfigurations()For responses, this returns true if the service returned a value for the RequestedConfigurations property.List<String>requestedConfigurations()The list of configuration IDs that were originally requested to be deleted by the deletion task.List<SdkField<?>>sdkFields()static Class<? extends BatchDeleteConfigurationTask.Builder>serializableBuilderClass()InstantstartTime()An epoch seconds timestamp (UTC) of when the deletion task was started.BatchDeleteConfigurationTaskStatusstatus()The current execution status of the deletion task.StringstatusAsString()The current execution status of the deletion task.StringtaskId()The deletion task's unique identifier.BatchDeleteConfigurationTask.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
taskId
public final String taskId()
The deletion task's unique identifier.
- Returns:
- The deletion task's unique identifier.
-
status
public final BatchDeleteConfigurationTaskStatus status()
The current execution status of the deletion task. Valid status are: INITIALIZING | VALIDATING | DELETING | COMPLETED | FAILED.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnBatchDeleteConfigurationTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current execution status of the deletion task. Valid status are: INITIALIZING | VALIDATING | DELETING | COMPLETED | FAILED.
- See Also:
BatchDeleteConfigurationTaskStatus
-
statusAsString
public final String statusAsString()
The current execution status of the deletion task. Valid status are: INITIALIZING | VALIDATING | DELETING | COMPLETED | FAILED.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnBatchDeleteConfigurationTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current execution status of the deletion task. Valid status are: INITIALIZING | VALIDATING | DELETING | COMPLETED | FAILED.
- See Also:
BatchDeleteConfigurationTaskStatus
-
startTime
public final Instant startTime()
An epoch seconds timestamp (UTC) of when the deletion task was started.
- Returns:
- An epoch seconds timestamp (UTC) of when the deletion task was started.
-
endTime
public final Instant endTime()
An epoch seconds timestamp (UTC) of when the deletion task was completed or failed.
- Returns:
- An epoch seconds timestamp (UTC) of when the deletion task was completed or failed.
-
configurationType
public final DeletionConfigurationItemType configurationType()
The type of configuration item to delete. Supported types are: SERVER.
If the service returns an enum value that is not available in the current SDK version,
configurationTypewill returnDeletionConfigurationItemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconfigurationTypeAsString().- Returns:
- The type of configuration item to delete. Supported types are: SERVER.
- See Also:
DeletionConfigurationItemType
-
configurationTypeAsString
public final String configurationTypeAsString()
The type of configuration item to delete. Supported types are: SERVER.
If the service returns an enum value that is not available in the current SDK version,
configurationTypewill returnDeletionConfigurationItemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconfigurationTypeAsString().- Returns:
- The type of configuration item to delete. Supported types are: SERVER.
- See Also:
DeletionConfigurationItemType
-
hasRequestedConfigurations
public final boolean hasRequestedConfigurations()
For responses, this returns true if the service returned a value for the RequestedConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
requestedConfigurations
public final List<String> requestedConfigurations()
The list of configuration IDs that were originally requested to be deleted by the deletion task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRequestedConfigurations()method.- Returns:
- The list of configuration IDs that were originally requested to be deleted by the deletion task.
-
hasDeletedConfigurations
public final boolean hasDeletedConfigurations()
For responses, this returns true if the service returned a value for the DeletedConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
deletedConfigurations
public final List<String> deletedConfigurations()
The list of configuration IDs that were successfully deleted by the deletion task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDeletedConfigurations()method.- Returns:
- The list of configuration IDs that were successfully deleted by the deletion task.
-
hasFailedConfigurations
public final boolean hasFailedConfigurations()
For responses, this returns true if the service returned a value for the FailedConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
failedConfigurations
public final List<FailedConfiguration> failedConfigurations()
A list of configuration IDs that failed to delete during the deletion task, each paired with an error message.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFailedConfigurations()method.- Returns:
- A list of configuration IDs that failed to delete during the deletion task, each paired with an error message.
-
hasDeletionWarnings
public final boolean hasDeletionWarnings()
For responses, this returns true if the service returned a value for the DeletionWarnings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
deletionWarnings
public final List<DeletionWarning> deletionWarnings()
A list of configuration IDs that produced warnings regarding their deletion, paired with a warning message.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDeletionWarnings()method.- Returns:
- A list of configuration IDs that produced warnings regarding their deletion, paired with a warning message.
-
toBuilder
public BatchDeleteConfigurationTask.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<BatchDeleteConfigurationTask.Builder,BatchDeleteConfigurationTask>
-
builder
public static BatchDeleteConfigurationTask.Builder builder()
-
serializableBuilderClass
public static Class<? extends BatchDeleteConfigurationTask.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-