Package software.amazon.awssdk.services.batch.model

Interface SubmitServiceJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BatchRequest.Builder, Buildable, CopyableBuilder<SubmitServiceJobRequest.Builder,SubmitServiceJobRequest>, SdkBuilder<SubmitServiceJobRequest.Builder,SubmitServiceJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SubmitServiceJobRequest

@Mutable
@NotThreadSafe
public static interface SubmitServiceJobRequest.Builder
extends BatchRequest.Builder, SdkPojo, CopyableBuilder<SubmitServiceJobRequest.Builder,SubmitServiceJobRequest>

Method Summary

Modifier and Type	Method	Description
SubmitServiceJobRequest.Builder	clientToken(String clientToken)	A unique identifier for the request.
SubmitServiceJobRequest.Builder	jobName(String jobName)	The name of the service job.
SubmitServiceJobRequest.Builder	jobQueue(String jobQueue)	The job queue into which the service job is submitted.
SubmitServiceJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SubmitServiceJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default SubmitServiceJobRequest.Builder	preemptionConfiguration(Consumer<ServiceJobPreemptionConfiguration.Builder> preemptionConfiguration)	Specifies the service job behavior when preempted.
SubmitServiceJobRequest.Builder	preemptionConfiguration(ServiceJobPreemptionConfiguration preemptionConfiguration)	Specifies the service job behavior when preempted.
SubmitServiceJobRequest.Builder	quotaShareName(String quotaShareName)	The quota share for the service job.
default SubmitServiceJobRequest.Builder	retryStrategy(Consumer<ServiceJobRetryStrategy.Builder> retryStrategy)	The retry strategy to use for failed service jobs that are submitted with this service job request.
SubmitServiceJobRequest.Builder	retryStrategy(ServiceJobRetryStrategy retryStrategy)	The retry strategy to use for failed service jobs that are submitted with this service job request.
SubmitServiceJobRequest.Builder	schedulingPriority(Integer schedulingPriority)	The scheduling priority of the service job.
SubmitServiceJobRequest.Builder	serviceJobType(String serviceJobType)	The type of service job.
SubmitServiceJobRequest.Builder	serviceJobType(ServiceJobType serviceJobType)	The type of service job.
SubmitServiceJobRequest.Builder	serviceRequestPayload(String serviceRequestPayload)	The request, in JSON, for the service that the SubmitServiceJob operation is queueing.
SubmitServiceJobRequest.Builder	shareIdentifier(String shareIdentifier)	The share identifier for the service job.
SubmitServiceJobRequest.Builder	tags(Map<String,String> tags)	The tags that you apply to the service job request.
default SubmitServiceJobRequest.Builder	timeoutConfig(Consumer<ServiceJobTimeout.Builder> timeoutConfig)	The timeout configuration for the service job.
SubmitServiceJobRequest.Builder	timeoutConfig(ServiceJobTimeout timeoutConfig)	The timeout configuration for the service job.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.batch.model.BatchRequest.Builder

build

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

copy

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 Detail

jobName

SubmitServiceJobRequest.Builder jobName(String jobName)

The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Parameters:

jobName - The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Returns:

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

jobQueue

SubmitServiceJobRequest.Builder jobQueue(String jobQueue)

The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type SAGEMAKER_TRAINING.

Parameters:

jobQueue - The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type SAGEMAKER_TRAINING.

Returns:

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

retryStrategy

SubmitServiceJobRequest.Builder retryStrategy(ServiceJobRetryStrategy retryStrategy)

The retry strategy to use for failed service jobs that are submitted with this service job request.

Parameters:

retryStrategy - The retry strategy to use for failed service jobs that are submitted with this service job request.

Returns:

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

retryStrategy

default SubmitServiceJobRequest.Builder retryStrategy(Consumer<ServiceJobRetryStrategy.Builder> retryStrategy)

The retry strategy to use for failed service jobs that are submitted with this service job request.

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

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

Parameters:

retryStrategy - a consumer that will call methods on ServiceJobRetryStrategy.Builder

Returns:

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

See Also:

retryStrategy(ServiceJobRetryStrategy)

schedulingPriority

SubmitServiceJobRequest.Builder schedulingPriority(Integer schedulingPriority)

The scheduling priority of the service job. Valid values are integers between 0 and 9999.

Parameters:

schedulingPriority - The scheduling priority of the service job. Valid values are integers between 0 and 9999.

Returns:

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

serviceRequestPayload

SubmitServiceJobRequest.Builder serviceRequestPayload(String serviceRequestPayload)

The request, in JSON, for the service that the SubmitServiceJob operation is queueing.

Parameters:

serviceRequestPayload - The request, in JSON, for the service that the SubmitServiceJob operation is queueing.

Returns:

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

serviceJobType

SubmitServiceJobRequest.Builder serviceJobType(String serviceJobType)

The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.

Parameters:

serviceJobType - The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.

Returns:

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

See Also:

ServiceJobType, ServiceJobType

serviceJobType

SubmitServiceJobRequest.Builder serviceJobType(ServiceJobType serviceJobType)

The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.

Parameters:

serviceJobType - The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.

Returns:

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

See Also:

ServiceJobType, ServiceJobType

shareIdentifier

SubmitServiceJobRequest.Builder shareIdentifier(String shareIdentifier)

The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.

Parameters:

shareIdentifier - The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.

Returns:

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

quotaShareName

SubmitServiceJobRequest.Builder quotaShareName(String quotaShareName)

The quota share for the service job. Don't specify this parameter if the job queue doesn't have a quota share scheduling policy. If the job queue has a quota share scheduling policy, then this parameter must be specified.

Parameters:

quotaShareName - The quota share for the service job. Don't specify this parameter if the job queue doesn't have a quota share scheduling policy. If the job queue has a quota share scheduling policy, then this parameter must be specified.

Returns:

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

preemptionConfiguration

SubmitServiceJobRequest.Builder preemptionConfiguration(ServiceJobPreemptionConfiguration preemptionConfiguration)

Specifies the service job behavior when preempted.

Parameters:

preemptionConfiguration - Specifies the service job behavior when preempted.

Returns:

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

preemptionConfiguration

default SubmitServiceJobRequest.Builder preemptionConfiguration(Consumer<ServiceJobPreemptionConfiguration.Builder> preemptionConfiguration)

Specifies the service job behavior when preempted.

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

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

Parameters:

preemptionConfiguration - a consumer that will call methods on ServiceJobPreemptionConfiguration.Builder

Returns:

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

See Also:

preemptionConfiguration(ServiceJobPreemptionConfiguration)

timeoutConfig

SubmitServiceJobRequest.Builder timeoutConfig(ServiceJobTimeout timeoutConfig)

The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.

Parameters:

timeoutConfig - The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.

Returns:

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

timeoutConfig

default SubmitServiceJobRequest.Builder timeoutConfig(Consumer<ServiceJobTimeout.Builder> timeoutConfig)

The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.

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

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

Parameters:

timeoutConfig - a consumer that will call methods on ServiceJobTimeout.Builder

Returns:

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

See Also:

timeoutConfig(ServiceJobTimeout)

tags

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

The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

Parameters:

tags - The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

Returns:

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

clientToken

SubmitServiceJobRequest.Builder clientToken(String clientToken)

A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and clientTokens are received, these requests are considered the same request and the second request is rejected.

Parameters:

clientToken - A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and clientTokens are received, these requests are considered the same request and the second request is rejected.

Returns:

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

overrideConfiguration

SubmitServiceJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder