Struct VisualReferenceInput 

#[non_exhaustive]
pub struct VisualReferenceInput {
    pub base_screenshots: Option<Vec<BaseScreenshot>>,
    pub base_canary_run_id: String,
    pub browser_type: Option<BrowserType>,
}

An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

base_screenshots: Option<Vec<BaseScreenshot>>

An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it from this array.

base_canary_run_id: String

Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are nextrun to use the screenshots from the next run after this update is made, lastrun to use the screenshots from the most recent run before this update was made, or the value of Id in the CanaryRun from a run of this a canary in the past 31 days. If you specify the Id of a canary run older than 31 days, the operation returns a 400 validation exception error..

browser_type: Option<BrowserType>

The browser type associated with this visual reference.

Implementations

impl VisualReferenceInput

pub fn base_screenshots(&self) -> &[BaseScreenshot]

An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for visual monitoring, remove it from this array.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .base_screenshots.is_none().

pub fn base_canary_run_id(&self) -> &str

Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are nextrun to use the screenshots from the next run after this update is made, lastrun to use the screenshots from the most recent run before this update was made, or the value of Id in the CanaryRun from a run of this a canary in the past 31 days. If you specify the Id of a canary run older than 31 days, the operation returns a 400 validation exception error..

pub fn browser_type(&self) -> Option<&BrowserType>

The browser type associated with this visual reference.

impl VisualReferenceInput

pub fn builder() -> VisualReferenceInputBuilder

Creates a new builder-style object to manufacture VisualReferenceInput.

Trait Implementations

impl Clone for VisualReferenceInput

fn clone(&self) -> VisualReferenceInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VisualReferenceInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for VisualReferenceInput

fn eq(&self, other: &VisualReferenceInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VisualReferenceInput