software.amazon.awssdk.services.cloudcontrol.model

Interface ProgressEvent.Builder

All Superinterfaces:

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

Enclosing class:

ProgressEvent

public static interface ProgressEvent.Builder
extends SdkPojo, CopyableBuilder<ProgressEvent.Builder,ProgressEvent>

Method Summary

Modifier and Type	Method and Description
ProgressEvent.Builder	errorCode(HandlerErrorCode errorCode) For requests with a status of FAILED, the associated error code.
ProgressEvent.Builder	errorCode(String errorCode) For requests with a status of FAILED, the associated error code.
ProgressEvent.Builder	eventTime(Instant eventTime) When the resource operation request was initiated.
ProgressEvent.Builder	identifier(String identifier) The primary identifier for the resource.
ProgressEvent.Builder	operation(Operation operation) The resource operation type.
ProgressEvent.Builder	operation(String operation) The resource operation type.
ProgressEvent.Builder	operationStatus(OperationStatus operationStatus) The current status of the resource operation request.
ProgressEvent.Builder	operationStatus(String operationStatus) The current status of the resource operation request.
ProgressEvent.Builder	requestToken(String requestToken) The unique token representing this resource operation request.
ProgressEvent.Builder	resourceModel(String resourceModel) A JSON string containing the resource model, consisting of each resource property and its current value.
ProgressEvent.Builder	retryAfter(Instant retryAfter) When to next request the status of this resource operation request.
ProgressEvent.Builder	statusMessage(String statusMessage) Any message explaining the current status.
ProgressEvent.Builder	typeName(String typeName) The name of the resource type used in the operation.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

typeName

ProgressEvent.Builder typeName(String typeName)

The name of the resource type used in the operation.

Parameters:

typeName - The name of the resource type used in the operation.

Returns:

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

identifier

ProgressEvent.Builder identifier(String identifier)

The primary identifier for the resource.

In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.

Parameters:

identifier - The primary identifier for the resource.

In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.

Returns:

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

requestToken

ProgressEvent.Builder requestToken(String requestToken)

The unique token representing this resource operation request.

Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

Parameters:

requestToken - The unique token representing this resource operation request.

Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

Returns:

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

operation

ProgressEvent.Builder operation(String operation)

The resource operation type.

Parameters:

operation - The resource operation type.

Returns:

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

See Also:

Operation, Operation

operation

ProgressEvent.Builder operation(Operation operation)

The resource operation type.

Parameters:

operation - The resource operation type.

Returns:

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

See Also:

Operation, Operation

operationStatus

ProgressEvent.Builder operationStatus(String operationStatus)

The current status of the resource operation request.

• PENDING: The resource operation hasn't yet started.

• IN_PROGRESS: The resource operation is currently in progress.

• SUCCESS: The resource operation has successfully completed.

• FAILED: The resource operation has failed. Refer to the error code and status message for more information.

• CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

• CANCEL_COMPLETE: The resource operation has been canceled.

Parameters:

operationStatus - The current status of the resource operation request.

• PENDING: The resource operation hasn't yet started.

• IN_PROGRESS: The resource operation is currently in progress.

• SUCCESS: The resource operation has successfully completed.

• FAILED: The resource operation has failed. Refer to the error code and status message for more information.

• CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

• CANCEL_COMPLETE: The resource operation has been canceled.

Returns:

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

See Also:

OperationStatus, OperationStatus

operationStatus

ProgressEvent.Builder operationStatus(OperationStatus operationStatus)

The current status of the resource operation request.

• PENDING: The resource operation hasn't yet started.

• IN_PROGRESS: The resource operation is currently in progress.

• SUCCESS: The resource operation has successfully completed.

• FAILED: The resource operation has failed. Refer to the error code and status message for more information.

• CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

• CANCEL_COMPLETE: The resource operation has been canceled.

Parameters:

operationStatus - The current status of the resource operation request.

• PENDING: The resource operation hasn't yet started.

• IN_PROGRESS: The resource operation is currently in progress.

• SUCCESS: The resource operation has successfully completed.

• FAILED: The resource operation has failed. Refer to the error code and status message for more information.

• CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

• CANCEL_COMPLETE: The resource operation has been canceled.

Returns:

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

See Also:

OperationStatus, OperationStatus

eventTime

ProgressEvent.Builder eventTime(Instant eventTime)

When the resource operation request was initiated.

Parameters:

eventTime - When the resource operation request was initiated.

Returns:

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

resourceModel

ProgressEvent.Builder resourceModel(String resourceModel)

A JSON string containing the resource model, consisting of each resource property and its current value.

Parameters:

resourceModel - A JSON string containing the resource model, consisting of each resource property and its current value.

Returns:

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

statusMessage

ProgressEvent.Builder statusMessage(String statusMessage)

Any message explaining the current status.

Parameters:

statusMessage - Any message explaining the current status.

Returns:

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

errorCode

ProgressEvent.Builder errorCode(String errorCode)

For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

Parameters:

errorCode - For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

Returns:

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

See Also:

HandlerErrorCode, HandlerErrorCode

errorCode

ProgressEvent.Builder errorCode(HandlerErrorCode errorCode)

For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

Parameters:

errorCode - For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

Returns:

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

See Also:

HandlerErrorCode, HandlerErrorCode

retryAfter

ProgressEvent.Builder retryAfter(Instant retryAfter)

When to next request the status of this resource operation request.

Parameters:

retryAfter - When to next request the status of this resource operation request.

Returns:

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