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

Property Summary

Type	Property and Description
NotificationProperty	notification Specifies configuration properties of a job run notification.

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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasArguments() For responses, this returns true if the service returned a value for the Arguments property.
int	hashCode()
String	jobName() The name of a job to be run.
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()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Property Detail

notification

public final NotificationProperty notificationProperty

Specifies configuration properties of a job run notification.

Method Detail

jobName

public final String jobName()

The name of a job to be run.

Returns:

The name of a job to be run.

hasArguments

public final boolean hasArguments()

For responses, this returns true if the service returned a value for the Arguments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasArguments() method.

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

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.

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()

Specified by:

toBuilder in interface ToCopyableBuilder<Action.Builder,Action>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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