TaskStateBase

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.services.stepfunctions.State
    - - software.amazon.awscdk.services.stepfunctions.TaskStateBase

All Implemented Interfaces:

IConstruct, IDependable, IChainable, INextable

Direct Known Subclasses:

AthenaGetQueryExecution, AthenaGetQueryResults, AthenaStartQueryExecution, AthenaStopQueryExecution, BatchSubmitJob, CallApiGatewayHttpApiEndpoint, CallApiGatewayRestApiEndpoint, CallAwsService, CodeBuildStartBuild, DynamoDeleteItem, DynamoGetItem, DynamoPutItem, DynamoUpdateItem, EcsRunTask, EksCall, EmrAddStep, EmrCancelStep, EmrContainersCreateVirtualCluster, EmrContainersDeleteVirtualCluster, EmrContainersStartJobRun, EmrCreateCluster, EmrModifyInstanceFleetByName, EmrModifyInstanceGroupByName, EmrSetClusterTerminationProtection, EmrTerminateCluster, EvaluateExpression, EventBridgePutEvents, GlueDataBrewStartJobRun, GlueStartJobRun, LambdaInvoke, SageMakerCreateEndpoint, SageMakerCreateEndpointConfig, SageMakerCreateModel, SageMakerCreateTrainingJob, SageMakerCreateTransformJob, SageMakerUpdateEndpoint, SnsPublish, SqsSendMessage, StepFunctionsInvokeActivity, StepFunctionsStartExecution
```
@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:04.077Z")
public abstract class TaskStateBase
extends State
implements INextable
```
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.

Nested Class Summary
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable
  INextable.Jsii$Default
- 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
`protected`	`TaskStateBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`TaskStateBase(software.amazon.jsii.JsiiObjectRef objRef)`
`protected`	`TaskStateBase(software.constructs.Construct scope, java.lang.String id, TaskStateBaseProps props)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`TaskStateBase`	`addCatch(IChainable handler)` Add a recovery handler for this state.
`TaskStateBase`	`addCatch(IChainable handler, CatchProps props)` Add a recovery handler for this state.
`TaskStateBase`	`addRetry()` Add retry configuration for this state.
`TaskStateBase`	`addRetry(RetryProps props)` Add retry configuration for this state.
`java.util.List<INextable>`	`getEndStates()` Continuable states of this Chainable.
`protected abstract TaskMetricsConfig`	`getTaskMetrics()`
`protected abstract java.util.List<PolicyStatement>`	`getTaskPolicies()`
`Metric`	`metric(java.lang.String metricName)` Return the given named metric for this Task.
`Metric`	`metric(java.lang.String metricName, MetricOptions props)` Return the given named metric for this Task.
`Metric`	`metricFailed()` Metric for the number of times this activity fails.
`Metric`	`metricFailed(MetricOptions props)` Metric for the number of times this activity fails.
`Metric`	`metricHeartbeatTimedOut()` Metric for the number of times the heartbeat times out for this activity.
`Metric`	`metricHeartbeatTimedOut(MetricOptions props)` Metric for the number of times the heartbeat times out for this activity.
`Metric`	`metricRunTime()` The interval, in milliseconds, between the time the Task starts and the time it closes.
`Metric`	`metricRunTime(MetricOptions props)` The interval, in milliseconds, between the time the Task starts and the time it closes.
`Metric`	`metricScheduled()` Metric for the number of times this activity is scheduled.
`Metric`	`metricScheduled(MetricOptions props)` Metric for the number of times this activity is scheduled.
`Metric`	`metricScheduleTime()` The interval, in milliseconds, for which the activity stays in the schedule state.
`Metric`	`metricScheduleTime(MetricOptions props)` The interval, in milliseconds, for which the activity stays in the schedule state.
`Metric`	`metricStarted()` Metric for the number of times this activity is started.
`Metric`	`metricStarted(MetricOptions props)` Metric for the number of times this activity is started.
`Metric`	`metricSucceeded()` Metric for the number of times this activity succeeds.
`Metric`	`metricSucceeded(MetricOptions props)` Metric for the number of times this activity succeeds.
`Metric`	`metricTime()` The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
`Metric`	`metricTime(MetricOptions props)` The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
`Metric`	`metricTimedOut()` Metric for the number of times this activity times out.
`Metric`	`metricTimedOut(MetricOptions props)` Metric for the number of times this activity times out.
`Chain`	`next(IChainable next)` Continue normal execution with the given state.
`com.fasterxml.jackson.databind.node.ObjectNode`	`toStateJson()` Return the Amazon States Language object for this state.
`protected void`	`whenBoundToGraph(StateGraph graph)` Called whenever this state is bound to a graph.

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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TaskStateBase
```
protected TaskStateBase(software.amazon.jsii.JsiiObjectRef objRef)
```
  - TaskStateBase
```
protected TaskStateBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - TaskStateBase
```
protected TaskStateBase(software.constructs.Construct scope,
                        java.lang.String id,
                        TaskStateBaseProps props)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    props - This parameter is required.
- Method Detail
  - addCatch
```
public TaskStateBase addCatch(IChainable handler,
                              CatchProps props)
```
    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
```
public TaskStateBase addCatch(IChainable handler)
```
    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
```
public TaskStateBase addRetry(RetryProps props)
```
    Add retry configuration for this state.
    This controls if and how the execution will be retried if a particular error occurs.
    
    Parameters:
    
    props -
  - addRetry
```
public TaskStateBase addRetry()
```
    Add retry configuration for this state.
    This controls if and how the execution will be retried if a particular error occurs.
  - metric
```
public Metric metric(java.lang.String metricName,
                     MetricOptions props)
```
    Return the given named metric for this Task.
    Default: - sum over 5 minutes
    
    Parameters:
    
    metricName - This parameter is required.
    
    props -
  - metric
```
public Metric metric(java.lang.String metricName)
```
    Return the given named metric for this Task.
    Default: - sum over 5 minutes
    
    Parameters:
    
    metricName - This parameter is required.
  - metricFailed
```
public Metric metricFailed(MetricOptions props)
```
    Metric for the number of times this activity fails.
    Default: - sum over 5 minutes
    
    Parameters:
    
    props -
  - metricFailed
```
public Metric metricFailed()
```
    Metric for the number of times this activity fails.
    Default: - sum over 5 minutes
  - metricHeartbeatTimedOut
```
public Metric metricHeartbeatTimedOut(MetricOptions props)
```
    Metric for the number of times the heartbeat times out for this activity.
    Default: - sum over 5 minutes
    
    Parameters:
    
    props -
  - metricHeartbeatTimedOut
```
public Metric metricHeartbeatTimedOut()
```
    Metric for the number of times the heartbeat times out for this activity.
    Default: - sum over 5 minutes
  - metricRunTime
```
public Metric metricRunTime(MetricOptions props)
```
    The interval, in milliseconds, between the time the Task starts and the time it closes.
    Default: - average over 5 minutes
    
    Parameters:
    
    props -
  - metricRunTime
```
public Metric metricRunTime()
```
    The interval, in milliseconds, between the time the Task starts and the time it closes.
    Default: - average over 5 minutes
  - metricScheduled
```
public Metric metricScheduled(MetricOptions props)
```
    Metric for the number of times this activity is scheduled.
    Default: - sum over 5 minutes
    
    Parameters:
    
    props -
  - metricScheduled
```
public Metric metricScheduled()
```
    Metric for the number of times this activity is scheduled.
    Default: - sum over 5 minutes
  - metricScheduleTime
```
public Metric metricScheduleTime(MetricOptions props)
```
    The interval, in milliseconds, for which the activity stays in the schedule state.
    Default: - average over 5 minutes
    
    Parameters:
    
    props -
  - metricScheduleTime
```
public Metric metricScheduleTime()
```
    The interval, in milliseconds, for which the activity stays in the schedule state.
    Default: - average over 5 minutes
  - metricStarted
```
public Metric metricStarted(MetricOptions props)
```
    Metric for the number of times this activity is started.
    Default: - sum over 5 minutes
    
    Parameters:
    
    props -
  - metricStarted
```
public Metric metricStarted()
```
    Metric for the number of times this activity is started.
    Default: - sum over 5 minutes
  - metricSucceeded
```
public Metric metricSucceeded(MetricOptions props)
```
    Metric for the number of times this activity succeeds.
    Default: - sum over 5 minutes
    
    Parameters:
    
    props -
  - metricSucceeded
```
public Metric metricSucceeded()
```
    Metric for the number of times this activity succeeds.
    Default: - sum over 5 minutes
  - metricTime
```
public Metric metricTime(MetricOptions props)
```
    The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
    Default: - average over 5 minutes
    
    Parameters:
    
    props -
  - metricTime
```
public Metric metricTime()
```
    The interval, in milliseconds, between the time the activity is scheduled and the time it closes.
    Default: - average over 5 minutes
  - metricTimedOut
```
public Metric metricTimedOut(MetricOptions props)
```
    Metric for the number of times this activity times out.
    Default: - sum over 5 minutes
    
    Parameters:
    
    props -
  - metricTimedOut
```
public Metric metricTimedOut()
```
    Metric for the number of times this activity times out.
    Default: - sum over 5 minutes
  - next
```
public Chain next(IChainable next)
```
    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
```
public com.fasterxml.jackson.databind.node.ObjectNode toStateJson()
```
    Return the Amazon States Language object for this state.
    
    Specified by:
    
    toStateJson in class State
  - whenBoundToGraph
```
protected void whenBoundToGraph(StateGraph graph)
```
    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
```
public java.util.List<INextable> getEndStates()
```
    Continuable states of this Chainable.
    
    Specified by:
    
    getEndStates in interface IChainable
    
    Specified by:
    
    getEndStates in class State
  - getTaskMetrics
```
protected abstract TaskMetricsConfig getTaskMetrics()
```
  - getTaskPolicies
```
protected abstract java.util.List<PolicyStatement> getTaskPolicies()
```

Class TaskStateBase

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

TaskStateBase

TaskStateBase

TaskStateBase

Method Detail

addCatch

addCatch

addRetry

addRetry

metric

metric

metricFailed

metricFailed

metricHeartbeatTimedOut

metricHeartbeatTimedOut

metricRunTime

metricRunTime

metricScheduled

metricScheduled

metricScheduleTime

metricScheduleTime

metricStarted

metricStarted

metricSucceeded

metricSucceeded

metricTime

metricTime

metricTimedOut

metricTimedOut

next

toStateJson

whenBoundToGraph

getEndStates

getTaskMetrics

getTaskPolicies