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(Experimental)
public static final class JobProps.Builder
extends Object
implements software.amazon.jsii.Builder<JobProps>
A builder for
JobProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.connections
(List<? extends IConnection> connections) Sets the value ofJobProps.getConnections()
continuousLogging
(ContinuousLoggingProps continuousLogging) Sets the value ofJobProps.getContinuousLogging()
defaultArguments
(Map<String, String> defaultArguments) Sets the value ofJobProps.getDefaultArguments()
description
(String description) Sets the value ofJobProps.getDescription()
enableProfilingMetrics
(Boolean enableProfilingMetrics) Sets the value ofJobProps.getEnableProfilingMetrics()
executable
(JobExecutable executable) Sets the value ofJobProps.getExecutable()
Sets the value ofJobProps.getJobName()
maxCapacity
(Number maxCapacity) Sets the value ofJobProps.getMaxCapacity()
maxConcurrentRuns
(Number maxConcurrentRuns) Sets the value ofJobProps.getMaxConcurrentRuns()
maxRetries
(Number maxRetries) Sets the value ofJobProps.getMaxRetries()
notifyDelayAfter
(Duration notifyDelayAfter) Sets the value ofJobProps.getNotifyDelayAfter()
Sets the value ofJobProps.getRole()
securityConfiguration
(ISecurityConfiguration securityConfiguration) Sets the value ofJobProps.getSecurityConfiguration()
sparkUi
(SparkUIProps sparkUi) Sets the value ofinvalid @link
JobProps#getSparkUi
Sets the value ofJobProps.getTags()
Sets the value ofJobProps.getTimeout()
workerCount
(Number workerCount) Sets the value ofJobProps.getWorkerCount()
workerType
(WorkerType workerType) Sets the value ofJobProps.getWorkerType()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
executable
Sets the value ofJobProps.getExecutable()
- Parameters:
executable
- The job's executable properties. This parameter is required.- Returns:
this
-
connections
@Stability(Experimental) public JobProps.Builder connections(List<? extends IConnection> connections) Sets the value ofJobProps.getConnections()
- Parameters:
connections
- TheConnection
s used for this job. Connections are used to connect to other AWS Service or resources within a VPC.- Returns:
this
-
continuousLogging
@Stability(Experimental) public JobProps.Builder continuousLogging(ContinuousLoggingProps continuousLogging) Sets the value ofJobProps.getContinuousLogging()
- Parameters:
continuousLogging
- Enables continuous logging with the specified props.- Returns:
this
-
defaultArguments
@Stability(Experimental) public JobProps.Builder defaultArguments(Map<String, String> defaultArguments) Sets the value ofJobProps.getDefaultArguments()
- Parameters:
defaultArguments
- The default arguments for this job, specified as name-value pairs.- Returns:
this
-
description
Sets the value ofJobProps.getDescription()
- Parameters:
description
- The description of the job.- Returns:
this
-
enableProfilingMetrics
@Stability(Experimental) public JobProps.Builder enableProfilingMetrics(Boolean enableProfilingMetrics) Sets the value ofJobProps.getEnableProfilingMetrics()
- Parameters:
enableProfilingMetrics
- Enables the collection of metrics for job profiling.- Returns:
this
-
jobName
Sets the value ofJobProps.getJobName()
- Parameters:
jobName
- The name of the job.- Returns:
this
-
maxCapacity
Sets the value ofJobProps.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
Sets the value ofJobProps.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
Sets the value ofJobProps.getMaxRetries()
- Parameters:
maxRetries
- The maximum number of times to retry this job after a job run fails.- Returns:
this
-
notifyDelayAfter
Sets the value ofJobProps.getNotifyDelayAfter()
- Parameters:
notifyDelayAfter
- The number of minutes to wait after a job run starts, before sending a job run delay notification.- Returns:
this
-
role
Sets the value ofJobProps.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(Experimental) public JobProps.Builder securityConfiguration(ISecurityConfiguration securityConfiguration) Sets the value ofJobProps.getSecurityConfiguration()
- Parameters:
securityConfiguration
- TheSecurityConfiguration
to use for this job.- Returns:
this
-
sparkUi
Sets the value ofinvalid @link
JobProps#getSparkUi
- Parameters:
sparkUi
- Enables the Spark UI debugging and monitoring with the specified props.- Returns:
this
-
tags
Sets the value ofJobProps.getTags()
- Parameters:
tags
- The tags to add to the resources on which the job runs.- Returns:
this
-
timeout
Sets the value ofJobProps.getTimeout()
- Parameters:
timeout
- The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.- Returns:
this
-
workerCount
Sets the value ofJobProps.getWorkerCount()
- Parameters:
workerCount
- The number of workers of a definedWorkerType
that are allocated when a job runs.- Returns:
this
-
workerType
Sets the value ofJobProps.getWorkerType()
- Parameters:
workerType
- The type of predefined worker that is allocated when a job runs.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<JobProps>
- Returns:
- a new instance of
JobProps
- Throws:
NullPointerException
- if any required attribute was not provided
-