software.amazon.awssdk.services.synthetics.model

Class VisualReferenceInput

java.lang.Object

software.amazon.awssdk.services.synthetics.model.VisualReferenceInput

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VisualReferenceInput.Builder,VisualReferenceInput>

@Generated(value="software.amazon.awssdk:codegen")
public final class VisualReferenceInput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VisualReferenceInput.Builder,VisualReferenceInput>

An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VisualReferenceInput.Builder

Method Summary

Modifier and Type	Method and Description
String	baseCanaryRunId() Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary.
List<BaseScreenshot>	baseScreenshots() An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary.
static VisualReferenceInput.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBaseScreenshots() For responses, this returns true if the service returned a value for the BaseScreenshots property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends VisualReferenceInput.Builder>	serializableBuilderClass()
VisualReferenceInput.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasBaseScreenshots

public final boolean hasBaseScreenshots()

For responses, this returns true if the service returned a value for the BaseScreenshots property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

baseScreenshots

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBaseScreenshots() method.

Returns:

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.

baseCanaryRunId

public final 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.

Returns:

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.

toBuilder

public VisualReferenceInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VisualReferenceInput.Builder,VisualReferenceInput>

builder

public static VisualReferenceInput.Builder builder()

serializableBuilderClass

public static Class<? extends VisualReferenceInput.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo