software.amazon.awssdk.services.glue.model

Class Job

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

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

Method Summary

Modifier and Type	Method and Description
Integer	allocatedCapacity() The number of AWS Glue data processing units (DPUs) allocated to runs of this job.
static Job.Builder	builder()
JobCommand	command() The JobCommand that executes 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() Description of the job being defined.
boolean	equals(Object obj)
ExecutionProperty	executionProperty() An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedOn() The last point in time when this job definition was modified.
String	logUri() This field is reserved for future use.
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.
NotificationProperty	notificationProperty() Specifies configuration properties of a job notification.
String	role() The name or 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()
Integer	timeout() The job timeout in minutes.
Job.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Property Detail

execution

public ExecutionProperty executionProperty

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

notification

public NotificationProperty notificationProperty

Specifies configuration properties of a job notification.

Method Detail

name

public String name()

The name you assign to this job definition.

Returns:

The name you assign to this job definition.

description

public String description()

Description of the job being defined.

Returns:

Description of the job being defined.

logUri

public String logUri()

This field is reserved for future use.

Returns:

This field is reserved for future use.

role

public String role()

The name or ARN of the IAM role associated with this job.

Returns:

The name or ARN of the IAM role associated with this job.

createdOn

public 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 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 ExecutionProperty executionProperty()

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

command

public JobCommand command()

The JobCommand that executes this job.

Returns:

The JobCommand that executes this job.

defaultArguments

public 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 AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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 AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

connections

public ConnectionsList connections()

The connections used for this job.

Returns:

The connections used for this job.

maxRetries

public 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

public Integer allocatedCapacity()

The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; 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 AWS Glue pricing page.

Returns:

The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; 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 AWS Glue pricing page.

timeout

public 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).

notificationProperty

public NotificationProperty notificationProperty()

Specifies configuration properties of a job notification.

securityConfiguration

public 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.

toBuilder

public Job.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Job.Builder,Job>

Returns:

a builder for type T

builder

public static Job.Builder builder()

serializableBuilderClass

public static Class<? extends Job.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.