com.ansys.ingress.client.api

## Class CacheStatus

- java.lang.Object
- - com.ansys.ingress.client.api.CacheStatus

-     public class CacheStatus
      extends java.lang.Object

  CacheStatus provides status information about transfers that are using the EKM cache server.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `ACTIVE` ACTIVE - the transfer is currently active on the EKM cache server.
    `static int` | `COMPLETED` COMPLETED - the EKM cache server has completed the transfer.
    `static int` | `FAILED` FAILED - the EKM cache server encountered an error in the transfer.
    `static int` | `NOT_FOUND` NOT_FOUND - no status exists for the given ID.

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `CacheStatus()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getDescription()`
    `java.util.Date` | `getEndTime()`
    `java.lang.String` | `getError()`
    `int` | `getPercentComplete()`
    `java.util.Date` | `getStartTime()`
    `int` | `getStatus()`
    `java.lang.String` | `getTaskName()`
    `void` | `setDescription(java.lang.String description)` Sets the description of the transfer.
    `void` | `setEndTime(java.util.Date endTime)` Sets the time when the transfer completed.
    `void` | `setError(java.lang.String error)` Sets the error message for a failed transfer.
    `void` | `setPercentComplete(int percentComplete)` Sets the percentage of the transfer that is complete.
    `void` | `setStartTime(java.util.Date startTime)` Sets the time when the transfer started.
    `void` | `setStatus(int status)` Sets the status of the transfer.
    `void` | `setTaskName(java.lang.String taskName)` Sets the current task name being executed by the cache server.

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

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

- - ### Field Detail

    - #### ACTIVE

          public static final int ACTIVE

      ACTIVE - the transfer is currently active on the EKM cache server.
      See Also:
        Constant Field Values

    - #### COMPLETED

          public static final int COMPLETED

      COMPLETED - the EKM cache server has completed the transfer.
      See Also:
        Constant Field Values

    - #### FAILED

          public static final int FAILED

      FAILED - the EKM cache server encountered an error in the transfer.
      See Also:
        Constant Field Values

    - #### NOT_FOUND

          public static final int NOT_FOUND

      NOT_FOUND - no status exists for the given ID.
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### CacheStatus

          public CacheStatus()

  - ### Method Detail

    - #### getDescription

          public java.lang.String getDescription()

      Returns:
        Returns the description of the transfer.

    - #### getEndTime

          public java.util.Date getEndTime()

      Returns:
        Returns the time when the transfer completed.

    - #### getError

          public java.lang.String getError()

      Returns:
        Returns an error message if the transfer failed.

    - #### getPercentComplete

          public int getPercentComplete()

      Returns:
        Returns the percentage of the transfer that is completed.

    - #### getStartTime

          public java.util.Date getStartTime()

      Returns:
        Returns the start time of the transfer.

    - #### getStatus

          public int getStatus()

      Returns:
        Returns the status of the transfer.
      See Also:
        `ACTIVE`, `COMPLETED`, `FAILED`, `NOT_FOUND`

    - #### getTaskName

          public java.lang.String getTaskName()

      Returns:
        Returns the current the task being executed by the cache server.

    - #### setDescription

          public void setDescription(java.lang.String description)

      Sets the description of the transfer.
      Parameters:
        `description` - the description to set

    - #### setEndTime

          public void setEndTime(java.util.Date endTime)

      Sets the time when the transfer completed.
      Parameters:
        `endTime` - the endTime to set

    - #### setError

          public void setError(java.lang.String error)

      Sets the error message for a failed transfer.
      Parameters:
        `error` - the error to set

    - #### setPercentComplete

          public void setPercentComplete(int percentComplete)

      Sets the percentage of the transfer that is complete.
      Parameters:
        `percentComplete` - the percentComplete to set

    - #### setStartTime

          public void setStartTime(java.util.Date startTime)

      Sets the time when the transfer started.
      Parameters:
        `startTime` - the startTime to set

    - #### setStatus

          public void setStatus(int status)

      Sets the status of the transfer.
      Parameters:
        `status` - the status to set
      See Also:
        `ACTIVE`, `COMPLETED`, `FAILED`, `NOT_FOUND`

    - #### setTaskName

          public void setTaskName(java.lang.String taskName)

      Sets the current task name being executed by the cache server.
      Parameters:
        `taskName` - the taskName to set