Package software.amazon.awssdk.services.greengrassv2.model

Class EffectiveDeploymentStatusDetails

java.lang.Object

software.amazon.awssdk.services.greengrassv2.model.EffectiveDeploymentStatusDetails

All Implemented Interfaces:

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

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

Contains all error-related information for the deployment record. The status details will be null if the deployment is in a success state.

Greengrass nucleus v2.8.0 or later is required to get an accurate errorStack and errorTypes response. This field will not be returned for earlier Greengrass nucleus versions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EffectiveDeploymentStatusDetails.Builder

Method Summary

Modifier and Type	Method	Description
static EffectiveDeploymentStatusDetails.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	errorStack()	Contains an ordered list of short error codes that range from the most generic error to the most specific one.
List<String>	errorTypes()	Contains tags which describe the error.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasErrorStack()	For responses, this returns true if the service returned a value for the ErrorStack property.
boolean	hasErrorTypes()	For responses, this returns true if the service returned a value for the ErrorTypes property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends EffectiveDeploymentStatusDetails.Builder>	serializableBuilderClass()
EffectiveDeploymentStatusDetails.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

hasErrorStack

public final boolean hasErrorStack()

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

errorStack

public final List<String> errorStack()

Contains an ordered list of short error codes that range from the most generic error to the most specific one. The error codes describe the reason for failure whenever the coreDeviceExecutionStatus is in a failed state. The response will be an empty list if there is no error.

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

Returns:

Contains an ordered list of short error codes that range from the most generic error to the most specific one. The error codes describe the reason for failure whenever the coreDeviceExecutionStatus is in a failed state. The response will be an empty list if there is no error.

hasErrorTypes

public final boolean hasErrorTypes()

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

errorTypes

public final List<String> errorTypes()

Contains tags which describe the error. You can use the error types to classify errors to assist with remediating the failure. The response will be an empty list if there is no error.

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

Returns:

Contains tags which describe the error. You can use the error types to classify errors to assist with remediating the failure. The response will be an empty list if there is no error.

toBuilder

public EffectiveDeploymentStatusDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EffectiveDeploymentStatusDetails.Builder,EffectiveDeploymentStatusDetails>

builder

public static EffectiveDeploymentStatusDetails.Builder builder()

serializableBuilderClass

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