Job (AWS Java SDK :: Services :: AWS Glue 2.18.21 API)

java.lang.Object
- software.amazon.awssdk.services.glue.model.Job

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Job.Builder,Job>

@Generated(value="software.amazon.awssdk:codegen")
public final class Job
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Job.Builder,Job>

Specifies a job definition.

See Also:: Serialized Form

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`ExecutionProperty`	`execution` An `ExecutionProperty` specifying the maximum number of concurrent runs allowed for this job.
`NotificationProperty`	`notification` Specifies configuration properties of a job notification.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Job.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Job.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Integer`	`allocatedCapacity()` Deprecated. This property is deprecated, use MaxCapacity instead.
`static Job.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.
`ConnectionsList`	`connections()` The connections used for this job.
`Instant`	`createdOn()` The time and date that this job definition was created.
`Map<String,String>`	`defaultArguments()` The default arguments for this job, specified as name-value pairs.
`String`	`description()` A description of the job.
`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()` Glue version determines the versions of Apache Spark and Python that Glue supports.
`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.
`Instant`	`lastModifiedOn()` The last point in time when this job definition was modified.
`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 after a JobRun fails.
`String`	`name()` The name you assign to this job definition.
`Map<String,String>`	`nonOverridableArguments()` Non-overridable arguments for this job, specified as name-value pairs.
`NotificationProperty`	`notificationProperty()` Specifies 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.
`List<SdkField<?>>`	`sdkFields()`
`String`	`securityConfiguration()` The name of the `SecurityConfiguration` structure to be used with this job.
`static Class<? extends Job.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.
`Job.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.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Property Detail
  - execution
```
public final ExecutionProperty executionProperty
```
    An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
  - notification
```
public final NotificationProperty notificationProperty
```
    Specifies configuration properties of a job notification.
- Method Detail
  - name
```
public final String name()
```
    The name you assign to this job definition.
    
    Returns:
    
    The name you assign to this job definition.
  - description
```
public final String description()
```
    A description of the job.
    
    Returns:
    
    A description of the job.
  - logUri
```
public final String logUri()
```
    This field is reserved for future use.
    
    Returns:
    
    This field is reserved for future use.
  - role
```
public final String role()
```
    The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
    
    Returns:
    
    The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
  - createdOn
```
public final Instant createdOn()
```
    The time and date that this job definition was created.
    
    Returns:
    
    The time and date that this job definition was created.
  - lastModifiedOn
```
public final Instant lastModifiedOn()
```
    The last point in time when this job definition was modified.
    
    Returns:
    
    The last point in time when this job definition was modified.
  - executionProperty
```
public final ExecutionProperty executionProperty()
```
    An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
  - command
```
public final JobCommand command()
```
    The JobCommand that runs this job.
    
    Returns:
    
    The JobCommand that runs this job.
  - hasDefaultArguments
```
public final boolean hasDefaultArguments()
```
    For responses, this returns true if the service returned a value for the DefaultArguments property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - defaultArguments
```
public final 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.
    
    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.
    
    Returns:
    
    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.
  - hasNonOverridableArguments
```
public final boolean hasNonOverridableArguments()
```
    For responses, this returns true if the service returned a value for the NonOverridableArguments property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - nonOverridableArguments
```
public final Map<String,String> nonOverridableArguments()
```
    Non-overridable arguments for this job, 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.
    
    Returns:
    
    Non-overridable arguments for this job, specified as name-value pairs.
  - connections
```
public final ConnectionsList connections()
```
    The connections used for this job.
    
    Returns:
    
    The connections used for this job.
  - maxRetries
```
public final Integer maxRetries()
```
    The maximum number of times to retry this job after a JobRun fails.
    
    Returns:
    
    The maximum number of times to retry this job after a JobRun fails.
  - allocatedCapacity
```
@Deprecated
public final Integer allocatedCapacity()
```
    Deprecated. This property is deprecated, use MaxCapacity instead.
    
    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.
    
    Returns:
    
    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.
  - timeout
```
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).
    
    Returns:
    
    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).
  - maxCapacity
```
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.
    
    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.
    Returns:
    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.
  - workerType
```
public final 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.
    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().
    Returns:
    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.
    See Also:
    
    WorkerType
  - workerTypeAsString
```
public final String workerTypeAsString()
```
    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.
    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().
    Returns:
    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.
    See Also:
    
    WorkerType
  - numberOfWorkers
```
public final Integer numberOfWorkers()
```
    The number of workers of a defined workerType that are allocated when a job runs.
    
    Returns:
    
    The number of workers of a defined workerType that are allocated when a job runs.
  - securityConfiguration
```
public final String securityConfiguration()
```
    The name of the SecurityConfiguration structure to be used with this job.
    
    Returns:
    
    The name of the SecurityConfiguration structure to be used with this job.
  - notificationProperty
```
public final NotificationProperty notificationProperty()
```
    Specifies configuration properties of a job notification.
  - glueVersion
```
public final 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.
    
    Returns:
    
    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.
  - hasCodeGenConfigurationNodes
```
public final boolean hasCodeGenConfigurationNodes()
```
    For responses, this returns true if the service returned a value for the CodeGenConfigurationNodes property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - codeGenConfigurationNodes
```
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.
    
    Returns:
    
    The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
  - executionClass
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    ExecutionClass
  - executionClassAsString
```
public 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().
    
    Returns:
    
    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.
    
    See Also:
    
    ExecutionClass
  - sourceControlDetails
```
public final SourceControlDetails sourceControlDetails()
```
    The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
    
    Returns:
    
    The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
  - toBuilder
```
public Job.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Job.Builder,Job>
  - builder
```
public static Job.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Job.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Job

Property Summary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Property Detail

execution

notification

Method Detail

name

description

logUri

role

createdOn

lastModifiedOn

executionProperty

command

hasDefaultArguments

defaultArguments

hasNonOverridableArguments

nonOverridableArguments

connections

maxRetries

allocatedCapacity

timeout

maxCapacity

workerType

workerTypeAsString

numberOfWorkers

securityConfiguration

notificationProperty

glueVersion

hasCodeGenConfigurationNodes

codeGenConfigurationNodes

executionClass

executionClassAsString

sourceControlDetails

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields