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

#include <BaseScreenshot.h>

Public Member Functions

 BaseScreenshot ()
 
 BaseScreenshot (Aws::Utils::Json::JsonView jsonValue)
 
BaseScreenshotoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetScreenshotName () const
 
bool ScreenshotNameHasBeenSet () const
 
void SetScreenshotName (const Aws::String &value)
 
void SetScreenshotName (Aws::String &&value)
 
void SetScreenshotName (const char *value)
 
BaseScreenshotWithScreenshotName (const Aws::String &value)
 
BaseScreenshotWithScreenshotName (Aws::String &&value)
 
BaseScreenshotWithScreenshotName (const char *value)
 
const Aws::Vector< Aws::String > & GetIgnoreCoordinates () const
 
bool IgnoreCoordinatesHasBeenSet () const
 
void SetIgnoreCoordinates (const Aws::Vector< Aws::String > &value)
 
void SetIgnoreCoordinates (Aws::Vector< Aws::String > &&value)
 
BaseScreenshotWithIgnoreCoordinates (const Aws::Vector< Aws::String > &value)
 
BaseScreenshotWithIgnoreCoordinates (Aws::Vector< Aws::String > &&value)
 
BaseScreenshotAddIgnoreCoordinates (const Aws::String &value)
 
BaseScreenshotAddIgnoreCoordinates (Aws::String &&value)
 
BaseScreenshotAddIgnoreCoordinates (const char *value)
 

Detailed Description

A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.

See Also:

AWS API Reference

Definition at line 33 of file BaseScreenshot.h.

Constructor & Destructor Documentation

◆ BaseScreenshot() [1/2]

Aws::Synthetics::Model::BaseScreenshot::BaseScreenshot ( )

◆ BaseScreenshot() [2/2]

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

Member Function Documentation

◆ AddIgnoreCoordinates() [1/3]

BaseScreenshot& Aws::Synthetics::Model::BaseScreenshot::AddIgnoreCoordinates ( Aws::String &&  value)
inline

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}

Definition at line 161 of file BaseScreenshot.h.

◆ AddIgnoreCoordinates() [2/3]

BaseScreenshot& Aws::Synthetics::Model::BaseScreenshot::AddIgnoreCoordinates ( const Aws::String value)
inline

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}

Definition at line 153 of file BaseScreenshot.h.

◆ AddIgnoreCoordinates() [3/3]

BaseScreenshot& Aws::Synthetics::Model::BaseScreenshot::AddIgnoreCoordinates ( const char *  value)
inline

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}

Definition at line 169 of file BaseScreenshot.h.

◆ GetIgnoreCoordinates()

const Aws::Vector<Aws::String>& Aws::Synthetics::Model::BaseScreenshot::GetIgnoreCoordinates ( ) const
inline

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}

Definition at line 105 of file BaseScreenshot.h.

◆ GetScreenshotName()

const Aws::String& Aws::Synthetics::Model::BaseScreenshot::GetScreenshotName ( ) const
inline

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.

Definition at line 47 of file BaseScreenshot.h.

◆ IgnoreCoordinatesHasBeenSet()

bool Aws::Synthetics::Model::BaseScreenshot::IgnoreCoordinatesHasBeenSet ( ) const
inline

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}

Definition at line 113 of file BaseScreenshot.h.

◆ Jsonize()

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

◆ operator=()

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

◆ ScreenshotNameHasBeenSet()

bool Aws::Synthetics::Model::BaseScreenshot::ScreenshotNameHasBeenSet ( ) const
inline

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.

Definition at line 54 of file BaseScreenshot.h.

◆ SetIgnoreCoordinates() [1/2]

void Aws::Synthetics::Model::BaseScreenshot::SetIgnoreCoordinates ( Aws::Vector< Aws::String > &&  value)
inline

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}

Definition at line 129 of file BaseScreenshot.h.

◆ SetIgnoreCoordinates() [2/2]

void Aws::Synthetics::Model::BaseScreenshot::SetIgnoreCoordinates ( const Aws::Vector< Aws::String > &  value)
inline

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}

Definition at line 121 of file BaseScreenshot.h.

◆ SetScreenshotName() [1/3]

void Aws::Synthetics::Model::BaseScreenshot::SetScreenshotName ( Aws::String &&  value)
inline

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.

Definition at line 68 of file BaseScreenshot.h.

◆ SetScreenshotName() [2/3]

void Aws::Synthetics::Model::BaseScreenshot::SetScreenshotName ( const Aws::String value)
inline

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.

Definition at line 61 of file BaseScreenshot.h.

◆ SetScreenshotName() [3/3]

void Aws::Synthetics::Model::BaseScreenshot::SetScreenshotName ( const char *  value)
inline

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.

Definition at line 75 of file BaseScreenshot.h.

◆ WithIgnoreCoordinates() [1/2]

BaseScreenshot& Aws::Synthetics::Model::BaseScreenshot::WithIgnoreCoordinates ( Aws::Vector< Aws::String > &&  value)
inline

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}

Definition at line 145 of file BaseScreenshot.h.

◆ WithIgnoreCoordinates() [2/2]

BaseScreenshot& Aws::Synthetics::Model::BaseScreenshot::WithIgnoreCoordinates ( const Aws::Vector< Aws::String > &  value)
inline

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}

Definition at line 137 of file BaseScreenshot.h.

◆ WithScreenshotName() [1/3]

BaseScreenshot& Aws::Synthetics::Model::BaseScreenshot::WithScreenshotName ( Aws::String &&  value)
inline

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.

Definition at line 89 of file BaseScreenshot.h.

◆ WithScreenshotName() [2/3]

BaseScreenshot& Aws::Synthetics::Model::BaseScreenshot::WithScreenshotName ( const Aws::String value)
inline

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.

Definition at line 82 of file BaseScreenshot.h.

◆ WithScreenshotName() [3/3]

BaseScreenshot& Aws::Synthetics::Model::BaseScreenshot::WithScreenshotName ( const char *  value)
inline

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.

Definition at line 96 of file BaseScreenshot.h.


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