StartJobRunRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.glue.model.GlueRequest
    - - software.amazon.awssdk.services.glue.model.StartJobRunRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartJobRunRequest.Builder,StartJobRunRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartJobRunRequest
extends GlueRequest
implements ToCopyableBuilder<StartJobRunRequest.Builder,StartJobRunRequest>

Property Summary

All Methods Instance Methods Concrete Methods
Type Property and Description

NotificationProperty notification
Specifies configuration properties of a job run notification.

All Methods Instance Methods Concrete Methods
Type	Property and Description
`NotificationProperty`	`notification` Specifies configuration properties of a job run notification.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartJobRunRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartJobRunRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`allocatedCapacity()` This field is deprecated.
`Map<String,String>`	`arguments()` The job arguments specifically for this run.
`static StartJobRunRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasArguments()` Returns true if the Arguments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`String`	`jobName()` The name of the job definition to use.
`String`	`jobRunId()` The ID of a previous `JobRun` to retry.
`Double`	`maxCapacity()` The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
`NotificationProperty`	`notificationProperty()` Specifies configuration properties of a job run notification.
`Integer`	`numberOfWorkers()` The number of workers of a defined `workerType` that are allocated when a job runs.
`List<SdkField<?>>`	`sdkFields()`
`String`	`securityConfiguration()` The name of the `SecurityConfiguration` structure to be used with this job run.
`static Class<? extends StartJobRunRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`timeout()` The `JobRun` timeout in minutes.
`StartJobRunRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`WorkerType`	`workerType()` The type of predefined worker that is allocated when a job runs.
`String`	`workerTypeAsString()` The type of predefined worker that is allocated when a job runs.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

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

- Property Detail
  - notification
```
public NotificationProperty notificationProperty
```
    Specifies configuration properties of a job run notification.
- Method Detail
  - jobName
```
public String jobName()
```
    The name of the job definition to use.
    
    Returns:
    
    The name of the job definition to use.
  - jobRunId
```
public String jobRunId()
```
    The ID of a previous JobRun to retry.
    
    Returns:
    
    The ID of a previous JobRun to retry.
  - hasArguments
```
public boolean hasArguments()
```
    Returns true if the Arguments property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - arguments
```
public 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasArguments() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - allocatedCapacity
```
public 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.
    
    Returns:
    
    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.
  - timeout
```
public 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.
    
    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.
  - maxCapacity
```
public 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.
    Returns:
    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.
  - securityConfiguration
```
public String securityConfiguration()
```
    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.
  - notificationProperty
```
public NotificationProperty notificationProperty()
```
    Specifies configuration properties of a job run notification.
  - workerType
```
public 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.
    If the service returns an enum value that is not available in the current SDK version, workerType will return WorkerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from workerTypeAsString().
    Returns:
    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.
    See Also:
    
    WorkerType
  - workerTypeAsString
```
public String workerTypeAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, workerType will return WorkerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from workerTypeAsString().
    Returns:
    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.
    See Also:
    
    WorkerType
  - numberOfWorkers
```
public 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.
    
    Returns:
    
    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.
  - toBuilder
```
public StartJobRunRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartJobRunRequest.Builder,StartJobRunRequest>
    
    Specified by:
    
    toBuilder in class GlueRequest
  - builder
```
public static StartJobRunRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartJobRunRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartJobRunRequest

Property Summary

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Property Detail

notification

Method Detail

jobName

jobRunId

hasArguments

arguments

allocatedCapacity

timeout

maxCapacity

securityConfiguration

notificationProperty

workerType

workerTypeAsString

numberOfWorkers

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields