software.amazon.awssdk.services.glue.model

Interface StartJobRunRequest.Builder

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

Modifier and Type	Method and Description
StartJobRunRequest.Builder	allocatedCapacity(Integer allocatedCapacity) The number of AWS Glue data processing units (DPUs) to allocate to this JobRun.
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.
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	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
StartJobRunRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
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.

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

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

allocatedCapacity

StartJobRunRequest.Builder allocatedCapacity(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.

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.

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)

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.

overrideConfiguration

StartJobRunRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartJobRunRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.