@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class JobRun extends Object implements Serializable, Cloneable, StructuredPojo
Contains information about a job run.
Constructor and Description |
---|
JobRun() |
Modifier and Type | Method and Description |
---|---|
JobRun |
addArgumentsEntry(String key,
String value) |
JobRun |
clearArgumentsEntries()
Removes all the entries added into Arguments.
|
JobRun |
clone() |
boolean |
equals(Object obj) |
Integer |
getAllocatedCapacity()
Deprecated.
|
Map<String,String> |
getArguments()
The job arguments associated with this run.
|
Integer |
getAttempt()
The number of the attempt to run this job.
|
Date |
getCompletedOn()
The date and time this job run completed.
|
String |
getErrorMessage()
An error message associated with this job run.
|
Integer |
getExecutionTime()
The amount of time (in seconds) that the job run consumed resources.
|
String |
getId()
The ID of this job run.
|
String |
getJobName()
The name of the job definition being used in this run.
|
String |
getJobRunState()
The current state of the job run.
|
Date |
getLastModifiedOn()
The last time this job run was modified.
|
String |
getLogGroupName()
The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using KMS.
|
Double |
getMaxCapacity()
The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
|
NotificationProperty |
getNotificationProperty()
Specifies configuration properties of a job run notification.
|
List<Predecessor> |
getPredecessorRuns()
A list of predecessors to this job run.
|
String |
getPreviousRunId()
The ID of the previous run of this job.
|
String |
getSecurityConfiguration()
The name of the SecurityConfiguration structure to be used with this job run.
|
Date |
getStartedOn()
The date and time at which this job run was started.
|
Integer |
getTimeout()
The JobRun timeout in minutes.
|
String |
getTriggerName()
The name of the trigger that started this job run.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller) |
void |
setAllocatedCapacity(Integer allocatedCapacity)
Deprecated.
|
void |
setArguments(Map<String,String> arguments)
The job arguments associated with this run.
|
void |
setAttempt(Integer attempt)
The number of the attempt to run this job.
|
void |
setCompletedOn(Date completedOn)
The date and time this job run completed.
|
void |
setErrorMessage(String errorMessage)
An error message associated with this job run.
|
void |
setExecutionTime(Integer executionTime)
The amount of time (in seconds) that the job run consumed resources.
|
void |
setId(String id)
The ID of this job run.
|
void |
setJobName(String jobName)
The name of the job definition being used in this run.
|
void |
setJobRunState(String jobRunState)
The current state of the job run.
|
void |
setLastModifiedOn(Date lastModifiedOn)
The last time this job run was modified.
|
void |
setLogGroupName(String logGroupName)
The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using KMS.
|
void |
setMaxCapacity(Double maxCapacity)
The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
|
void |
setNotificationProperty(NotificationProperty notificationProperty)
Specifies configuration properties of a job run notification.
|
void |
setPredecessorRuns(Collection<Predecessor> predecessorRuns)
A list of predecessors to this job run.
|
void |
setPreviousRunId(String previousRunId)
The ID of the previous run of this job.
|
void |
setSecurityConfiguration(String securityConfiguration)
The name of the SecurityConfiguration structure to be used with this job run.
|
void |
setStartedOn(Date startedOn)
The date and time at which this job run was started.
|
void |
setTimeout(Integer timeout)
The JobRun timeout in minutes.
|
void |
setTriggerName(String triggerName)
The name of the trigger that started this job run.
|
String |
toString()
Returns a string representation of this object.
|
JobRun |
withAllocatedCapacity(Integer allocatedCapacity)
Deprecated.
|
JobRun |
withArguments(Map<String,String> arguments)
The job arguments associated with this run.
|
JobRun |
withAttempt(Integer attempt)
The number of the attempt to run this job.
|
JobRun |
withCompletedOn(Date completedOn)
The date and time this job run completed.
|
JobRun |
withErrorMessage(String errorMessage)
An error message associated with this job run.
|
JobRun |
withExecutionTime(Integer executionTime)
The amount of time (in seconds) that the job run consumed resources.
|
JobRun |
withId(String id)
The ID of this job run.
|
JobRun |
withJobName(String jobName)
The name of the job definition being used in this run.
|
JobRun |
withJobRunState(JobRunState jobRunState)
The current state of the job run.
|
JobRun |
withJobRunState(String jobRunState)
The current state of the job run.
|
JobRun |
withLastModifiedOn(Date lastModifiedOn)
The last time this job run was modified.
|
JobRun |
withLogGroupName(String logGroupName)
The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using KMS.
|
JobRun |
withMaxCapacity(Double maxCapacity)
The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
|
JobRun |
withNotificationProperty(NotificationProperty notificationProperty)
Specifies configuration properties of a job run notification.
|
JobRun |
withPredecessorRuns(Collection<Predecessor> predecessorRuns)
A list of predecessors to this job run.
|
JobRun |
withPredecessorRuns(Predecessor... predecessorRuns)
A list of predecessors to this job run.
|
JobRun |
withPreviousRunId(String previousRunId)
The ID of the previous run of this job.
|
JobRun |
withSecurityConfiguration(String securityConfiguration)
The name of the SecurityConfiguration structure to be used with this job run.
|
JobRun |
withStartedOn(Date startedOn)
The date and time at which this job run was started.
|
JobRun |
withTimeout(Integer timeout)
The JobRun timeout in minutes.
|
JobRun |
withTriggerName(String triggerName)
The name of the trigger that started this job run.
|
public void setId(String id)
The ID of this job run.
id
- The ID of this job run.public String getId()
The ID of this job run.
public JobRun withId(String id)
The ID of this job run.
id
- The ID of this job run.public void setAttempt(Integer attempt)
The number of the attempt to run this job.
attempt
- The number of the attempt to run this job.public Integer getAttempt()
The number of the attempt to run this job.
public JobRun withAttempt(Integer attempt)
The number of the attempt to run this job.
attempt
- The number of the attempt to run this job.public void setPreviousRunId(String previousRunId)
The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
previousRunId
- The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.public String getPreviousRunId()
The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
public JobRun withPreviousRunId(String previousRunId)
The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
previousRunId
- The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.public void setTriggerName(String triggerName)
The name of the trigger that started this job run.
triggerName
- The name of the trigger that started this job run.public String getTriggerName()
The name of the trigger that started this job run.
public JobRun withTriggerName(String triggerName)
The name of the trigger that started this job run.
triggerName
- The name of the trigger that started this job run.public void setJobName(String jobName)
The name of the job definition being used in this run.
jobName
- The name of the job definition being used in this run.public String getJobName()
The name of the job definition being used in this run.
public JobRun withJobName(String jobName)
The name of the job definition being used in this run.
jobName
- The name of the job definition being used in this run.public void setStartedOn(Date startedOn)
The date and time at which this job run was started.
startedOn
- The date and time at which this job run was started.public Date getStartedOn()
The date and time at which this job run was started.
public JobRun withStartedOn(Date startedOn)
The date and time at which this job run was started.
startedOn
- The date and time at which this job run was started.public void setLastModifiedOn(Date lastModifiedOn)
The last time this job run was modified.
lastModifiedOn
- The last time this job run was modified.public Date getLastModifiedOn()
The last time this job run was modified.
public JobRun withLastModifiedOn(Date lastModifiedOn)
The last time this job run was modified.
lastModifiedOn
- The last time this job run was modified.public void setCompletedOn(Date completedOn)
The date and time this job run completed.
completedOn
- The date and time this job run completed.public Date getCompletedOn()
The date and time this job run completed.
public JobRun withCompletedOn(Date completedOn)
The date and time this job run completed.
completedOn
- The date and time this job run completed.public void setJobRunState(String jobRunState)
The current state of the job run.
jobRunState
- The current state of the job run.JobRunState
public String getJobRunState()
The current state of the job run.
JobRunState
public JobRun withJobRunState(String jobRunState)
The current state of the job run.
jobRunState
- The current state of the job run.JobRunState
public JobRun withJobRunState(JobRunState jobRunState)
The current state of the job run.
jobRunState
- The current state of the job run.JobRunState
public Map<String,String> getArguments()
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.
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 void setArguments(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.
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.
public JobRun withArguments(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.
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.
public JobRun clearArgumentsEntries()
public void setErrorMessage(String errorMessage)
An error message associated with this job run.
errorMessage
- An error message associated with this job run.public String getErrorMessage()
An error message associated with this job run.
public JobRun withErrorMessage(String errorMessage)
An error message associated with this job run.
errorMessage
- An error message associated with this job run.public List<Predecessor> getPredecessorRuns()
A list of predecessors to this job run.
public void setPredecessorRuns(Collection<Predecessor> predecessorRuns)
A list of predecessors to this job run.
predecessorRuns
- A list of predecessors to this job run.public JobRun withPredecessorRuns(Predecessor... predecessorRuns)
A list of predecessors to this job run.
NOTE: This method appends the values to the existing list (if any). Use
setPredecessorRuns(java.util.Collection)
or withPredecessorRuns(java.util.Collection)
if you
want to override the existing values.
predecessorRuns
- A list of predecessors to this job run.public JobRun withPredecessorRuns(Collection<Predecessor> predecessorRuns)
A list of predecessors to this job run.
predecessorRuns
- A list of predecessors to this job run.@Deprecated public void setAllocatedCapacity(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.
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.
@Deprecated public Integer getAllocatedCapacity()
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.
@Deprecated public JobRun withAllocatedCapacity(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.
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.
public void setExecutionTime(Integer executionTime)
The amount of time (in seconds) that the job run consumed resources.
executionTime
- The amount of time (in seconds) that the job run consumed resources.public Integer getExecutionTime()
The amount of time (in seconds) that the job run consumed resources.
public JobRun withExecutionTime(Integer executionTime)
The amount of time (in seconds) that the job run consumed resources.
executionTime
- The amount of time (in seconds) that the job run consumed resources.public void setTimeout(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.
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.public Integer getTimeout()
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.
TIMEOUT
status. The default is 2,880 minutes (48 hours). This
overrides the timeout value set in the parent job.public JobRun withTimeout(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.
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.public void setMaxCapacity(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.
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.
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.
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 Double getMaxCapacity()
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.
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.
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 JobRun withMaxCapacity(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.
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.
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.
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 void setNotificationProperty(NotificationProperty notificationProperty)
Specifies configuration properties of a job run notification.
notificationProperty
- Specifies configuration properties of a job run notification.public NotificationProperty getNotificationProperty()
Specifies configuration properties of a job run notification.
public JobRun withNotificationProperty(NotificationProperty notificationProperty)
Specifies configuration properties of a job run notification.
notificationProperty
- Specifies configuration properties of a job run notification.public void setSecurityConfiguration(String securityConfiguration)
The name of the SecurityConfiguration structure to be used with this job run.
securityConfiguration
- The name of the SecurityConfiguration structure to be used with this job run.public String getSecurityConfiguration()
The name of the SecurityConfiguration structure to be used with this job run.
public JobRun withSecurityConfiguration(String securityConfiguration)
The name of the SecurityConfiguration structure to be used with this job run.
securityConfiguration
- The name of the SecurityConfiguration structure to be used with this job run.public void setLogGroupName(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.
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.public String getLogGroupName()
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.
/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.public JobRun withLogGroupName(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.
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.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2019. All rights reserved.