software.amazon.awssdk.services.glue.model

Class Action

java.lang.Object

software.amazon.awssdk.services.glue.model.Action

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Action.Builder,Action>

@Generated(value="software.amazon.awssdk:codegen")
public final class Action
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Action.Builder,Action>

Defines an action to be initiated by a trigger.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Action.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,String>	arguments() The job arguments used when this trigger fires.
static Action.Builder	builder()
String	crawlerName() The name of the crawler to be used with this action.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasArguments() Returns true if the Arguments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	jobName() The name of a job to be executed.
NotificationProperty	notificationProperty() Specifies configuration properties of a job run notification.
List<SdkField<?>>	sdkFields()
String	securityConfiguration() The name of the SecurityConfiguration structure to be used with this action.
static Class<? extends Action.Builder>	serializableBuilderClass()
Integer	timeout() The JobRun timeout in minutes.
Action.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

jobName

public final String jobName()

The name of a job to be executed.

Returns:

The name of a job to be executed.

hasArguments

public final boolean hasArguments()

Returns true if the Arguments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

arguments

public final 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasArguments() to see if a value was sent in this field.

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.

timeout

public final 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.

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.

securityConfiguration

public final String securityConfiguration()

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.

notificationProperty

public final NotificationProperty notificationProperty()

Specifies configuration properties of a job run notification.

Returns:

Specifies configuration properties of a job run notification.

crawlerName

public final String crawlerName()

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

Returns:

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

toBuilder

public Action.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Action.Builder,Action>

Returns:

a builder for type T

builder

public static Action.Builder builder()

serializableBuilderClass

public static Class<? extends Action.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.