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

#include <Workflow.h>

Public Member Functions

 Workflow ()
 
 Workflow (Aws::Utils::Json::JsonView jsonValue)
 
Workflowoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
WorkflowWithName (const Aws::String &value)
 
WorkflowWithName (Aws::String &&value)
 
WorkflowWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
WorkflowWithDescription (const Aws::String &value)
 
WorkflowWithDescription (Aws::String &&value)
 
WorkflowWithDescription (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetDefaultRunProperties () const
 
bool DefaultRunPropertiesHasBeenSet () const
 
void SetDefaultRunProperties (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetDefaultRunProperties (Aws::Map< Aws::String, Aws::String > &&value)
 
WorkflowWithDefaultRunProperties (const Aws::Map< Aws::String, Aws::String > &value)
 
WorkflowWithDefaultRunProperties (Aws::Map< Aws::String, Aws::String > &&value)
 
WorkflowAddDefaultRunProperties (const Aws::String &key, const Aws::String &value)
 
WorkflowAddDefaultRunProperties (Aws::String &&key, const Aws::String &value)
 
WorkflowAddDefaultRunProperties (const Aws::String &key, Aws::String &&value)
 
WorkflowAddDefaultRunProperties (Aws::String &&key, Aws::String &&value)
 
WorkflowAddDefaultRunProperties (const char *key, Aws::String &&value)
 
WorkflowAddDefaultRunProperties (Aws::String &&key, const char *value)
 
WorkflowAddDefaultRunProperties (const char *key, const char *value)
 
const Aws::Utils::DateTimeGetCreatedOn () const
 
bool CreatedOnHasBeenSet () const
 
void SetCreatedOn (const Aws::Utils::DateTime &value)
 
void SetCreatedOn (Aws::Utils::DateTime &&value)
 
WorkflowWithCreatedOn (const Aws::Utils::DateTime &value)
 
WorkflowWithCreatedOn (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastModifiedOn () const
 
bool LastModifiedOnHasBeenSet () const
 
void SetLastModifiedOn (const Aws::Utils::DateTime &value)
 
void SetLastModifiedOn (Aws::Utils::DateTime &&value)
 
WorkflowWithLastModifiedOn (const Aws::Utils::DateTime &value)
 
WorkflowWithLastModifiedOn (Aws::Utils::DateTime &&value)
 
const WorkflowRunGetLastRun () const
 
bool LastRunHasBeenSet () const
 
void SetLastRun (const WorkflowRun &value)
 
void SetLastRun (WorkflowRun &&value)
 
WorkflowWithLastRun (const WorkflowRun &value)
 
WorkflowWithLastRun (WorkflowRun &&value)
 
const WorkflowGraphGetGraph () const
 
bool GraphHasBeenSet () const
 
void SetGraph (const WorkflowGraph &value)
 
void SetGraph (WorkflowGraph &&value)
 
WorkflowWithGraph (const WorkflowGraph &value)
 
WorkflowWithGraph (WorkflowGraph &&value)
 
int GetMaxConcurrentRuns () const
 
bool MaxConcurrentRunsHasBeenSet () const
 
void SetMaxConcurrentRuns (int value)
 
WorkflowWithMaxConcurrentRuns (int value)
 

Detailed Description

A workflow represents a flow in which AWS Glue components should be executed to complete a logical task.

See Also:

AWS API Reference

Definition at line 36 of file Workflow.h.

Constructor & Destructor Documentation

◆ Workflow() [1/2]

Aws::Glue::Model::Workflow::Workflow ( )

◆ Workflow() [2/2]

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

Member Function Documentation

◆ AddDefaultRunProperties() [1/7]

Workflow& Aws::Glue::Model::Workflow::AddDefaultRunProperties ( const Aws::String key,
const Aws::String value 
)
inline

A collection of properties to be used as part of each execution of the workflow.

Definition at line 167 of file Workflow.h.

◆ AddDefaultRunProperties() [2/7]

Workflow& Aws::Glue::Model::Workflow::AddDefaultRunProperties ( Aws::String &&  key,
const Aws::String value 
)
inline

A collection of properties to be used as part of each execution of the workflow.

Definition at line 173 of file Workflow.h.

◆ AddDefaultRunProperties() [3/7]

Workflow& Aws::Glue::Model::Workflow::AddDefaultRunProperties ( const Aws::String key,
Aws::String &&  value 
)
inline

A collection of properties to be used as part of each execution of the workflow.

Definition at line 179 of file Workflow.h.

◆ AddDefaultRunProperties() [4/7]

Workflow& Aws::Glue::Model::Workflow::AddDefaultRunProperties ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A collection of properties to be used as part of each execution of the workflow.

Definition at line 185 of file Workflow.h.

◆ AddDefaultRunProperties() [5/7]

Workflow& Aws::Glue::Model::Workflow::AddDefaultRunProperties ( const char *  key,
Aws::String &&  value 
)
inline

A collection of properties to be used as part of each execution of the workflow.

Definition at line 191 of file Workflow.h.

◆ AddDefaultRunProperties() [6/7]

Workflow& Aws::Glue::Model::Workflow::AddDefaultRunProperties ( Aws::String &&  key,
const char *  value 
)
inline

A collection of properties to be used as part of each execution of the workflow.

Definition at line 197 of file Workflow.h.

◆ AddDefaultRunProperties() [7/7]

Workflow& Aws::Glue::Model::Workflow::AddDefaultRunProperties ( const char *  key,
const char *  value 
)
inline

A collection of properties to be used as part of each execution of the workflow.

Definition at line 203 of file Workflow.h.

◆ CreatedOnHasBeenSet()

bool Aws::Glue::Model::Workflow::CreatedOnHasBeenSet ( ) const
inline

The date and time when the workflow was created.

Definition at line 214 of file Workflow.h.

◆ DefaultRunPropertiesHasBeenSet()

bool Aws::Glue::Model::Workflow::DefaultRunPropertiesHasBeenSet ( ) const
inline

A collection of properties to be used as part of each execution of the workflow.

Definition at line 137 of file Workflow.h.

◆ DescriptionHasBeenSet()

bool Aws::Glue::Model::Workflow::DescriptionHasBeenSet ( ) const
inline

A description of the workflow.

Definition at line 94 of file Workflow.h.

◆ GetCreatedOn()

const Aws::Utils::DateTime& Aws::Glue::Model::Workflow::GetCreatedOn ( ) const
inline

The date and time when the workflow was created.

Definition at line 209 of file Workflow.h.

◆ GetDefaultRunProperties()

const Aws::Map<Aws::String, Aws::String>& Aws::Glue::Model::Workflow::GetDefaultRunProperties ( ) const
inline

A collection of properties to be used as part of each execution of the workflow.

Definition at line 131 of file Workflow.h.

◆ GetDescription()

const Aws::String& Aws::Glue::Model::Workflow::GetDescription ( ) const
inline

A description of the workflow.

Definition at line 89 of file Workflow.h.

◆ GetGraph()

const WorkflowGraph& Aws::Glue::Model::Workflow::GetGraph ( ) const
inline

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

Definition at line 303 of file Workflow.h.

◆ GetLastModifiedOn()

const Aws::Utils::DateTime& Aws::Glue::Model::Workflow::GetLastModifiedOn ( ) const
inline

The date and time when the workflow was last modified.

Definition at line 240 of file Workflow.h.

◆ GetLastRun()

const WorkflowRun& Aws::Glue::Model::Workflow::GetLastRun ( ) const
inline

The information about the last execution of the workflow.

Definition at line 271 of file Workflow.h.

◆ GetMaxConcurrentRuns()

int Aws::Glue::Model::Workflow::GetMaxConcurrentRuns ( ) const
inline

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

Definition at line 342 of file Workflow.h.

◆ GetName()

const Aws::String& Aws::Glue::Model::Workflow::GetName ( ) const
inline

The name of the workflow representing the flow.

Definition at line 48 of file Workflow.h.

◆ GraphHasBeenSet()

bool Aws::Glue::Model::Workflow::GraphHasBeenSet ( ) const
inline

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

Definition at line 309 of file Workflow.h.

◆ Jsonize()

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

◆ LastModifiedOnHasBeenSet()

bool Aws::Glue::Model::Workflow::LastModifiedOnHasBeenSet ( ) const
inline

The date and time when the workflow was last modified.

Definition at line 245 of file Workflow.h.

◆ LastRunHasBeenSet()

bool Aws::Glue::Model::Workflow::LastRunHasBeenSet ( ) const
inline

The information about the last execution of the workflow.

Definition at line 276 of file Workflow.h.

◆ MaxConcurrentRunsHasBeenSet()

bool Aws::Glue::Model::Workflow::MaxConcurrentRunsHasBeenSet ( ) const
inline

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

Definition at line 350 of file Workflow.h.

◆ NameHasBeenSet()

bool Aws::Glue::Model::Workflow::NameHasBeenSet ( ) const
inline

The name of the workflow representing the flow.

Definition at line 53 of file Workflow.h.

◆ operator=()

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

◆ SetCreatedOn() [1/2]

void Aws::Glue::Model::Workflow::SetCreatedOn ( const Aws::Utils::DateTime value)
inline

The date and time when the workflow was created.

Definition at line 219 of file Workflow.h.

◆ SetCreatedOn() [2/2]

void Aws::Glue::Model::Workflow::SetCreatedOn ( Aws::Utils::DateTime &&  value)
inline

The date and time when the workflow was created.

Definition at line 224 of file Workflow.h.

◆ SetDefaultRunProperties() [1/2]

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

A collection of properties to be used as part of each execution of the workflow.

Definition at line 143 of file Workflow.h.

◆ SetDefaultRunProperties() [2/2]

void Aws::Glue::Model::Workflow::SetDefaultRunProperties ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A collection of properties to be used as part of each execution of the workflow.

Definition at line 149 of file Workflow.h.

◆ SetDescription() [1/3]

void Aws::Glue::Model::Workflow::SetDescription ( const Aws::String value)
inline

A description of the workflow.

Definition at line 99 of file Workflow.h.

◆ SetDescription() [2/3]

void Aws::Glue::Model::Workflow::SetDescription ( Aws::String &&  value)
inline

A description of the workflow.

Definition at line 104 of file Workflow.h.

◆ SetDescription() [3/3]

void Aws::Glue::Model::Workflow::SetDescription ( const char *  value)
inline

A description of the workflow.

Definition at line 109 of file Workflow.h.

◆ SetGraph() [1/2]

void Aws::Glue::Model::Workflow::SetGraph ( const WorkflowGraph value)
inline

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

Definition at line 315 of file Workflow.h.

◆ SetGraph() [2/2]

void Aws::Glue::Model::Workflow::SetGraph ( WorkflowGraph &&  value)
inline

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

Definition at line 321 of file Workflow.h.

◆ SetLastModifiedOn() [1/2]

void Aws::Glue::Model::Workflow::SetLastModifiedOn ( const Aws::Utils::DateTime value)
inline

The date and time when the workflow was last modified.

Definition at line 250 of file Workflow.h.

◆ SetLastModifiedOn() [2/2]

void Aws::Glue::Model::Workflow::SetLastModifiedOn ( Aws::Utils::DateTime &&  value)
inline

The date and time when the workflow was last modified.

Definition at line 255 of file Workflow.h.

◆ SetLastRun() [1/2]

void Aws::Glue::Model::Workflow::SetLastRun ( const WorkflowRun value)
inline

The information about the last execution of the workflow.

Definition at line 281 of file Workflow.h.

◆ SetLastRun() [2/2]

void Aws::Glue::Model::Workflow::SetLastRun ( WorkflowRun &&  value)
inline

The information about the last execution of the workflow.

Definition at line 286 of file Workflow.h.

◆ SetMaxConcurrentRuns()

void Aws::Glue::Model::Workflow::SetMaxConcurrentRuns ( int  value)
inline

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

Definition at line 358 of file Workflow.h.

◆ SetName() [1/3]

void Aws::Glue::Model::Workflow::SetName ( const Aws::String value)
inline

The name of the workflow representing the flow.

Definition at line 58 of file Workflow.h.

◆ SetName() [2/3]

void Aws::Glue::Model::Workflow::SetName ( Aws::String &&  value)
inline

The name of the workflow representing the flow.

Definition at line 63 of file Workflow.h.

◆ SetName() [3/3]

void Aws::Glue::Model::Workflow::SetName ( const char *  value)
inline

The name of the workflow representing the flow.

Definition at line 68 of file Workflow.h.

◆ WithCreatedOn() [1/2]

Workflow& Aws::Glue::Model::Workflow::WithCreatedOn ( const Aws::Utils::DateTime value)
inline

The date and time when the workflow was created.

Definition at line 229 of file Workflow.h.

◆ WithCreatedOn() [2/2]

Workflow& Aws::Glue::Model::Workflow::WithCreatedOn ( Aws::Utils::DateTime &&  value)
inline

The date and time when the workflow was created.

Definition at line 234 of file Workflow.h.

◆ WithDefaultRunProperties() [1/2]

Workflow& Aws::Glue::Model::Workflow::WithDefaultRunProperties ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A collection of properties to be used as part of each execution of the workflow.

Definition at line 155 of file Workflow.h.

◆ WithDefaultRunProperties() [2/2]

Workflow& Aws::Glue::Model::Workflow::WithDefaultRunProperties ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A collection of properties to be used as part of each execution of the workflow.

Definition at line 161 of file Workflow.h.

◆ WithDescription() [1/3]

Workflow& Aws::Glue::Model::Workflow::WithDescription ( const Aws::String value)
inline

A description of the workflow.

Definition at line 114 of file Workflow.h.

◆ WithDescription() [2/3]

Workflow& Aws::Glue::Model::Workflow::WithDescription ( Aws::String &&  value)
inline

A description of the workflow.

Definition at line 119 of file Workflow.h.

◆ WithDescription() [3/3]

Workflow& Aws::Glue::Model::Workflow::WithDescription ( const char *  value)
inline

A description of the workflow.

Definition at line 124 of file Workflow.h.

◆ WithGraph() [1/2]

Workflow& Aws::Glue::Model::Workflow::WithGraph ( const WorkflowGraph value)
inline

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

Definition at line 327 of file Workflow.h.

◆ WithGraph() [2/2]

Workflow& Aws::Glue::Model::Workflow::WithGraph ( WorkflowGraph &&  value)
inline

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

Definition at line 333 of file Workflow.h.

◆ WithLastModifiedOn() [1/2]

Workflow& Aws::Glue::Model::Workflow::WithLastModifiedOn ( const Aws::Utils::DateTime value)
inline

The date and time when the workflow was last modified.

Definition at line 260 of file Workflow.h.

◆ WithLastModifiedOn() [2/2]

Workflow& Aws::Glue::Model::Workflow::WithLastModifiedOn ( Aws::Utils::DateTime &&  value)
inline

The date and time when the workflow was last modified.

Definition at line 265 of file Workflow.h.

◆ WithLastRun() [1/2]

Workflow& Aws::Glue::Model::Workflow::WithLastRun ( const WorkflowRun value)
inline

The information about the last execution of the workflow.

Definition at line 291 of file Workflow.h.

◆ WithLastRun() [2/2]

Workflow& Aws::Glue::Model::Workflow::WithLastRun ( WorkflowRun &&  value)
inline

The information about the last execution of the workflow.

Definition at line 296 of file Workflow.h.

◆ WithMaxConcurrentRuns()

Workflow& Aws::Glue::Model::Workflow::WithMaxConcurrentRuns ( int  value)
inline

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

Definition at line 366 of file Workflow.h.

◆ WithName() [1/3]

Workflow& Aws::Glue::Model::Workflow::WithName ( const Aws::String value)
inline

The name of the workflow representing the flow.

Definition at line 73 of file Workflow.h.

◆ WithName() [2/3]

Workflow& Aws::Glue::Model::Workflow::WithName ( Aws::String &&  value)
inline

The name of the workflow representing the flow.

Definition at line 78 of file Workflow.h.

◆ WithName() [3/3]

Workflow& Aws::Glue::Model::Workflow::WithName ( const char *  value)
inline

The name of the workflow representing the flow.

Definition at line 83 of file Workflow.h.


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