@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.
Constructor and Description |
---|
VisualReferenceOutput() |
Modifier and Type | Method and Description |
---|---|
VisualReferenceOutput |
clone() |
boolean |
equals(Object obj) |
String |
getBaseCanaryRunId()
The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons
by 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 baseline screenshots that are used for visual monitoring comparisons
by 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 baseline screenshots that are used for visual monitoring comparisons
by 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.
|
public List<BaseScreenshot> getBaseScreenshots()
An array of screenshots that are used as the baseline for comparisons during visual monitoring.
public void setBaseScreenshots(Collection<BaseScreenshot> baseScreenshots)
An array of screenshots that are used as the baseline for comparisons during visual monitoring.
baseScreenshots
- An array of screenshots that are used as the baseline for comparisons during visual monitoring.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.
baseScreenshots
- An array of screenshots that are used as the baseline for comparisons during visual monitoring.public VisualReferenceOutput withBaseScreenshots(Collection<BaseScreenshot> baseScreenshots)
An array of screenshots that are used as the baseline for comparisons during visual monitoring.
baseScreenshots
- An array of screenshots that are used as the baseline for comparisons during visual monitoring.public void setBaseCanaryRunId(String baseCanaryRunId)
The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.
baseCanaryRunId
- The ID of the canary run that produced the baseline screenshots that are used for visual monitoring
comparisons by this canary.public String getBaseCanaryRunId()
The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.
public VisualReferenceOutput withBaseCanaryRunId(String baseCanaryRunId)
The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.
baseCanaryRunId
- The ID of the canary run that produced the baseline screenshots that are used for visual monitoring
comparisons by this canary.public String toString()
toString
in class Object
Object.toString()
public VisualReferenceOutput clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.