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

Interface ServiceJobSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ServiceJobSummary.Builder,ServiceJobSummary>, SdkBuilder<ServiceJobSummary.Builder,ServiceJobSummary>, SdkPojo

Enclosing class:

ServiceJobSummary

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

Method Summary

Modifier and Type	Method	Description
ServiceJobSummary.Builder	capacityUsage(Collection<ServiceJobCapacityUsageSummary> capacityUsage)	The capacity usage information for this service job, including the unit of measure and quantity of resources being used.
ServiceJobSummary.Builder	capacityUsage(Consumer<ServiceJobCapacityUsageSummary.Builder>... capacityUsage)	The capacity usage information for this service job, including the unit of measure and quantity of resources being used.
ServiceJobSummary.Builder	capacityUsage(ServiceJobCapacityUsageSummary... capacityUsage)	The capacity usage information for this service job, including the unit of measure and quantity of resources being used.
ServiceJobSummary.Builder	createdAt(Long createdAt)	The Unix timestamp (in milliseconds) for when the service job was created.
ServiceJobSummary.Builder	jobArn(String jobArn)	The Amazon Resource Name (ARN) of the service job.
ServiceJobSummary.Builder	jobId(String jobId)	The job ID for the service job.
ServiceJobSummary.Builder	jobName(String jobName)	The name of the service job.
default ServiceJobSummary.Builder	latestAttempt(Consumer<LatestServiceJobAttempt.Builder> latestAttempt)	Information about the latest attempt for the service job.
ServiceJobSummary.Builder	latestAttempt(LatestServiceJobAttempt latestAttempt)	Information about the latest attempt for the service job.
ServiceJobSummary.Builder	quotaShareName(String quotaShareName)	The quota share for the service job.
ServiceJobSummary.Builder	scheduledAt(Long scheduledAt)	The Unix timestamp (in milliseconds) for when the service job was scheduled for execution.
ServiceJobSummary.Builder	serviceJobType(String serviceJobType)	The type of service job.
ServiceJobSummary.Builder	serviceJobType(ServiceJobType serviceJobType)	The type of service job.
ServiceJobSummary.Builder	shareIdentifier(String shareIdentifier)	The share identifier for the job.
ServiceJobSummary.Builder	startedAt(Long startedAt)	The Unix timestamp (in milliseconds) for when the service job was started.
ServiceJobSummary.Builder	status(String status)	The current status of the service job.
ServiceJobSummary.Builder	status(ServiceJobStatus status)	The current status of the service job.
ServiceJobSummary.Builder	statusReason(String statusReason)	A short string to provide more details on the current status of the service job.
ServiceJobSummary.Builder	stoppedAt(Long stoppedAt)	The Unix timestamp (in milliseconds) for when the service job stopped running.

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

latestAttempt

ServiceJobSummary.Builder latestAttempt(LatestServiceJobAttempt latestAttempt)

Information about the latest attempt for the service job.

Parameters:

latestAttempt - Information about the latest attempt for the service job.

Returns:

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

latestAttempt

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

Information about the latest attempt for 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)

capacityUsage

ServiceJobSummary.Builder capacityUsage(Collection<ServiceJobCapacityUsageSummary> capacityUsage)

The capacity usage information for this service job, including the unit of measure and quantity of resources being used.

Parameters:

capacityUsage - The capacity usage information for this service job, including the unit of measure and quantity of resources being used.

Returns:

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

capacityUsage

ServiceJobSummary.Builder capacityUsage(ServiceJobCapacityUsageSummary... capacityUsage)

The capacity usage information for this service job, including the unit of measure and quantity of resources being used.

Parameters:

capacityUsage - The capacity usage information for this service job, including the unit of measure and quantity of resources being used.

Returns:

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

capacityUsage

ServiceJobSummary.Builder capacityUsage(Consumer<ServiceJobCapacityUsageSummary.Builder>... capacityUsage)

The capacity usage information for this service job, including the unit of measure and quantity of resources being used.

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

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

Parameters:

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

Returns:

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

See Also:

#capacityUsage(java.util.Collection)

createdAt

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

jobArn

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

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

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

scheduledAt

ServiceJobSummary.Builder scheduledAt(Long scheduledAt)

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

Parameters:

scheduledAt - The Unix timestamp (in milliseconds) for when the service job was scheduled for execution.

Returns:

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

serviceJobType

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

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

ServiceJobSummary.Builder shareIdentifier(String shareIdentifier)

The share identifier for the job.

Parameters:

shareIdentifier - The share identifier for the job.

Returns:

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

quotaShareName

ServiceJobSummary.Builder quotaShareName(String quotaShareName)

The quota share for the service job.

Parameters:

quotaShareName - The quota share for the service job.

Returns:

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

status

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

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

ServiceJobSummary.Builder statusReason(String statusReason)

A short string to provide more details on the current status of the service job.

Parameters:

statusReason - A short string to provide more details on the current status of the service job.

Returns:

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

startedAt

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

stoppedAt

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