StartJobRunRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartJobRunRequest.Builder,StartJobRunRequest>, GlueRequest.Builder, SdkBuilder<StartJobRunRequest.Builder,StartJobRunRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartJobRunRequest
```
public static interface StartJobRunRequest.Builder
extends GlueRequest.Builder, SdkPojo, CopyableBuilder<StartJobRunRequest.Builder,StartJobRunRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`StartJobRunRequest.Builder`	`allocatedCapacity(Integer allocatedCapacity)` This field is deprecated.
`StartJobRunRequest.Builder`	`arguments(Map<String,String> arguments)` The job arguments specifically for this run.
`StartJobRunRequest.Builder`	`jobName(String jobName)` The name of the job definition to use.
`StartJobRunRequest.Builder`	`jobRunId(String jobRunId)` The ID of a previous `JobRun` to retry.
`StartJobRunRequest.Builder`	`maxCapacity(Double maxCapacity)` The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
`default StartJobRunRequest.Builder`	`notificationProperty(Consumer<NotificationProperty.Builder> notificationProperty)` Specifies configuration properties of a job run notification.
`StartJobRunRequest.Builder`	`notificationProperty(NotificationProperty notificationProperty)` Specifies configuration properties of a job run notification.
`StartJobRunRequest.Builder`	`numberOfWorkers(Integer numberOfWorkers)` The number of workers of a defined `workerType` that are allocated when a job runs.
`StartJobRunRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`StartJobRunRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`StartJobRunRequest.Builder`	`securityConfiguration(String securityConfiguration)` The name of the `SecurityConfiguration` structure to be used with this job run.
`StartJobRunRequest.Builder`	`timeout(Integer timeout)` The `JobRun` timeout in minutes.
`StartJobRunRequest.Builder`	`workerType(String workerType)` The type of predefined worker that is allocated when a job runs.
`StartJobRunRequest.Builder`	`workerType(WorkerType workerType)` The type of predefined worker that is allocated when a job runs.

Methods inherited from interface software.amazon.awssdk.services.glue.model.GlueRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - jobName
```
StartJobRunRequest.Builder jobName(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.
  - jobRunId
```
StartJobRunRequest.Builder jobRunId(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.
  - arguments
```
StartJobRunRequest.Builder arguments(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - allocatedCapacity
```
StartJobRunRequest.Builder allocatedCapacity(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - timeout
```
StartJobRunRequest.Builder timeout(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.
  - maxCapacity
```
StartJobRunRequest.Builder maxCapacity(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - securityConfiguration
```
StartJobRunRequest.Builder securityConfiguration(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.
  - notificationProperty
```
StartJobRunRequest.Builder notificationProperty(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.
  - notificationProperty
```
default StartJobRunRequest.Builder notificationProperty(Consumer<NotificationProperty.Builder> notificationProperty)
```
    Specifies configuration properties of a job run notification.
    This is a convenience that creates an instance of the NotificationProperty.Builder avoiding the need to create one manually via NotificationProperty.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notificationProperty(NotificationProperty).
    
    Parameters:
    
    notificationProperty - a consumer that will call methods on NotificationProperty.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    notificationProperty(NotificationProperty)
  - workerType
```
StartJobRunRequest.Builder workerType(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkerType, WorkerType
  - workerType
```
StartJobRunRequest.Builder workerType(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkerType, WorkerType
  - numberOfWorkers
```
StartJobRunRequest.Builder numberOfWorkers(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.
    
    Parameters:
    
    numberOfWorkers - The number of workers of a defined workerType that are allocated when a job runs.
    
    The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
StartJobRunRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
StartJobRunRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface StartJobRunRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.glue.model.GlueRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

jobName

jobRunId

arguments

allocatedCapacity

timeout

maxCapacity

securityConfiguration

notificationProperty

notificationProperty

workerType

workerType

numberOfWorkers

overrideConfiguration

overrideConfiguration