Action (AWS Java SDK for AWS Glue 1.11.527 API)

java.lang.Object
- com.amazonaws.services.glue.model.Action

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Action()

Constructors
Constructor and Description
`Action()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Action`	`addArgumentsEntry(String key, String value)`
`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`	`getJobName()` The name of a job to be executed.
`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)`
`void`	`setArguments(Map<String,String> arguments)` The job arguments used when this trigger fires.
`void`	`setJobName(String jobName)` The name of a job to be executed.
`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`	`withJobName(String jobName)` The name of a job to be executed.
`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.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Action
```
public Action()
```
- Method Detail
  - setJobName
```
public void setJobName(String jobName)
```
    The name of a job to be executed.
    
    Parameters:
    
    jobName - The name of a job to be executed.
  - getJobName
```
public String getJobName()
```
    The name of a job to be executed.
    
    Returns:
    
    The name of a job to be executed.
  - withJobName
```
public Action withJobName(String jobName)
```
    The name of a job to be executed.
    
    Parameters:
    
    jobName - The name of a job to be executed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getArguments
```
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 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.
    
    Returns:
    
    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.
  - setArguments
```
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 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.
    
    Parameters:
    
    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 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.
  - withArguments
```
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 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.
    
    Parameters:
    
    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 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addArgumentsEntry
```
public Action addArgumentsEntry(String key,
                                String value)
```
  - clearArgumentsEntries
```
public Action clearArgumentsEntries()
```
    Removes all the entries added into Arguments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeout
```
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.
    
    Parameters:
    
    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.
  - getTimeout
```
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.
    
    Returns:
    
    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.
  - withTimeout
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotificationProperty
```
public void setNotificationProperty(NotificationProperty notificationProperty)
```
    Specifies configuration properties of a job run notification.
    
    Parameters:
    
    notificationProperty - Specifies configuration properties of a job run notification.
  - getNotificationProperty
```
public NotificationProperty getNotificationProperty()
```
    Specifies configuration properties of a job run notification.
    
    Returns:
    
    Specifies configuration properties of a job run notification.
  - withNotificationProperty
```
public Action withNotificationProperty(NotificationProperty notificationProperty)
```
    Specifies configuration properties of a job run notification.
    
    Parameters:
    
    notificationProperty - Specifies configuration properties of a job run notification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecurityConfiguration
```
public void setSecurityConfiguration(String securityConfiguration)
```
    The name of the SecurityConfiguration structure to be used with this action.
    
    Parameters:
    
    securityConfiguration - The name of the SecurityConfiguration structure to be used with this action.
  - getSecurityConfiguration
```
public String getSecurityConfiguration()
```
    The name of the SecurityConfiguration structure to be used with this action.
    
    Returns:
    
    The name of the SecurityConfiguration structure to be used with this action.
  - withSecurityConfiguration
```
public Action withSecurityConfiguration(String securityConfiguration)
```
    The name of the SecurityConfiguration structure to be used with this action.
    
    Parameters:
    
    securityConfiguration - The name of the SecurityConfiguration structure to be used with this action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Action clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Action

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Action

Method Detail

setJobName

getJobName

withJobName

getArguments

setArguments

withArguments

addArgumentsEntry

clearArgumentsEntries

setTimeout

getTimeout

withTimeout

setNotificationProperty

getNotificationProperty

withNotificationProperty

setSecurityConfiguration

getSecurityConfiguration

withSecurityConfiguration

toString

equals

hashCode

clone

marshall