@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSStepFunctionsAsync extends AbstractAWSStepFunctions implements AWSStepFunctionsAsync
AWSStepFunctionsAsync. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler, which throws an
UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAWSStepFunctionsAsync() |
createActivity, createStateMachine, deleteActivity, deleteStateMachine, describeActivity, describeExecution, describeStateMachine, getActivityTask, getCachedResponseMetadata, getExecutionHistory, listActivities, listExecutions, listStateMachines, sendTaskFailure, sendTaskHeartbeat, sendTaskSuccess, setEndpoint, setRegion, shutdown, startExecution, stopExecutionclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateActivity, createStateMachine, deleteActivity, deleteStateMachine, describeActivity, describeExecution, describeStateMachine, getActivityTask, getCachedResponseMetadata, getExecutionHistory, listActivities, listExecutions, listStateMachines, sendTaskFailure, sendTaskHeartbeat, sendTaskSuccess, setEndpoint, setRegion, shutdown, startExecution, stopExecutionpublic Future<CreateActivityResult> createActivityAsync(CreateActivityRequest request)
AWSStepFunctionsAsync
Creates an activity. An Activity is a task which you write, in any language and hosted on any machine which has
access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask and
respond using SendTask* API calls. This function lets Step Functions know the existence of your
activity and returns an identifier for use in a state machine and when polling from the activity.
createActivityAsync in interface AWSStepFunctionsAsyncpublic Future<CreateActivityResult> createActivityAsync(CreateActivityRequest request, AsyncHandler<CreateActivityRequest,CreateActivityResult> asyncHandler)
AWSStepFunctionsAsync
Creates an activity. An Activity is a task which you write, in any language and hosted on any machine which has
access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask and
respond using SendTask* API calls. This function lets Step Functions know the existence of your
activity and returns an identifier for use in a state machine and when polling from the activity.
createActivityAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateStateMachineResult> createStateMachineAsync(CreateStateMachineRequest request)
AWSStepFunctionsAsync
Creates a state machine. A state machine consists of a collection of states that can do work (Task
states), determine which states to transition to next (Choice states), stop an execution with an
error (Fail states), and so on. State machines are specified using a JSON-based, structured
language.
createStateMachineAsync in interface AWSStepFunctionsAsyncpublic Future<CreateStateMachineResult> createStateMachineAsync(CreateStateMachineRequest request, AsyncHandler<CreateStateMachineRequest,CreateStateMachineResult> asyncHandler)
AWSStepFunctionsAsync
Creates a state machine. A state machine consists of a collection of states that can do work (Task
states), determine which states to transition to next (Choice states), stop an execution with an
error (Fail states), and so on. State machines are specified using a JSON-based, structured
language.
createStateMachineAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteActivityResult> deleteActivityAsync(DeleteActivityRequest request)
AWSStepFunctionsAsyncDeletes an activity.
deleteActivityAsync in interface AWSStepFunctionsAsyncpublic Future<DeleteActivityResult> deleteActivityAsync(DeleteActivityRequest request, AsyncHandler<DeleteActivityRequest,DeleteActivityResult> asyncHandler)
AWSStepFunctionsAsyncDeletes an activity.
deleteActivityAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteStateMachineResult> deleteStateMachineAsync(DeleteStateMachineRequest request)
AWSStepFunctionsAsyncDeletes a state machine. This is an asynchronous operation-- it sets the state machine's status to "DELETING" and begins the delete process. Each state machine execution will be deleted the next time it makes a state transition. After all executions have completed or been deleted, the state machine itself will be deleted.
deleteStateMachineAsync in interface AWSStepFunctionsAsyncpublic Future<DeleteStateMachineResult> deleteStateMachineAsync(DeleteStateMachineRequest request, AsyncHandler<DeleteStateMachineRequest,DeleteStateMachineResult> asyncHandler)
AWSStepFunctionsAsyncDeletes a state machine. This is an asynchronous operation-- it sets the state machine's status to "DELETING" and begins the delete process. Each state machine execution will be deleted the next time it makes a state transition. After all executions have completed or been deleted, the state machine itself will be deleted.
deleteStateMachineAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeActivityResult> describeActivityAsync(DescribeActivityRequest request)
AWSStepFunctionsAsyncDescribes an activity.
describeActivityAsync in interface AWSStepFunctionsAsyncpublic Future<DescribeActivityResult> describeActivityAsync(DescribeActivityRequest request, AsyncHandler<DescribeActivityRequest,DescribeActivityResult> asyncHandler)
AWSStepFunctionsAsyncDescribes an activity.
describeActivityAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request)
AWSStepFunctionsAsyncDescribes an execution.
describeExecutionAsync in interface AWSStepFunctionsAsyncpublic Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request, AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)
AWSStepFunctionsAsyncDescribes an execution.
describeExecutionAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeStateMachineResult> describeStateMachineAsync(DescribeStateMachineRequest request)
AWSStepFunctionsAsyncDescribes a state machine.
describeStateMachineAsync in interface AWSStepFunctionsAsyncpublic Future<DescribeStateMachineResult> describeStateMachineAsync(DescribeStateMachineRequest request, AsyncHandler<DescribeStateMachineRequest,DescribeStateMachineResult> asyncHandler)
AWSStepFunctionsAsyncDescribes a state machine.
describeStateMachineAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetActivityTaskResult> getActivityTaskAsync(GetActivityTaskRequest request)
AWSStepFunctionsAsync
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds
as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the
service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the
poll will return a taskToken with a null string.
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
getActivityTaskAsync in interface AWSStepFunctionsAsyncpublic Future<GetActivityTaskResult> getActivityTaskAsync(GetActivityTaskRequest request, AsyncHandler<GetActivityTaskRequest,GetActivityTaskResult> asyncHandler)
AWSStepFunctionsAsync
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds
as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the
service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the
poll will return a taskToken with a null string.
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
getActivityTaskAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetExecutionHistoryResult> getExecutionHistoryAsync(GetExecutionHistoryRequest request)
AWSStepFunctionsAsync
Returns the history of the specified execution as a list of events. By default, the results are returned in
ascending order of the timeStamp of the events. Use the reverseOrder parameter to get
the latest events first. The results may be split into multiple pages. To retrieve subsequent pages, make the
call again using the nextToken returned by the previous call.
getExecutionHistoryAsync in interface AWSStepFunctionsAsyncpublic Future<GetExecutionHistoryResult> getExecutionHistoryAsync(GetExecutionHistoryRequest request, AsyncHandler<GetExecutionHistoryRequest,GetExecutionHistoryResult> asyncHandler)
AWSStepFunctionsAsync
Returns the history of the specified execution as a list of events. By default, the results are returned in
ascending order of the timeStamp of the events. Use the reverseOrder parameter to get
the latest events first. The results may be split into multiple pages. To retrieve subsequent pages, make the
call again using the nextToken returned by the previous call.
getExecutionHistoryAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListActivitiesResult> listActivitiesAsync(ListActivitiesRequest request)
AWSStepFunctionsAsync
Lists the existing activities. The results may be split into multiple pages. To retrieve subsequent pages, make
the call again using the nextToken returned by the previous call.
listActivitiesAsync in interface AWSStepFunctionsAsyncpublic Future<ListActivitiesResult> listActivitiesAsync(ListActivitiesRequest request, AsyncHandler<ListActivitiesRequest,ListActivitiesResult> asyncHandler)
AWSStepFunctionsAsync
Lists the existing activities. The results may be split into multiple pages. To retrieve subsequent pages, make
the call again using the nextToken returned by the previous call.
listActivitiesAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request)
AWSStepFunctionsAsync
Lists the executions of a state machine that meet the filtering criteria. The results may be split into multiple
pages. To retrieve subsequent pages, make the call again using the nextToken returned by the
previous call.
listExecutionsAsync in interface AWSStepFunctionsAsyncpublic Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request, AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
AWSStepFunctionsAsync
Lists the executions of a state machine that meet the filtering criteria. The results may be split into multiple
pages. To retrieve subsequent pages, make the call again using the nextToken returned by the
previous call.
listExecutionsAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListStateMachinesResult> listStateMachinesAsync(ListStateMachinesRequest request)
AWSStepFunctionsAsync
Lists the existing state machines. The results may be split into multiple pages. To retrieve subsequent pages,
make the call again using the nextToken returned by the previous call.
listStateMachinesAsync in interface AWSStepFunctionsAsyncpublic Future<ListStateMachinesResult> listStateMachinesAsync(ListStateMachinesRequest request, AsyncHandler<ListStateMachinesRequest,ListStateMachinesResult> asyncHandler)
AWSStepFunctionsAsync
Lists the existing state machines. The results may be split into multiple pages. To retrieve subsequent pages,
make the call again using the nextToken returned by the previous call.
listStateMachinesAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendTaskFailureResult> sendTaskFailureAsync(SendTaskFailureRequest request)
AWSStepFunctionsAsync
Used by workers to report that the task identified by the taskToken failed.
sendTaskFailureAsync in interface AWSStepFunctionsAsyncpublic Future<SendTaskFailureResult> sendTaskFailureAsync(SendTaskFailureRequest request, AsyncHandler<SendTaskFailureRequest,SendTaskFailureResult> asyncHandler)
AWSStepFunctionsAsync
Used by workers to report that the task identified by the taskToken failed.
sendTaskFailureAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendTaskHeartbeatResult> sendTaskHeartbeatAsync(SendTaskHeartbeatRequest request)
AWSStepFunctionsAsync
Used by workers to report to the service that the task represented by the specified taskToken is
still making progress. This action resets the Heartbeat clock. The Heartbeat threshold
is specified in the state machine's Amazon States Language definition. This action does not in itself create an
event in the execution history. However, if the task times out, the execution history will contain an
ActivityTimedOut event.
The Timeout of a task, defined in the state machine's Amazon States Language definition, is its
maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received.
This operation is only useful for long-lived tasks to report the liveliness of the task.
sendTaskHeartbeatAsync in interface AWSStepFunctionsAsyncpublic Future<SendTaskHeartbeatResult> sendTaskHeartbeatAsync(SendTaskHeartbeatRequest request, AsyncHandler<SendTaskHeartbeatRequest,SendTaskHeartbeatResult> asyncHandler)
AWSStepFunctionsAsync
Used by workers to report to the service that the task represented by the specified taskToken is
still making progress. This action resets the Heartbeat clock. The Heartbeat threshold
is specified in the state machine's Amazon States Language definition. This action does not in itself create an
event in the execution history. However, if the task times out, the execution history will contain an
ActivityTimedOut event.
The Timeout of a task, defined in the state machine's Amazon States Language definition, is its
maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received.
This operation is only useful for long-lived tasks to report the liveliness of the task.
sendTaskHeartbeatAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SendTaskSuccessResult> sendTaskSuccessAsync(SendTaskSuccessRequest request)
AWSStepFunctionsAsync
Used by workers to report that the task identified by the taskToken completed successfully.
sendTaskSuccessAsync in interface AWSStepFunctionsAsyncpublic Future<SendTaskSuccessResult> sendTaskSuccessAsync(SendTaskSuccessRequest request, AsyncHandler<SendTaskSuccessRequest,SendTaskSuccessResult> asyncHandler)
AWSStepFunctionsAsync
Used by workers to report that the task identified by the taskToken completed successfully.
sendTaskSuccessAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartExecutionResult> startExecutionAsync(StartExecutionRequest request)
AWSStepFunctionsAsyncStarts a state machine execution.
startExecutionAsync in interface AWSStepFunctionsAsyncpublic Future<StartExecutionResult> startExecutionAsync(StartExecutionRequest request, AsyncHandler<StartExecutionRequest,StartExecutionResult> asyncHandler)
AWSStepFunctionsAsyncStarts a state machine execution.
startExecutionAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopExecutionResult> stopExecutionAsync(StopExecutionRequest request)
AWSStepFunctionsAsyncStops an execution.
stopExecutionAsync in interface AWSStepFunctionsAsyncpublic Future<StopExecutionResult> stopExecutionAsync(StopExecutionRequest request, AsyncHandler<StopExecutionRequest,StopExecutionResult> asyncHandler)
AWSStepFunctionsAsyncStops an execution.
stopExecutionAsync in interface AWSStepFunctionsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2017. All rights reserved.