Class ExecutionError
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ExecutionError.Builder,
ExecutionError>
Specifies the error message and type, for an error that occurs during the execution of the workflow.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ExecutionError.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
message()
Specifies the descriptive message that corresponds to theErrorType
.static Class
<? extends ExecutionError.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ExecutionErrorType
type()
Specifies the error type.final String
Specifies the error type.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnsBAD_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 returnExecutionErrorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- 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 returnsBAD_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:
-
-
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 returnsBAD_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 returnExecutionErrorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- 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 returnsBAD_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:
-
-
message
Specifies the descriptive message that corresponds to the
ErrorType
.- Returns:
- Specifies the descriptive message that corresponds to the
ErrorType
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ExecutionError.Builder,
ExecutionError> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-