Managed Object - ConverterServerDiagnosticManager

Extends
ConverterDiagnosticManager
See also
ConverterDiagnosticManagerTaskLogBundleInfo, ConverterServerJobJob
Since
Converter API 5.0


Managed Object Description

Provides an interface to get job related diagnostic bundles containing low-level debugging logs. For conversion jobs this includes the task log bundles for all tasks associated with the job as well as the related server logs.

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

ConverterGenerateJobLogBundle

Instructs the server to generate diagnostic bundle for the specified job. A diagnostic bundle includes log files and other configuration information that can be used to investigate failures.

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterServerDiagnosticManager used to make the method call.
job* PManagedObjectReference
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
*Need not be set P Required privilege: job

Return Value

Type Description
ConverterDiagnosticManagerTaskLogBundleInfoA TaskLogBundleInfo object for the diagnostic bundle that has been generated.

Faults

Type Description
InvalidStateThrown if the Task is still running.
LogBundlingFailedThrown 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.
NoPermissionThrown if the user has no permission to access the diagnostic logs for this task.
NotFoundThrown if the Task was not found on the server.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None