com.ansys.ingress.client.api.transfers

## Class TransferEvent.Error

- java.lang.Object
- - com.ansys.ingress.client.api.transfers.TransferEvent.Error

- Enclosing class:
    TransferEvent

      public class TransferEvent.Error
      extends java.lang.Object

  Error describes an error that occured during the transfer.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `Error()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addFailedItem(java.lang.String failedPath, java.lang.Throwable reason)` Adds a failed item.
    `java.lang.Throwable` | `getException()`
    `java.util.List<TransferEvent.FailedItem>` | `getFailedItems()`
    `java.util.List<java.lang.String>` | `getFailures()`
    `java.lang.String` | `getMessage()`
    `java.lang.Throwable` | `getRootCause()`
    `java.lang.String` | `getStackTrace()`
    `void` | `setException(java.lang.Throwable exception)` Sets the exception that caused the error.
    `void` | `setFailures(java.util.List<java.lang.String> failures)` Sets the list of files and folders that were not transferred due to errors.
    `java.lang.String` | `toString()`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### Error

          public Error()

  - ### Method Detail

    - #### getException

          public java.lang.Throwable getException()

      Returns:
        Returns the exception that caused the error.

    - #### getFailures

          public java.util.List<java.lang.String> getFailures()

      Returns:
        Returns a list of files and folders that were not transferred.

    - #### getMessage

          public java.lang.String getMessage()

      Returns:
        Returns the message describing the exception.

    - #### getRootCause

          public java.lang.Throwable getRootCause()

      Returns:
        Returns the root cause of the error. This may be the same as the exception returned by `getException()`.

    - #### getStackTrace

          public java.lang.String getStackTrace()

      Returns:
        Returns the stack trace of the error as a string.

    - #### setException

          public void setException(java.lang.Throwable exception)

      Sets the exception that caused the error.
      Parameters:
        `exception` - the exception

    - #### setFailures

          public void setFailures(java.util.List<java.lang.String> failures)

      Sets the list of files and folders that were not transferred due to errors.
      Parameters:
        `failures` - the list of files and folders

    - #### toString

          public java.lang.String toString()

      Overrides:
        `toString` in class `java.lang.Object`

    - #### addFailedItem

          public void addFailedItem(java.lang.String failedPath,
                                    java.lang.Throwable reason)

      Adds a failed item.
      Parameters:
        `failedPath` - the path of the item
        `reason` - the reason for the failure

    - #### getFailedItems

          public java.util.List<TransferEvent.FailedItem> getFailedItems()

      Returns:
        Returns all of the failed items.