software.amazon.awssdk.services.glue.model

Class JobRun

java.lang.Object

software.amazon.awssdk.services.glue.model.JobRun

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobRun.Builder,JobRun>

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

See Also:

Serialized Form

Property Summary

Type	Property and Description
NotificationProperty	notification Specifies configuration properties of a job run notification.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobRun.Builder

Method Summary

Modifier and Type	Method and Description
Integer	allocatedCapacity() The number of AWS Glue data processing units (DPUs) allocated to this JobRun.
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 this job run completed.
boolean	equals(Object obj)
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)
int	hashCode()
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 this job run was modified.
String	logGroupName() The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using KMS.
NotificationProperty	notificationProperty() Specifies configuration properties of a job run notification.
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()
String	triggerName() The name of the trigger that started this job run.

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

notification

public NotificationProperty notificationProperty

Specifies configuration properties of a job run notification.

Method Detail

id

public String id()

The ID of this job run.

Returns:

The ID of this job run.

attempt

public Integer attempt()

The number of the attempt to run this job.

Returns:

The number of the attempt to run this job.

previousRunId

public String previousRunId()

The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

Returns:

The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

triggerName

public String triggerName()

The name of the trigger that started this job run.

Returns:

The name of the trigger that started this job run.

jobName

public String jobName()

The name of the job definition being used in this run.

Returns:

The name of the job definition being used in this run.

startedOn

public Instant startedOn()

The date and time at which this job run was started.

Returns:

The date and time at which this job run was started.

lastModifiedOn

public Instant lastModifiedOn()

The last time this job run was modified.

Returns:

The last time this job run was modified.

completedOn

public Instant completedOn()

The date and time this job run completed.

Returns:

The date and time this job run completed.

jobRunState

public JobRunState jobRunState()

The current state of the job run.

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

Returns:

The current state of the job run.

See Also:

JobRunState

jobRunStateAsString

public String jobRunStateAsString()

The current state of the job run.

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

Returns:

The current state of the job run.

See Also:

JobRunState

arguments

public Map<String,String> arguments()

The job arguments associated with this run. These override equivalent default arguments set for the job.

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 job arguments associated with this run. These override equivalent default arguments set for the job.

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.

errorMessage

public String errorMessage()

An error message associated with this job run.

Returns:

An error message associated with this job run.

predecessorRuns

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

Returns:

A list of predecessors to this job run.

allocatedCapacity

public Integer allocatedCapacity()

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.

Returns:

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.

executionTime

public Integer executionTime()

The amount of time (in seconds) that the job run consumed resources.

Returns:

The amount of time (in seconds) that the job run consumed resources.

timeout

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

Returns:

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.

notificationProperty

public NotificationProperty notificationProperty()

Specifies configuration properties of a job run notification.

securityConfiguration

public String securityConfiguration()

The name of the SecurityConfiguration structure to be used with this job run.

Returns:

The name of the SecurityConfiguration structure to be used with this job run.

logGroupName

public String logGroupName()

The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using 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 will be used to encrypt the log group.

Returns:

The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using 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 will be used to encrypt the log group.

toBuilder

public JobRun.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<JobRun.Builder,JobRun>

Returns:

a builder for type T

builder

public static JobRun.Builder builder()

serializableBuilderClass

public static Class<? extends JobRun.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.