software.amazon.awssdk.services.codedeploy.model

Class Diagnostics

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Diagnostics.Builder,Diagnostics>

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Diagnostics.Builder

Method Summary

Modifier and Type	Method and Description
static Diagnostics.Builder	builder()
boolean	equals(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.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	message() The message associated with the error.
String	scriptName() The name of the script.
static Class<? extends Diagnostics.Builder>	serializableBuilderClass()
Diagnostics.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

errorCode

public 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 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 String scriptName()

The name of the script.

Returns:

The name of the script.

message

public String message()

The message associated with the error.

Returns:

The message associated with the error.

logTail

public String logTail()

The last portion of the diagnostic log.

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

Returns:

The last portion of the diagnostic log.

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

toBuilder

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

Returns:

a builder for type T

builder

public static Diagnostics.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.