Package software.amazon.awssdk.services.synthetics.model

Class BaseScreenshot

java.lang.Object

software.amazon.awssdk.services.synthetics.model.BaseScreenshot

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BaseScreenshot.Builder

Method Summary

Modifier and Type	Method	Description
static BaseScreenshot.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIgnoreCoordinates()	For responses, this returns true if the service returned a value for the IgnoreCoordinates property.
List<String>	ignoreCoordinates()	Coordinates that define the part of a screen to ignore during screenshot comparisons.
String	screenshotName()	The name of the screenshot.
List<SdkField<?>>	sdkFields()
static Class<? extends BaseScreenshot.Builder>	serializableBuilderClass()
BaseScreenshot.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

screenshotName

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

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.

hasIgnoreCoordinates

public final boolean hasIgnoreCoordinates()

For responses, this returns true if the service returned a value for the IgnoreCoordinates 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.

ignoreCoordinates

public final List<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

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 hasIgnoreCoordinates() method.

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

toBuilder

public BaseScreenshot.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BaseScreenshot.Builder,BaseScreenshot>

builder

public static BaseScreenshot.Builder builder()

serializableBuilderClass

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