com.amazonaws.services.synthetics.model

Class BaseScreenshot

java.lang.Object

com.amazonaws.services.synthetics.model.BaseScreenshot

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseScreenshot()

Method Summary

Modifier and Type	Method and Description
BaseScreenshot	clone()
boolean	equals(Object obj)
List<String>	getIgnoreCoordinates() Coordinates that define the part of a screen to ignore during screenshot comparisons.
String	getScreenshotName() The name of the screenshot.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setIgnoreCoordinates(Collection<String> ignoreCoordinates) Coordinates that define the part of a screen to ignore during screenshot comparisons.
void	setScreenshotName(String screenshotName) The name of the screenshot.
String	toString() Returns a string representation of this object.
BaseScreenshot	withIgnoreCoordinates(Collection<String> ignoreCoordinates) Coordinates that define the part of a screen to ignore during screenshot comparisons.
BaseScreenshot	withIgnoreCoordinates(String... ignoreCoordinates) Coordinates that define the part of a screen to ignore during screenshot comparisons.
BaseScreenshot	withScreenshotName(String screenshotName) The name of the screenshot.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseScreenshot

public BaseScreenshot()

Method Detail

setScreenshotName

public void setScreenshotName(String screenshotName)

The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring.

Parameters:

screenshotName - The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring.

getScreenshotName

public String getScreenshotName()

The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring.

Returns:

The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring.

withScreenshotName

public BaseScreenshot withScreenshotName(String screenshotName)

The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring.

Parameters:

screenshotName - The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that specified for this canary to perform visual monitoring.

Returns:

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

getIgnoreCoordinates

public List<String> getIgnoreCoordinates()

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary

Returns:

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary

setIgnoreCoordinates

public void setIgnoreCoordinates(Collection<String> ignoreCoordinates)

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary

Parameters:

ignoreCoordinates - Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary

withIgnoreCoordinates

public BaseScreenshot withIgnoreCoordinates(String... ignoreCoordinates)

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary

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

Parameters:

ignoreCoordinates - Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary

Returns:

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

withIgnoreCoordinates

public BaseScreenshot withIgnoreCoordinates(Collection<String> ignoreCoordinates)

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary

Parameters:

ignoreCoordinates - Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a 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 BaseScreenshot 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.