com.amazonaws.services.synthetics.model

Class VisualReferenceInput

java.lang.Object

com.amazonaws.services.synthetics.model.VisualReferenceInput

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
VisualReferenceInput()

Method Summary

Modifier and Type	Method and Description
VisualReferenceInput	clone()
boolean	equals(Object obj)
String	getBaseCanaryRunId() Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary.
List<BaseScreenshot>	getBaseScreenshots() An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBaseCanaryRunId(String baseCanaryRunId) Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary.
void	setBaseScreenshots(Collection<BaseScreenshot> baseScreenshots) An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary.
String	toString() Returns a string representation of this object.
VisualReferenceInput	withBaseCanaryRunId(String baseCanaryRunId) Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary.
VisualReferenceInput	withBaseScreenshots(BaseScreenshot... baseScreenshots) An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary.
VisualReferenceInput	withBaseScreenshots(Collection<BaseScreenshot> baseScreenshots) An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VisualReferenceInput

public VisualReferenceInput()

Method Detail

getBaseScreenshots

public List<BaseScreenshot> getBaseScreenshots()

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:

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.

setBaseScreenshots

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

withBaseScreenshots

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

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

withBaseScreenshots

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

setBaseCanaryRunId

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

getBaseCanaryRunId

public String getBaseCanaryRunId()

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.

withBaseCanaryRunId

public VisualReferenceInput withBaseCanaryRunId(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.

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