software.amazon.awssdk.services.glue.model

Interface Action.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Action.Builder,Action>, SdkBuilder<Action.Builder,Action>, SdkPojo

Enclosing class:

Action

public static interface Action.Builder
extends SdkPojo, CopyableBuilder<Action.Builder,Action>

Method Summary

Modifier and Type	Method and Description
Action.Builder	arguments(Map<String,String> arguments) Arguments to be passed to the job run.
Action.Builder	jobName(String jobName) The name of a job to be executed.
default Action.Builder	notificationProperty(Consumer<NotificationProperty.Builder> notificationProperty) Specifies configuration properties of a job run notification.
Action.Builder	notificationProperty(NotificationProperty notificationProperty) Specifies configuration properties of a job run notification.
Action.Builder	securityConfiguration(String securityConfiguration) The name of the SecurityConfiguration structure to be used with this action.
Action.Builder	timeout(Integer timeout) The JobRun timeout in minutes.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

jobName

Action.Builder jobName(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.

arguments

Action.Builder arguments(Map<String,String> arguments)

Arguments to be passed to the job run.

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 - Arguments to be passed to the job run.

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.

timeout

Action.Builder timeout(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.

notificationProperty

Action.Builder notificationProperty(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.

notificationProperty

default Action.Builder notificationProperty(Consumer<NotificationProperty.Builder> notificationProperty)

Specifies configuration properties of a job run notification.

This is a convenience that creates an instance of the NotificationProperty.Builder avoiding the need to create one manually via NotificationProperty.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notificationProperty(NotificationProperty).

Parameters:

notificationProperty - a consumer that will call methods on NotificationProperty.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

notificationProperty(NotificationProperty)

securityConfiguration

Action.Builder securityConfiguration(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.