@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StartJobRunRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
StartJobRunRequest() |
Modifier and Type | Method and Description |
---|---|
StartJobRunRequest |
addArgumentsEntry(String key,
String value) |
StartJobRunRequest |
clearArgumentsEntries()
Removes all the entries added into Arguments.
|
StartJobRunRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getAllocatedCapacity()
Deprecated.
|
Map<String,String> |
getArguments()
The job arguments specifically for this run.
|
String |
getJobName()
The name of the job definition to use.
|
String |
getJobRunId()
The ID of a previous
JobRun to retry. |
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.
|
Integer |
getNumberOfWorkers()
The number of workers of a defined
workerType that are allocated when a job runs. |
String |
getSecurityConfiguration()
The name of the
SecurityConfiguration structure to be used with this job run. |
Integer |
getTimeout()
The
JobRun timeout in minutes. |
String |
getWorkerType()
The type of predefined worker that is allocated when a job runs.
|
int |
hashCode() |
void |
setAllocatedCapacity(Integer allocatedCapacity)
Deprecated.
|
void |
setArguments(Map<String,String> arguments)
The job arguments specifically for this run.
|
void |
setJobName(String jobName)
The name of the job definition to use.
|
void |
setJobRunId(String jobRunId)
The ID of a previous
JobRun to retry. |
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 |
setNumberOfWorkers(Integer numberOfWorkers)
The number of workers of a defined
workerType that are allocated when a job runs. |
void |
setSecurityConfiguration(String securityConfiguration)
The name of the
SecurityConfiguration structure to be used with this job run. |
void |
setTimeout(Integer timeout)
The
JobRun timeout in minutes. |
void |
setWorkerType(String workerType)
The type of predefined worker that is allocated when a job runs.
|
String |
toString()
Returns a string representation of this object.
|
StartJobRunRequest |
withAllocatedCapacity(Integer allocatedCapacity)
Deprecated.
|
StartJobRunRequest |
withArguments(Map<String,String> arguments)
The job arguments specifically for this run.
|
StartJobRunRequest |
withJobName(String jobName)
The name of the job definition to use.
|
StartJobRunRequest |
withJobRunId(String jobRunId)
The ID of a previous
JobRun to retry. |
StartJobRunRequest |
withMaxCapacity(Double maxCapacity)
The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
|
StartJobRunRequest |
withNotificationProperty(NotificationProperty notificationProperty)
Specifies configuration properties of a job run notification.
|
StartJobRunRequest |
withNumberOfWorkers(Integer numberOfWorkers)
The number of workers of a defined
workerType that are allocated when a job runs. |
StartJobRunRequest |
withSecurityConfiguration(String securityConfiguration)
The name of the
SecurityConfiguration structure to be used with this job run. |
StartJobRunRequest |
withTimeout(Integer timeout)
The
JobRun timeout in minutes. |
StartJobRunRequest |
withWorkerType(String workerType)
The type of predefined worker that is allocated when a job runs.
|
StartJobRunRequest |
withWorkerType(WorkerType workerType)
The type of predefined worker that is allocated when a job runs.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setJobName(String jobName)
The name of the job definition to use.
jobName
- The name of the job definition to use.public String getJobName()
The name of the job definition to use.
public StartJobRunRequest withJobName(String jobName)
The name of the job definition to use.
jobName
- The name of the job definition to use.public void setJobRunId(String jobRunId)
The ID of a previous JobRun
to retry.
jobRunId
- The ID of a previous JobRun
to retry.public String getJobRunId()
The ID of a previous JobRun
to retry.
JobRun
to retry.public StartJobRunRequest withJobRunId(String jobRunId)
The ID of a previous JobRun
to retry.
jobRunId
- The ID of a previous JobRun
to retry.public Map<String,String> getArguments()
The job arguments specifically for 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 specifically for 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 specifically for 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 StartJobRunRequest withArguments(Map<String,String> arguments)
The job arguments specifically for 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 specifically for 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 StartJobRunRequest addArgumentsEntry(String key, String value)
public StartJobRunRequest clearArgumentsEntries()
@Deprecated public void setAllocatedCapacity(Integer allocatedCapacity)
This field is deprecated. Use MaxCapacity
instead.
The number of AWS Glue data processing units (DPUs) to allocate 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) to allocate 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) to allocate 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) to allocate 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 StartJobRunRequest withAllocatedCapacity(Integer allocatedCapacity)
This field is deprecated. Use MaxCapacity
instead.
The number of AWS Glue data processing units (DPUs) to allocate 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) to allocate 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 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.
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 StartJobRunRequest 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.
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.
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.
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.
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 StartJobRunRequest 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.
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.
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.
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.
SecurityConfiguration
structure to be used with this job run.public StartJobRunRequest 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 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 StartJobRunRequest withNotificationProperty(NotificationProperty notificationProperty)
Specifies configuration properties of a job run notification.
notificationProperty
- Specifies configuration properties of a job run notification.public void setWorkerType(String 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.
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.
WorkerType
public String getWorkerType()
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.
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 StartJobRunRequest withWorkerType(String 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.
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.
WorkerType
public StartJobRunRequest withWorkerType(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.
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.
WorkerType
public void setNumberOfWorkers(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
.
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
.
public Integer getNumberOfWorkers()
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 StartJobRunRequest withNumberOfWorkers(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
.
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
.
public String toString()
toString
in class Object
Object.toString()
public StartJobRunRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.