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

#include <VisualReferenceInput.h>

Public Member Functions

 VisualReferenceInput ()
 
 VisualReferenceInput (Aws::Utils::Json::JsonView jsonValue)
 
VisualReferenceInputoperator= (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)
 
VisualReferenceInputWithBaseScreenshots (const Aws::Vector< BaseScreenshot > &value)
 
VisualReferenceInputWithBaseScreenshots (Aws::Vector< BaseScreenshot > &&value)
 
VisualReferenceInputAddBaseScreenshots (const BaseScreenshot &value)
 
VisualReferenceInputAddBaseScreenshots (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)
 
VisualReferenceInputWithBaseCanaryRunId (const Aws::String &value)
 
VisualReferenceInputWithBaseCanaryRunId (Aws::String &&value)
 
VisualReferenceInputWithBaseCanaryRunId (const char *value)
 

Detailed Description

An object that specifies what screenshots to use as a baseline for visual monitoring by this canary, and optionally the 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

See Also:

AWS API Reference

Definition at line 41 of file VisualReferenceInput.h.

Constructor & Destructor Documentation

◆ VisualReferenceInput() [1/2]

Aws::Synthetics::Model::VisualReferenceInput::VisualReferenceInput ( )

◆ VisualReferenceInput() [2/2]

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

Member Function Documentation

◆ AddBaseScreenshots() [1/2]

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

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.

Definition at line 104 of file VisualReferenceInput.h.

◆ AddBaseScreenshots() [2/2]

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

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.

Definition at line 97 of file VisualReferenceInput.h.

◆ BaseCanaryRunIdHasBeenSet()

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

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 any past run of this canary.

Definition at line 127 of file VisualReferenceInput.h.

◆ BaseScreenshotsHasBeenSet()

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

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.

Definition at line 62 of file VisualReferenceInput.h.

◆ GetBaseCanaryRunId()

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

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 any past run of this canary.

Definition at line 116 of file VisualReferenceInput.h.

◆ GetBaseScreenshots()

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

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.

Definition at line 55 of file VisualReferenceInput.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetBaseCanaryRunId() [1/3]

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

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 any past run of this canary.

Definition at line 149 of file VisualReferenceInput.h.

◆ SetBaseCanaryRunId() [2/3]

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

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 any past run of this canary.

Definition at line 138 of file VisualReferenceInput.h.

◆ SetBaseCanaryRunId() [3/3]

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

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 any past run of this canary.

Definition at line 160 of file VisualReferenceInput.h.

◆ SetBaseScreenshots() [1/2]

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

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.

Definition at line 76 of file VisualReferenceInput.h.

◆ SetBaseScreenshots() [2/2]

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

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.

Definition at line 69 of file VisualReferenceInput.h.

◆ WithBaseCanaryRunId() [1/3]

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

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 any past run of this canary.

Definition at line 182 of file VisualReferenceInput.h.

◆ WithBaseCanaryRunId() [2/3]

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

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 any past run of this canary.

Definition at line 171 of file VisualReferenceInput.h.

◆ WithBaseCanaryRunId() [3/3]

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

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 any past run of this canary.

Definition at line 193 of file VisualReferenceInput.h.

◆ WithBaseScreenshots() [1/2]

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

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.

Definition at line 90 of file VisualReferenceInput.h.

◆ WithBaseScreenshots() [2/2]

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

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.

Definition at line 83 of file VisualReferenceInput.h.


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