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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<ExecutionError.Builder,ExecutionError>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.