logDownloadStatus

The logDownloadStatus data type describes the download status for General and S Series Nodes.

logDownloadStatus data type properties

The following table describes the properties included in the logDownloadStatus data type.

Property nameData typeDescriptionNotes
readyForStreamingBoolean

Specifies whether the download package is ready to be downloaded. Valid values are:

  • true

    The logs have been prepared are ready for download.

  • false

    The logs have either not been prepared, are still being prepared, or they have not been downloaded for twenty four hours after being prepared and so have been deleted.

streamingInProgressBoolean

Specifies whether the download package is currently being downloaded. Valid values are:

  • true

    The logs are currently being downloaded.

  • false

    The logs are not currently being downloaded.

startedBoolean

Specifies whether the download package is currently being prepared. Valid values are:

  • true

    The logs are currently being prepared for download.

  • false

    The logs are not currently being prepared for downloaded.

errorBoolean

Specifies whether an error has occurred during the package preparation or download phase. Valid values are:

  • true

    The logs are experiencing an error with being prepared or downloaded.

  • false

    The logs are not experiencing an error with being prepared or downloaded.

contentString

Specifies, through a comma-separated list, the General Nodes log types being downloaded. The possible types are:

  • ACCESS
  • SYSTEM
  • SERVICE
  • APPLICATION
This list does not apply to HCP S Series Nodes. All list types are taken from HCP S Series Nodes regardless of the content.

Example

Here's an XML example of the logDownloadStatus data type:

<logDownloadStatus>
    <readyForStreaming>true</readyForStreaming>
    <streamingInProgress>false</streamingInProgress>
    <started>true</started>
    <error>false</error>
    <content>ACCESS,SYSTEM,SERVICE,APPLICATION</content>
</logDownloadStatus>