@Generated(value="software.amazon.awssdk:codegen") public final class JobUpdate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<JobUpdate.Builder,JobUpdate>
Specifies information used to update an existing job definition. The previous job definition is completely overwritten by this information.
| Type | Property and Description |
|---|---|
ExecutionProperty |
execution
An
ExecutionProperty specifying the maximum number of concurrent runs allowed for this job. |
NotificationProperty |
notification
Specifies the configuration properties of a job notification.
|
| Modifier and Type | Class and Description |
|---|---|
static interface |
JobUpdate.Builder |
| Modifier and Type | Method and Description |
|---|---|
Integer |
allocatedCapacity()
Deprecated.
This property is deprecated, use MaxCapacity instead.
|
static JobUpdate.Builder |
builder() |
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.
|
JobCommand |
command()
The
JobCommand that runs this job (required). |
ConnectionsList |
connections()
The connections used for this job.
|
Map<String,String> |
defaultArguments()
The default arguments for every run of this job, specified as name-value pairs.
|
String |
description()
Description of the job being defined.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
ExecutionClass |
executionClass()
Indicates whether the job is run with a standard or flexible execution class.
|
String |
executionClassAsString()
Indicates whether the job is run with a standard or flexible execution class.
|
ExecutionProperty |
executionProperty()
An
ExecutionProperty specifying the maximum number of concurrent runs allowed for this job. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
String |
glueVersion()
In Spark jobs,
GlueVersion determines the versions of Apache Spark and Python that Glue available in
a job. |
boolean |
hasCodeGenConfigurationNodes()
For responses, this returns true if the service returned a value for the CodeGenConfigurationNodes property.
|
boolean |
hasDefaultArguments()
For responses, this returns true if the service returned a value for the DefaultArguments property.
|
int |
hashCode() |
boolean |
hasNonOverridableArguments()
For responses, this returns true if the service returned a value for the NonOverridableArguments property.
|
String |
logUri()
This field is reserved for future use.
|
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.
|
Integer |
maxRetries()
The maximum number of times to retry this job if it fails.
|
Map<String,String> |
nonOverridableArguments()
Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value
pairs.
|
NotificationProperty |
notificationProperty()
Specifies the configuration properties of a job notification.
|
Integer |
numberOfWorkers()
The number of workers of a defined
workerType that are allocated when a job runs. |
String |
role()
The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).
|
List<SdkField<?>> |
sdkFields() |
String |
securityConfiguration()
The name of the
SecurityConfiguration structure to be used with this job. |
static Class<? extends JobUpdate.Builder> |
serializableBuilderClass() |
SourceControlDetails |
sourceControlDetails()
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a
remote repository.
|
Integer |
timeout()
The job timeout in minutes.
|
JobUpdate.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
WorkerType |
workerType()
The type of predefined worker that is allocated when a job runs.
|
String |
workerTypeAsString()
The type of predefined worker that is allocated when a job runs.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final ExecutionProperty executionProperty
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
public final NotificationProperty notificationProperty
Specifies the configuration properties of a job notification.
public final String description()
Description of the job being defined.
public final String logUri()
This field is reserved for future use.
public final String role()
The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).
public final ExecutionProperty executionProperty()
An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
public final JobCommand command()
The JobCommand that runs this job (required).
JobCommand that runs this job (required).public final boolean hasDefaultArguments()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final Map<String,String> defaultArguments()
The default arguments for every run of 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.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
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 arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDefaultArguments() method.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
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 arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
public final boolean hasNonOverridableArguments()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final Map<String,String> nonOverridableArguments()
Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasNonOverridableArguments() method.
public final ConnectionsList connections()
The connections used for this job.
public final Integer maxRetries()
The maximum number of times to retry this job if it fails.
@Deprecated public final Integer allocatedCapacity()
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to 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.
MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to 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.
public final 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 status. The default is 2,880 minutes (48 hours).public final 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.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity. Instead, you should specify a
Worker type and the Number of workers.
Do not set MaxCapacity 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 from 2 to 100 DPUs. The default is 10 DPUs.
This job type cannot have a fractional DPU allocation.
For Glue version 2.0+ jobs, you cannot specify a Maximum capacity. Instead, you should
specify a Worker type and the Number of workers.
Do not set MaxCapacity 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 from 2 to 100 DPUs.
The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
public final WorkerType workerType()
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk
(approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such
as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk
(approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such
as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk
(approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose
workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available
only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio),
US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo),
Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk
(approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose
workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available
only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the
G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk
(approximately 34GB free), 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.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk
(approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
If the service returns an enum value that is not available in the current SDK version, workerType will
return WorkerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
workerTypeAsString().
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB
disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for
workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run
most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB
disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for
workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run
most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB
disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for
jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This
worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web
Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia
Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and
Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB
disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for
jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This
worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web
Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB
disk (approximately 34GB free), 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.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB
disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
WorkerTypepublic final String workerTypeAsString()
The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk
(approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such
as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk
(approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such
as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk
(approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose
workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available
only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio),
US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo),
Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk
(approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose
workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available
only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the
G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk
(approximately 34GB free), 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.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk
(approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
If the service returns an enum value that is not available in the current SDK version, workerType will
return WorkerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
workerTypeAsString().
For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB
disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for
workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run
most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB
disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for
workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run
most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB
disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for
jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This
worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web
Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia
Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and
Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB
disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for
jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This
worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web
Services Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB
disk (approximately 34GB free), 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.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB
disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
WorkerTypepublic final Integer numberOfWorkers()
The number of workers of a defined workerType that are allocated when a job runs.
workerType that are allocated when a job runs.public final String securityConfiguration()
The name of the SecurityConfiguration structure to be used with this job.
SecurityConfiguration structure to be used with this job.public final NotificationProperty notificationProperty()
Specifies the configuration properties of a job notification.
public final String glueVersion()
In Spark jobs, GlueVersion determines the versions of Apache Spark and Python that Glue available in
a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of Ray, Python
and additional libraries available in your Ray job are determined by the Runtime parameter of the
Job command.
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 determines the versions of Apache Spark and Python that Glue
available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion to 4.0 or greater. However, the versions of
Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
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.
public final boolean hasCodeGenConfigurationNodes()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasCodeGenConfigurationNodes() method.
public final 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.
If the service returns an enum value that is not available in the current SDK version, executionClass
will return ExecutionClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from executionClassAsString().
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.
ExecutionClasspublic final String executionClassAsString()
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.
If the service returns an enum value that is not available in the current SDK version, executionClass
will return ExecutionClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from executionClassAsString().
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.
ExecutionClasspublic final SourceControlDetails sourceControlDetails()
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
public JobUpdate.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<JobUpdate.Builder,JobUpdate>public static JobUpdate.Builder builder()
public static Class<? extends JobUpdate.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.