Interface VisualReferenceInput.Builder

All Superinterfaces:
Buildable, CopyableBuilder<VisualReferenceInput.Builder,VisualReferenceInput>, SdkBuilder<VisualReferenceInput.Builder,VisualReferenceInput>, SdkPojo
Enclosing class:
VisualReferenceInput
public static interface VisualReferenceInput.Builder extends SdkPojo, CopyableBuilder<VisualReferenceInput.Builder,VisualReferenceInput>

  • Method Details

    • baseScreenshots

      VisualReferenceInput.Builder baseScreenshots(Collection<BaseScreenshot> baseScreenshots)

      An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it from this array.

      Parameters:
      baseScreenshots - An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it from this array.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • baseScreenshots

      VisualReferenceInput.Builder baseScreenshots(BaseScreenshot... baseScreenshots)

      An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it from this array.

      Parameters:
      baseScreenshots - An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it from this array.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • baseScreenshots

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

      An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it from this array.

      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

      VisualReferenceInput.Builder baseCanaryRunId(String baseCanaryRunId)

      Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are nextrun to use the screenshots from the next run after this update is made, lastrun to use the screenshots from the most recent run before this update was made, or the value of Id in the CanaryRun from any past run of this canary.

      Parameters:
      baseCanaryRunId - Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are nextrun to use the screenshots from the next run after this update is made, lastrun to use the screenshots from the most recent run before this update was made, or the value of Id in the CanaryRun from any past run of this canary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.