JobRun (AWS SDK for Java

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface JobRun.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JobRun.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.
`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 Glue supports.
`boolean`	`hasArguments()` For responses, this returns true if the service returned a value for the Arguments property.
`int`	`hashCode()`
`boolean`	`hasPredecessorRuns()` For responses, this returns true if the service returned a value for the PredecessorRuns property.
`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 KMS.
`Double`	`maxCapacity()` The number of 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.

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

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

- Method Detail
  - id
```
public final String id()
```
    The ID of this job run.
    
    Returns:
    
    The ID of this job run.
  - attempt
```
public final Integer attempt()
```
    The number of the attempt to run this job.
    
    Returns:
    
    The number of the attempt to run this job.
  - previousRunId
```
public final 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 final 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 final 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 final 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 final Instant lastModifiedOn()
```
    The last time that this job run was modified.
    
    Returns:
    
    The last time that this job run was modified.
  - completedOn
```
public final Instant completedOn()
```
    The date and time that this job run completed.
    
    Returns:
    
    The date and time that this job run completed.
  - jobRunState
```
public final JobRunState jobRunState()
```
    The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see 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().
    
    Returns:
    
    The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
    
    See Also:
    
    JobRunState
  - jobRunStateAsString
```
public final String jobRunStateAsString()
```
    The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see 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().
    
    Returns:
    
    The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
    
    See Also:
    
    JobRunState
  - hasArguments
```
public final boolean hasArguments()
```
    For responses, this returns true if the service returned a value for the Arguments 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.
  - arguments
```
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 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 hasArguments() method.
    
    Returns:
    
    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 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.
  - errorMessage
```
public final String errorMessage()
```
    An error message associated with this job run.
    
    Returns:
    
    An error message associated with this job run.
  - hasPredecessorRuns
```
public final boolean hasPredecessorRuns()
```
    For responses, this returns true if the service returned a value for the PredecessorRuns 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.
  - predecessorRuns
```
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.
    
    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 hasPredecessorRuns() method.
    
    Returns:
    
    A list of predecessors to this job run.
  - 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 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 Glue pricing page.
    
    Returns:
    
    This field is deprecated. Use MaxCapacity instead.
    
    The number of 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 Glue pricing page.
  - executionTime
```
public final 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 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.
    
    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.
  - maxCapacity
```
public final Double maxCapacity()
```
    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 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.
    Returns:
    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 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.
  - workerType
```
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().
    Returns:
    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.
    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, 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().
    Returns:
    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.
    See Also:
    
    WorkerType
  - numberOfWorkers
```
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.
    
    Returns:
    
    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.
  - securityConfiguration
```
public final 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 final String logGroupName()
```
    The name of the log group for secure logging that can be server-side encrypted in Amazon 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 is used to encrypt the log group.
    
    Returns:
    
    The name of the log group for secure logging that can be server-side encrypted in Amazon 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 is used to encrypt the log group.
  - notificationProperty
```
public final NotificationProperty notificationProperty()
```
    Specifies configuration properties of a job run notification.
    
    Returns:
    
    Specifies configuration properties of a job run 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.
  - 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 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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.94

Class JobRun

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

attempt

previousRunId

triggerName

jobName

startedOn

lastModifiedOn

completedOn

jobRunState

jobRunStateAsString

hasArguments

arguments

errorMessage

hasPredecessorRuns

predecessorRuns

allocatedCapacity

executionTime

timeout

maxCapacity

workerType

workerTypeAsString

numberOfWorkers

securityConfiguration

logGroupName

notificationProperty

glueVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields