Interface CanaryRun.Builder

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

  • Method Details

    • id

      CanaryRun.Builder id(String id)

      A unique ID that identifies this canary run.

      Parameters:
      id - A unique ID that identifies this canary run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduledRunId

      CanaryRun.Builder scheduledRunId(String scheduledRunId)

      The ID of the scheduled canary run.

      Parameters:
      scheduledRunId - The ID of the scheduled canary run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retryAttempt

      CanaryRun.Builder retryAttempt(Integer retryAttempt)

      The count in number of the retry attempt.

      Parameters:
      retryAttempt - The count in number of the retry attempt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CanaryRun.Builder name(String name)

      The name of the canary.

      Parameters:
      name - The name of the canary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      CanaryRun.Builder status(CanaryRunStatus status)

      The status of this run.

      Parameters:
      status - The status of this run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      default CanaryRun.Builder status(Consumer<CanaryRunStatus.Builder> status)

      The status of this run.

      This is a convenience method that creates an instance of the CanaryRunStatus.Builder avoiding the need to create one manually via CanaryRunStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to status(CanaryRunStatus).

      Parameters:
      status - a consumer that will call methods on CanaryRunStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timeline

      CanaryRun.Builder timeline(CanaryRunTimeline timeline)

      A structure that contains the start and end times of this run.

      Parameters:
      timeline - A structure that contains the start and end times of this run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeline

      default CanaryRun.Builder timeline(Consumer<CanaryRunTimeline.Builder> timeline)

      A structure that contains the start and end times of this run.

      This is a convenience method that creates an instance of the CanaryRunTimeline.Builder avoiding the need to create one manually via CanaryRunTimeline.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeline(CanaryRunTimeline).

      Parameters:
      timeline - a consumer that will call methods on CanaryRunTimeline.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • artifactS3Location

      CanaryRun.Builder artifactS3Location(String artifactS3Location)

      The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.

      Parameters:
      artifactS3Location - The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRunConfig

      CanaryRun.Builder dryRunConfig(CanaryDryRunConfigOutput dryRunConfig)

      Returns the dry run configurations for a canary.

      Parameters:
      dryRunConfig - Returns the dry run configurations for a canary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRunConfig

      default CanaryRun.Builder dryRunConfig(Consumer<CanaryDryRunConfigOutput.Builder> dryRunConfig)

      Returns the dry run configurations for a canary.

      This is a convenience method that creates an instance of the CanaryDryRunConfigOutput.Builder avoiding the need to create one manually via CanaryDryRunConfigOutput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dryRunConfig(CanaryDryRunConfigOutput).

      Parameters:
      dryRunConfig - a consumer that will call methods on CanaryDryRunConfigOutput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • browserType

      CanaryRun.Builder browserType(String browserType)

      The browser type associated with this canary run.

      Parameters:
      browserType - The browser type associated with this canary run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • browserType

      CanaryRun.Builder browserType(BrowserType browserType)

      The browser type associated with this canary run.

      Parameters:
      browserType - The browser type associated with this canary run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • location

      CanaryRun.Builder location(String location)

      The Amazon Web Services Region where this canary run was executed.

      Parameters:
      location - The Amazon Web Services Region where this canary run was executed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.