com.amazonaws.services.datapipeline.model

Class ReportTaskProgressRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datapipeline.model.ReportTaskProgressRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ReportTaskProgressRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ReportTaskProgress operation.

Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline.

If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds.

See Also:

DataPipeline.reportTaskProgress(ReportTaskProgressRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ReportTaskProgressRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ReportTaskProgressRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<Field>	getFields() Key-value pairs that define the properties of the ReportTaskProgressInput object.
String	getTaskId() The ID of the task assigned to the task runner.
int	hashCode()
void	setFields(Collection<Field> fields) Key-value pairs that define the properties of the ReportTaskProgressInput object.
void	setTaskId(String taskId) The ID of the task assigned to the task runner.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ReportTaskProgressRequest	withFields(Collection<Field> fields) Key-value pairs that define the properties of the ReportTaskProgressInput object.
ReportTaskProgressRequest	withFields(Field... fields) Key-value pairs that define the properties of the ReportTaskProgressInput object.
ReportTaskProgressRequest	withTaskId(String taskId) The ID of the task assigned to the task runner.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportTaskProgressRequest

public ReportTaskProgressRequest()

Method Detail

getTaskId

public String getTaskId()

The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

setTaskId

public void setTaskId(String taskId)

The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

taskId - The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

withTaskId

public ReportTaskProgressRequest withTaskId(String taskId)

The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

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

Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

taskId - The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

Returns:

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

getFields

public List<Field> getFields()

Key-value pairs that define the properties of the ReportTaskProgressInput object.

Returns:

Key-value pairs that define the properties of the ReportTaskProgressInput object.

setFields

public void setFields(Collection<Field> fields)

Key-value pairs that define the properties of the ReportTaskProgressInput object.

Parameters:

fields - Key-value pairs that define the properties of the ReportTaskProgressInput object.

withFields

public ReportTaskProgressRequest withFields(Field... fields)

Key-value pairs that define the properties of the ReportTaskProgressInput object.

NOTE: This method appends the values to the existing list (if any). Use setFields(java.util.Collection) or withFields(java.util.Collection) if you want to override the existing values.

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

Parameters:

fields - Key-value pairs that define the properties of the ReportTaskProgressInput object.

Returns:

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

withFields

public ReportTaskProgressRequest withFields(Collection<Field> fields)

Key-value pairs that define the properties of the ReportTaskProgressInput object.

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

Parameters:

fields - Key-value pairs that define the properties of the ReportTaskProgressInput object.

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

clone

public ReportTaskProgressRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()