software.amazon.awscdk.services.stepfunctions

Class Task

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.Task

All Implemented Interfaces:

IDependable, IChainable, INextable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Deprecated.

- replaced by service integration specific classes (i.e. LambdaInvoke, SnsPublish)

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-07-13T22:11:54.717Z")
 @Stability(value=Deprecated)
 @Deprecated
public class Task
extends State
implements INextable

(deprecated) Define a Task state in the state machine.

Reaching a Task state causes some work to be executed, represented by the Task's resource property. Task constructs represent a generic Amazon States Language Task.

For some resource types, more specific subclasses of Task may be available which are more convenient to use.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 import software.amazon.awscdk.core.*;
 Object parameters;
 IStepFunctionsTask stepFunctionsTask;
 Task task = Task.Builder.create(this, "MyTask")
         .task(stepFunctionsTask)
         // the properties below are optional
         .comment("comment")
         .inputPath("inputPath")
         .outputPath("outputPath")
         .parameters(Map.of(
                 "parametersKey", parameters))
         .resultPath("resultPath")
         .timeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Task.Builder Deprecated.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable

INextable.Jsii$Default, INextable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	Task(software.constructs.Construct scope, String id, TaskProps props) Deprecated.
protected	Task(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) Deprecated.
protected	Task(software.amazon.jsii.JsiiObjectRef objRef) Deprecated.

Method Summary

Modifier and Type	Method and Description
Task	addCatch(IChainable handler) Deprecated.
Task	addCatch(IChainable handler, CatchProps props) Deprecated.
Task	addRetry() Deprecated.
Task	addRetry(RetryProps props) Deprecated.
List<INextable>	getEndStates() Deprecated.
Metric	metric(String metricName) Deprecated.
Metric	metric(String metricName, MetricOptions props) Deprecated.
Metric	metricFailed() Deprecated.
Metric	metricFailed(MetricOptions props) Deprecated.
Metric	metricHeartbeatTimedOut() Deprecated.
Metric	metricHeartbeatTimedOut(MetricOptions props) Deprecated.
Metric	metricRunTime() Deprecated.
Metric	metricRunTime(MetricOptions props) Deprecated.
Metric	metricScheduled() Deprecated.
Metric	metricScheduled(MetricOptions props) Deprecated.
Metric	metricScheduleTime() Deprecated.
Metric	metricScheduleTime(MetricOptions props) Deprecated.
Metric	metricStarted() Deprecated.
Metric	metricStarted(MetricOptions props) Deprecated.
Metric	metricSucceeded() Deprecated.
Metric	metricSucceeded(MetricOptions props) Deprecated.
Metric	metricTime() Deprecated.
Metric	metricTime(MetricOptions props) Deprecated.
Metric	metricTimedOut() Deprecated.
Metric	metricTimedOut(MetricOptions props) Deprecated.
Chain	next(IChainable next) Deprecated.
com.fasterxml.jackson.databind.node.ObjectNode	toStateJson() Deprecated.
protected void	whenBoundToGraph(StateGraph graph) Deprecated.

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getParameters, getResultPath, getResultSelector, getStartState, getStateId, makeDefault, makeNext, prefixStates, renderBranches, renderChoices, renderInputOutput, renderIterator, renderNextEnd, renderResultSelector, renderRetryCatch, setDefaultChoice, setIteration

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Task

protected Task(software.amazon.jsii.JsiiObjectRef objRef)

Deprecated.

Task

protected Task(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Deprecated.

Task

@Stability(value=Deprecated)
 @Deprecated
public Task(@NotNull
                                                      software.constructs.Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      TaskProps props)

Deprecated.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addCatch

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Task addCatch(@NotNull
                                                                         IChainable handler,
                                                                         @Nullable
                                                                         CatchProps props)

Deprecated.

(deprecated) Add a recovery handler for this state.

When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.

Parameters:

handler - This parameter is required.

props -

addCatch

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Task addCatch(@NotNull
                                                                         IChainable handler)

Deprecated.

(deprecated) Add a recovery handler for this state.

When a particular error occurs, execution will continue at the error handler instead of failing the state machine execution.

Parameters:

handler - This parameter is required.

addRetry

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Task addRetry(@Nullable
                                                                         RetryProps props)

Deprecated.

(deprecated) Add retry configuration for this state.

This controls if and how the execution will be retried if a particular error occurs.

Parameters:

props -

addRetry

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Task addRetry()

Deprecated.

(deprecated) Add retry configuration for this state.

This controls if and how the execution will be retried if a particular error occurs.

metric

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metric(@NotNull
                                                                         String metricName,
                                                                         @Nullable
                                                                         MetricOptions props)

Deprecated.

(deprecated) Return the given named metric for this Task.

Default: sum over 5 minutes

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metric(@NotNull
                                                                         String metricName)

Deprecated.

(deprecated) Return the given named metric for this Task.

Default: sum over 5 minutes

Parameters:

metricName - This parameter is required.

metricFailed

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricFailed(@Nullable
                                                                               MetricOptions props)

Deprecated.

(deprecated) Metric for the number of times this activity fails.

Default: sum over 5 minutes

Parameters:

props -

metricFailed

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricFailed()

Deprecated.

(deprecated) Metric for the number of times this activity fails.

Default: sum over 5 minutes

metricHeartbeatTimedOut

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricHeartbeatTimedOut(@Nullable
                                                                                          MetricOptions props)

Deprecated.

(deprecated) Metric for the number of times the heartbeat times out for this activity.

Default: sum over 5 minutes

Parameters:

props -

metricHeartbeatTimedOut

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricHeartbeatTimedOut()

Deprecated.

(deprecated) Metric for the number of times the heartbeat times out for this activity.

Default: sum over 5 minutes

metricRunTime

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricRunTime(@Nullable
                                                                                MetricOptions props)

Deprecated.

(deprecated) The interval, in milliseconds, between the time the Task starts and the time it closes.

Default: average over 5 minutes

Parameters:

props -

metricRunTime

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricRunTime()

Deprecated.

(deprecated) The interval, in milliseconds, between the time the Task starts and the time it closes.

Default: average over 5 minutes

metricScheduled

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricScheduled(@Nullable
                                                                                  MetricOptions props)

Deprecated.

(deprecated) Metric for the number of times this activity is scheduled.

Default: sum over 5 minutes

Parameters:

props -

metricScheduled

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricScheduled()

Deprecated.

(deprecated) Metric for the number of times this activity is scheduled.

Default: sum over 5 minutes

metricScheduleTime

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricScheduleTime(@Nullable
                                                                                     MetricOptions props)

Deprecated.

(deprecated) The interval, in milliseconds, for which the activity stays in the schedule state.

Default: average over 5 minutes

Parameters:

props -

metricScheduleTime

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricScheduleTime()

Deprecated.

(deprecated) The interval, in milliseconds, for which the activity stays in the schedule state.

Default: average over 5 minutes

metricStarted

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricStarted(@Nullable
                                                                                MetricOptions props)

Deprecated.

(deprecated) Metric for the number of times this activity is started.

Default: sum over 5 minutes

Parameters:

props -

metricStarted

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricStarted()

Deprecated.

(deprecated) Metric for the number of times this activity is started.

Default: sum over 5 minutes

metricSucceeded

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricSucceeded(@Nullable
                                                                                  MetricOptions props)

Deprecated.

(deprecated) Metric for the number of times this activity succeeds.

Default: sum over 5 minutes

Parameters:

props -

metricSucceeded

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricSucceeded()

Deprecated.

(deprecated) Metric for the number of times this activity succeeds.

Default: sum over 5 minutes

metricTime

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricTime(@Nullable
                                                                             MetricOptions props)

Deprecated.

(deprecated) The interval, in milliseconds, between the time the activity is scheduled and the time it closes.

Default: average over 5 minutes

Parameters:

props -

metricTime

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricTime()

Deprecated.

(deprecated) The interval, in milliseconds, between the time the activity is scheduled and the time it closes.

Default: average over 5 minutes

metricTimedOut

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricTimedOut(@Nullable
                                                                                 MetricOptions props)

Deprecated.

(deprecated) Metric for the number of times this activity times out.

Default: sum over 5 minutes

Parameters:

props -

metricTimedOut

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Metric metricTimedOut()

Deprecated.

(deprecated) Metric for the number of times this activity times out.

Default: sum over 5 minutes

next

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Chain next(@NotNull
                                                                      IChainable next)

Deprecated.

(deprecated) Continue normal execution with the given state.

Specified by:

next in interface INextable

Parameters:

next - This parameter is required.

Returns:

The chain of states built up

toStateJson

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public com.fasterxml.jackson.databind.node.ObjectNode toStateJson()

Deprecated.

(deprecated) Return the Amazon States Language object for this state.

Specified by:

toStateJson in class State

whenBoundToGraph

@Stability(value=Deprecated)
 @Deprecated
protected void whenBoundToGraph(@NotNull
                                                                          StateGraph graph)

Deprecated.

(deprecated) Called whenever this state is bound to a graph.

Can be overridden by subclasses.

Overrides:

whenBoundToGraph in class State

Parameters:

graph - This parameter is required.

getEndStates

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public List<INextable> getEndStates()

Deprecated.

(deprecated) Continuable states of this Chainable.

Specified by:

getEndStates in interface IChainable

Specified by:

getEndStates in class State