com.amazonaws.services.datapipeline.model

Class TaskObject

java.lang.Object

com.amazonaws.services.datapipeline.model.TaskObject

All Implemented Interfaces:

Serializable, Cloneable

public class TaskObject
extends Object
implements Serializable, Cloneable

Contains information about a pipeline task that is assigned to a task runner.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TaskObject()

Method Summary

Methods

Modifier and Type	Method and Description
TaskObject	addObjectsEntry(String key, PipelineObject value) Connection information for the location where the task runner will publish the output of the task.
TaskObject	clearObjectsEntries() Removes all the entries added into Objects.
TaskObject	clone()
boolean	equals(Object obj)
String	getAttemptId() The ID of the pipeline task attempt object.
Map<String,PipelineObject>	getObjects() Connection information for the location where the task runner will publish the output of the task.
String	getPipelineId() The ID of the pipeline that provided the task.
String	getTaskId() An internal identifier for the task.
int	hashCode()
void	setAttemptId(String attemptId) The ID of the pipeline task attempt object.
void	setObjects(Map<String,PipelineObject> objects) Connection information for the location where the task runner will publish the output of the task.
void	setPipelineId(String pipelineId) The ID of the pipeline that provided the task.
void	setTaskId(String taskId) An internal identifier for the task.
String	toString() Returns a string representation of this object; useful for testing and debugging.
TaskObject	withAttemptId(String attemptId) The ID of the pipeline task attempt object.
TaskObject	withObjects(Map<String,PipelineObject> objects) Connection information for the location where the task runner will publish the output of the task.
TaskObject	withPipelineId(String pipelineId) The ID of the pipeline that provided the task.
TaskObject	withTaskId(String taskId) An internal identifier for the task.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskObject

public TaskObject()

Method Detail

getTaskId

public String getTaskId()

An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

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

Returns:

An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

setTaskId

public void setTaskId(String taskId)

An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

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

Parameters:

taskId - An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

withTaskId

public TaskObject withTaskId(String taskId)

An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

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 - An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

Returns:

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

getPipelineId

public String getPipelineId()

The ID of the pipeline that provided the task.

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

Returns:

The ID of the pipeline that provided the task.

setPipelineId

public void setPipelineId(String pipelineId)

The ID of the pipeline that provided the task.

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

Parameters:

pipelineId - The ID of the pipeline that provided the task.

withPipelineId

public TaskObject withPipelineId(String pipelineId)

The ID of the pipeline that provided the task.

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

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

Parameters:

pipelineId - The ID of the pipeline that provided the task.

Returns:

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

getAttemptId

public String getAttemptId()

The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

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

Returns:

The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

setAttemptId

public void setAttemptId(String attemptId)

The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

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

Parameters:

attemptId - The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

withAttemptId

public TaskObject withAttemptId(String attemptId)

The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

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

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

Parameters:

attemptId - The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

Returns:

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

getObjects

public Map<String,PipelineObject> getObjects()

Connection information for the location where the task runner will publish the output of the task.

Returns:

Connection information for the location where the task runner will publish the output of the task.

setObjects

public void setObjects(Map<String,PipelineObject> objects)

Connection information for the location where the task runner will publish the output of the task.

Parameters:

objects - Connection information for the location where the task runner will publish the output of the task.

withObjects

public TaskObject withObjects(Map<String,PipelineObject> objects)

Connection information for the location where the task runner will publish the output of the task.

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

Parameters:

objects - Connection information for the location where the task runner will publish the output of the task.

Returns:

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

addObjectsEntry

public TaskObject addObjectsEntry(String key,
                         PipelineObject value)

Connection information for the location where the task runner will publish the output of the task.

The method adds a new key-value pair into Objects parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Objects.

value - The corresponding value of the entry to be added into Objects.

clearObjectsEntries

public TaskObject clearObjectsEntries()

Removes all the entries added into Objects.

Returns a reference to this 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 TaskObject clone()

Overrides:

clone in class Object