Package software.amazon.awssdk.services.codedeploy.model

Class Diagnostics

java.lang.Object

software.amazon.awssdk.services.codedeploy.model.Diagnostics

All Implemented Interfaces:

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

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

Diagnostic information about executable scripts that are part of a deployment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Diagnostics.Builder

Method Summary

Modifier and Type	Method	Description
static Diagnostics.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
LifecycleErrorCode	errorCode()	The associated error code:
String	errorCodeAsString()	The associated error code:
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	logTail()	The last portion of the diagnostic log.
String	message()	The message associated with the error.
String	scriptName()	The name of the script.
List<SdkField<?>>	sdkFields()
static Class<? extends Diagnostics.Builder>	serializableBuilderClass()
Diagnostics.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

errorCode

public final LifecycleErrorCode errorCode()

The associated error code:

• Success: The specified script ran.

• ScriptMissing: The specified script was not found in the specified location.

• ScriptNotExecutable: The specified script is not a recognized executable file type.

• ScriptTimedOut: The specified script did not finish running in the specified time period.

• ScriptFailed: The specified script failed to run as expected.

• UnknownError: The specified script did not run for an unknown reason.

If the service returns an enum value that is not available in the current SDK version, errorCode will return LifecycleErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().

Returns:

The associated error code:

• Success: The specified script ran.

• ScriptMissing: The specified script was not found in the specified location.

• ScriptNotExecutable: The specified script is not a recognized executable file type.

• ScriptTimedOut: The specified script did not finish running in the specified time period.

• ScriptFailed: The specified script failed to run as expected.

• UnknownError: The specified script did not run for an unknown reason.

See Also:

LifecycleErrorCode

errorCodeAsString

public final String errorCodeAsString()

The associated error code:

• Success: The specified script ran.

• ScriptMissing: The specified script was not found in the specified location.

• ScriptNotExecutable: The specified script is not a recognized executable file type.

• ScriptTimedOut: The specified script did not finish running in the specified time period.

• ScriptFailed: The specified script failed to run as expected.

• UnknownError: The specified script did not run for an unknown reason.

If the service returns an enum value that is not available in the current SDK version, errorCode will return LifecycleErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().

Returns:

The associated error code:

• Success: The specified script ran.

• ScriptMissing: The specified script was not found in the specified location.

• ScriptNotExecutable: The specified script is not a recognized executable file type.

• ScriptTimedOut: The specified script did not finish running in the specified time period.

• ScriptFailed: The specified script failed to run as expected.

• UnknownError: The specified script did not run for an unknown reason.

See Also:

LifecycleErrorCode

scriptName

public final String scriptName()

The name of the script.

Returns:

The name of the script.

message

public final String message()

The message associated with the error.

Returns:

The message associated with the error.

logTail

public final String logTail()

The last portion of the diagnostic log.

If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.

Returns:

The last portion of the diagnostic log.

If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.

toBuilder

public Diagnostics.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Diagnostics.Builder,Diagnostics>

builder

public static Diagnostics.Builder builder()

serializableBuilderClass

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