| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None | ||
Properties inherited from ConverterDiagnosticManager | ||
None |
Methods
Methods defined in this Managed Object |
---|
ConverterGenerateJobLogBundle |
Methods inherited from ConverterDiagnosticManager |
ConverterDeleteTaskLogBundle, ConverterGenerateLogBundle, ConverterGenerateTaskLogBundle, ConverterRetrieveTaskLogBundle, ConverterRetrieveTaskLogBundleUrl |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterServerDiagnosticManager used to make the method call. |
job* P | ManagedObjectReference
to a ConverterServerJobJob |
Specifies the Job object for which to generate
the diagnostic bundle. It will include the diagnostic
bundles for all tasks associated with that job if
present.
If this parameter is not specified then only the server
diagnostic logs are added to the bundle.
Since Converter API 5.0 |
Return Value
Type | Description |
---|---|
ConverterDiagnosticManagerTaskLogBundleInfo | A TaskLogBundleInfo object for the diagnostic bundle that has been generated. |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the Task is still running. |
LogBundlingFailed | Thrown if generation of support bundle failed. The caller can download the bundle using an HTTP GET operation for the URL returned by retrieveTaskLogBundleUrl or alternatively the bundle can be retrieved with calls to retrieveTaskLogBundle. Bundles are usually available for at least 24 hours, but the caller should not assume that the returned URLs are valid indefinitely. Servers often automatically delete generated diagnostic bundles after some given period of time. |
NoPermission | Thrown if the user has no permission to access the diagnostic logs for this task. |
NotFound | Thrown if the Task was not found on the server. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |