Interface SubmitServiceJobRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,BatchRequest.Builder
,Buildable
,CopyableBuilder<SubmitServiceJobRequest.Builder,
,SubmitServiceJobRequest> SdkBuilder<SubmitServiceJobRequest.Builder,
,SubmitServiceJobRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SubmitServiceJobRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) A unique identifier for the request.The name of the service job.The job queue into which the service job is submitted.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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.retryStrategy
(ServiceJobRetryStrategy retryStrategy) The retry strategy to use for failed service jobs that are submitted with this service job request.schedulingPriority
(Integer schedulingPriority) The scheduling priority of the service job.serviceJobType
(String serviceJobType) The type of service job.serviceJobType
(ServiceJobType serviceJobType) The type of service job.serviceRequestPayload
(String serviceRequestPayload) The request, in JSON, for the service that the SubmitServiceJob operation is queueing.shareIdentifier
(String shareIdentifier) The share identifier for the service job.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.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 Details
-
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
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 typeSAGEMAKER_TRAINING
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theServiceJobRetryStrategy.Builder
avoiding the need to create one manually viaServiceJobRetryStrategy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretryStrategy(ServiceJobRetryStrategy)
.- Parameters:
retryStrategy
- a consumer that will call methods onServiceJobRetryStrategy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
The type of service job. For SageMaker Training jobs, specify
SAGEMAKER_TRAINING
.- Parameters:
serviceJobType
- The type of service job. For SageMaker Training jobs, specifySAGEMAKER_TRAINING
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serviceJobType
The type of service job. For SageMaker Training jobs, specify
SAGEMAKER_TRAINING
.- Parameters:
serviceJobType
- The type of service job. For SageMaker Training jobs, specifySAGEMAKER_TRAINING
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theServiceJobTimeout.Builder
avoiding the need to create one manually viaServiceJobTimeout.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimeoutConfig(ServiceJobTimeout)
.- Parameters:
timeoutConfig
- a consumer that will call methods onServiceJobTimeout.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
clientToken
s 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 andclientToken
s 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) 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
SubmitServiceJobRequest.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.
-