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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<BaseScreenshot.Builder,BaseScreenshot>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.