@Generated(value="software.amazon.awssdk:codegen") public final class SetTaskStatusRequest extends DataPipelineRequest implements ToCopyableBuilder<SetTaskStatusRequest.Builder,SetTaskStatusRequest>
Contains the parameters for SetTaskStatus.
Modifier and Type | Class and Description |
---|---|
static interface |
SetTaskStatusRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static SetTaskStatusRequest.Builder |
builder() |
boolean |
equals(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)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String taskId()
The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
public 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()
.
FINISHED
, the task successfully completed. If FAILED
, the task ended
unsuccessfully. Preconditions use false.TaskStatus
public 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()
.
FINISHED
, the task successfully completed. If FAILED
, the task ended
unsuccessfully. Preconditions use false.TaskStatus
public 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.
public 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.
public 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.
public SetTaskStatusRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SetTaskStatusRequest.Builder,SetTaskStatusRequest>
toBuilder
in class DataPipelineRequest
public static SetTaskStatusRequest.Builder builder()
public static Class<? extends SetTaskStatusRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.