CanaryRunStatus (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.synthetics.model.CanaryRunStatus

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CanaryRunStatus
extends Object
implements Serializable, Cloneable, StructuredPojo
```
This structure contains the status information about a canary run.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CanaryRunStatus()

Constructors
Constructor and Description
`CanaryRunStatus()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CanaryRunStatus`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getState()` The current state of the run.
`String`	`getStateReason()` If run of the canary failed, this field contains the reason for the error.
`String`	`getStateReasonCode()` If this value is `CANARY_FAILURE`, an exception occurred in the canary code.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setState(String state)` The current state of the run.
`void`	`setStateReason(String stateReason)` If run of the canary failed, this field contains the reason for the error.
`void`	`setStateReasonCode(String stateReasonCode)` If this value is `CANARY_FAILURE`, an exception occurred in the canary code.
`String`	`toString()` Returns a string representation of this object.
`CanaryRunStatus`	`withState(CanaryRunState state)` The current state of the run.
`CanaryRunStatus`	`withState(String state)` The current state of the run.
`CanaryRunStatus`	`withStateReason(String stateReason)` If run of the canary failed, this field contains the reason for the error.
`CanaryRunStatus`	`withStateReasonCode(CanaryRunStateReasonCode stateReasonCode)` If this value is `CANARY_FAILURE`, an exception occurred in the canary code.
`CanaryRunStatus`	`withStateReasonCode(String stateReasonCode)` If this value is `CANARY_FAILURE`, an exception occurred in the canary code.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CanaryRunStatus
```
public CanaryRunStatus()
```
- Method Detail
  - setState
```
public void setState(String state)
```
    The current state of the run.
    
    Parameters:
    
    state - The current state of the run.
    
    See Also:
    
    CanaryRunState
  - getState
```
public String getState()
```
    The current state of the run.
    
    Returns:
    
    The current state of the run.
    
    See Also:
    
    CanaryRunState
  - withState
```
public CanaryRunStatus withState(String state)
```
    The current state of the run.
    
    Parameters:
    
    state - The current state of the run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CanaryRunState
  - withState
```
public CanaryRunStatus withState(CanaryRunState state)
```
    The current state of the run.
    
    Parameters:
    
    state - The current state of the run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CanaryRunState
  - setStateReason
```
public void setStateReason(String stateReason)
```
    If run of the canary failed, this field contains the reason for the error.
    
    Parameters:
    
    stateReason - If run of the canary failed, this field contains the reason for the error.
  - getStateReason
```
public String getStateReason()
```
    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.
  - withStateReason
```
public CanaryRunStatus withStateReason(String stateReason)
```
    If run of the canary failed, this field contains the reason for the error.
    
    Parameters:
    
    stateReason - If run of the canary failed, this field contains the reason for the error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStateReasonCode
```
public void setStateReasonCode(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    CanaryRunStateReasonCode
  - getStateReasonCode
```
public String getStateReasonCode()
```
    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.
    
    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
  - withStateReasonCode
```
public CanaryRunStatus withStateReasonCode(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CanaryRunStateReasonCode
  - withStateReasonCode
```
public CanaryRunStatus withStateReasonCode(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CanaryRunStateReasonCode
  - 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 CanaryRunStatus 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.

AWS SDK for Java 1.x API Reference - 1.12.793

Class CanaryRunStatus

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CanaryRunStatus

Method Detail

setState

getState

withState

withState

setStateReason

getStateReason

withStateReason

setStateReasonCode

getStateReasonCode

withStateReasonCode

withStateReasonCode

toString

equals

hashCode

clone

marshall