software.amazon.awssdk.services.glue.model

Class StartJobRunRequest

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

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

Method Summary

Modifier and Type	Method and Description
Integer	allocatedCapacity() The number of AWS Glue data processing units (DPUs) to allocate to this JobRun.
Map<String,String>	arguments() The job arguments specifically for this run.
static StartJobRunRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	jobName() The name of the job definition to use.
String	jobRunId() The ID of a previous JobRun to retry.
NotificationProperty	notificationProperty() Specifies configuration properties of a job run notification.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

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.

arguments

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

allocatedCapacity

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

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.

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.

notificationProperty

public NotificationProperty notificationProperty()

Specifies configuration properties of a job run notification.

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.

toBuilder

public StartJobRunRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StartJobRunRequest.Builder,StartJobRunRequest>

Specified by:

toBuilder in class GlueRequest

Returns:

a builder for type T

builder

public static StartJobRunRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartJobRunRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.