com.ansys.ingress.client.api.transfers

## Enum TransferEvent.Reason

- java.lang.Object
- - java.lang.Enum<TransferEvent.Reason>
  - - com.ansys.ingress.client.api.transfers.TransferEvent.Reason

- All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TransferEvent.Reason>
  Enclosing class:
    TransferEvent

      public static enum TransferEvent.Reason
      extends java.lang.Enum<TransferEvent.Reason>

  Reason is the reason for the event.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `CACHED` Reason for the event: the transfer finished sending the data to the cache server.
    `COMPLETED` Reason for the event: the transfer completed
    `ERROR` Reason for the event: the transfer failed
    `FILE_DOWNLOADED` Reason for the event: file was downloaded
    `METADATA_EXTRACTION_ENDED` Reason for the event: metadata extraction ended on the server
    `METADATA_EXTRACTION_STARTED` Reason for the event: metatdata extraction started on the server
    `PROGRESS` Reason for the event: the transfer is reporting progress
    `STARTED` Reason for the event: the transfer was started
    `TERMINATED` Reason for the event: the transfer was terminated

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static TransferEvent.Reason` | `fromValue(java.lang.String v)` Gets a `TransferEvent.Reason` from a string value.
    `java.lang.String` | `value()`
    `static TransferEvent.Reason` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
    `static TransferEvent.Reason[]` | `values()` Returns an array containing the constants of this enum type, in the order they are declared.

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

      `clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

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

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### STARTED

          public static final TransferEvent.Reason STARTED

      Reason for the event: the transfer was started

    - #### COMPLETED

          public static final TransferEvent.Reason COMPLETED

      Reason for the event: the transfer completed

    - #### ERROR

          public static final TransferEvent.Reason ERROR

      Reason for the event: the transfer failed

    - #### PROGRESS

          public static final TransferEvent.Reason PROGRESS

      Reason for the event: the transfer is reporting progress

    - #### CACHED

          public static final TransferEvent.Reason CACHED

      Reason for the event: the transfer finished sending the data to the cache server.

    - #### TERMINATED

          public static final TransferEvent.Reason TERMINATED

      Reason for the event: the transfer was terminated

    - #### METADATA_EXTRACTION_STARTED

          public static final TransferEvent.Reason METADATA_EXTRACTION_STARTED

      Reason for the event: metatdata extraction started on the server

    - #### METADATA_EXTRACTION_ENDED

          public static final TransferEvent.Reason METADATA_EXTRACTION_ENDED

      Reason for the event: metadata extraction ended on the server

    - #### FILE_DOWNLOADED

          public static final TransferEvent.Reason FILE_DOWNLOADED

      Reason for the event: file was downloaded

  - ### Method Detail

    - #### values

          public static TransferEvent.Reason[] values()

      Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

          for (TransferEvent.Reason c : TransferEvent.Reason.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

          public static TransferEvent.Reason valueOf(java.lang.String name)

      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
        `name` - the name of the enum constant to be returned.
      Returns:
        the enum constant with the specified name
      Throws:
        `java.lang.IllegalArgumentException` - if this enum type has no constant with the specified name
        `java.lang.NullPointerException` - if the argument is null

    - #### value

          public java.lang.String value()

      Returns:
        Returns the string value for the reason.

    - #### fromValue

          public static TransferEvent.Reason fromValue(java.lang.String v)

      Gets a `TransferEvent.Reason` from a string value.
      Parameters:
        `v` - the string value
      Returns:
        Returns the `TransferEvent.Reason` associated with the given value.