Interface StartJobRunRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<StartJobRunRequest.Builder,
,StartJobRunRequest> EmrServerlessRequest.Builder
,SdkBuilder<StartJobRunRequest.Builder,
,StartJobRunRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartJobRunRequest
-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) The ID of the application on which to run the job.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.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.executionIamPolicy
(JobRunExecutionIamPolicy executionIamPolicy) You can pass an optional IAM policy.executionRoleArn
(String executionRoleArn) The execution role ARN for the job run.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.The job driver for the job run.The mode of the job run when it starts.mode
(JobRunMode mode) The mode of the job run when it starts.The optional job run name.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default StartJobRunRequest.Builder
retryPolicy
(Consumer<RetryPolicy.Builder> retryPolicy) The retry policy when job run starts.retryPolicy
(RetryPolicy retryPolicy) The retry policy when job run starts.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
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
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
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
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 theJobRunExecutionIamPolicy.Builder
avoiding the need to create one manually viaJobRunExecutionIamPolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexecutionIamPolicy(JobRunExecutionIamPolicy)
.- Parameters:
executionIamPolicy
- a consumer that will call methods onJobRunExecutionIamPolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The job driver for the job run.
This is a convenience method that creates an instance of theJobDriver.Builder
avoiding the need to create one manually viaJobDriver.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tojobDriver(JobDriver)
.- Parameters:
jobDriver
- a consumer that will call methods onJobDriver.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theConfigurationOverrides.Builder
avoiding the need to create one manually viaConfigurationOverrides.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconfigurationOverrides(ConfigurationOverrides)
.- Parameters:
configurationOverrides
- a consumer that will call methods onConfigurationOverrides.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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:
-
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:
-
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
The retry policy when job run starts.
This is a convenience method that creates an instance of theRetryPolicy.Builder
avoiding the need to create one manually viaRetryPolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretryPolicy(RetryPolicy)
.- Parameters:
retryPolicy
- a consumer that will call methods onRetryPolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
StartJobRunRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-