software.amazon.awssdk.services.glue.model

Interface Job.Builder

All Superinterfaces:

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

Enclosing class:

Job

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

Method Summary

Modifier and Type	Method and Description
Job.Builder	allocatedCapacity(Integer allocatedCapacity) The number of AWS Glue data processing units (DPUs) allocated to runs of this job.
default Job.Builder	command(Consumer<JobCommand.Builder> command) The JobCommand that executes this job.
Job.Builder	command(JobCommand command) The JobCommand that executes this job.
Job.Builder	connections(ConnectionsList connections) The connections used for this job.
default Job.Builder	connections(Consumer<ConnectionsList.Builder> connections) The connections used for this job.
Job.Builder	createdOn(Instant createdOn) The time and date that this job definition was created.
Job.Builder	defaultArguments(Map<String,String> defaultArguments) The default arguments for this job, specified as name-value pairs.
Job.Builder	description(String description) Description of the job being defined.
default Job.Builder	executionProperty(Consumer<ExecutionProperty.Builder> executionProperty) An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
Job.Builder	executionProperty(ExecutionProperty executionProperty) An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
Job.Builder	lastModifiedOn(Instant lastModifiedOn) The last point in time when this job definition was modified.
Job.Builder	logUri(String logUri) This field is reserved for future use.
Job.Builder	maxRetries(Integer maxRetries) The maximum number of times to retry this job after a JobRun fails.
Job.Builder	name(String name) The name you assign to this job definition.
default Job.Builder	notificationProperty(Consumer<NotificationProperty.Builder> notificationProperty) Specifies configuration properties of a job notification.
Job.Builder	notificationProperty(NotificationProperty notificationProperty) Specifies configuration properties of a job notification.
Job.Builder	role(String role) The name or ARN of the IAM role associated with this job.
Job.Builder	securityConfiguration(String securityConfiguration) The name of the SecurityConfiguration structure to be used with this job.
Job.Builder	timeout(Integer timeout) The job 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

name

Job.Builder name(String name)

The name you assign to this job definition.

Parameters:

name - The name you assign to this job definition.

Returns:

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

description

Job.Builder description(String description)

Description of the job being defined.

Parameters:

description - Description of the job being defined.

Returns:

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

logUri

Job.Builder logUri(String logUri)

This field is reserved for future use.

Parameters:

logUri - This field is reserved for future use.

Returns:

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

role

Job.Builder role(String role)

The name or ARN of the IAM role associated with this job.

Parameters:

role - The name or ARN of the IAM role associated with this job.

Returns:

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

createdOn

Job.Builder createdOn(Instant createdOn)

The time and date that this job definition was created.

Parameters:

createdOn - The time and date that this job definition was created.

Returns:

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

lastModifiedOn

Job.Builder lastModifiedOn(Instant lastModifiedOn)

The last point in time when this job definition was modified.

Parameters:

lastModifiedOn - The last point in time when this job definition was modified.

Returns:

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

executionProperty

Job.Builder executionProperty(ExecutionProperty executionProperty)

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

Parameters:

executionProperty - An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

Returns:

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

executionProperty

default Job.Builder executionProperty(Consumer<ExecutionProperty.Builder> executionProperty)

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

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

Parameters:

executionProperty - a consumer that will call methods on ExecutionProperty.Builder

Returns:

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

See Also:

executionProperty(ExecutionProperty)

command

Job.Builder command(JobCommand command)

The JobCommand that executes this job.

Parameters:

command - The JobCommand that executes this job.

Returns:

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

command

default Job.Builder command(Consumer<JobCommand.Builder> command)

The JobCommand that executes this job.

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

Parameters:

command - a consumer that will call methods on JobCommand.Builder

Returns:

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

See Also:

command(JobCommand)

defaultArguments

Job.Builder defaultArguments(Map<String,String> defaultArguments)

The default arguments for this job, specified as name-value pairs.

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:

defaultArguments - The default arguments for this job, specified as name-value pairs.

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.

connections

Job.Builder connections(ConnectionsList connections)

The connections used for this job.

Parameters:

connections - The connections used for this job.

Returns:

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

connections

default Job.Builder connections(Consumer<ConnectionsList.Builder> connections)

The connections used for this job.

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

Parameters:

connections - a consumer that will call methods on ConnectionsList.Builder

Returns:

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

See Also:

connections(ConnectionsList)

maxRetries

Job.Builder maxRetries(Integer maxRetries)

The maximum number of times to retry this job after a JobRun fails.

Parameters:

maxRetries - The maximum number of times to retry this job after a JobRun fails.

Returns:

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

allocatedCapacity

Job.Builder allocatedCapacity(Integer allocatedCapacity)

The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Parameters:

allocatedCapacity - The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Returns:

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

timeout

Job.Builder timeout(Integer timeout)

The job 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).

Parameters:

timeout - The job 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).

Returns:

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

notificationProperty

Job.Builder notificationProperty(NotificationProperty notificationProperty)

Specifies configuration properties of a job notification.

Parameters:

notificationProperty - Specifies configuration properties of a job notification.

Returns:

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

notificationProperty

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

Specifies configuration properties of a job 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

Job.Builder securityConfiguration(String securityConfiguration)

The name of the SecurityConfiguration structure to be used with this job.

Parameters:

securityConfiguration - The name of the SecurityConfiguration structure to be used with this job.

Returns:

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