Package software.amazon.awssdk.services.datapipeline.model

Class SetTaskStatusRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datapipeline.model.DataPipelineRequest

software.amazon.awssdk.services.datapipeline.model.SetTaskStatusRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetTaskStatusRequest.Builder,SetTaskStatusRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SetTaskStatusRequest
extends DataPipelineRequest
implements ToCopyableBuilder<SetTaskStatusRequest.Builder,SetTaskStatusRequest>

Contains the parameters for SetTaskStatus.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SetTaskStatusRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SetTaskStatusRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorId()	If an error occurred during the task, this value specifies the error code.
String	errorMessage()	If an error occurred during the task, this value specifies a text description of the error.
String	errorStackTrace()	If an error occurred during the task, this value specifies the stack trace associated with the error.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SetTaskStatusRequest.Builder>	serializableBuilderClass()
String	taskId()	The ID of the task assigned to the task runner.
TaskStatus	taskStatus()	If FINISHED, the task successfully completed.
String	taskStatusAsString()	If FINISHED, the task successfully completed.
SetTaskStatusRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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()

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

Returns:

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

taskStatus

public final TaskStatus taskStatus()

If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

If the service returns an enum value that is not available in the current SDK version, taskStatus will return TaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskStatusAsString().

Returns:

If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

See Also:

TaskStatus

taskStatusAsString

public final String taskStatusAsString()

If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

If the service returns an enum value that is not available in the current SDK version, taskStatus will return TaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskStatusAsString().

Returns:

If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

See Also:

TaskStatus

errorId

public final String errorId()

If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.

Returns:

If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.

errorMessage

public final String errorMessage()

If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

Returns:

If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

errorStackTrace

public final String errorStackTrace()

If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

Returns:

If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

toBuilder

public SetTaskStatusRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetTaskStatusRequest.Builder,SetTaskStatusRequest>

Specified by:

toBuilder in class DataPipelineRequest

builder

public static SetTaskStatusRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo