Interface Action.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Action.Builder,
,Action> SdkBuilder<Action.Builder,
,Action> SdkPojo
- Enclosing class:
Action
-
Method Summary
Modifier and TypeMethodDescriptionThe job arguments used when this trigger fires.crawlerName
(String crawlerName) The name of the crawler to be used with this action.The name of a job to be run.default Action.Builder
notificationProperty
(Consumer<NotificationProperty.Builder> notificationProperty) Specifies configuration properties of a job run notification.notificationProperty
(NotificationProperty notificationProperty) Specifies configuration properties of a job run notification.securityConfiguration
(String securityConfiguration) The name of theSecurityConfiguration
structure to be used with this action.TheJobRun
timeout in minutes.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
jobName
The name of a job to be run.
- Parameters:
jobName
- The name of a job to be run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timeout
The
JobRun
timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and entersTIMEOUT
status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.- Parameters:
timeout
- TheJobRun
timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and entersTIMEOUT
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.
-
securityConfiguration
The name of the
SecurityConfiguration
structure to be used with this action.- Parameters:
securityConfiguration
- The name of theSecurityConfiguration
structure to be used with this action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 method that creates an instance of theNotificationProperty.Builder
avoiding the need to create one manually viaNotificationProperty.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonotificationProperty(NotificationProperty)
.- Parameters:
notificationProperty
- a consumer that will call methods onNotificationProperty.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
crawlerName
The name of the crawler to be used with this action.
- Parameters:
crawlerName
- The name of the crawler to be used with this action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-