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

Class CanaryStatus

java.lang.Object

software.amazon.awssdk.services.synthetics.model.CanaryStatus

All Implemented Interfaces:

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

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

A structure that contains the current state of the canary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CanaryStatus.Builder

Method Summary

Modifier and Type	Method	Description
static CanaryStatus.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 CanaryStatus.Builder>	serializableBuilderClass()
CanaryState	state()	The current state of the canary.
String	stateAsString()	The current state of the canary.
String	stateReason()	If the canary has insufficient permissions to run, this field provides more details.
CanaryStateReasonCode	stateReasonCode()	If the canary cannot run or has failed, this field displays the reason.
String	stateReasonCodeAsString()	If the canary cannot run or has failed, this field displays the reason.
CanaryStatus.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 CanaryState state()

The current state of the canary.

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

Returns:

The current state of the canary.

See Also:

CanaryState

stateAsString

public final String stateAsString()

The current state of the canary.

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

Returns:

The current state of the canary.

See Also:

CanaryState

stateReason

public final String stateReason()

If the canary has insufficient permissions to run, this field provides more details.

Returns:

If the canary has insufficient permissions to run, this field provides more details.

stateReasonCode

public final CanaryStateReasonCode stateReasonCode()

If the canary cannot run or has failed, this field displays the reason.

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

Returns:

If the canary cannot run or has failed, this field displays the reason.

See Also:

CanaryStateReasonCode

stateReasonCodeAsString

public final String stateReasonCodeAsString()

If the canary cannot run or has failed, this field displays the reason.

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

Returns:

If the canary cannot run or has failed, this field displays the reason.

See Also:

CanaryStateReasonCode

toBuilder

public CanaryStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CanaryStatus.Builder,CanaryStatus>

builder

public static CanaryStatus.Builder builder()

serializableBuilderClass

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