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

Method Summary

Modifier and Type	Method and 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) Indicates whether some other object is "equal to" this one by SDK fields.
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() Returns true if the Details property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends FailureDetails.Builder>	serializableBuilderClass()
FailureDetails.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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()

Returns true if the Details property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasDetails() to see if a value was sent in this field.

Returns:

Detailed information about the Automation step failure.

toBuilder

public FailureDetails.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<FailureDetails.Builder,FailureDetails>

Returns:

a builder for type T

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)

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)

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.