@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Action extends Object implements Serializable, Cloneable, StructuredPojo
Defines an action to be initiated by a trigger.
Constructor and Description |
---|
Action() |
Modifier and Type | Method and Description |
---|---|
Action |
addArgumentsEntry(String key,
String value)
Add a single Arguments entry
|
Action |
clearArgumentsEntries()
Removes all the entries added into Arguments.
|
Action |
clone() |
boolean |
equals(Object obj) |
Map<String,String> |
getArguments()
The job arguments used when this trigger fires.
|
String |
getCrawlerName()
The name of the crawler to be used with this action.
|
String |
getJobName()
The name of a job to be run.
|
NotificationProperty |
getNotificationProperty()
Specifies configuration properties of a job run notification.
|
String |
getSecurityConfiguration()
The name of the
SecurityConfiguration structure to be used with this action. |
Integer |
getTimeout()
The
JobRun timeout in minutes. |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArguments(Map<String,String> arguments)
The job arguments used when this trigger fires.
|
void |
setCrawlerName(String crawlerName)
The name of the crawler to be used with this action.
|
void |
setJobName(String jobName)
The name of a job to be run.
|
void |
setNotificationProperty(NotificationProperty notificationProperty)
Specifies configuration properties of a job run notification.
|
void |
setSecurityConfiguration(String securityConfiguration)
The name of the
SecurityConfiguration structure to be used with this action. |
void |
setTimeout(Integer timeout)
The
JobRun timeout in minutes. |
String |
toString()
Returns a string representation of this object.
|
Action |
withArguments(Map<String,String> arguments)
The job arguments used when this trigger fires.
|
Action |
withCrawlerName(String crawlerName)
The name of the crawler to be used with this action.
|
Action |
withJobName(String jobName)
The name of a job to be run.
|
Action |
withNotificationProperty(NotificationProperty notificationProperty)
Specifies configuration properties of a job run notification.
|
Action |
withSecurityConfiguration(String securityConfiguration)
The name of the
SecurityConfiguration structure to be used with this action. |
Action |
withTimeout(Integer timeout)
The
JobRun timeout in minutes. |
public void setJobName(String jobName)
The name of a job to be run.
jobName
- The name of a job to be run.public String getJobName()
The name of a job to be run.
public Action withJobName(String jobName)
The name of a job to be run.
jobName
- The name of a job to be run.public Map<String,String> getArguments()
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
public void setArguments(Map<String,String> arguments)
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
arguments
- 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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
public Action withArguments(Map<String,String> arguments)
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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
arguments
- 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 Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
public Action addArgumentsEntry(String key, String value)
public Action clearArgumentsEntries()
public void setTimeout(Integer timeout)
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.
timeout
- 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.public Integer getTimeout()
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.
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.public Action withTimeout(Integer timeout)
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.
timeout
- 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.public void setSecurityConfiguration(String securityConfiguration)
The name of the SecurityConfiguration
structure to be used with this action.
securityConfiguration
- The name of the SecurityConfiguration
structure to be used with this action.public String getSecurityConfiguration()
The name of the SecurityConfiguration
structure to be used with this action.
SecurityConfiguration
structure to be used with this action.public Action withSecurityConfiguration(String securityConfiguration)
The name of the SecurityConfiguration
structure to be used with this action.
securityConfiguration
- The name of the SecurityConfiguration
structure to be used with this action.public void setNotificationProperty(NotificationProperty notificationProperty)
Specifies configuration properties of a job run notification.
notificationProperty
- Specifies configuration properties of a job run notification.public NotificationProperty getNotificationProperty()
Specifies configuration properties of a job run notification.
public Action withNotificationProperty(NotificationProperty notificationProperty)
Specifies configuration properties of a job run notification.
notificationProperty
- Specifies configuration properties of a job run notification.public void setCrawlerName(String crawlerName)
The name of the crawler to be used with this action.
crawlerName
- The name of the crawler to be used with this action.public String getCrawlerName()
The name of the crawler to be used with this action.
public Action withCrawlerName(String crawlerName)
The name of the crawler to be used with this action.
crawlerName
- The name of the crawler to be used with this action.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.