com.amazonaws.services.synthetics.model

Class VisualReferenceOutput

java.lang.Object

com.amazonaws.services.synthetics.model.VisualReferenceOutput

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VisualReferenceOutput
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
VisualReferenceOutput()

Method Summary

Modifier and Type	Method and Description
VisualReferenceOutput	clone()
boolean	equals(Object obj)
String	getBaseCanaryRunId() The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.
List<BaseScreenshot>	getBaseScreenshots() An array of screenshots that are used as the baseline for comparisons during visual monitoring.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBaseCanaryRunId(String baseCanaryRunId) The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.
void	setBaseScreenshots(Collection<BaseScreenshot> baseScreenshots) An array of screenshots that are used as the baseline for comparisons during visual monitoring.
String	toString() Returns a string representation of this object.
VisualReferenceOutput	withBaseCanaryRunId(String baseCanaryRunId) The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.
VisualReferenceOutput	withBaseScreenshots(BaseScreenshot... baseScreenshots) An array of screenshots that are used as the baseline for comparisons during visual monitoring.
VisualReferenceOutput	withBaseScreenshots(Collection<BaseScreenshot> baseScreenshots) An array of screenshots that are used as the baseline for comparisons during visual monitoring.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VisualReferenceOutput

public VisualReferenceOutput()

Method Detail

getBaseScreenshots

public List<BaseScreenshot> getBaseScreenshots()

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

Returns:

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

setBaseScreenshots

public void setBaseScreenshots(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.

withBaseScreenshots

public VisualReferenceOutput withBaseScreenshots(BaseScreenshot... baseScreenshots)

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

NOTE: This method appends the values to the existing list (if any). Use setBaseScreenshots(java.util.Collection) or withBaseScreenshots(java.util.Collection) if you want to override the existing values.

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.

withBaseScreenshots

public VisualReferenceOutput withBaseScreenshots(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.

setBaseCanaryRunId

public void setBaseCanaryRunId(String baseCanaryRunId)

The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

Parameters:

baseCanaryRunId - The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

getBaseCanaryRunId

public String getBaseCanaryRunId()

The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

Returns:

The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

withBaseCanaryRunId

public VisualReferenceOutput withBaseCanaryRunId(String baseCanaryRunId)

The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

Parameters:

baseCanaryRunId - The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public VisualReferenceOutput clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.