AWS SDK for C++  1.8.76
AWS SDK for C++
Public Member Functions | List of all members
Aws::Glue::Model::Action Class Reference

#include <Action.h>

Public Member Functions

 Action ()
 
 Action (Aws::Utils::Json::JsonView jsonValue)
 
Actionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetJobName () const
 
bool JobNameHasBeenSet () const
 
void SetJobName (const Aws::String &value)
 
void SetJobName (Aws::String &&value)
 
void SetJobName (const char *value)
 
ActionWithJobName (const Aws::String &value)
 
ActionWithJobName (Aws::String &&value)
 
ActionWithJobName (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetArguments () const
 
bool ArgumentsHasBeenSet () const
 
void SetArguments (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetArguments (Aws::Map< Aws::String, Aws::String > &&value)
 
ActionWithArguments (const Aws::Map< Aws::String, Aws::String > &value)
 
ActionWithArguments (Aws::Map< Aws::String, Aws::String > &&value)
 
ActionAddArguments (const Aws::String &key, const Aws::String &value)
 
ActionAddArguments (Aws::String &&key, const Aws::String &value)
 
ActionAddArguments (const Aws::String &key, Aws::String &&value)
 
ActionAddArguments (Aws::String &&key, Aws::String &&value)
 
ActionAddArguments (const char *key, Aws::String &&value)
 
ActionAddArguments (Aws::String &&key, const char *value)
 
ActionAddArguments (const char *key, const char *value)
 
int GetTimeout () const
 
bool TimeoutHasBeenSet () const
 
void SetTimeout (int value)
 
ActionWithTimeout (int value)
 
const Aws::StringGetSecurityConfiguration () const
 
bool SecurityConfigurationHasBeenSet () const
 
void SetSecurityConfiguration (const Aws::String &value)
 
void SetSecurityConfiguration (Aws::String &&value)
 
void SetSecurityConfiguration (const char *value)
 
ActionWithSecurityConfiguration (const Aws::String &value)
 
ActionWithSecurityConfiguration (Aws::String &&value)
 
ActionWithSecurityConfiguration (const char *value)
 
const NotificationPropertyGetNotificationProperty () const
 
bool NotificationPropertyHasBeenSet () const
 
void SetNotificationProperty (const NotificationProperty &value)
 
void SetNotificationProperty (NotificationProperty &&value)
 
ActionWithNotificationProperty (const NotificationProperty &value)
 
ActionWithNotificationProperty (NotificationProperty &&value)
 
const Aws::StringGetCrawlerName () const
 
bool CrawlerNameHasBeenSet () const
 
void SetCrawlerName (const Aws::String &value)
 
void SetCrawlerName (Aws::String &&value)
 
void SetCrawlerName (const char *value)
 
ActionWithCrawlerName (const Aws::String &value)
 
ActionWithCrawlerName (Aws::String &&value)
 
ActionWithCrawlerName (const char *value)
 

Detailed Description

Defines an action to be initiated by a trigger.

See Also:

AWS API Reference

Definition at line 33 of file Action.h.

Constructor & Destructor Documentation

◆ Action() [1/2]

Aws::Glue::Model::Action::Action ( )

◆ Action() [2/2]

Aws::Glue::Model::Action::Action ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddArguments() [1/7]

Action& Aws::Glue::Model::Action::AddArguments ( const Aws::String key,
const Aws::String value 
)
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 179 of file Action.h.

◆ AddArguments() [2/7]

Action& Aws::Glue::Model::Action::AddArguments ( Aws::String &&  key,
const Aws::String value 
)
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 193 of file Action.h.

◆ AddArguments() [3/7]

Action& Aws::Glue::Model::Action::AddArguments ( const Aws::String key,
Aws::String &&  value 
)
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 207 of file Action.h.

◆ AddArguments() [4/7]

Action& Aws::Glue::Model::Action::AddArguments ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 221 of file Action.h.

◆ AddArguments() [5/7]

Action& Aws::Glue::Model::Action::AddArguments ( const char *  key,
Aws::String &&  value 
)
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 235 of file Action.h.

◆ AddArguments() [6/7]

Action& Aws::Glue::Model::Action::AddArguments ( Aws::String &&  key,
const char *  value 
)
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 249 of file Action.h.

◆ AddArguments() [7/7]

Action& Aws::Glue::Model::Action::AddArguments ( const char *  key,
const char *  value 
)
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 263 of file Action.h.

◆ ArgumentsHasBeenSet()

bool Aws::Glue::Model::Action::ArgumentsHasBeenSet ( ) const
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 109 of file Action.h.

◆ CrawlerNameHasBeenSet()

bool Aws::Glue::Model::Action::CrawlerNameHasBeenSet ( ) const
inline

The name of the crawler to be used with this action.

Definition at line 387 of file Action.h.

◆ GetArguments()

const Aws::Map<Aws::String, Aws::String>& Aws::Glue::Model::Action::GetArguments ( ) const
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 95 of file Action.h.

◆ GetCrawlerName()

const Aws::String& Aws::Glue::Model::Action::GetCrawlerName ( ) const
inline

The name of the crawler to be used with this action.

Definition at line 382 of file Action.h.

◆ GetJobName()

const Aws::String& Aws::Glue::Model::Action::GetJobName ( ) const
inline

The name of a job to be executed.

Definition at line 45 of file Action.h.

◆ GetNotificationProperty()

const NotificationProperty& Aws::Glue::Model::Action::GetNotificationProperty ( ) const
inline

Specifies configuration properties of a job run notification.

Definition at line 351 of file Action.h.

◆ GetSecurityConfiguration()

const Aws::String& Aws::Glue::Model::Action::GetSecurityConfiguration ( ) const
inline

The name of the SecurityConfiguration structure to be used with this action.

Definition at line 303 of file Action.h.

◆ GetTimeout()

int Aws::Glue::Model::Action::GetTimeout ( ) const
inline

The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

Definition at line 272 of file Action.h.

◆ JobNameHasBeenSet()

bool Aws::Glue::Model::Action::JobNameHasBeenSet ( ) const
inline

The name of a job to be executed.

Definition at line 50 of file Action.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Glue::Model::Action::Jsonize ( ) const

◆ NotificationPropertyHasBeenSet()

bool Aws::Glue::Model::Action::NotificationPropertyHasBeenSet ( ) const
inline

Specifies configuration properties of a job run notification.

Definition at line 356 of file Action.h.

◆ operator=()

Action& Aws::Glue::Model::Action::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SecurityConfigurationHasBeenSet()

bool Aws::Glue::Model::Action::SecurityConfigurationHasBeenSet ( ) const
inline

The name of the SecurityConfiguration structure to be used with this action.

Definition at line 309 of file Action.h.

◆ SetArguments() [1/2]

void Aws::Glue::Model::Action::SetArguments ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 123 of file Action.h.

◆ SetArguments() [2/2]

void Aws::Glue::Model::Action::SetArguments ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 137 of file Action.h.

◆ SetCrawlerName() [1/3]

void Aws::Glue::Model::Action::SetCrawlerName ( const Aws::String value)
inline

The name of the crawler to be used with this action.

Definition at line 392 of file Action.h.

◆ SetCrawlerName() [2/3]

void Aws::Glue::Model::Action::SetCrawlerName ( Aws::String &&  value)
inline

The name of the crawler to be used with this action.

Definition at line 397 of file Action.h.

◆ SetCrawlerName() [3/3]

void Aws::Glue::Model::Action::SetCrawlerName ( const char *  value)
inline

The name of the crawler to be used with this action.

Definition at line 402 of file Action.h.

◆ SetJobName() [1/3]

void Aws::Glue::Model::Action::SetJobName ( const Aws::String value)
inline

The name of a job to be executed.

Definition at line 55 of file Action.h.

◆ SetJobName() [2/3]

void Aws::Glue::Model::Action::SetJobName ( Aws::String &&  value)
inline

The name of a job to be executed.

Definition at line 60 of file Action.h.

◆ SetJobName() [3/3]

void Aws::Glue::Model::Action::SetJobName ( const char *  value)
inline

The name of a job to be executed.

Definition at line 65 of file Action.h.

◆ SetNotificationProperty() [1/2]

void Aws::Glue::Model::Action::SetNotificationProperty ( const NotificationProperty value)
inline

Specifies configuration properties of a job run notification.

Definition at line 361 of file Action.h.

◆ SetNotificationProperty() [2/2]

void Aws::Glue::Model::Action::SetNotificationProperty ( NotificationProperty &&  value)
inline

Specifies configuration properties of a job run notification.

Definition at line 366 of file Action.h.

◆ SetSecurityConfiguration() [1/3]

void Aws::Glue::Model::Action::SetSecurityConfiguration ( const Aws::String value)
inline

The name of the SecurityConfiguration structure to be used with this action.

Definition at line 315 of file Action.h.

◆ SetSecurityConfiguration() [2/3]

void Aws::Glue::Model::Action::SetSecurityConfiguration ( Aws::String &&  value)
inline

The name of the SecurityConfiguration structure to be used with this action.

Definition at line 321 of file Action.h.

◆ SetSecurityConfiguration() [3/3]

void Aws::Glue::Model::Action::SetSecurityConfiguration ( const char *  value)
inline

The name of the SecurityConfiguration structure to be used with this action.

Definition at line 327 of file Action.h.

◆ SetTimeout()

void Aws::Glue::Model::Action::SetTimeout ( int  value)
inline

The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

Definition at line 288 of file Action.h.

◆ TimeoutHasBeenSet()

bool Aws::Glue::Model::Action::TimeoutHasBeenSet ( ) const
inline

The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

Definition at line 280 of file Action.h.

◆ WithArguments() [1/2]

Action& Aws::Glue::Model::Action::WithArguments ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 151 of file Action.h.

◆ WithArguments() [2/2]

Action& Aws::Glue::Model::Action::WithArguments ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Definition at line 165 of file Action.h.

◆ WithCrawlerName() [1/3]

Action& Aws::Glue::Model::Action::WithCrawlerName ( const Aws::String value)
inline

The name of the crawler to be used with this action.

Definition at line 407 of file Action.h.

◆ WithCrawlerName() [2/3]

Action& Aws::Glue::Model::Action::WithCrawlerName ( Aws::String &&  value)
inline

The name of the crawler to be used with this action.

Definition at line 412 of file Action.h.

◆ WithCrawlerName() [3/3]

Action& Aws::Glue::Model::Action::WithCrawlerName ( const char *  value)
inline

The name of the crawler to be used with this action.

Definition at line 417 of file Action.h.

◆ WithJobName() [1/3]

Action& Aws::Glue::Model::Action::WithJobName ( const Aws::String value)
inline

The name of a job to be executed.

Definition at line 70 of file Action.h.

◆ WithJobName() [2/3]

Action& Aws::Glue::Model::Action::WithJobName ( Aws::String &&  value)
inline

The name of a job to be executed.

Definition at line 75 of file Action.h.

◆ WithJobName() [3/3]

Action& Aws::Glue::Model::Action::WithJobName ( const char *  value)
inline

The name of a job to be executed.

Definition at line 80 of file Action.h.

◆ WithNotificationProperty() [1/2]

Action& Aws::Glue::Model::Action::WithNotificationProperty ( const NotificationProperty value)
inline

Specifies configuration properties of a job run notification.

Definition at line 371 of file Action.h.

◆ WithNotificationProperty() [2/2]

Action& Aws::Glue::Model::Action::WithNotificationProperty ( NotificationProperty &&  value)
inline

Specifies configuration properties of a job run notification.

Definition at line 376 of file Action.h.

◆ WithSecurityConfiguration() [1/3]

Action& Aws::Glue::Model::Action::WithSecurityConfiguration ( const Aws::String value)
inline

The name of the SecurityConfiguration structure to be used with this action.

Definition at line 333 of file Action.h.

◆ WithSecurityConfiguration() [2/3]

Action& Aws::Glue::Model::Action::WithSecurityConfiguration ( Aws::String &&  value)
inline

The name of the SecurityConfiguration structure to be used with this action.

Definition at line 339 of file Action.h.

◆ WithSecurityConfiguration() [3/3]

Action& Aws::Glue::Model::Action::WithSecurityConfiguration ( const char *  value)
inline

The name of the SecurityConfiguration structure to be used with this action.

Definition at line 345 of file Action.h.

◆ WithTimeout()

Action& Aws::Glue::Model::Action::WithTimeout ( int  value)
inline

The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

Definition at line 296 of file Action.h.


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