AWS SDK for C++  1.9.71
AWS SDK for C++
Public Member Functions | List of all members
Aws::RoboMaker::Model::Tool Class Reference

#include <Tool.h>

Public Member Functions

 Tool ()
 
 Tool (Aws::Utils::Json::JsonView jsonValue)
 
Tooloperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetStreamUI () const
 
bool StreamUIHasBeenSet () const
 
void SetStreamUI (bool value)
 
ToolWithStreamUI (bool value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
ToolWithName (const Aws::String &value)
 
ToolWithName (Aws::String &&value)
 
ToolWithName (const char *value)
 
const Aws::StringGetCommand () const
 
bool CommandHasBeenSet () const
 
void SetCommand (const Aws::String &value)
 
void SetCommand (Aws::String &&value)
 
void SetCommand (const char *value)
 
ToolWithCommand (const Aws::String &value)
 
ToolWithCommand (Aws::String &&value)
 
ToolWithCommand (const char *value)
 
bool GetStreamOutputToCloudWatch () const
 
bool StreamOutputToCloudWatchHasBeenSet () const
 
void SetStreamOutputToCloudWatch (bool value)
 
ToolWithStreamOutputToCloudWatch (bool value)
 
const ExitBehaviorGetExitBehavior () const
 
bool ExitBehaviorHasBeenSet () const
 
void SetExitBehavior (const ExitBehavior &value)
 
void SetExitBehavior (ExitBehavior &&value)
 
ToolWithExitBehavior (const ExitBehavior &value)
 
ToolWithExitBehavior (ExitBehavior &&value)
 

Detailed Description

Information about a tool. Tools are used in a simulation job.

See Also:

AWS API Reference

Definition at line 33 of file Tool.h.

Constructor & Destructor Documentation

◆ Tool() [1/2]

Aws::RoboMaker::Model::Tool::Tool ( )

◆ Tool() [2/2]

Aws::RoboMaker::Model::Tool::Tool ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CommandHasBeenSet()

bool Aws::RoboMaker::Model::Tool::CommandHasBeenSet ( ) const
inline

Command-line arguments for the tool. It must include the tool executable name.

Definition at line 126 of file Tool.h.

◆ ExitBehaviorHasBeenSet()

bool Aws::RoboMaker::Model::Tool::ExitBehaviorHasBeenSet ( ) const
inline

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

Definition at line 202 of file Tool.h.

◆ GetCommand()

const Aws::String& Aws::RoboMaker::Model::Tool::GetCommand ( ) const
inline

Command-line arguments for the tool. It must include the tool executable name.

Definition at line 120 of file Tool.h.

◆ GetExitBehavior()

const ExitBehavior& Aws::RoboMaker::Model::Tool::GetExitBehavior ( ) const
inline

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

Definition at line 195 of file Tool.h.

◆ GetName()

const Aws::String& Aws::RoboMaker::Model::Tool::GetName ( ) const
inline

The name of the tool.

Definition at line 78 of file Tool.h.

◆ GetStreamOutputToCloudWatch()

bool Aws::RoboMaker::Model::Tool::GetStreamOutputToCloudWatch ( ) const
inline

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

Definition at line 169 of file Tool.h.

◆ GetStreamUI()

bool Aws::RoboMaker::Model::Tool::GetStreamUI ( ) const
inline

Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

Definition at line 48 of file Tool.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::RoboMaker::Model::Tool::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::RoboMaker::Model::Tool::NameHasBeenSet ( ) const
inline

The name of the tool.

Definition at line 83 of file Tool.h.

◆ operator=()

Tool& Aws::RoboMaker::Model::Tool::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCommand() [1/3]

void Aws::RoboMaker::Model::Tool::SetCommand ( Aws::String &&  value)
inline

Command-line arguments for the tool. It must include the tool executable name.

Definition at line 138 of file Tool.h.

◆ SetCommand() [2/3]

void Aws::RoboMaker::Model::Tool::SetCommand ( const Aws::String value)
inline

Command-line arguments for the tool. It must include the tool executable name.

Definition at line 132 of file Tool.h.

◆ SetCommand() [3/3]

void Aws::RoboMaker::Model::Tool::SetCommand ( const char *  value)
inline

Command-line arguments for the tool. It must include the tool executable name.

Definition at line 144 of file Tool.h.

◆ SetExitBehavior() [1/2]

void Aws::RoboMaker::Model::Tool::SetExitBehavior ( const ExitBehavior value)
inline

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

Definition at line 209 of file Tool.h.

◆ SetExitBehavior() [2/2]

void Aws::RoboMaker::Model::Tool::SetExitBehavior ( ExitBehavior &&  value)
inline

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

Definition at line 216 of file Tool.h.

◆ SetName() [1/3]

void Aws::RoboMaker::Model::Tool::SetName ( Aws::String &&  value)
inline

The name of the tool.

Definition at line 93 of file Tool.h.

◆ SetName() [2/3]

void Aws::RoboMaker::Model::Tool::SetName ( const Aws::String value)
inline

The name of the tool.

Definition at line 88 of file Tool.h.

◆ SetName() [3/3]

void Aws::RoboMaker::Model::Tool::SetName ( const char *  value)
inline

The name of the tool.

Definition at line 98 of file Tool.h.

◆ SetStreamOutputToCloudWatch()

void Aws::RoboMaker::Model::Tool::SetStreamOutputToCloudWatch ( bool  value)
inline

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

Definition at line 181 of file Tool.h.

◆ SetStreamUI()

void Aws::RoboMaker::Model::Tool::SetStreamUI ( bool  value)
inline

Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

Definition at line 64 of file Tool.h.

◆ StreamOutputToCloudWatchHasBeenSet()

bool Aws::RoboMaker::Model::Tool::StreamOutputToCloudWatchHasBeenSet ( ) const
inline

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

Definition at line 175 of file Tool.h.

◆ StreamUIHasBeenSet()

bool Aws::RoboMaker::Model::Tool::StreamUIHasBeenSet ( ) const
inline

Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

Definition at line 56 of file Tool.h.

◆ WithCommand() [1/3]

Tool& Aws::RoboMaker::Model::Tool::WithCommand ( Aws::String &&  value)
inline

Command-line arguments for the tool. It must include the tool executable name.

Definition at line 156 of file Tool.h.

◆ WithCommand() [2/3]

Tool& Aws::RoboMaker::Model::Tool::WithCommand ( const Aws::String value)
inline

Command-line arguments for the tool. It must include the tool executable name.

Definition at line 150 of file Tool.h.

◆ WithCommand() [3/3]

Tool& Aws::RoboMaker::Model::Tool::WithCommand ( const char *  value)
inline

Command-line arguments for the tool. It must include the tool executable name.

Definition at line 162 of file Tool.h.

◆ WithExitBehavior() [1/2]

Tool& Aws::RoboMaker::Model::Tool::WithExitBehavior ( const ExitBehavior value)
inline

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

Definition at line 223 of file Tool.h.

◆ WithExitBehavior() [2/2]

Tool& Aws::RoboMaker::Model::Tool::WithExitBehavior ( ExitBehavior &&  value)
inline

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

Definition at line 230 of file Tool.h.

◆ WithName() [1/3]

Tool& Aws::RoboMaker::Model::Tool::WithName ( Aws::String &&  value)
inline

The name of the tool.

Definition at line 108 of file Tool.h.

◆ WithName() [2/3]

Tool& Aws::RoboMaker::Model::Tool::WithName ( const Aws::String value)
inline

The name of the tool.

Definition at line 103 of file Tool.h.

◆ WithName() [3/3]

Tool& Aws::RoboMaker::Model::Tool::WithName ( const char *  value)
inline

The name of the tool.

Definition at line 113 of file Tool.h.

◆ WithStreamOutputToCloudWatch()

Tool& Aws::RoboMaker::Model::Tool::WithStreamOutputToCloudWatch ( bool  value)
inline

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

Definition at line 187 of file Tool.h.

◆ WithStreamUI()

Tool& Aws::RoboMaker::Model::Tool::WithStreamUI ( bool  value)
inline

Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

Definition at line 72 of file Tool.h.


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