com.amazonaws.services.simpleworkflow.model

Class RecordActivityTaskHeartbeatRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.RecordActivityTaskHeartbeatRequest

All Implemented Interfaces:

Serializable

public class RecordActivityTaskHeartbeatRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the RecordActivityTaskHeartbeat operation.

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true .

This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.

This action does not in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

NOTE: The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.

NOTE: This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.

IMPORTANT: If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

See Also:

AmazonSimpleWorkflow.recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
RecordActivityTaskHeartbeatRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDetails() If specified, contains details about the progress of the task.
String	getTaskToken() The taskToken of the ActivityTask.
int	hashCode()
void	setDetails(String details) If specified, contains details about the progress of the task.
void	setTaskToken(String taskToken) The taskToken of the ActivityTask.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RecordActivityTaskHeartbeatRequest	withDetails(String details) If specified, contains details about the progress of the task.
RecordActivityTaskHeartbeatRequest	withTaskToken(String taskToken) The taskToken of the ActivityTask.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RecordActivityTaskHeartbeatRequest

public RecordActivityTaskHeartbeatRequest()

Method Detail

getTaskToken

public String getTaskToken()

The taskToken of the ActivityTask. The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Constraints:
Length: 1 - 1024

Returns:

The taskToken of the ActivityTask. The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

setTaskToken

public void setTaskToken(String taskToken)

The taskToken of the ActivityTask. The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Constraints:
Length: 1 - 1024

Parameters:

taskToken - The taskToken of the ActivityTask. The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

withTaskToken

public RecordActivityTaskHeartbeatRequest withTaskToken(String taskToken)

The taskToken of the ActivityTask. The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

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

Constraints:
Length: 1 - 1024

Parameters:

taskToken - The taskToken of the ActivityTask. The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Returns:

A reference to this updated object so that method calls can be chained together.

getDetails

public String getDetails()

If specified, contains details about the progress of the task.

Constraints:
Length: 0 - 2048

Returns:

If specified, contains details about the progress of the task.

setDetails

public void setDetails(String details)

If specified, contains details about the progress of the task.

Constraints:
Length: 0 - 2048

Parameters:

details - If specified, contains details about the progress of the task.

withDetails

public RecordActivityTaskHeartbeatRequest withDetails(String details)

If specified, contains details about the progress of the task.

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

Constraints:
Length: 0 - 2048

Parameters:

details - If specified, contains details about the progress of the task.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object