Job (AWS Java SDK for AWS Glue 1.11.490 API)

java.lang.Object
- com.amazonaws.services.glue.model.Job

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Specifies a job definition.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Job()

Constructors
Constructor and Description
`Job()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Job`	`addDefaultArgumentsEntry(String key, String value)`
`Job`	`clearDefaultArgumentsEntries()` Removes all the entries added into DefaultArguments.
`Job`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getAllocatedCapacity()` Deprecated.
`JobCommand`	`getCommand()` The JobCommand that executes this job.
`ConnectionsList`	`getConnections()` The connections used for this job.
`Date`	`getCreatedOn()` The time and date that this job definition was created.
`Map<String,String>`	`getDefaultArguments()` The default arguments for this job, specified as name-value pairs.
`String`	`getDescription()` Description of the job being defined.
`ExecutionProperty`	`getExecutionProperty()` An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
`Date`	`getLastModifiedOn()` The last point in time when this job definition was modified.
`String`	`getLogUri()` This field is reserved for future use.
`Double`	`getMaxCapacity()` AWS Glue supports running jobs on a `JobCommand.Name`="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using `MaxCapacity`.
`Integer`	`getMaxRetries()` The maximum number of times to retry this job after a JobRun fails.
`String`	`getName()` The name you assign to this job definition.
`NotificationProperty`	`getNotificationProperty()` Specifies configuration properties of a job notification.
`String`	`getRole()` The name or ARN of the IAM role associated with this job.
`String`	`getSecurityConfiguration()` The name of the SecurityConfiguration structure to be used with this job.
`Integer`	`getTimeout()` The job timeout in minutes.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAllocatedCapacity(Integer allocatedCapacity)` Deprecated.
`void`	`setCommand(JobCommand command)` The JobCommand that executes this job.
`void`	`setConnections(ConnectionsList connections)` The connections used for this job.
`void`	`setCreatedOn(Date createdOn)` The time and date that this job definition was created.
`void`	`setDefaultArguments(Map<String,String> defaultArguments)` The default arguments for this job, specified as name-value pairs.
`void`	`setDescription(String description)` Description of the job being defined.
`void`	`setExecutionProperty(ExecutionProperty executionProperty)` An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
`void`	`setLastModifiedOn(Date lastModifiedOn)` The last point in time when this job definition was modified.
`void`	`setLogUri(String logUri)` This field is reserved for future use.
`void`	`setMaxCapacity(Double maxCapacity)` AWS Glue supports running jobs on a `JobCommand.Name`="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using `MaxCapacity`.
`void`	`setMaxRetries(Integer maxRetries)` The maximum number of times to retry this job after a JobRun fails.
`void`	`setName(String name)` The name you assign to this job definition.
`void`	`setNotificationProperty(NotificationProperty notificationProperty)` Specifies configuration properties of a job notification.
`void`	`setRole(String role)` The name or ARN of the IAM role associated with this job.
`void`	`setSecurityConfiguration(String securityConfiguration)` The name of the SecurityConfiguration structure to be used with this job.
`void`	`setTimeout(Integer timeout)` The job timeout in minutes.
`String`	`toString()` Returns a string representation of this object.
`Job`	`withAllocatedCapacity(Integer allocatedCapacity)` Deprecated.
`Job`	`withCommand(JobCommand command)` The JobCommand that executes this job.
`Job`	`withConnections(ConnectionsList connections)` The connections used for this job.
`Job`	`withCreatedOn(Date createdOn)` The time and date that this job definition was created.
`Job`	`withDefaultArguments(Map<String,String> defaultArguments)` The default arguments for this job, specified as name-value pairs.
`Job`	`withDescription(String description)` Description of the job being defined.
`Job`	`withExecutionProperty(ExecutionProperty executionProperty)` An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
`Job`	`withLastModifiedOn(Date lastModifiedOn)` The last point in time when this job definition was modified.
`Job`	`withLogUri(String logUri)` This field is reserved for future use.
`Job`	`withMaxCapacity(Double maxCapacity)` AWS Glue supports running jobs on a `JobCommand.Name`="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using `MaxCapacity`.
`Job`	`withMaxRetries(Integer maxRetries)` The maximum number of times to retry this job after a JobRun fails.
`Job`	`withName(String name)` The name you assign to this job definition.
`Job`	`withNotificationProperty(NotificationProperty notificationProperty)` Specifies configuration properties of a job notification.
`Job`	`withRole(String role)` The name or ARN of the IAM role associated with this job.
`Job`	`withSecurityConfiguration(String securityConfiguration)` The name of the SecurityConfiguration structure to be used with this job.
`Job`	`withTimeout(Integer timeout)` The job timeout in minutes.

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

- Constructor Detail
  - Job
```
public Job()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name you assign to this job definition.
    
    Parameters:
    
    name - The name you assign to this job definition.
  - getName
```
public String getName()
```
    The name you assign to this job definition.
    
    Returns:
    
    The name you assign to this job definition.
  - withName
```
public Job withName(String name)
```
    The name you assign to this job definition.
    
    Parameters:
    
    name - The name you assign to this job definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    Description of the job being defined.
    
    Parameters:
    
    description - Description of the job being defined.
  - getDescription
```
public String getDescription()
```
    Description of the job being defined.
    
    Returns:
    
    Description of the job being defined.
  - withDescription
```
public Job withDescription(String description)
```
    Description of the job being defined.
    
    Parameters:
    
    description - Description of the job being defined.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogUri
```
public void setLogUri(String logUri)
```
    This field is reserved for future use.
    
    Parameters:
    
    logUri - This field is reserved for future use.
  - getLogUri
```
public String getLogUri()
```
    This field is reserved for future use.
    
    Returns:
    
    This field is reserved for future use.
  - withLogUri
```
public Job withLogUri(String logUri)
```
    This field is reserved for future use.
    
    Parameters:
    
    logUri - This field is reserved for future use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRole
```
public void setRole(String role)
```
    The name or ARN of the IAM role associated with this job.
    
    Parameters:
    
    role - The name or ARN of the IAM role associated with this job.
  - getRole
```
public String getRole()
```
    The name or ARN of the IAM role associated with this job.
    
    Returns:
    
    The name or ARN of the IAM role associated with this job.
  - withRole
```
public Job withRole(String role)
```
    The name or ARN of the IAM role associated with this job.
    
    Parameters:
    
    role - The name or ARN of the IAM role associated with this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedOn
```
public void setCreatedOn(Date createdOn)
```
    The time and date that this job definition was created.
    
    Parameters:
    
    createdOn - The time and date that this job definition was created.
  - getCreatedOn
```
public Date getCreatedOn()
```
    The time and date that this job definition was created.
    
    Returns:
    
    The time and date that this job definition was created.
  - withCreatedOn
```
public Job withCreatedOn(Date createdOn)
```
    The time and date that this job definition was created.
    
    Parameters:
    
    createdOn - The time and date that this job definition was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedOn
```
public void setLastModifiedOn(Date lastModifiedOn)
```
    The last point in time when this job definition was modified.
    
    Parameters:
    
    lastModifiedOn - The last point in time when this job definition was modified.
  - getLastModifiedOn
```
public Date getLastModifiedOn()
```
    The last point in time when this job definition was modified.
    
    Returns:
    
    The last point in time when this job definition was modified.
  - withLastModifiedOn
```
public Job withLastModifiedOn(Date lastModifiedOn)
```
    The last point in time when this job definition was modified.
    
    Parameters:
    
    lastModifiedOn - The last point in time when this job definition was modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionProperty
```
public void setExecutionProperty(ExecutionProperty executionProperty)
```
    An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
    
    Parameters:
    
    executionProperty - An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
  - getExecutionProperty
```
public ExecutionProperty getExecutionProperty()
```
    An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
    
    Returns:
    
    An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
  - withExecutionProperty
```
public Job withExecutionProperty(ExecutionProperty executionProperty)
```
    An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
    
    Parameters:
    
    executionProperty - An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCommand
```
public void setCommand(JobCommand command)
```
    The JobCommand that executes this job.
    
    Parameters:
    
    command - The JobCommand that executes this job.
  - getCommand
```
public JobCommand getCommand()
```
    The JobCommand that executes this job.
    
    Returns:
    
    The JobCommand that executes this job.
  - withCommand
```
public Job withCommand(JobCommand command)
```
    The JobCommand that executes this job.
    
    Parameters:
    
    command - The JobCommand that executes this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDefaultArguments
```
public Map<String,String> getDefaultArguments()
```
    The default arguments for this job, specified as name-value pairs.
    
    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 default arguments for this job, specified as name-value pairs.
    
    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.
  - setDefaultArguments
```
public void setDefaultArguments(Map<String,String> defaultArguments)
```
    The default arguments for this job, specified as name-value pairs.
    
    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:
    
    defaultArguments - The default arguments for this job, specified as name-value pairs.
    
    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.
  - withDefaultArguments
```
public Job withDefaultArguments(Map<String,String> defaultArguments)
```
    The default arguments for this job, specified as name-value pairs.
    
    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:
    
    defaultArguments - The default arguments for this job, specified as name-value pairs.
    
    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.
  - addDefaultArgumentsEntry
```
public Job addDefaultArgumentsEntry(String key,
                                    String value)
```
  - clearDefaultArgumentsEntries
```
public Job clearDefaultArgumentsEntries()
```
    Removes all the entries added into DefaultArguments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnections
```
public void setConnections(ConnectionsList connections)
```
    The connections used for this job.
    
    Parameters:
    
    connections - The connections used for this job.
  - getConnections
```
public ConnectionsList getConnections()
```
    The connections used for this job.
    
    Returns:
    
    The connections used for this job.
  - withConnections
```
public Job withConnections(ConnectionsList connections)
```
    The connections used for this job.
    
    Parameters:
    
    connections - The connections used for this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxRetries
```
public void setMaxRetries(Integer maxRetries)
```
    The maximum number of times to retry this job after a JobRun fails.
    
    Parameters:
    
    maxRetries - The maximum number of times to retry this job after a JobRun fails.
  - getMaxRetries
```
public Integer getMaxRetries()
```
    The maximum number of times to retry this job after a JobRun fails.
    
    Returns:
    
    The maximum number of times to retry this job after a JobRun fails.
  - withMaxRetries
```
public Job withMaxRetries(Integer maxRetries)
```
    The maximum number of times to retry this job after a JobRun fails.
    
    Parameters:
    
    maxRetries - The maximum number of times to retry this job after a JobRun fails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAllocatedCapacity
```
@Deprecated
public void setAllocatedCapacity(Integer allocatedCapacity)
```
    Deprecated.
    
    This field is deprecated, use MaxCapacity instead.
    
    The number of AWS Glue data processing units (DPUs) allocated to runs of this job. 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 - This field is deprecated, use MaxCapacity instead.
    
    The number of AWS Glue data processing units (DPUs) allocated to runs of this job. 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
```
@Deprecated
public Integer getAllocatedCapacity()
```
    Deprecated.
    
    This field is deprecated, use MaxCapacity instead.
    
    The number of AWS Glue data processing units (DPUs) allocated to runs of this job. 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:
    
    This field is deprecated, use MaxCapacity instead.
    
    The number of AWS Glue data processing units (DPUs) allocated to runs of this job. 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
```
@Deprecated
public Job withAllocatedCapacity(Integer allocatedCapacity)
```
    Deprecated.
    
    This field is deprecated, use MaxCapacity instead.
    
    The number of AWS Glue data processing units (DPUs) allocated to runs of this job. 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 - This field is deprecated, use MaxCapacity instead.
    
    The number of AWS Glue data processing units (DPUs) allocated to runs of this job. 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 job 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).
    
    Parameters:
    
    timeout - The job 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).
  - getTimeout
```
public Integer getTimeout()
```
    The job 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).
    
    Returns:
    
    The job 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).
  - withTimeout
```
public Job withTimeout(Integer timeout)
```
    The job 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).
    
    Parameters:
    
    timeout - The job 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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxCapacity
```
public void setMaxCapacity(Double maxCapacity)
```
    AWS Glue supports running jobs on a JobCommand.Name="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity. Glue ETL jobs running in any other way cannot have fractional DPU allocations.
    
    Parameters:
    
    maxCapacity - AWS Glue supports running jobs on a JobCommand.Name="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity. Glue ETL jobs running in any other way cannot have fractional DPU allocations.
  - getMaxCapacity
```
public Double getMaxCapacity()
```
    AWS Glue supports running jobs on a JobCommand.Name="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity. Glue ETL jobs running in any other way cannot have fractional DPU allocations.
    
    Returns:
    
    AWS Glue supports running jobs on a JobCommand.Name="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity. Glue ETL jobs running in any other way cannot have fractional DPU allocations.
  - withMaxCapacity
```
public Job withMaxCapacity(Double maxCapacity)
```
    AWS Glue supports running jobs on a JobCommand.Name="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity. Glue ETL jobs running in any other way cannot have fractional DPU allocations.
    
    Parameters:
    
    maxCapacity - AWS Glue supports running jobs on a JobCommand.Name="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity. Glue ETL jobs running in any other way cannot have fractional DPU allocations.
    
    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 notification.
    
    Parameters:
    
    notificationProperty - Specifies configuration properties of a job notification.
  - getNotificationProperty
```
public NotificationProperty getNotificationProperty()
```
    Specifies configuration properties of a job notification.
    
    Returns:
    
    Specifies configuration properties of a job notification.
  - withNotificationProperty
```
public Job withNotificationProperty(NotificationProperty notificationProperty)
```
    Specifies configuration properties of a job notification.
    
    Parameters:
    
    notificationProperty - Specifies configuration properties of a job 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.
    
    Parameters:
    
    securityConfiguration - The name of the SecurityConfiguration structure to be used with this job.
  - getSecurityConfiguration
```
public String getSecurityConfiguration()
```
    The name of the SecurityConfiguration structure to be used with this job.
    
    Returns:
    
    The name of the SecurityConfiguration structure to be used with this job.
  - withSecurityConfiguration
```
public Job withSecurityConfiguration(String securityConfiguration)
```
    The name of the SecurityConfiguration structure to be used with this job.
    
    Parameters:
    
    securityConfiguration - The name of the SecurityConfiguration structure to be used with this job.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 Job clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Job

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Job

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setLogUri

getLogUri

withLogUri

setRole

getRole

withRole

setCreatedOn

getCreatedOn

withCreatedOn

setLastModifiedOn

getLastModifiedOn

withLastModifiedOn

setExecutionProperty

getExecutionProperty

withExecutionProperty

setCommand

getCommand

withCommand

getDefaultArguments

setDefaultArguments

withDefaultArguments

addDefaultArgumentsEntry

clearDefaultArgumentsEntries

setConnections

getConnections

withConnections

setMaxRetries

getMaxRetries

withMaxRetries

setAllocatedCapacity

getAllocatedCapacity

withAllocatedCapacity

setTimeout

getTimeout

withTimeout

setMaxCapacity

getMaxCapacity

withMaxCapacity

setNotificationProperty

getNotificationProperty

withNotificationProperty

setSecurityConfiguration

getSecurityConfiguration

withSecurityConfiguration

toString

equals

hashCode

clone

marshall