Interface PolicyPreviewJobDetails.Builder

All Superinterfaces:

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

Enclosing class:

PolicyPreviewJobDetails

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

Method Summary

Modifier and Type	Method	Description
PolicyPreviewJobDetails.Builder	completedAt(Instant completedAt)	The time at which the job completed.
default PolicyPreviewJobDetails.Builder	jobError(Consumer<JobError.Builder> jobError)	Detailed information about the error that caused the job to fail.
PolicyPreviewJobDetails.Builder	jobError(JobError jobError)	Detailed information about the error that caused the job to fail.
PolicyPreviewJobDetails.Builder	jobStatus(String jobStatus)	The current status of the job.
PolicyPreviewJobDetails.Builder	jobStatus(ImpactAnalysisJobStatus jobStatus)	The current status of the job.
PolicyPreviewJobDetails.Builder	startedAt(Instant startedAt)	The time at which the job execution started.
PolicyPreviewJobDetails.Builder	submittedAt(Instant submittedAt)	The time at which the job was submitted.

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

jobStatus

PolicyPreviewJobDetails.Builder jobStatus(String jobStatus)

The current status of the job. Possible values are:

• SUBMITTED - The job has been submitted but not yet started.

• IN_PROGRESS - The job is currently executing.

• COMPLETED - The job completed successfully.

• FAILED - The job failed with an error.

• CANCELED - The job was canceled by the user.

Parameters:

jobStatus - The current status of the job. Possible values are:

• SUBMITTED - The job has been submitted but not yet started.

• IN_PROGRESS - The job is currently executing.

• COMPLETED - The job completed successfully.

• FAILED - The job failed with an error.

• CANCELED - The job was canceled by the user.

Returns:

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

See Also:

• ImpactAnalysisJobStatus
• ImpactAnalysisJobStatus

jobStatus

PolicyPreviewJobDetails.Builder jobStatus(ImpactAnalysisJobStatus jobStatus)

The current status of the job. Possible values are:

• SUBMITTED - The job has been submitted but not yet started.

• IN_PROGRESS - The job is currently executing.

• COMPLETED - The job completed successfully.

• FAILED - The job failed with an error.

• CANCELED - The job was canceled by the user.

Parameters:

jobStatus - The current status of the job. Possible values are:

• SUBMITTED - The job has been submitted but not yet started.

• IN_PROGRESS - The job is currently executing.

• COMPLETED - The job completed successfully.

• FAILED - The job failed with an error.

• CANCELED - The job was canceled by the user.

Returns:

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

See Also:

• ImpactAnalysisJobStatus
• ImpactAnalysisJobStatus

submittedAt

PolicyPreviewJobDetails.Builder submittedAt(Instant submittedAt)

The time at which the job was submitted.

Parameters:

submittedAt - The time at which the job was submitted.

Returns:

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

startedAt

PolicyPreviewJobDetails.Builder startedAt(Instant startedAt)

The time at which the job execution started. This field is not populated until the job begins processing.

Parameters:

startedAt - The time at which the job execution started. This field is not populated until the job begins processing.

Returns:

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

completedAt

PolicyPreviewJobDetails.Builder completedAt(Instant completedAt)

The time at which the job completed. This field is populated only when the job reaches a terminal state (COMPLETED, FAILED, or CANCELED).

Parameters:

completedAt - The time at which the job completed. This field is populated only when the job reaches a terminal state (COMPLETED, FAILED, or CANCELED).

Returns:

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

jobError

PolicyPreviewJobDetails.Builder jobError(JobError jobError)

Detailed information about the error that caused the job to fail. This field is populated only when the job status is FAILED.

Parameters:

jobError - Detailed information about the error that caused the job to fail. This field is populated only when the job status is FAILED.

Returns:

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

jobError

default PolicyPreviewJobDetails.Builder jobError(Consumer<JobError.Builder> jobError)

Detailed information about the error that caused the job to fail. This field is populated only when the job status is FAILED.

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

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

Parameters:

jobError - a consumer that will call methods on JobError.Builder

Returns:

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

See Also:

• jobError(JobError)