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

Interface DescribeServiceJobResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BatchResponse.Builder, Buildable, CopyableBuilder<DescribeServiceJobResponse.Builder,DescribeServiceJobResponse>, SdkBuilder<DescribeServiceJobResponse.Builder,DescribeServiceJobResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeServiceJobResponse

@Mutable
@NotThreadSafe
public static interface DescribeServiceJobResponse.Builder
extends BatchResponse.Builder, SdkPojo, CopyableBuilder<DescribeServiceJobResponse.Builder,DescribeServiceJobResponse>

Method Summary

Modifier and Type	Method	Description
DescribeServiceJobResponse.Builder	attempts(Collection<ServiceJobAttemptDetail> attempts)	A list of job attempts associated with the service job.
DescribeServiceJobResponse.Builder	attempts(Consumer<ServiceJobAttemptDetail.Builder>... attempts)	A list of job attempts associated with the service job.
DescribeServiceJobResponse.Builder	attempts(ServiceJobAttemptDetail... attempts)	A list of job attempts associated with the service job.
DescribeServiceJobResponse.Builder	capacityUsage(Collection<ServiceJobCapacityUsageDetail> capacityUsage)	The configured capacity for the service job, such as the number of instances.
DescribeServiceJobResponse.Builder	capacityUsage(Consumer<ServiceJobCapacityUsageDetail.Builder>... capacityUsage)	The configured capacity for the service job, such as the number of instances.
DescribeServiceJobResponse.Builder	capacityUsage(ServiceJobCapacityUsageDetail... capacityUsage)	The configured capacity for the service job, such as the number of instances.
DescribeServiceJobResponse.Builder	createdAt(Long createdAt)	The Unix timestamp (in milliseconds) for when the service job was created.
DescribeServiceJobResponse.Builder	isTerminated(Boolean isTerminated)	Indicates whether the service job has been terminated.
DescribeServiceJobResponse.Builder	jobArn(String jobArn)	The Amazon Resource Name (ARN) of the service job.
DescribeServiceJobResponse.Builder	jobId(String jobId)	The job ID for the service job.
DescribeServiceJobResponse.Builder	jobName(String jobName)	The name of the service job.
DescribeServiceJobResponse.Builder	jobQueue(String jobQueue)	The ARN of the job queue that the service job is associated with.
default DescribeServiceJobResponse.Builder	latestAttempt(Consumer<LatestServiceJobAttempt.Builder> latestAttempt)	The latest attempt associated with the service job.
DescribeServiceJobResponse.Builder	latestAttempt(LatestServiceJobAttempt latestAttempt)	The latest attempt associated with the service job.
default DescribeServiceJobResponse.Builder	preemptionConfiguration(Consumer<ServiceJobPreemptionConfiguration.Builder> preemptionConfiguration)	Specifies the service job behavior when preempted.
DescribeServiceJobResponse.Builder	preemptionConfiguration(ServiceJobPreemptionConfiguration preemptionConfiguration)	Specifies the service job behavior when preempted.
default DescribeServiceJobResponse.Builder	preemptionSummary(Consumer<ServiceJobPreemptionSummary.Builder> preemptionSummary)	Summarizes the preemptions of the service job.
DescribeServiceJobResponse.Builder	preemptionSummary(ServiceJobPreemptionSummary preemptionSummary)	Summarizes the preemptions of the service job.
DescribeServiceJobResponse.Builder	quotaShareName(String quotaShareName)	The name of the quota share that the service job is associated with.
default DescribeServiceJobResponse.Builder	retryStrategy(Consumer<ServiceJobRetryStrategy.Builder> retryStrategy)	The retry strategy to use for failed service jobs that are submitted with this service job.
DescribeServiceJobResponse.Builder	retryStrategy(ServiceJobRetryStrategy retryStrategy)	The retry strategy to use for failed service jobs that are submitted with this service job.
DescribeServiceJobResponse.Builder	scheduledAt(Long scheduledAt)	The Unix timestamp (in milliseconds) for when the service job was scheduled.
DescribeServiceJobResponse.Builder	schedulingPriority(Integer schedulingPriority)	The scheduling priority of the service job.
DescribeServiceJobResponse.Builder	serviceJobType(String serviceJobType)	The type of service job.
DescribeServiceJobResponse.Builder	serviceJobType(ServiceJobType serviceJobType)	The type of service job.
DescribeServiceJobResponse.Builder	serviceRequestPayload(String serviceRequestPayload)	The request, in JSON, for the service that the SubmitServiceJob operation is queueing.
DescribeServiceJobResponse.Builder	shareIdentifier(String shareIdentifier)	The share identifier for the service job.
DescribeServiceJobResponse.Builder	startedAt(Long startedAt)	The Unix timestamp (in milliseconds) for when the service job was started.
DescribeServiceJobResponse.Builder	status(String status)	The current status of the service job.
DescribeServiceJobResponse.Builder	status(ServiceJobStatus status)	The current status of the service job.
DescribeServiceJobResponse.Builder	statusReason(String statusReason)	A short, human-readable string to provide more details for the current status of the service job.
DescribeServiceJobResponse.Builder	stoppedAt(Long stoppedAt)	The Unix timestamp (in milliseconds) for when the service job stopped running.
DescribeServiceJobResponse.Builder	tags(Map<String,String> tags)	The tags that are associated with the service job.
default DescribeServiceJobResponse.Builder	timeoutConfig(Consumer<ServiceJobTimeout.Builder> timeoutConfig)	The timeout configuration for the service job.
DescribeServiceJobResponse.Builder	timeoutConfig(ServiceJobTimeout timeoutConfig)	The timeout configuration for the service job.

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

build, responseMetadata, responseMetadata

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

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

attempts

DescribeServiceJobResponse.Builder attempts(Collection<ServiceJobAttemptDetail> attempts)

A list of job attempts associated with the service job.

Parameters:

attempts - A list of job attempts associated with the service job.

Returns:

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

attempts

DescribeServiceJobResponse.Builder attempts(ServiceJobAttemptDetail... attempts)

A list of job attempts associated with the service job.

Parameters:

attempts - A list of job attempts associated with the service job.

Returns:

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

attempts

DescribeServiceJobResponse.Builder attempts(Consumer<ServiceJobAttemptDetail.Builder>... attempts)

A list of job attempts associated with the service job.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attempts(List<ServiceJobAttemptDetail>).

Parameters:

attempts - a consumer that will call methods on ServiceJobAttemptDetail.Builder

Returns:

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

See Also:

• attempts(java.util.Collection<ServiceJobAttemptDetail>)

capacityUsage

DescribeServiceJobResponse.Builder capacityUsage(Collection<ServiceJobCapacityUsageDetail> capacityUsage)

The configured capacity for the service job, such as the number of instances. The number of instances should be the same value as the serviceRequestPayload.InstanceCount field.

Parameters:

capacityUsage - The configured capacity for the service job, such as the number of instances. The number of instances should be the same value as the serviceRequestPayload.InstanceCount field.

Returns:

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

capacityUsage

DescribeServiceJobResponse.Builder capacityUsage(ServiceJobCapacityUsageDetail... capacityUsage)

The configured capacity for the service job, such as the number of instances. The number of instances should be the same value as the serviceRequestPayload.InstanceCount field.

Parameters:

capacityUsage - The configured capacity for the service job, such as the number of instances. The number of instances should be the same value as the serviceRequestPayload.InstanceCount field.

Returns:

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

capacityUsage

DescribeServiceJobResponse.Builder capacityUsage(Consumer<ServiceJobCapacityUsageDetail.Builder>... capacityUsage)

The configured capacity for the service job, such as the number of instances. The number of instances should be the same value as the serviceRequestPayload.InstanceCount field.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capacityUsage(List<ServiceJobCapacityUsageDetail>).

Parameters:

capacityUsage - a consumer that will call methods on ServiceJobCapacityUsageDetail.Builder

Returns:

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

See Also:

• capacityUsage(java.util.Collection<ServiceJobCapacityUsageDetail>)

createdAt

DescribeServiceJobResponse.Builder createdAt(Long createdAt)

The Unix timestamp (in milliseconds) for when the service job was created.

Parameters:

createdAt - The Unix timestamp (in milliseconds) for when the service job was created.

Returns:

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

isTerminated

DescribeServiceJobResponse.Builder isTerminated(Boolean isTerminated)

Indicates whether the service job has been terminated.

Parameters:

isTerminated - Indicates whether the service job has been terminated.

Returns:

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

jobArn

DescribeServiceJobResponse.Builder jobArn(String jobArn)

The Amazon Resource Name (ARN) of the service job.

Parameters:

jobArn - The Amazon Resource Name (ARN) of the service job.

Returns:

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

jobId

DescribeServiceJobResponse.Builder jobId(String jobId)

The job ID for the service job.

Parameters:

jobId - The job ID for the service job.

Returns:

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

jobName

DescribeServiceJobResponse.Builder jobName(String jobName)

The name of the service job.

Parameters:

jobName - The name of the service job.

Returns:

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

jobQueue

DescribeServiceJobResponse.Builder jobQueue(String jobQueue)

The ARN of the job queue that the service job is associated with.

Parameters:

jobQueue - The ARN of the job queue that the service job is associated with.

Returns:

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

latestAttempt

DescribeServiceJobResponse.Builder latestAttempt(LatestServiceJobAttempt latestAttempt)

The latest attempt associated with the service job.

Parameters:

latestAttempt - The latest attempt associated with the service job.

Returns:

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

latestAttempt

default DescribeServiceJobResponse.Builder latestAttempt(Consumer<LatestServiceJobAttempt.Builder> latestAttempt)

The latest attempt associated with the service job.

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

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

Parameters:

latestAttempt - a consumer that will call methods on LatestServiceJobAttempt.Builder

Returns:

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

See Also:

• latestAttempt(LatestServiceJobAttempt)

retryStrategy

DescribeServiceJobResponse.Builder retryStrategy(ServiceJobRetryStrategy retryStrategy)

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

Parameters:

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

Returns:

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

retryStrategy

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

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

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)

scheduledAt

DescribeServiceJobResponse.Builder scheduledAt(Long scheduledAt)

The Unix timestamp (in milliseconds) for when the service job was scheduled. This represents when the service job was dispatched to SageMaker and the service job transitioned to the SCHEDULED state.

Parameters:

scheduledAt - The Unix timestamp (in milliseconds) for when the service job was scheduled. This represents when the service job was dispatched to SageMaker and the service job transitioned to the SCHEDULED state.

Returns:

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

schedulingPriority

DescribeServiceJobResponse.Builder schedulingPriority(Integer schedulingPriority)

The scheduling priority of the service job.

Parameters:

schedulingPriority - The scheduling priority of the service job.

Returns:

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

serviceRequestPayload

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

DescribeServiceJobResponse.Builder serviceJobType(String serviceJobType)

The type of service job. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.

Parameters:

serviceJobType - The type of service job. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.

Returns:

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

See Also:

• ServiceJobType
• ServiceJobType

serviceJobType

DescribeServiceJobResponse.Builder serviceJobType(ServiceJobType serviceJobType)

The type of service job. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.

Parameters:

serviceJobType - The type of service job. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.

Returns:

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

See Also:

• ServiceJobType
• ServiceJobType

shareIdentifier

DescribeServiceJobResponse.Builder shareIdentifier(String shareIdentifier)

The share identifier for the service job. This is used for fair-share scheduling.

Parameters:

shareIdentifier - The share identifier for the service job. This is used for fair-share scheduling.

Returns:

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

quotaShareName

DescribeServiceJobResponse.Builder quotaShareName(String quotaShareName)

The name of the quota share that the service job is associated with.

Parameters:

quotaShareName - The name of the quota share that the service job is associated with.

Returns:

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

preemptionConfiguration

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

preemptionSummary

DescribeServiceJobResponse.Builder preemptionSummary(ServiceJobPreemptionSummary preemptionSummary)

Summarizes the preemptions of the service job. This field appears on a service job when it has been preempted.

Parameters:

preemptionSummary - Summarizes the preemptions of the service job. This field appears on a service job when it has been preempted.

Returns:

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

preemptionSummary

default DescribeServiceJobResponse.Builder preemptionSummary(Consumer<ServiceJobPreemptionSummary.Builder> preemptionSummary)

Summarizes the preemptions of the service job. This field appears on a service job when it has been preempted.

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

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

Parameters:

preemptionSummary - a consumer that will call methods on ServiceJobPreemptionSummary.Builder

Returns:

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

See Also:

• preemptionSummary(ServiceJobPreemptionSummary)

startedAt

DescribeServiceJobResponse.Builder startedAt(Long startedAt)

The Unix timestamp (in milliseconds) for when the service job was started.

Parameters:

startedAt - The Unix timestamp (in milliseconds) for when the service job was started.

Returns:

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

status

DescribeServiceJobResponse.Builder status(String status)

The current status of the service job.

Parameters:

status - The current status of the service job.

Returns:

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

See Also:

• ServiceJobStatus
• ServiceJobStatus

status

DescribeServiceJobResponse.Builder status(ServiceJobStatus status)

The current status of the service job.

Parameters:

status - The current status of the service job.

Returns:

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

See Also:

• ServiceJobStatus
• ServiceJobStatus

statusReason

DescribeServiceJobResponse.Builder statusReason(String statusReason)

A short, human-readable string to provide more details for the current status of the service job.

Parameters:

statusReason - A short, human-readable string to provide more details for the current status of the service job.

Returns:

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

stoppedAt

DescribeServiceJobResponse.Builder stoppedAt(Long stoppedAt)

The Unix timestamp (in milliseconds) for when the service job stopped running.

Parameters:

stoppedAt - The Unix timestamp (in milliseconds) for when the service job stopped running.

Returns:

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

tags

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

The tags that are associated with the service job. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

Parameters:

tags - The tags that are associated with the service job. 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.

timeoutConfig

DescribeServiceJobResponse.Builder timeoutConfig(ServiceJobTimeout timeoutConfig)

The timeout configuration for the service job.

Parameters:

timeoutConfig - The timeout configuration for the service job.

Returns:

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

timeoutConfig

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

The timeout configuration for the service 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)