com.amazonaws.services.transfer.model

Class ExecutionError

java.lang.Object

com.amazonaws.services.transfer.model.ExecutionError

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExecutionError
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExecutionError()

Method Summary

Modifier and Type	Method and Description
ExecutionError	clone()
boolean	equals(Object obj)
String	getMessage() Specifies the descriptive message that corresponds to the ErrorType.
String	getType() Specifies the error type.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setMessage(String message) Specifies the descriptive message that corresponds to the ErrorType.
void	setType(String type) Specifies the error type.
String	toString() Returns a string representation of this object.
ExecutionError	withMessage(String message) Specifies the descriptive message that corresponds to the ErrorType.
ExecutionError	withType(ExecutionErrorType type) Specifies the error type.
ExecutionError	withType(String type) Specifies the error type.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecutionError

public ExecutionError()

Method Detail

setType

public void setType(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.

See Also:

ExecutionErrorType

getType

public String getType()

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:

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

withType

public ExecutionError withType(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

withType

public ExecutionError withType(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

setMessage

public void setMessage(String message)

Specifies the descriptive message that corresponds to the ErrorType.

Parameters:

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

getMessage

public String getMessage()

Specifies the descriptive message that corresponds to the ErrorType.

Returns:

Specifies the descriptive message that corresponds to the ErrorType.

withMessage

public ExecutionError withMessage(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ExecutionError clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.