Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.simpleworkflow.model;
 
 
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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

 
 public class RecordActivityTaskHeartbeatRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
The taskToken of the ActivityTask. <important> 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. </important>

Constraints:
Length: 1 - 1024

    private String taskToken;

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

Constraints:
Length: 0 - 2048

    private String details;

    
The taskToken of the ActivityTask. <important> 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. </important>

Constraints:
Length: 1 - 1024

Returns:
The taskToken of the ActivityTask. <important> 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. </important>
    public String getTaskToken() {
        return ;
    }
    
    
The taskToken of the ActivityTask. <important> 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. </important>

Constraints:
Length: 1 - 1024

Parameters:
taskToken The taskToken of the ActivityTask. <important> 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. </important>
    public void setTaskToken(String taskToken) {
        this. = taskToken;
    }
    
    
The taskToken of the ActivityTask. <important> 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. </important>

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. <important> 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. </important>
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = taskToken;
        return this;
    }

    
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.
    public String getDetails() {
        return ;
    }
    
    
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.
    public void setDetails(String details) {
        this. = 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.
        this. = details;
        return this;
    }

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

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getTaskToken() != nullsb.append("TaskToken: " + getTaskToken() + ",");
        if (getDetails() != nullsb.append("Details: " + getDetails() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getTaskToken() == null) ? 0 : getTaskToken().hashCode()); 
        hashCode = prime * hashCode + ((getDetails() == null) ? 0 : getDetails().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof RecordActivityTaskHeartbeatRequest == falsereturn false;
        
        if (other.getTaskToken() == null ^ this.getTaskToken() == nullreturn false;
        if (other.getTaskToken() != null && other.getTaskToken().equals(this.getTaskToken()) == falsereturn false
        if (other.getDetails() == null ^ this.getDetails() == nullreturn false;
        if (other.getDetails() != null && other.getDetails().equals(this.getDetails()) == falsereturn false
        return true;
    }
    
    @Override
        
            return (RecordActivityTaskHeartbeatRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X