Class BatchDeleteConfigurationTask
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BatchDeleteConfigurationTask.Builder,
BatchDeleteConfigurationTask>
A metadata object that represents the deletion task being executed.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The type of configuration item to delete.final String
The type of configuration item to delete.The list of configuration IDs that were successfully deleted by the deletion task.final List
<DeletionWarning> A list of configuration IDs that produced warnings regarding their deletion, paired with a warning message.final Instant
endTime()
An epoch seconds timestamp (UTC) of when the deletion task was completed or failed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<FailedConfiguration> A list of configuration IDs that failed to delete during the deletion task, each paired with an error message.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DeletedConfigurations property.final boolean
For responses, this returns true if the service returned a value for the DeletionWarnings property.final boolean
For responses, this returns true if the service returned a value for the FailedConfigurations property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RequestedConfigurations property.The list of configuration IDs that were originally requested to be deleted by the deletion task.static Class
<? extends BatchDeleteConfigurationTask.Builder> final Instant
An epoch seconds timestamp (UTC) of when the deletion task was started.status()
The current execution status of the deletion task.final String
The current execution status of the deletion task.final String
taskId()
The deletion task's unique identifier.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
taskId
The deletion task's unique identifier.
- Returns:
- The deletion task's unique identifier.
-
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,
status
will 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:
-
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,
status
will 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:
-
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
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
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,
configurationType
will 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:
-
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,
configurationType
will 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:
-
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
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
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
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
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
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 interfaceToCopyableBuilder<BatchDeleteConfigurationTask.Builder,
BatchDeleteConfigurationTask> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-