@Generated(value="software.amazon.awssdk:codegen") public final class JobRun extends Object implements SdkPojo, Serializable, ToCopyableBuilder<JobRun.Builder,JobRun>
Contains information about a job run.
Modifier and Type | Class and Description |
---|---|
static interface |
JobRun.Builder |
Modifier and Type | Method and Description |
---|---|
Integer |
allocatedCapacity()
This field is deprecated.
|
Map<String,String> |
arguments()
The job arguments associated with this run.
|
Integer |
attempt()
The number of the attempt to run this job.
|
static JobRun.Builder |
builder() |
Instant |
completedOn()
The date and time that this job run completed.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
errorMessage()
An error message associated with this job run.
|
Integer |
executionTime()
The amount of time (in seconds) that the job run consumed resources.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
String |
glueVersion()
Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
|
boolean |
hasArguments()
Returns true if the Arguments property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasPredecessorRuns()
Returns true if the PredecessorRuns property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
String |
id()
The ID of this job run.
|
String |
jobName()
The name of the job definition being used in this run.
|
JobRunState |
jobRunState()
The current state of the job run.
|
String |
jobRunStateAsString()
The current state of the job run.
|
Instant |
lastModifiedOn()
The last time that this job run was modified.
|
String |
logGroupName()
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS
KMS.
|
Double |
maxCapacity()
The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
|
NotificationProperty |
notificationProperty()
Specifies configuration properties of a job run notification.
|
Integer |
numberOfWorkers()
The number of workers of a defined
workerType that are allocated when a job runs. |
List<Predecessor> |
predecessorRuns()
A list of predecessors to this job run.
|
String |
previousRunId()
The ID of the previous run of this job.
|
List<SdkField<?>> |
sdkFields() |
String |
securityConfiguration()
The name of the
SecurityConfiguration structure to be used with this job run. |
static Class<? extends JobRun.Builder> |
serializableBuilderClass() |
Instant |
startedOn()
The date and time at which this job run was started.
|
Integer |
timeout()
The
JobRun timeout in minutes. |
JobRun.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
triggerName()
The name of the trigger that started this job run.
|
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.
|
copy
public final String id()
The ID of this job run.
public final Integer attempt()
The number of the attempt to run this job.
public final String previousRunId()
The ID of the previous run of this job. For example, the JobRunId
specified in the
StartJobRun
action.
JobRunId
specified in the
StartJobRun
action.public final String triggerName()
The name of the trigger that started this job run.
public final String jobName()
The name of the job definition being used in this run.
public final Instant startedOn()
The date and time at which this job run was started.
public final Instant lastModifiedOn()
The last time that this job run was modified.
public final Instant completedOn()
The date and time that this job run completed.
public final JobRunState jobRunState()
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see AWS Glue Job Run Statuses.
If the service returns an enum value that is not available in the current SDK version, jobRunState
will
return JobRunState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
jobRunStateAsString()
.
JobRunState
public final String jobRunStateAsString()
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see AWS Glue Job Run Statuses.
If the service returns an enum value that is not available in the current SDK version, jobRunState
will
return JobRunState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
jobRunStateAsString()
.
JobRunState
public final boolean hasArguments()
public final Map<String,String> arguments()
The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
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.
You can use hasArguments()
to see if a value was sent in this field.
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.
public final String errorMessage()
An error message associated with this job run.
public final boolean hasPredecessorRuns()
public final List<Predecessor> predecessorRuns()
A list of predecessors to this job run.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasPredecessorRuns()
to see if a value was sent in this field.
public final Integer allocatedCapacity()
This field is deprecated. Use MaxCapacity
instead.
The number of AWS Glue data processing units (DPUs) allocated to this JobRun. 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.
MaxCapacity
instead.
The number of AWS Glue data processing units (DPUs) allocated to this JobRun. 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.
public final Integer executionTime()
The amount of time (in seconds) that the job run consumed resources.
public final Integer timeout()
The JobRun
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). This overrides
the timeout value set in the parent job.
JobRun
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).
This overrides the timeout value set in the parent job.public final Double maxCapacity()
The number of AWS 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 AWS 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 or an Apache Spark 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"), you can allocate from 2 to 100
DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
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 or an Apache Spark 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"), 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 Standard, G.1X, or G.2X.
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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1
executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1
executor per worker.
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 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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and
1 executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and
1 executor per worker.
WorkerType
public final String workerTypeAsString()
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1
executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1
executor per worker.
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 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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and
1 executor per worker.
For the G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and
1 executor per worker.
WorkerType
public final Integer numberOfWorkers()
The number of workers of a defined workerType
that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X
, and 149 for G.2X
.
workerType
that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X
, and 149 for G.2X
.
public final String securityConfiguration()
The name of the SecurityConfiguration
structure to be used with this job run.
SecurityConfiguration
structure to be used with this job run.public final String logGroupName()
The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS
KMS. This name can be /aws-glue/jobs/
, in which case the default encryption is NONE
. If
you add a role name and SecurityConfiguration
name (in other words,
/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then that security configuration is
used to encrypt the log group.
/aws-glue/jobs/
, in which case the default encryption is
NONE
. If you add a role name and SecurityConfiguration
name (in other words,
/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then that security
configuration is used to encrypt the log group.public final NotificationProperty notificationProperty()
Specifies configuration properties of a job run notification.
public final String glueVersion()
Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.
For more information about the available AWS 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.
For more information about the available AWS 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 JobRun.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<JobRun.Builder,JobRun>
public static JobRun.Builder builder()
public static Class<? extends JobRun.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()