Package software.amazon.awssdk.services.synthetics.model

Class CanaryRunStatus

java.lang.Object

software.amazon.awssdk.services.synthetics.model.CanaryRunStatus

All Implemented Interfaces:

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

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

This structure contains the status information about a canary run.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CanaryRunStatus.Builder

Method Summary

Modifier and Type	Method	Description
static CanaryRunStatus.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CanaryRunStatus.Builder>	serializableBuilderClass()
CanaryRunState	state()	The current state of the run.
String	stateAsString()	The current state of the run.
String	stateReason()	If run of the canary failed, this field contains the reason for the error.
CanaryRunStateReasonCode	stateReasonCode()	If this value is CANARY_FAILURE, an exception occurred in the canary code.
String	stateReasonCodeAsString()	If this value is CANARY_FAILURE, an exception occurred in the canary code.
CanaryRunStatus.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

state

public final CanaryRunState state()

The current state of the run.

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

Returns:

The current state of the run.

See Also:

CanaryRunState

stateAsString

public final String stateAsString()

The current state of the run.

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

Returns:

The current state of the run.

See Also:

CanaryRunState

stateReason

public final String stateReason()

If run of the canary failed, this field contains the reason for the error.

Returns:

If run of the canary failed, this field contains the reason for the error.

stateReasonCode

public final CanaryRunStateReasonCode stateReasonCode()

If this value is CANARY_FAILURE, an exception occurred in the canary code. If this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics.

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

Returns:

If this value is CANARY_FAILURE, an exception occurred in the canary code. If this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics.

See Also:

CanaryRunStateReasonCode

stateReasonCodeAsString

public final String stateReasonCodeAsString()

If this value is CANARY_FAILURE, an exception occurred in the canary code. If this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics.

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

Returns:

If this value is CANARY_FAILURE, an exception occurred in the canary code. If this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics.

See Also:

CanaryRunStateReasonCode

toBuilder

public CanaryRunStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CanaryRunStatus.Builder,CanaryRunStatus>

builder

public static CanaryRunStatus.Builder builder()

serializableBuilderClass

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