software.amazon.awssdk.services.synthetics.model

Interface VisualReferenceOutput.Builder

All Superinterfaces:

Buildable, CopyableBuilder<VisualReferenceOutput.Builder,VisualReferenceOutput>, SdkBuilder<VisualReferenceOutput.Builder,VisualReferenceOutput>, SdkPojo

Enclosing class:

VisualReferenceOutput

public static interface VisualReferenceOutput.Builder
extends SdkPojo, CopyableBuilder<VisualReferenceOutput.Builder,VisualReferenceOutput>

Method Summary

Modifier and Type	Method and Description
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.
VisualReferenceOutput.Builder	baseScreenshots(BaseScreenshot... baseScreenshots) An array of screenshots that are used as the baseline for comparisons during visual monitoring.
VisualReferenceOutput.Builder	baseScreenshots(Collection<BaseScreenshot> baseScreenshots) An array of screenshots that are used as the baseline for comparisons during visual monitoring.
VisualReferenceOutput.Builder	baseScreenshots(Consumer<BaseScreenshot.Builder>... baseScreenshots) An array of screenshots that are used as the baseline for comparisons during visual monitoring.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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).

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:

#baseScreenshots(java.util.Collection)

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.