logDownloadStatus

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

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 name Data type Description Notes
readyForStreaming Boolean

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.
streamingInProgress Boolean

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.
started Boolean

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.
error Boolean

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.
content String

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>