Interface Action.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Action.Builder,Action>, SdkBuilder<Action.Builder,Action>, SdkPojo
Enclosing class:
Action
@Mutable @NotThreadSafe public static interface Action.Builder extends SdkPojo, CopyableBuilder<Action.Builder,Action>

  • Method Details

    • jobName

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

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

      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

      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. This overrides the timeout value set in the parent job.

      Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.

      When the value is left blank, the timeout is defaulted to 2880 minutes.

      Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.

      For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.

      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. This overrides the timeout value set in the parent job.

      Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.

      When the value is left blank, the timeout is defaulted to 2880 minutes.

      Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.

      For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.

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

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

    • 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 method 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:

    • crawlerName

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