Class VisualReferenceOutput

java.lang.Object
software.amazon.awssdk.services.synthetics.model.VisualReferenceOutput
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VisualReferenceOutput.Builder,VisualReferenceOutput>
@Generated("software.amazon.awssdk:codegen") public final class VisualReferenceOutput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VisualReferenceOutput.Builder,VisualReferenceOutput>

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.

See Also:

  • Method Details

    • hasBaseScreenshots

      public final boolean hasBaseScreenshots()
      For responses, this returns true if the service returned a value for the BaseScreenshots 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.

    • baseScreenshots

      public final List<BaseScreenshot> baseScreenshots()

      An array of screenshots that are used as the baseline for comparisons during visual monitoring.

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

      Returns:
      An array of screenshots that are used as the baseline for comparisons during visual monitoring.

    • baseCanaryRunId

      public final String baseCanaryRunId()

      The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.

      Returns:
      The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.

    • browserType

      public final BrowserType browserType()

      The browser type associated with this visual reference.

      If the service returns an enum value that is not available in the current SDK version, browserType will return BrowserType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from browserTypeAsString().

      Returns:
      The browser type associated with this visual reference.
      See Also:

    • browserTypeAsString

      public final String browserTypeAsString()

      The browser type associated with this visual reference.

      If the service returns an enum value that is not available in the current SDK version, browserType will return BrowserType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from browserTypeAsString().

      Returns:
      The browser type associated with this visual reference.
      See Also:

    • toBuilder

      public VisualReferenceOutput.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<VisualReferenceOutput.Builder,VisualReferenceOutput>
      Returns:
      a builder for type T

    • builder

      public static VisualReferenceOutput.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.