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

Interface ExecutionError.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ExecutionError.Builder,ExecutionError>, SdkBuilder<ExecutionError.Builder,ExecutionError>, SdkPojo

Enclosing class:

ExecutionError

public static interface ExecutionError.Builder
extends SdkPojo, CopyableBuilder<ExecutionError.Builder,ExecutionError>

Method Summary

Modifier and Type	Method	Description
ExecutionError.Builder	message(String message)	Specifies the descriptive message that corresponds to the ErrorType.
ExecutionError.Builder	type(String type)	Specifies the error type.
ExecutionError.Builder	type(ExecutionErrorType type)	Specifies the error type.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

type

ExecutionError.Builder type(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExecutionErrorType, ExecutionErrorType

type

ExecutionError.Builder type(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExecutionErrorType, ExecutionErrorType

message

ExecutionError.Builder message(String message)

Specifies the descriptive message that corresponds to the ErrorType.

Parameters:

message - Specifies the descriptive message that corresponds to the ErrorType.

Returns:

Returns a reference to this object so that method calls can be chained together.