Interface StartJobRunRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartJobRunRequest

@Mutable
@NotThreadSafe
public static interface StartJobRunRequest.Builder
extends EmrServerlessRequest.Builder, SdkPojo, CopyableBuilder<StartJobRunRequest.Builder,StartJobRunRequest>

Method Summary

Modifier and Type	Method	Description
StartJobRunRequest.Builder	applicationId(String applicationId)	The ID of the application on which to run the job.
StartJobRunRequest.Builder	clientToken(String clientToken)	The client idempotency token of the job run to start.
default StartJobRunRequest.Builder	configurationOverrides(Consumer<ConfigurationOverrides.Builder> configurationOverrides)	The configuration overrides for the job run.
StartJobRunRequest.Builder	configurationOverrides(ConfigurationOverrides configurationOverrides)	The configuration overrides for the job run.
default StartJobRunRequest.Builder	executionIamPolicy(Consumer<JobRunExecutionIamPolicy.Builder> executionIamPolicy)	You can pass an optional IAM policy.
StartJobRunRequest.Builder	executionIamPolicy(JobRunExecutionIamPolicy executionIamPolicy)	You can pass an optional IAM policy.
StartJobRunRequest.Builder	executionRoleArn(String executionRoleArn)	The execution role ARN for the job run.
StartJobRunRequest.Builder	executionTimeoutMinutes(Long executionTimeoutMinutes)	The maximum duration for the job run to run.
default StartJobRunRequest.Builder	jobDriver(Consumer<JobDriver.Builder> jobDriver)	The job driver for the job run.
StartJobRunRequest.Builder	jobDriver(JobDriver jobDriver)	The job driver for the job run.
StartJobRunRequest.Builder	mode(String mode)	The mode of the job run when it starts.
StartJobRunRequest.Builder	mode(JobRunMode mode)	The mode of the job run when it starts.
StartJobRunRequest.Builder	name(String name)	The optional job run name.
StartJobRunRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartJobRunRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default StartJobRunRequest.Builder	retryPolicy(Consumer<RetryPolicy.Builder> retryPolicy)	The retry policy when job run starts.
StartJobRunRequest.Builder	retryPolicy(RetryPolicy retryPolicy)	The retry policy when job run starts.
StartJobRunRequest.Builder	tags(Map<String,String> tags)	The tags assigned to the job run.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.emrserverless.model.EmrServerlessRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

applicationId

StartJobRunRequest.Builder applicationId(String applicationId)

The ID of the application on which to run the job.

Parameters:

applicationId - The ID of the application on which to run the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

StartJobRunRequest.Builder clientToken(String clientToken)

The client idempotency token of the job run to start. Its value must be unique for each request.

Parameters:

clientToken - The client idempotency token of the job run to start. Its value must be unique for each request.

Returns:

Returns a reference to this object so that method calls can be chained together.

executionRoleArn

StartJobRunRequest.Builder executionRoleArn(String executionRoleArn)

The execution role ARN for the job run.

Parameters:

executionRoleArn - The execution role ARN for the job run.

Returns:

Returns a reference to this object so that method calls can be chained together.

executionIamPolicy

StartJobRunRequest.Builder executionIamPolicy(JobRunExecutionIamPolicy executionIamPolicy)

You can pass an optional IAM policy. The resulting job IAM role permissions will be an intersection of this policy and the policy associated with your job execution role.

Parameters:

executionIamPolicy - You can pass an optional IAM policy. The resulting job IAM role permissions will be an intersection of this policy and the policy associated with your job execution role.

Returns:

Returns a reference to this object so that method calls can be chained together.

executionIamPolicy

default StartJobRunRequest.Builder executionIamPolicy(Consumer<JobRunExecutionIamPolicy.Builder> executionIamPolicy)

You can pass an optional IAM policy. The resulting job IAM role permissions will be an intersection of this policy and the policy associated with your job execution role.

This is a convenience method that creates an instance of the JobRunExecutionIamPolicy.Builder avoiding the need to create one manually via JobRunExecutionIamPolicy.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to executionIamPolicy(JobRunExecutionIamPolicy).

Parameters:

executionIamPolicy - a consumer that will call methods on JobRunExecutionIamPolicy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• executionIamPolicy(JobRunExecutionIamPolicy)

jobDriver

StartJobRunRequest.Builder jobDriver(JobDriver jobDriver)

The job driver for the job run.

Parameters:

jobDriver - The job driver for the job run.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobDriver

default StartJobRunRequest.Builder jobDriver(Consumer<JobDriver.Builder> jobDriver)

The job driver for the job run.

This is a convenience method that creates an instance of the JobDriver.Builder avoiding the need to create one manually via JobDriver.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobDriver(JobDriver).

Parameters:

jobDriver - a consumer that will call methods on JobDriver.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• jobDriver(JobDriver)

configurationOverrides

StartJobRunRequest.Builder configurationOverrides(ConfigurationOverrides configurationOverrides)

The configuration overrides for the job run.

Parameters:

configurationOverrides - The configuration overrides for the job run.

Returns:

Returns a reference to this object so that method calls can be chained together.

configurationOverrides

default StartJobRunRequest.Builder configurationOverrides(Consumer<ConfigurationOverrides.Builder> configurationOverrides)

The configuration overrides for the job run.

This is a convenience method that creates an instance of the ConfigurationOverrides.Builder avoiding the need to create one manually via ConfigurationOverrides.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configurationOverrides(ConfigurationOverrides).

Parameters:

configurationOverrides - a consumer that will call methods on ConfigurationOverrides.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• configurationOverrides(ConfigurationOverrides)

tags

StartJobRunRequest.Builder tags(Map<String,String> tags)

The tags assigned to the job run.

Parameters:

tags - The tags assigned to the job run.

Returns:

Returns a reference to this object so that method calls can be chained together.

executionTimeoutMinutes

StartJobRunRequest.Builder executionTimeoutMinutes(Long executionTimeoutMinutes)

The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.

Parameters:

executionTimeoutMinutes - The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

StartJobRunRequest.Builder name(String name)

The optional job run name. This doesn't have to be unique.

Parameters:

name - The optional job run name. This doesn't have to be unique.

Returns:

Returns a reference to this object so that method calls can be chained together.

mode

StartJobRunRequest.Builder mode(String mode)

The mode of the job run when it starts.

Parameters:

mode - The mode of the job run when it starts.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• JobRunMode
• JobRunMode

mode

StartJobRunRequest.Builder mode(JobRunMode mode)

The mode of the job run when it starts.

Parameters:

mode - The mode of the job run when it starts.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• JobRunMode
• JobRunMode

retryPolicy

StartJobRunRequest.Builder retryPolicy(RetryPolicy retryPolicy)

The retry policy when job run starts.

Parameters:

retryPolicy - The retry policy when job run starts.

Returns:

Returns a reference to this object so that method calls can be chained together.

retryPolicy

default StartJobRunRequest.Builder retryPolicy(Consumer<RetryPolicy.Builder> retryPolicy)

The retry policy when job run starts.

This is a convenience method that creates an instance of the RetryPolicy.Builder avoiding the need to create one manually via RetryPolicy.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryPolicy(RetryPolicy).

Parameters:

retryPolicy - a consumer that will call methods on RetryPolicy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• retryPolicy(RetryPolicy)

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.