# Managed Object - ConverterTaskManager

Property of
  ConverterHelperServiceContent, ConverterServiceContent
See also
  ConverterRuntimeEnvironmentInfo, ConverterTask, ConverterTaskDescription, ConverterTaskFilterSpec, ConverterTaskHistoryCollector, ConverterTaskInfo, ConverterTaskSpec
Since
  Converter API 1.0

## Managed Object Description

Clients use the task manager to access tasks and information on tasks.

Properties

Name | Type | Description
--- | --- | ---
description | ConverterTaskDescription | Static descriptive strings used to represent task information to users. These strings are locale-specific.
maxCollector | xsd:int | For each client, the maximum number of task collectors that can exist simultaneously.
maxConnection | xsd:int | The maximum number of concurrent connections within one task. (0 means unlimited) When value is not set then defaults to 2 simultaneous connections. Since Converter API 5.0
maxTask | xsd:int | The maximum number of concurrent tasks.
recentTask* | ManagedObjectReference[] to a ConverterTask[] | Tasks that completed recently, are currently running, or are queued to run.

*May not be present

Methods

Methods defined in this Managed Object
ConverterCreateCollectorForTasks, ConverterCreateTask, ConverterDestroyTask, ConverterEstimateTimeToComplete, ConverterGetChildTask, ConverterGetTaskInfo, ConverterGetTaskSpec, ConverterGetUuid, ConverterIsEnableTelemetry, ConverterSetEnableTelemetry, ConverterSetMaxConnection, ConverterSetMaxTask

# ConverterCreateCollectorForTasks

Creates a task history collector, as a specialized history collector that provides TaskInfo objects.

Task collectors do not persist beyond the current client session.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call.
filter P | ConverterTaskFilterSpec | The specification for the task query filter. Since Converter API 1.0

P Required privilege: filter

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTaskHistoryCollector | The task collector based on the filter.

Faults

Type | Description
--- | ---
InvalidState | Thrown if there are more than the maximum number of task collectors.
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

# ConverterCreateTask

Deprecated. as of Converter API 3.0. Tasks are integral part of jobs and ought not be created on their own. Leaved for Fusion/WS interoperability. Use ConverterServerConversionManagerCreateJob

Creates a new task, specifying the specification of the task and whether the task is cancelable.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call.
taskSpec P | ConverterTaskSpec | Task specification. Since Converter API 1.0

P Required privilege: taskSpec

Return Value

Type | Description
--- | ---
ConverterTaskInfo | TaskInfo Data object describing the new task.

Faults

Type | Description
--- | ---
InvalidLogin | Thrown if managed entity is specified but authentication with the host fails.
InvalidName | Thrown if the source or target name is not valid.
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

# ConverterDestroyTask

Deprecated. as of Converter API 3.0. Tasks are integral part of jobs and ought not be created on their own. Leaved for Fusion/WS interoperability. Use ConverterServerConversionManagerDestroyJob

Removes a task.

Required Privileges
  Task.Update

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call.
task P | ManagedObjectReference to a ConverterTask | Task object. Since Converter API 1.0

P Required privilege: task

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidState | Thrown if the task is queued or running.
NotFound | Thrown if the task could not be 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

# ConverterEstimateTimeToComplete

Estimates the time in seconds that will be required to sucessfully complete the given task.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call.
taskSpec P | ConverterTaskSpec | The specification of the task that should be estimated. Since Converter API 1.0
envInfo P | ConverterRuntimeEnvironmentInfo | Additional information on the environment in which the task will run. Since Converter API 1.0

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
xsd:int | The estimated time remaining to complete the task in seconds.

Faults

Type | Description
--- | ---
InvalidLogin | Thrown if authentication with the host fails.
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

# ConverterGetChildTask

Gets the list of child tasks by parent task.

Required Privileges
  None
Since
  Converter API 2.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call.
task P | ManagedObjectReference to a ConverterTask | Task object. Since Converter API 2.0

P Required privilege: task

Return Value

Type | Description
--- | ---
ConverterTaskInfo[] | Array of TaskInfo data objects describing the child tasks of the parent task.

Faults

Type | Description
--- | ---
NotFound | Thrown if the task could not be 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

# ConverterGetTaskInfo

Gets detailed information about a task.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call.
task P | ManagedObjectReference | Task object. Since Converter API 1.0

P Required privilege: task

Return Value

Type | Description
--- | ---
ConverterTaskInfo | TaskInfo Data object describing the task information.

Faults

Type | Description
--- | ---
NotFound | Thrown if the task could not be 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

# ConverterGetTaskSpec

Gets detailed specification about a task.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call.
task P | ManagedObjectReference | Task object. Since Converter API 1.0

P Required privilege: task

Return Value

Type | Description
--- | ---
ConverterTaskSpec | TaskSpec Data object describing the task specification.

Faults

Type | Description
--- | ---
NotFound | Thrown if the task could not be 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

# ConverterGetUuid

Required Privileges
  None
Since
  Converter API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call.

Return Value

Type | Description
--- | ---
xsd:string |

Faults

Type | Description
--- | ---
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

# ConverterIsEnableTelemetry

Required Privileges
  None
Since
  Converter API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call.

Return Value

Type | Description
--- | ---
xsd:boolean |

Faults

Type | Description
--- | ---
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

# ConverterSetEnableTelemetry

Required Privileges
  Task.Update
Since
  Converter API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call.
enable P | xsd:boolean | Since Converter API 7.0

P Required privilege: enable

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
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

# ConverterSetMaxConnection

Sets the maximum number of concurrent connections in task.

Required Privileges
  Task.Update
Since
  Converter API 5.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call.
maxConnection P | xsd:int | The maximum number of concurrent connections in task. Since Converter API 5.0

P Required privilege: maxConnection

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
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

# ConverterSetMaxTask

Sets the maximum number of concurrent tasks.

Required Privileges
  Task.Update

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterTaskManager used to make the method call.
maxTask P | xsd:int | The maximum number of concurrent tasks. Since Converter API 1.0

P Required privilege: maxTask

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
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