Package software.amazon.awssdk.services.transfer.model

Class ExecutionError

java.lang.Object

software.amazon.awssdk.services.transfer.model.ExecutionError

All Implemented Interfaces:

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

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

Specifies the error message and type, for an error that occurs during the execution of the workflow.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExecutionError.Builder

Method Summary

Modifier and Type	Method	Description
static ExecutionError.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	message()	Specifies the descriptive message that corresponds to the ErrorType.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ExecutionError.Builder>	serializableBuilderClass()
ExecutionError.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ExecutionErrorType	type()	Specifies the error type.
String	typeAsString()	Specifies the error type.

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

type

public final ExecutionErrorType type()

Specifies the error type.

• ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.

• BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.

• CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.

• INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.

• NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.

• PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

• TIMEOUT: occurs when the execution times out.

  You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).

• THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

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

Returns:

Specifies the error type.

• ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.

• BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.

• CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.

• INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.

• NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.

• PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

• TIMEOUT: occurs when the execution times out.

  You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).

• THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

See Also:

ExecutionErrorType

typeAsString

public final String typeAsString()

Specifies the error type.

• ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.

• BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.

• CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.

• INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.

• NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.

• PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

• TIMEOUT: occurs when the execution times out.

  You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).

• THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

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

Returns:

Specifies the error type.

• ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the same name already exists in the target location.

• BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns BAD_REQUEST, as only S3 files can be tagged.

• CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.

• INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.

• NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not exist.

• PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or more of the steps in the workflow.

• TIMEOUT: occurs when the execution times out.

  You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30 minutes).

• THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.

See Also:

ExecutionErrorType

message

public final String message()

Specifies the descriptive message that corresponds to the ErrorType.

Returns:

Specifies the descriptive message that corresponds to the ErrorType.

toBuilder

public ExecutionError.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExecutionError.Builder,ExecutionError>

builder

public static ExecutionError.Builder builder()

serializableBuilderClass

public static Class<? extends ExecutionError.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo