com.amazonaws.services.glue.model

Class StartJobRunRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.glue.model.StartJobRunRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartJobRunRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartJobRunRequest()

Method Summary

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() The number of AWS Glue data processing units (DPUs) to allocate to this JobRun.
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.
NotificationProperty	getNotificationProperty() Specifies configuration properties of a job run notification.
String	getSecurityConfiguration() The name of the SecurityConfiguration structure to be used with this job run.
Integer	getTimeout() The JobRun timeout in minutes.
int	hashCode()
void	setAllocatedCapacity(Integer allocatedCapacity) The number of AWS Glue data processing units (DPUs) to allocate to this JobRun.
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	setNotificationProperty(NotificationProperty notificationProperty) Specifies configuration properties of a job run notification.
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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StartJobRunRequest	withAllocatedCapacity(Integer allocatedCapacity) The number of AWS Glue data processing units (DPUs) to allocate to this JobRun.
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	withNotificationProperty(NotificationProperty notificationProperty) Specifies configuration properties of a job run notification.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartJobRunRequest

public StartJobRunRequest()

Method Detail

setJobName

public void setJobName(String jobName)

The name of the job definition to use.

Parameters:

jobName - The name of the job definition to use.

getJobName

public String getJobName()

The name of the job definition to use.

Returns:

The name of the job definition to use.

withJobName

public StartJobRunRequest withJobName(String jobName)

The name of the job definition to use.

Parameters:

jobName - The name of the job definition to use.

Returns:

Returns a reference to this object so that method calls can be chained together.

setJobRunId

public void setJobRunId(String jobRunId)

The ID of a previous JobRun to retry.

Parameters:

jobRunId - The ID of a previous JobRun to retry.

getJobRunId

public String getJobRunId()

The ID of a previous JobRun to retry.

Returns:

The ID of a previous JobRun to retry.

withJobRunId

public StartJobRunRequest withJobRunId(String jobRunId)

The ID of a previous JobRun to retry.

Parameters:

jobRunId - The ID of a previous JobRun to retry.

Returns:

Returns a reference to this object so that method calls can be chained together.

getArguments

public Map<String,String> getArguments()

The job arguments specifically for this run. They override the equivalent default arguments set for 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.

Returns:

The job arguments specifically for this run. They override the equivalent default arguments set for 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.

setArguments

public void setArguments(Map<String,String> arguments)

The job arguments specifically for this run. They override the equivalent default arguments set for 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.

Parameters:

arguments - The job arguments specifically for this run. They override the equivalent default arguments set for 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.

withArguments

public StartJobRunRequest withArguments(Map<String,String> arguments)

The job arguments specifically for this run. They override the equivalent default arguments set for 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.

Parameters:

arguments - The job arguments specifically for this run. They override the equivalent default arguments set for 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addArgumentsEntry

public StartJobRunRequest addArgumentsEntry(String key,
                                            String value)

clearArgumentsEntries

public StartJobRunRequest clearArgumentsEntries()

Removes all the entries added into Arguments.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAllocatedCapacity

public void setAllocatedCapacity(Integer allocatedCapacity)

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.

Parameters:

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

getAllocatedCapacity

public Integer getAllocatedCapacity()

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.

Returns:

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.

withAllocatedCapacity

public StartJobRunRequest withAllocatedCapacity(Integer allocatedCapacity)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setTimeout

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.

Parameters:

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.

getTimeout

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.

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.

withTimeout

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setNotificationProperty

public void setNotificationProperty(NotificationProperty notificationProperty)

Specifies configuration properties of a job run notification.

Parameters:

notificationProperty - Specifies configuration properties of a job run notification.

getNotificationProperty

public NotificationProperty getNotificationProperty()

Specifies configuration properties of a job run notification.

Returns:

Specifies configuration properties of a job run notification.

withNotificationProperty

public StartJobRunRequest withNotificationProperty(NotificationProperty notificationProperty)

Specifies configuration properties of a job run notification.

Parameters:

notificationProperty - Specifies configuration properties of a job run notification.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSecurityConfiguration

public void setSecurityConfiguration(String securityConfiguration)

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

Parameters:

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

getSecurityConfiguration

public String getSecurityConfiguration()

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.

withSecurityConfiguration

public StartJobRunRequest withSecurityConfiguration(String securityConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartJobRunRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()