software.amazon.awssdk.services.datapipeline.model

Class TaskObject

java.lang.Object

software.amazon.awssdk.services.datapipeline.model.TaskObject

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TaskObject.Builder,TaskObject>

@Generated(value="software.amazon.awssdk:codegen")
public final class TaskObject
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TaskObject.Builder,TaskObject>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TaskObject.Builder

Method Summary

Modifier and Type	Method and Description
String	attemptId() The ID of the pipeline task attempt object.
static TaskObject.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasObjects() For responses, this returns true if the service returned a value for the Objects property.
Map<String,PipelineObject>	objects() Connection information for the location where the task runner will publish the output of the task.
String	pipelineId() The ID of the pipeline that provided the task.
List<SdkField<?>>	sdkFields()
static Class<? extends TaskObject.Builder>	serializableBuilderClass()
String	taskId() An internal identifier for the task.
TaskObject.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

taskId

public final String taskId()

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

Returns:

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

pipelineId

public final String pipelineId()

The ID of the pipeline that provided the task.

Returns:

The ID of the pipeline that provided the task.

attemptId

public final 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:

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

hasObjects

public final boolean hasObjects()

For responses, this returns true if the service returned a value for the Objects property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

objects

public final Map<String,PipelineObject> objects()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasObjects() method.

Returns:

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

toBuilder

public TaskObject.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TaskObject.Builder,TaskObject>

builder

public static TaskObject.Builder builder()

serializableBuilderClass

public static Class<? extends TaskObject.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo