This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-glue/include/aws/glue/model/Action.h

443 lines
22 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/glue/Glue_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSMap.h>
#include <aws/glue/model/NotificationProperty.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace Glue
{
namespace Model
{
/**
* <p>Defines an action to be initiated by a trigger.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/Action">AWS API
* Reference</a></p>
*/
class AWS_GLUE_API Action
{
public:
Action();
Action(Aws::Utils::Json::JsonView jsonValue);
Action& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The name of a job to be executed.</p>
*/
inline const Aws::String& GetJobName() const{ return m_jobName; }
/**
* <p>The name of a job to be executed.</p>
*/
inline bool JobNameHasBeenSet() const { return m_jobNameHasBeenSet; }
/**
* <p>The name of a job to be executed.</p>
*/
inline void SetJobName(const Aws::String& value) { m_jobNameHasBeenSet = true; m_jobName = value; }
/**
* <p>The name of a job to be executed.</p>
*/
inline void SetJobName(Aws::String&& value) { m_jobNameHasBeenSet = true; m_jobName = std::move(value); }
/**
* <p>The name of a job to be executed.</p>
*/
inline void SetJobName(const char* value) { m_jobNameHasBeenSet = true; m_jobName.assign(value); }
/**
* <p>The name of a job to be executed.</p>
*/
inline Action& WithJobName(const Aws::String& value) { SetJobName(value); return *this;}
/**
* <p>The name of a job to be executed.</p>
*/
inline Action& WithJobName(Aws::String&& value) { SetJobName(std::move(value)); return *this;}
/**
* <p>The name of a job to be executed.</p>
*/
inline Action& WithJobName(const char* value) { SetJobName(value); return *this;}
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline const Aws::Map<Aws::String, Aws::String>& GetArguments() const{ return m_arguments; }
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline bool ArgumentsHasBeenSet() const { return m_argumentsHasBeenSet; }
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline void SetArguments(const Aws::Map<Aws::String, Aws::String>& value) { m_argumentsHasBeenSet = true; m_arguments = value; }
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline void SetArguments(Aws::Map<Aws::String, Aws::String>&& value) { m_argumentsHasBeenSet = true; m_arguments = std::move(value); }
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline Action& WithArguments(const Aws::Map<Aws::String, Aws::String>& value) { SetArguments(value); return *this;}
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline Action& WithArguments(Aws::Map<Aws::String, Aws::String>&& value) { SetArguments(std::move(value)); return *this;}
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline Action& AddArguments(const Aws::String& key, const Aws::String& value) { m_argumentsHasBeenSet = true; m_arguments.emplace(key, value); return *this; }
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline Action& AddArguments(Aws::String&& key, const Aws::String& value) { m_argumentsHasBeenSet = true; m_arguments.emplace(std::move(key), value); return *this; }
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline Action& AddArguments(const Aws::String& key, Aws::String&& value) { m_argumentsHasBeenSet = true; m_arguments.emplace(key, std::move(value)); return *this; }
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline Action& AddArguments(Aws::String&& key, Aws::String&& value) { m_argumentsHasBeenSet = true; m_arguments.emplace(std::move(key), std::move(value)); return *this; }
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline Action& AddArguments(const char* key, Aws::String&& value) { m_argumentsHasBeenSet = true; m_arguments.emplace(key, std::move(value)); return *this; }
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline Action& AddArguments(Aws::String&& key, const char* value) { m_argumentsHasBeenSet = true; m_arguments.emplace(std::move(key), value); return *this; }
/**
* <p>The job arguments used when this trigger fires. For this job run, they
* replace the default arguments set in the job definition itself.</p> <p>You can
* specify arguments here that your own job-execution script consumes, as well as
* arguments that AWS Glue itself consumes.</p> <p>For information about how to
* specify and consume your own Job arguments, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling
* AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information
* about the key-value pairs that AWS Glue consumes to set up your job, see the <a
* href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special
* Parameters Used by AWS Glue</a> topic in the developer guide.</p>
*/
inline Action& AddArguments(const char* key, const char* value) { m_argumentsHasBeenSet = true; m_arguments.emplace(key, value); return *this; }
/**
* <p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a
* job run can consume resources before it is terminated and enters
* <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours). This
* overrides the timeout value set in the parent job.</p>
*/
inline int GetTimeout() const{ return m_timeout; }
/**
* <p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a
* job run can consume resources before it is terminated and enters
* <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours). This
* overrides the timeout value set in the parent job.</p>
*/
inline bool TimeoutHasBeenSet() const { return m_timeoutHasBeenSet; }
/**
* <p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a
* job run can consume resources before it is terminated and enters
* <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours). This
* overrides the timeout value set in the parent job.</p>
*/
inline void SetTimeout(int value) { m_timeoutHasBeenSet = true; m_timeout = value; }
/**
* <p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a
* job run can consume resources before it is terminated and enters
* <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours). This
* overrides the timeout value set in the parent job.</p>
*/
inline Action& WithTimeout(int value) { SetTimeout(value); return *this;}
/**
* <p>The name of the <code>SecurityConfiguration</code> structure to be used with
* this action.</p>
*/
inline const Aws::String& GetSecurityConfiguration() const{ return m_securityConfiguration; }
/**
* <p>The name of the <code>SecurityConfiguration</code> structure to be used with
* this action.</p>
*/
inline bool SecurityConfigurationHasBeenSet() const { return m_securityConfigurationHasBeenSet; }
/**
* <p>The name of the <code>SecurityConfiguration</code> structure to be used with
* this action.</p>
*/
inline void SetSecurityConfiguration(const Aws::String& value) { m_securityConfigurationHasBeenSet = true; m_securityConfiguration = value; }
/**
* <p>The name of the <code>SecurityConfiguration</code> structure to be used with
* this action.</p>
*/
inline void SetSecurityConfiguration(Aws::String&& value) { m_securityConfigurationHasBeenSet = true; m_securityConfiguration = std::move(value); }
/**
* <p>The name of the <code>SecurityConfiguration</code> structure to be used with
* this action.</p>
*/
inline void SetSecurityConfiguration(const char* value) { m_securityConfigurationHasBeenSet = true; m_securityConfiguration.assign(value); }
/**
* <p>The name of the <code>SecurityConfiguration</code> structure to be used with
* this action.</p>
*/
inline Action& WithSecurityConfiguration(const Aws::String& value) { SetSecurityConfiguration(value); return *this;}
/**
* <p>The name of the <code>SecurityConfiguration</code> structure to be used with
* this action.</p>
*/
inline Action& WithSecurityConfiguration(Aws::String&& value) { SetSecurityConfiguration(std::move(value)); return *this;}
/**
* <p>The name of the <code>SecurityConfiguration</code> structure to be used with
* this action.</p>
*/
inline Action& WithSecurityConfiguration(const char* value) { SetSecurityConfiguration(value); return *this;}
/**
* <p>Specifies configuration properties of a job run notification.</p>
*/
inline const NotificationProperty& GetNotificationProperty() const{ return m_notificationProperty; }
/**
* <p>Specifies configuration properties of a job run notification.</p>
*/
inline bool NotificationPropertyHasBeenSet() const { return m_notificationPropertyHasBeenSet; }
/**
* <p>Specifies configuration properties of a job run notification.</p>
*/
inline void SetNotificationProperty(const NotificationProperty& value) { m_notificationPropertyHasBeenSet = true; m_notificationProperty = value; }
/**
* <p>Specifies configuration properties of a job run notification.</p>
*/
inline void SetNotificationProperty(NotificationProperty&& value) { m_notificationPropertyHasBeenSet = true; m_notificationProperty = std::move(value); }
/**
* <p>Specifies configuration properties of a job run notification.</p>
*/
inline Action& WithNotificationProperty(const NotificationProperty& value) { SetNotificationProperty(value); return *this;}
/**
* <p>Specifies configuration properties of a job run notification.</p>
*/
inline Action& WithNotificationProperty(NotificationProperty&& value) { SetNotificationProperty(std::move(value)); return *this;}
/**
* <p>The name of the crawler to be used with this action.</p>
*/
inline const Aws::String& GetCrawlerName() const{ return m_crawlerName; }
/**
* <p>The name of the crawler to be used with this action.</p>
*/
inline bool CrawlerNameHasBeenSet() const { return m_crawlerNameHasBeenSet; }
/**
* <p>The name of the crawler to be used with this action.</p>
*/
inline void SetCrawlerName(const Aws::String& value) { m_crawlerNameHasBeenSet = true; m_crawlerName = value; }
/**
* <p>The name of the crawler to be used with this action.</p>
*/
inline void SetCrawlerName(Aws::String&& value) { m_crawlerNameHasBeenSet = true; m_crawlerName = std::move(value); }
/**
* <p>The name of the crawler to be used with this action.</p>
*/
inline void SetCrawlerName(const char* value) { m_crawlerNameHasBeenSet = true; m_crawlerName.assign(value); }
/**
* <p>The name of the crawler to be used with this action.</p>
*/
inline Action& WithCrawlerName(const Aws::String& value) { SetCrawlerName(value); return *this;}
/**
* <p>The name of the crawler to be used with this action.</p>
*/
inline Action& WithCrawlerName(Aws::String&& value) { SetCrawlerName(std::move(value)); return *this;}
/**
* <p>The name of the crawler to be used with this action.</p>
*/
inline Action& WithCrawlerName(const char* value) { SetCrawlerName(value); return *this;}
private:
Aws::String m_jobName;
bool m_jobNameHasBeenSet;
Aws::Map<Aws::String, Aws::String> m_arguments;
bool m_argumentsHasBeenSet;
int m_timeout;
bool m_timeoutHasBeenSet;
Aws::String m_securityConfiguration;
bool m_securityConfigurationHasBeenSet;
NotificationProperty m_notificationProperty;
bool m_notificationPropertyHasBeenSet;
Aws::String m_crawlerName;
bool m_crawlerNameHasBeenSet;
};
} // namespace Model
} // namespace Glue
} // namespace Aws