software.amazon.awscdk.services.glue

Class JobProps.Builder

java.lang.Object

software.amazon.awscdk.services.glue.JobProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JobProps>

Enclosing interface:

JobProps

@Stability(value=Experimental)
public static final class JobProps.Builder
extends Object
implements software.amazon.jsii.Builder<JobProps>

A builder for JobProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
JobProps	build() Builds the configured instance.
JobProps.Builder	connections(List<? extends IConnection> connections) Sets the value of JobProps.getConnections()
JobProps.Builder	continuousLogging(ContinuousLoggingProps continuousLogging) Sets the value of JobProps.getContinuousLogging()
JobProps.Builder	defaultArguments(Map<String,String> defaultArguments) Sets the value of JobProps.getDefaultArguments()
JobProps.Builder	description(String description) Sets the value of JobProps.getDescription()
JobProps.Builder	enableProfilingMetrics(Boolean enableProfilingMetrics) Sets the value of JobProps.getEnableProfilingMetrics()
JobProps.Builder	executable(JobExecutable executable) Sets the value of JobProps.getExecutable()
JobProps.Builder	jobName(String jobName) Sets the value of JobProps.getJobName()
JobProps.Builder	maxCapacity(Number maxCapacity) Sets the value of JobProps.getMaxCapacity()
JobProps.Builder	maxConcurrentRuns(Number maxConcurrentRuns) Sets the value of JobProps.getMaxConcurrentRuns()
JobProps.Builder	maxRetries(Number maxRetries) Sets the value of JobProps.getMaxRetries()
JobProps.Builder	notifyDelayAfter(Duration notifyDelayAfter) Sets the value of JobProps.getNotifyDelayAfter()
JobProps.Builder	role(IRole role) Sets the value of JobProps.getRole()
JobProps.Builder	securityConfiguration(ISecurityConfiguration securityConfiguration) Sets the value of JobProps.getSecurityConfiguration()
JobProps.Builder	sparkUi(SparkUIProps sparkUi) Sets the value of JobProps#getSparkUi
JobProps.Builder	tags(Map<String,String> tags) Sets the value of JobProps.getTags()
JobProps.Builder	timeout(Duration timeout) Sets the value of JobProps.getTimeout()
JobProps.Builder	workerCount(Number workerCount) Sets the value of JobProps.getWorkerCount()
JobProps.Builder	workerType(WorkerType workerType) Sets the value of JobProps.getWorkerType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

executable

@Stability(value=Experimental)
public JobProps.Builder executable(JobExecutable executable)

Sets the value of JobProps.getExecutable()

Parameters:

executable - The job's executable properties. This parameter is required.

Returns:

this

connections

@Stability(value=Experimental)
public JobProps.Builder connections(List<? extends IConnection> connections)

Sets the value of JobProps.getConnections()

Parameters:

connections - The Connections used for this job. Connections are used to connect to other AWS Service or resources within a VPC.

Returns:

this

continuousLogging

@Stability(value=Experimental)
public JobProps.Builder continuousLogging(ContinuousLoggingProps continuousLogging)

Sets the value of JobProps.getContinuousLogging()

Parameters:

continuousLogging - Enables continuous logging with the specified props.

Returns:

this

defaultArguments

@Stability(value=Experimental)
public JobProps.Builder defaultArguments(Map<String,String> defaultArguments)

Sets the value of JobProps.getDefaultArguments()

Parameters:

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

Returns:

this

description

@Stability(value=Experimental)
public JobProps.Builder description(String description)

Sets the value of JobProps.getDescription()

Parameters:

description - The description of the job.

Returns:

this

enableProfilingMetrics

@Stability(value=Experimental)
public JobProps.Builder enableProfilingMetrics(Boolean enableProfilingMetrics)

Sets the value of JobProps.getEnableProfilingMetrics()

Parameters:

enableProfilingMetrics - Enables the collection of metrics for job profiling.

Returns:

this

jobName

@Stability(value=Experimental)
public JobProps.Builder jobName(String jobName)

Sets the value of JobProps.getJobName()

Parameters:

jobName - The name of the job.

Returns:

this

maxCapacity

@Stability(value=Experimental)
public JobProps.Builder maxCapacity(Number maxCapacity)

Sets the value of JobProps.getMaxCapacity()

Parameters:

maxCapacity - The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. Cannot be used for Glue version 2.0 and later - workerType and workerCount should be used instead.

Returns:

this

maxConcurrentRuns

@Stability(value=Experimental)
public JobProps.Builder maxConcurrentRuns(Number maxConcurrentRuns)

Sets the value of JobProps.getMaxConcurrentRuns()

Parameters:

maxConcurrentRuns - The maximum number of concurrent runs allowed for the job. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

Returns:

this

maxRetries

@Stability(value=Experimental)
public JobProps.Builder maxRetries(Number maxRetries)

Sets the value of JobProps.getMaxRetries()

Parameters:

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

Returns:

this

notifyDelayAfter

@Stability(value=Experimental)
public JobProps.Builder notifyDelayAfter(Duration notifyDelayAfter)

Sets the value of JobProps.getNotifyDelayAfter()

Parameters:

notifyDelayAfter - The number of minutes to wait after a job run starts, before sending a job run delay notification.

Returns:

this

role

@Stability(value=Experimental)
public JobProps.Builder role(IRole role)

Sets the value of JobProps.getRole()

Parameters:

role - The IAM role assumed by Glue to run this job. If providing a custom role, it needs to trust the Glue service principal (glue.amazonaws.com) and be granted sufficient permissions.

Returns:

this

securityConfiguration

@Stability(value=Experimental)
public JobProps.Builder securityConfiguration(ISecurityConfiguration securityConfiguration)

Sets the value of JobProps.getSecurityConfiguration()

Parameters:

securityConfiguration - The SecurityConfiguration to use for this job.

Returns:

this

sparkUi

@Stability(value=Experimental)
public JobProps.Builder sparkUi(SparkUIProps sparkUi)

Sets the value of JobProps#getSparkUi

Parameters:

sparkUi - Enables the Spark UI debugging and monitoring with the specified props.

Returns:

this

tags

@Stability(value=Experimental)
public JobProps.Builder tags(Map<String,String> tags)

Sets the value of JobProps.getTags()

Parameters:

tags - The tags to add to the resources on which the job runs.

Returns:

this

timeout

@Stability(value=Experimental)
public JobProps.Builder timeout(Duration timeout)

Sets the value of JobProps.getTimeout()

Parameters:

timeout - The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.

Returns:

this

workerCount

@Stability(value=Experimental)
public JobProps.Builder workerCount(Number workerCount)

Sets the value of JobProps.getWorkerCount()

Parameters:

workerCount - The number of workers of a defined WorkerType that are allocated when a job runs.

Returns:

this

workerType

@Stability(value=Experimental)
public JobProps.Builder workerType(WorkerType workerType)

Sets the value of JobProps.getWorkerType()

Parameters:

workerType - The type of predefined worker that is allocated when a job runs.

Returns:

this

build

@Stability(value=Experimental)
public JobProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<JobProps>

Returns:

a new instance of JobProps

Throws:

NullPointerException - if any required attribute was not provided