Interface CanaryRunStatus.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CanaryRunStatus.Builder,CanaryRunStatus>, SdkBuilder<CanaryRunStatus.Builder,CanaryRunStatus>, SdkPojo
Enclosing class:
CanaryRunStatus
@Mutable @NotThreadSafe public static interface CanaryRunStatus.Builder extends SdkPojo, CopyableBuilder<CanaryRunStatus.Builder,CanaryRunStatus>

  • Method Details

    • state

      CanaryRunStatus.Builder state(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:

    • state

      CanaryRunStatus.Builder state(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:

    • stateReason

      CanaryRunStatus.Builder stateReason(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.

    • stateReasonCode

      CanaryRunStatus.Builder stateReasonCode(String stateReasonCode)

      If this value is CANARY_FAILURE, either the canary script failed or Synthetics ran into a fatal error when running the canary. For example, a canary timeout misconfiguration setting can cause the canary to timeout before Synthetics can evaluate its status.

      If this value is EXECUTION_FAILURE, a non-critical failure occurred such as failing to save generated debug artifacts (for example, screenshots or har files).

      If both types of failures occurred, the CANARY_FAILURE takes precedence. To understand the exact error, use the StateReason API.

      Parameters:
      stateReasonCode - If this value is CANARY_FAILURE, either the canary script failed or Synthetics ran into a fatal error when running the canary. For example, a canary timeout misconfiguration setting can cause the canary to timeout before Synthetics can evaluate its status.

      If this value is EXECUTION_FAILURE, a non-critical failure occurred such as failing to save generated debug artifacts (for example, screenshots or har files).

      If both types of failures occurred, the CANARY_FAILURE takes precedence. To understand the exact error, use the StateReason API.

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

    • stateReasonCode

      CanaryRunStatus.Builder stateReasonCode(CanaryRunStateReasonCode stateReasonCode)

      If this value is CANARY_FAILURE, either the canary script failed or Synthetics ran into a fatal error when running the canary. For example, a canary timeout misconfiguration setting can cause the canary to timeout before Synthetics can evaluate its status.

      If this value is EXECUTION_FAILURE, a non-critical failure occurred such as failing to save generated debug artifacts (for example, screenshots or har files).

      If both types of failures occurred, the CANARY_FAILURE takes precedence. To understand the exact error, use the StateReason API.

      Parameters:
      stateReasonCode - If this value is CANARY_FAILURE, either the canary script failed or Synthetics ran into a fatal error when running the canary. For example, a canary timeout misconfiguration setting can cause the canary to timeout before Synthetics can evaluate its status.

      If this value is EXECUTION_FAILURE, a non-critical failure occurred such as failing to save generated debug artifacts (for example, screenshots or har files).

      If both types of failures occurred, the CANARY_FAILURE takes precedence. To understand the exact error, use the StateReason API.

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

    • testResult

      CanaryRunStatus.Builder testResult(String testResult)

      Specifies the status of canary script for this run. When Synthetics tries to determine the status but fails, the result is marked as UNKNOWN. For the overall status of canary run, see State.

      Parameters:
      testResult - Specifies the status of canary script for this run. When Synthetics tries to determine the status but fails, the result is marked as UNKNOWN. For the overall status of canary run, see State.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • testResult

      CanaryRunStatus.Builder testResult(CanaryRunTestResult testResult)

      Specifies the status of canary script for this run. When Synthetics tries to determine the status but fails, the result is marked as UNKNOWN. For the overall status of canary run, see State.

      Parameters:
      testResult - Specifies the status of canary script for this run. When Synthetics tries to determine the status but fails, the result is marked as UNKNOWN. For the overall status of canary run, see State.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: