Interface VisualReferenceOutput.Builder

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

  • Method Details

    • baseScreenshots

      VisualReferenceOutput.Builder baseScreenshots(Collection<BaseScreenshot> baseScreenshots)

      An array of screenshots that are used as the baseline for comparisons during visual monitoring.

      Parameters:
      baseScreenshots - An array of screenshots that are used as the baseline for comparisons during visual monitoring.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • baseScreenshots

      VisualReferenceOutput.Builder baseScreenshots(BaseScreenshot... baseScreenshots)

      An array of screenshots that are used as the baseline for comparisons during visual monitoring.

      Parameters:
      baseScreenshots - An array of screenshots that are used as the baseline for comparisons during visual monitoring.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • baseScreenshots

      VisualReferenceOutput.Builder baseScreenshots(Consumer<BaseScreenshot.Builder>... baseScreenshots)

      An array of screenshots that are used as the baseline for comparisons during visual monitoring.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to baseScreenshots(List<BaseScreenshot>).

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

    • baseCanaryRunId

      VisualReferenceOutput.Builder baseCanaryRunId(String baseCanaryRunId)

      The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.

      Parameters:
      baseCanaryRunId - The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • browserType

      VisualReferenceOutput.Builder browserType(String browserType)

      The browser type associated with this visual reference.

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

    • browserType

      VisualReferenceOutput.Builder browserType(BrowserType browserType)

      The browser type associated with this visual reference.

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