AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::Synthetics::Model::VisualReferenceOutput Class Reference

#include <VisualReferenceOutput.h>

Public Member Functions

 VisualReferenceOutput ()
 
 VisualReferenceOutput (Aws::Utils::Json::JsonView jsonValue)
 
VisualReferenceOutputoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< BaseScreenshot > & GetBaseScreenshots () const
 
bool BaseScreenshotsHasBeenSet () const
 
void SetBaseScreenshots (const Aws::Vector< BaseScreenshot > &value)
 
void SetBaseScreenshots (Aws::Vector< BaseScreenshot > &&value)
 
VisualReferenceOutputWithBaseScreenshots (const Aws::Vector< BaseScreenshot > &value)
 
VisualReferenceOutputWithBaseScreenshots (Aws::Vector< BaseScreenshot > &&value)
 
VisualReferenceOutputAddBaseScreenshots (const BaseScreenshot &value)
 
VisualReferenceOutputAddBaseScreenshots (BaseScreenshot &&value)
 
const Aws::StringGetBaseCanaryRunId () const
 
bool BaseCanaryRunIdHasBeenSet () const
 
void SetBaseCanaryRunId (const Aws::String &value)
 
void SetBaseCanaryRunId (Aws::String &&value)
 
void SetBaseCanaryRunId (const char *value)
 
VisualReferenceOutputWithBaseCanaryRunId (const Aws::String &value)
 
VisualReferenceOutputWithBaseCanaryRunId (Aws::String &&value)
 
VisualReferenceOutputWithBaseCanaryRunId (const char *value)
 

Detailed Description

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:

AWS API Reference

Definition at line 38 of file VisualReferenceOutput.h.

Constructor & Destructor Documentation

◆ VisualReferenceOutput() [1/2]

Aws::Synthetics::Model::VisualReferenceOutput::VisualReferenceOutput ( )

◆ VisualReferenceOutput() [2/2]

Aws::Synthetics::Model::VisualReferenceOutput::VisualReferenceOutput ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddBaseScreenshots() [1/2]

VisualReferenceOutput& Aws::Synthetics::Model::VisualReferenceOutput::AddBaseScreenshots ( BaseScreenshot &&  value)
inline

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

Definition at line 93 of file VisualReferenceOutput.h.

◆ AddBaseScreenshots() [2/2]

VisualReferenceOutput& Aws::Synthetics::Model::VisualReferenceOutput::AddBaseScreenshots ( const BaseScreenshot value)
inline

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

Definition at line 87 of file VisualReferenceOutput.h.

◆ BaseCanaryRunIdHasBeenSet()

bool Aws::Synthetics::Model::VisualReferenceOutput::BaseCanaryRunIdHasBeenSet ( ) const
inline

The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

Definition at line 108 of file VisualReferenceOutput.h.

◆ BaseScreenshotsHasBeenSet()

bool Aws::Synthetics::Model::VisualReferenceOutput::BaseScreenshotsHasBeenSet ( ) const
inline

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

Definition at line 57 of file VisualReferenceOutput.h.

◆ GetBaseCanaryRunId()

const Aws::String& Aws::Synthetics::Model::VisualReferenceOutput::GetBaseCanaryRunId ( ) const
inline

The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

Definition at line 101 of file VisualReferenceOutput.h.

◆ GetBaseScreenshots()

const Aws::Vector<BaseScreenshot>& Aws::Synthetics::Model::VisualReferenceOutput::GetBaseScreenshots ( ) const
inline

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

Definition at line 51 of file VisualReferenceOutput.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Synthetics::Model::VisualReferenceOutput::Jsonize ( ) const

◆ operator=()

VisualReferenceOutput& Aws::Synthetics::Model::VisualReferenceOutput::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetBaseCanaryRunId() [1/3]

void Aws::Synthetics::Model::VisualReferenceOutput::SetBaseCanaryRunId ( Aws::String &&  value)
inline

The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

Definition at line 122 of file VisualReferenceOutput.h.

◆ SetBaseCanaryRunId() [2/3]

void Aws::Synthetics::Model::VisualReferenceOutput::SetBaseCanaryRunId ( const Aws::String value)
inline

The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

Definition at line 115 of file VisualReferenceOutput.h.

◆ SetBaseCanaryRunId() [3/3]

void Aws::Synthetics::Model::VisualReferenceOutput::SetBaseCanaryRunId ( const char *  value)
inline

The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

Definition at line 129 of file VisualReferenceOutput.h.

◆ SetBaseScreenshots() [1/2]

void Aws::Synthetics::Model::VisualReferenceOutput::SetBaseScreenshots ( Aws::Vector< BaseScreenshot > &&  value)
inline

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

Definition at line 69 of file VisualReferenceOutput.h.

◆ SetBaseScreenshots() [2/2]

void Aws::Synthetics::Model::VisualReferenceOutput::SetBaseScreenshots ( const Aws::Vector< BaseScreenshot > &  value)
inline

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

Definition at line 63 of file VisualReferenceOutput.h.

◆ WithBaseCanaryRunId() [1/3]

VisualReferenceOutput& Aws::Synthetics::Model::VisualReferenceOutput::WithBaseCanaryRunId ( Aws::String &&  value)
inline

The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

Definition at line 143 of file VisualReferenceOutput.h.

◆ WithBaseCanaryRunId() [2/3]

VisualReferenceOutput& Aws::Synthetics::Model::VisualReferenceOutput::WithBaseCanaryRunId ( const Aws::String value)
inline

The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

Definition at line 136 of file VisualReferenceOutput.h.

◆ WithBaseCanaryRunId() [3/3]

VisualReferenceOutput& Aws::Synthetics::Model::VisualReferenceOutput::WithBaseCanaryRunId ( const char *  value)
inline

The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.

Definition at line 150 of file VisualReferenceOutput.h.

◆ WithBaseScreenshots() [1/2]

VisualReferenceOutput& Aws::Synthetics::Model::VisualReferenceOutput::WithBaseScreenshots ( Aws::Vector< BaseScreenshot > &&  value)
inline

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

Definition at line 81 of file VisualReferenceOutput.h.

◆ WithBaseScreenshots() [2/2]

VisualReferenceOutput& Aws::Synthetics::Model::VisualReferenceOutput::WithBaseScreenshots ( const Aws::Vector< BaseScreenshot > &  value)
inline

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

Definition at line 75 of file VisualReferenceOutput.h.


The documentation for this class was generated from the following file: