software.amazon.cloudformation.proxy

Class ProgressEvent<ResourceT,CallbackT>

java.lang.Object

software.amazon.cloudformation.proxy.ProgressEvent<ResourceT,CallbackT>

public class ProgressEvent<ResourceT,CallbackT>
extends Object

Constructor Summary

Constructors

Constructor and Description
ProgressEvent()

Method Summary

Modifier and Type	Method and Description
boolean	canContinueProgress()
static <ResourceT,CallbackT> ProgressEvent<ResourceT,CallbackT>	defaultFailureHandler(Throwable e, HandlerErrorCode handlerErrorCode) Convenience method for constructing a FAILED response
static <ResourceT,CallbackT> ProgressEvent<ResourceT,CallbackT>	defaultInProgressHandler(CallbackT callbackContext, int callbackDelaySeconds, ResourceT resourceModel) Convenience method for constructing a IN_PROGRESS response
static <ResourceT,CallbackT> ProgressEvent<ResourceT,CallbackT>	defaultSuccessHandler(ResourceT resourceModel) Convenience method for constructing a SUCCESS response
static <ResourceT,CallbackT> ProgressEvent<ResourceT,CallbackT>	failed(ResourceT model, CallbackT cxt, HandlerErrorCode code, String message)
boolean	isFailed()
boolean	isInProgress()
boolean	isInProgressCallbackDelay()
boolean	isSuccess()
ProgressEvent<ResourceT,CallbackT>	onSuccess(Function<ProgressEvent<ResourceT,CallbackT>,ProgressEvent<ResourceT,CallbackT>> func)
static <ResourceT,CallbackT> ProgressEvent<ResourceT,CallbackT>	progress(ResourceT model, CallbackT cxt)
static <ResourceT,CallbackT> ProgressEvent<ResourceT,CallbackT>	success(ResourceT model, CallbackT cxt)
ProgressEvent<ResourceT,CallbackT>	then(Function<ProgressEvent<ResourceT,CallbackT>,ProgressEvent<ResourceT,CallbackT>> func)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgressEvent

public ProgressEvent()

Method Detail

defaultFailureHandler

public static <ResourceT,CallbackT> ProgressEvent<ResourceT,CallbackT> defaultFailureHandler(Throwable e,
                                                                                             HandlerErrorCode handlerErrorCode)

Convenience method for constructing a FAILED response

Type Parameters:

ResourceT - The type for the resource model

CallbackT - the type for the callback context

Parameters:

e - actual service exception

handlerErrorCode - error code to return to CloudFormation

Returns:

ProgressEvent failed status code

failed

public static <ResourceT,CallbackT> ProgressEvent<ResourceT,CallbackT> failed(ResourceT model,
                                                                              CallbackT cxt,
                                                                              HandlerErrorCode code,
                                                                              String message)

defaultInProgressHandler

public static <ResourceT,CallbackT> ProgressEvent<ResourceT,CallbackT> defaultInProgressHandler(CallbackT callbackContext,
                                                                                                int callbackDelaySeconds,
                                                                                                ResourceT resourceModel)

Convenience method for constructing a IN_PROGRESS response

Type Parameters:

ResourceT - The type for the resource model

CallbackT - the type for the callback context

Parameters:

callbackContext - callback context

callbackDelaySeconds - how much time to wait before calling back the handler

resourceModel - the actual resource model state

Returns:

ProgressEvent with OperationStatus.IN_PROGRESS with delay

progress

public static <ResourceT,CallbackT> ProgressEvent<ResourceT,CallbackT> progress(ResourceT model,
                                                                                CallbackT cxt)

defaultSuccessHandler

public static <ResourceT,CallbackT> ProgressEvent<ResourceT,CallbackT> defaultSuccessHandler(ResourceT resourceModel)

Convenience method for constructing a SUCCESS response

Type Parameters:

ResourceT - The type for the resource model

CallbackT - the type for the callback context

Parameters:

resourceModel - the current resource model state

Returns:

ProgressEvent with OperationStatus.SUCCESS indicating successful completion for operation

success

public static <ResourceT,CallbackT> ProgressEvent<ResourceT,CallbackT> success(ResourceT model,
                                                                               CallbackT cxt)

onSuccess

public ProgressEvent<ResourceT,CallbackT> onSuccess(Function<ProgressEvent<ResourceT,CallbackT>,ProgressEvent<ResourceT,CallbackT>> func)

isFailed

public boolean isFailed()

isInProgress

public boolean isInProgress()

canContinueProgress

public boolean canContinueProgress()

then

public ProgressEvent<ResourceT,CallbackT> then(Function<ProgressEvent<ResourceT,CallbackT>,ProgressEvent<ResourceT,CallbackT>> func)

isSuccess

public boolean isSuccess()

isInProgressCallbackDelay

public boolean isInProgressCallbackDelay()