software.amazon.awssdk.services.synthetics.model

Class VisualReferenceOutput

java.lang.Object

software.amazon.awssdk.services.synthetics.model.VisualReferenceOutput

All Implemented Interfaces:

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

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

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run that is used as the baseline for screenshots, and the coordinates of any parts of those screenshots that are ignored during visual monitoring comparison.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VisualReferenceOutput.Builder

Method Summary

Modifier and Type	Method and Description
String	baseCanaryRunId() The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.
List<BaseScreenshot>	baseScreenshots() An array of screenshots that are used as the baseline for comparisons during visual monitoring.
static VisualReferenceOutput.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 VisualReferenceOutput.Builder>	serializableBuilderClass()
VisualReferenceOutput.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 are used as the baseline for comparisons during visual monitoring.

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 are used as the baseline for comparisons during visual monitoring.

baseCanaryRunId

public final String baseCanaryRunId()

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

Returns:

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

toBuilder

public VisualReferenceOutput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VisualReferenceOutput.Builder,VisualReferenceOutput>

builder

public static VisualReferenceOutput.Builder builder()

serializableBuilderClass

public static Class<? extends VisualReferenceOutput.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