| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
ConverterDeleteTaskLogBundle, ConverterGenerateLogBundle, ConverterGenerateTaskLogBundle, ConverterRetrieveTaskLogBundle, ConverterRetrieveTaskLogBundleUrl |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterDiagnosticManager used to make the method call. |
key P | xsd:string |
The TaskLogBundleInfo key parameter returned by
a call to generateTaskLogBundle.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
CannotDeleteFile | |
NotFound | Thrown if the TaskLogBundleInfo key was not found. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterDiagnosticManager used to make the method call. |
source* P | ConverterComputerSpec |
Specifies ComputerSpec object of the source for which
to generate the diagnostic bundle.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
ConverterDiagnosticManagerTaskLogBundleInfo | A TaskLogBundleInfo object for the diagnostic bundle that has been generated. |
Faults
Type | Description |
---|---|
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. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterDiagnosticManager used to make the method call. |
task* P | ManagedObjectReference
to a ConverterTask |
Specifies the Task object for which to generate
the diagnostic bundle. If this parameter is not
specified then only the server diagnostic logs
are added to the bundle.
Since Converter API 1.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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterDiagnosticManager used to make the method call. |
key P | xsd:string |
The TaskLogBundleInfo key parameter returned by
a call to generateTaskLogBundle.
Since Converter API 1.0 |
offset P | xsd:long |
Byte offset into the bundle file to the start of
the chunk that is to be returned.
Since Converter API 1.0 |
maxPageSize P | xsd:long |
Maximum size in bytes of the chunk to be returned.
This parameter can be used to control the size and
number of chunks with which to retrieve a bundle.
The maximum page size can also be limited internally
by the server so the size of the returned chunk may
be smaller than maxPageSize even if the bundle file
contains more bytes.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
xsd:string | A Base64 encoded string containing the requested chunk of the bundle file. Its length may be less than the maxPageSize. |
Faults
Type | Description |
---|---|
NotFound | Thrown if the TaskLogBundleInfo key was not found. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterDiagnosticManager used to make the method call. |
key P | xsd:string |
The TaskLogBundleInfo key parameter returned by
a call to generateTaskLogBundle.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
xsd:string | A URL for the location of the diagnostic bundle. |
Faults
Type | Description |
---|---|
InvalidState | Thrown if the server does not support HTTP GET. The caller can download the bundle using an HTTP GET operation for the returned URL. 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. |
NotFound | Thrown if the TaskLogBundleInfo key was not found. |
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 |