public static interface Job.Builder extends SdkPojo, CopyableBuilder<Job.Builder,Job>
Modifier and Type | Method and Description |
---|---|
Job.Builder |
allocatedCapacity(Integer allocatedCapacity)
Deprecated.
This property is deprecated, use MaxCapacity instead.
|
Job.Builder |
codeGenConfigurationNodes(Map<String,CodeGenConfigurationNode> codeGenConfigurationNodes)
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio
code generation is based.
|
default Job.Builder |
command(Consumer<JobCommand.Builder> command)
The
JobCommand that runs this job. |
Job.Builder |
command(JobCommand command)
The
JobCommand that runs 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)
A description of the job.
|
Job.Builder |
executionClass(ExecutionClass executionClass)
Indicates whether the job is run with a standard or flexible execution class.
|
Job.Builder |
executionClass(String executionClass)
Indicates whether the job is run with a standard or flexible execution class.
|
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 |
glueVersion(String glueVersion)
Glue version determines the versions of Apache Spark and Python that Glue supports.
|
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 |
maxCapacity(Double maxCapacity)
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing
units (DPUs) that can be allocated when this job runs.
|
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.
|
Job.Builder |
nonOverridableArguments(Map<String,String> nonOverridableArguments)
Non-overridable arguments for this job, specified as name-value pairs.
|
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 |
numberOfWorkers(Integer numberOfWorkers)
The number of workers of a defined
workerType that are allocated when a job runs. |
Job.Builder |
role(String role)
The name or Amazon Resource Name (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. |
default Job.Builder |
sourceControlDetails(Consumer<SourceControlDetails.Builder> sourceControlDetails)
The details for a source control configuration for a job, allowing synchronization of job artifacts to or
from a remote repository.
|
Job.Builder |
sourceControlDetails(SourceControlDetails sourceControlDetails)
The details for a source control configuration for a job, allowing synchronization of job artifacts to or
from a remote repository.
|
Job.Builder |
timeout(Integer timeout)
The job timeout in minutes.
|
Job.Builder |
workerType(String workerType)
The type of predefined worker that is allocated when a job runs.
|
Job.Builder |
workerType(WorkerType workerType)
The type of predefined worker that is allocated when a job runs.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
Job.Builder name(String name)
The name you assign to this job definition.
name
- The name you assign to this job definition.Job.Builder description(String description)
A description of the job.
description
- A description of the job.Job.Builder logUri(String logUri)
This field is reserved for future use.
logUri
- This field is reserved for future use.Job.Builder role(String role)
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
role
- The name or Amazon Resource Name (ARN) of the IAM role associated with this job.Job.Builder createdOn(Instant createdOn)
The time and date that this job definition was created.
createdOn
- The time and date that this job definition was created.Job.Builder lastModifiedOn(Instant lastModifiedOn)
The last point in time when this job definition was modified.
lastModifiedOn
- The last point in time when this job definition was modified.Job.Builder executionProperty(ExecutionProperty executionProperty)
An ExecutionProperty
specifying the maximum number of concurrent runs allowed for this job.
executionProperty
- An ExecutionProperty
specifying the maximum number of concurrent runs allowed for this
job.default Job.Builder executionProperty(Consumer<ExecutionProperty.Builder> executionProperty)
An ExecutionProperty
specifying the maximum number of concurrent runs allowed for this job.
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)
.
executionProperty
- a consumer that will call methods on ExecutionProperty.Builder
executionProperty(ExecutionProperty)
Job.Builder command(JobCommand command)
The JobCommand
that runs this job.
command
- The JobCommand
that runs this job.default Job.Builder command(Consumer<JobCommand.Builder> command)
The JobCommand
that runs this job.
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)
.
command
- a consumer that will call methods on JobCommand.Builder
command(JobCommand)
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 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.
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 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.
Job.Builder nonOverridableArguments(Map<String,String> nonOverridableArguments)
Non-overridable arguments for this job, specified as name-value pairs.
nonOverridableArguments
- Non-overridable arguments for this job, specified as name-value pairs.Job.Builder connections(ConnectionsList connections)
The connections used for this job.
connections
- The connections used for this job.default Job.Builder connections(Consumer<ConnectionsList.Builder> connections)
The connections used for this job.
This is a convenience method that creates an instance of theConnectionsList.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)
.
connections
- a consumer that will call methods on ConnectionsList.Builder
connections(ConnectionsList)
Job.Builder maxRetries(Integer maxRetries)
The maximum number of times to retry this job after a JobRun fails.
maxRetries
- The maximum number of times to retry this job after a JobRun fails.@Deprecated Job.Builder allocatedCapacity(Integer allocatedCapacity)
This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; 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 Glue pricing page.
allocatedCapacity
- This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; 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 Glue pricing page.
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).
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).Job.Builder maxCapacity(Double maxCapacity)
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. 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 Glue pricing page.
Do not set Max Capacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python
shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
="pythonshell"), you can allocate either
0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
="glueetl") or Apache Spark streaming
ETL job (JobCommand.Name
="gluestreaming"), you can allocate a minimum of 2 DPUs. The default is
10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity
. Instead, you should
specify a Worker type
and the Number of workers
.
maxCapacity
- For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data
processing units (DPUs) that can be allocated when this job runs. 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 Glue pricing page.
Do not set Max Capacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a
Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (JobCommand.Name
="pythonshell"), you can allocate
either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name
="glueetl") or Apache Spark
streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate a minimum of 2
DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity
. Instead, you
should specify a Worker type
and the Number of workers
.
Job.Builder workerType(String workerType)
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and
2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and
provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and
provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk),
and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker
type is only available for Glue version 3.0 streaming jobs.
workerType
- The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X,
G.2X, or G.025X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB
disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB
disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB
disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB
disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming
jobs. This worker type is only available for Glue version 3.0 streaming jobs.
WorkerType
,
WorkerType
Job.Builder workerType(WorkerType workerType)
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and
2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and
provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and
provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk),
and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker
type is only available for Glue version 3.0 streaming jobs.
workerType
- The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X,
G.2X, or G.025X.
For the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB
disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB
disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB
disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB
disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming
jobs. This worker type is only available for Glue version 3.0 streaming jobs.
WorkerType
,
WorkerType
Job.Builder numberOfWorkers(Integer numberOfWorkers)
The number of workers of a defined workerType
that are allocated when a job runs.
numberOfWorkers
- The number of workers of a defined workerType
that are allocated when a job runs.Job.Builder securityConfiguration(String securityConfiguration)
The name of the SecurityConfiguration
structure to be used with this job.
securityConfiguration
- The name of the SecurityConfiguration
structure to be used with this job.Job.Builder notificationProperty(NotificationProperty notificationProperty)
Specifies configuration properties of a job notification.
notificationProperty
- Specifies configuration properties of a job notification.default Job.Builder notificationProperty(Consumer<NotificationProperty.Builder> notificationProperty)
Specifies configuration properties of a job notification.
This is a convenience method that creates an instance of theNotificationProperty.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)
.
notificationProperty
- a consumer that will call methods on NotificationProperty.Builder
notificationProperty(NotificationProperty)
Job.Builder glueVersion(String glueVersion)
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
glueVersion
- Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version
indicates the version supported for jobs of type Spark.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
Job.Builder codeGenConfigurationNodes(Map<String,CodeGenConfigurationNode> codeGenConfigurationNodes)
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
codeGenConfigurationNodes
- The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue
Studio code generation is based.Job.Builder executionClass(String executionClass)
Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set
ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
executionClass
- Indicates whether the job is run with a standard or flexible execution class. The standard execution
class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set
ExecutionClass
to FLEX
. The flexible execution class is available for Spark
jobs.
ExecutionClass
,
ExecutionClass
Job.Builder executionClass(ExecutionClass executionClass)
Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set
ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
executionClass
- Indicates whether the job is run with a standard or flexible execution class. The standard execution
class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set
ExecutionClass
to FLEX
. The flexible execution class is available for Spark
jobs.
ExecutionClass
,
ExecutionClass
Job.Builder sourceControlDetails(SourceControlDetails sourceControlDetails)
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
sourceControlDetails
- The details for a source control configuration for a job, allowing synchronization of job artifacts to
or from a remote repository.default Job.Builder sourceControlDetails(Consumer<SourceControlDetails.Builder> sourceControlDetails)
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
This is a convenience method that creates an instance of theSourceControlDetails.Builder
avoiding
the need to create one manually via SourceControlDetails.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to sourceControlDetails(SourceControlDetails)
.
sourceControlDetails
- a consumer that will call methods on SourceControlDetails.Builder
sourceControlDetails(SourceControlDetails)
Copyright © 2022. All rights reserved.