com.amazonaws.services.synthetics.model

Class CanaryStatus

java.lang.Object

com.amazonaws.services.synthetics.model.CanaryStatus

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CanaryStatus
extends Object
implements Serializable, Cloneable, StructuredPojo

A structure that contains the current state of the canary.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CanaryStatus()

Method Summary

Modifier and Type	Method and Description
CanaryStatus	clone()
boolean	equals(Object obj)
String	getState() The current state of the canary.
String	getStateReason() If the canary has insufficient permissions to run, this field provides more details.
String	getStateReasonCode() If the canary cannot run or has failed, this field displays the reason.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setState(String state) The current state of the canary.
void	setStateReason(String stateReason) If the canary has insufficient permissions to run, this field provides more details.
void	setStateReasonCode(String stateReasonCode) If the canary cannot run or has failed, this field displays the reason.
String	toString() Returns a string representation of this object.
CanaryStatus	withState(CanaryState state) The current state of the canary.
CanaryStatus	withState(String state) The current state of the canary.
CanaryStatus	withStateReason(String stateReason) If the canary has insufficient permissions to run, this field provides more details.
CanaryStatus	withStateReasonCode(CanaryStateReasonCode stateReasonCode) If the canary cannot run or has failed, this field displays the reason.
CanaryStatus	withStateReasonCode(String stateReasonCode) If the canary cannot run or has failed, this field displays the reason.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CanaryStatus

public CanaryStatus()

Method Detail

setState

public void setState(String state)

The current state of the canary.

Parameters:

state - The current state of the canary.

See Also:

CanaryState

getState

public String getState()

The current state of the canary.

Returns:

The current state of the canary.

See Also:

CanaryState

withState

public CanaryStatus withState(String state)

The current state of the canary.

Parameters:

state - The current state of the canary.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CanaryState

withState

public CanaryStatus withState(CanaryState state)

The current state of the canary.

Parameters:

state - The current state of the canary.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CanaryState

setStateReason

public void setStateReason(String stateReason)

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

Parameters:

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

getStateReason

public String getStateReason()

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.

withStateReason

public CanaryStatus withStateReason(String stateReason)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setStateReasonCode

public void setStateReasonCode(String stateReasonCode)

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

Parameters:

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

See Also:

CanaryStateReasonCode

getStateReasonCode

public String getStateReasonCode()

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

Returns:

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

See Also:

CanaryStateReasonCode

withStateReasonCode

public CanaryStatus withStateReasonCode(String stateReasonCode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CanaryStateReasonCode

withStateReasonCode

public CanaryStatus withStateReasonCode(CanaryStateReasonCode stateReasonCode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CanaryStateReasonCode

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CanaryStatus clone()

Overrides:

clone in class Object

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.