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

Class FailureDetails

java.lang.Object

software.amazon.awssdk.services.ssm.model.FailureDetails

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class FailureDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FailureDetails.Builder,FailureDetails>

Information about an Automation failure.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FailureDetails.Builder

Method Summary

Modifier and Type	Method	Description
static FailureDetails.Builder	builder()
Map<String,List<String>>	details()	Detailed information about the Automation step failure.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureStage()	The stage of the Automation execution when the failure occurred.
String	failureType()	The type of Automation failure.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDetails()	For responses, this returns true if the service returned a value for the Details property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends FailureDetails.Builder>	serializableBuilderClass()
FailureDetails.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

failureStage

public final String failureStage()

The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.

Returns:

The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.

failureType

public final String failureType()

The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.

Returns:

The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.

hasDetails

public final boolean hasDetails()

For responses, this returns true if the service returned a value for the Details 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.

details

public final Map<String,List<String>> details()

Detailed information about the Automation step failure.

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 hasDetails() method.

Returns:

Detailed information about the Automation step failure.

toBuilder

public FailureDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FailureDetails.Builder,FailureDetails>

builder

public static FailureDetails.Builder builder()

serializableBuilderClass

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