software.amazon.awssdk.services.applicationdiscovery.model

Class BatchDeleteConfigurationTask

java.lang.Object

software.amazon.awssdk.services.applicationdiscovery.model.BatchDeleteConfigurationTask

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BatchDeleteConfigurationTask.Builder,BatchDeleteConfigurationTask>

@Generated(value="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 and Description
static interface	BatchDeleteConfigurationTask.Builder

Method Summary

Modifier and Type	Method and Description
static BatchDeleteConfigurationTask.Builder	builder()
DeletionConfigurationItemType	configurationType() The type of configuration item to delete.
String	configurationTypeAsString() 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.
Instant	endTime() An epoch seconds timestamp (UTC) of when the deletion task was completed or failed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(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)
boolean	hasDeletedConfigurations() For responses, this returns true if the service returned a value for the DeletedConfigurations property.
boolean	hasDeletionWarnings() For responses, this returns true if the service returned a value for the DeletionWarnings property.
boolean	hasFailedConfigurations() For responses, this returns true if the service returned a value for the FailedConfigurations property.
int	hashCode()
boolean	hasRequestedConfigurations() 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()
Instant	startTime() An epoch seconds timestamp (UTC) of when the deletion task was started.
BatchDeleteConfigurationTaskStatus	status() The current execution status of the deletion task.
String	statusAsString() The current execution status of the deletion task.
String	taskId() The deletion task's unique identifier.
BatchDeleteConfigurationTask.Builder	toBuilder()
String	toString() 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, status will return BatchDeleteConfigurationTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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, status will return BatchDeleteConfigurationTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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, configurationType will return DeletionConfigurationItemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationTypeAsString().

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, configurationType will return DeletionConfigurationItemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configurationTypeAsString().

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 the isEmpty() 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 the isEmpty() 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 the isEmpty() 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 the isEmpty() 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:

toBuilder in interface ToCopyableBuilder<BatchDeleteConfigurationTask.Builder,BatchDeleteConfigurationTask>

builder

public static BatchDeleteConfigurationTask.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo