| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
extraInfo* | xsd:anyType |
Property for extra information associated with this managed object.
|
info | ConverterServerJobJobInfo |
Gets the dynamic job information for the job.
|
spec | ConverterServerJobJobSpec |
Get the job specification for this job.
|
Properties inherited from ConverterManagedEntity | ||
name, overallStatus |
Methods
Methods defined in this Managed Object |
---|
ConverterServerJobResume, ConverterServerJobStop, ConverterServerJobSuspend, ConverterServerJobUpdateExtaInfo, ConverterServerJobUpdateSpec |
Methods inherited from ConverterManagedEntity |
ConverterServerManagedEntityRename |
In standalone mode this operation can be initiated by the user that created the job or by Administrator.
In VC-integrated mode this operation can be initiated by the user that created the job or by any user who has Task.Update privilege on the inventory root.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterServerJobJob used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidState | |
NoPermission | Thrown if the user is not authorized for this operation. |
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 ConverterServerJobJob used to make the method call. |
activeTaskHandling P | xsd:string |
Describes how to handle active tasks. Must be stringized
representation of a value from the ConverterServerJobJobActiveTaskHandling enumeration.
Since Converter API 3.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
ConverterJobDeactivationFault | Thrown if there is a general error deactivating the given job. Check to see if the faultCause property is set for more detailed information. |
ConverterJobHasActiveTaskFault | Thrown if the "activeTaskHandling" is set to "failIfActiveTask" and the job was found to have an active task at the time of suspend. |
InvalidArgument | |
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 |
In standalone mode this operation can be initiated by the user that created the job or by Administrator.
In VC-integrated mode this operation can be initiated by the user that created the job or by any user who has Task.Update privilege on the inventory root.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterServerJobJob used to make the method call. |
activeTaskHandling P | xsd:string |
Describes how to handle active tasks. Must be a
stringized representation of a value from the Job.ActiveTaskHandling
enumeration.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
ConverterJobHasActiveTaskFault | Throw if the "activeTaskHandling" is set to "failIfActiveTask" and the job was found to have an active task at the time of suspend. |
InvalidState | Thrown if the job is already in the suspended state. |
NoPermission | Thrown if the user is not authorized for this operation. |
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 |
In standalone mode this operation can be initiated by the user that created the job or by Administrator.
In VC-integrated mode this operation can be initiated by the user that created the job or by any user who has Task.Update privilege on the inventory root.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterServerJobJob used to make the method call. |
replacementInfo* P | xsd:anyType |
Information with which to replace the "extraInfo" property
in this Job managed object. If not set then this will clear
the value of "extraInfo".
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
xsd:anyType | The old extraInfo property before replacment. |
Faults
Type | Description |
---|---|
NoPermission | Thrown if the user is not authorized for this operation. |
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 |
Adds the ability to update the first run time, including to run as soon as possible. It is an error to update the first run time if the job has already started its initial run.
In standalone mode this operation can be initiated by the user that created the job or by Administrator.
In VC-integrated mode this operation can be initiated by the user that created the job or by any user who has Task.Update privilege on the inventory root.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterServerJobJob used to make the method call. |
updateParams P | ConverterServerJobJobJobUpdateSpec |
Parameters to use for updating a job's specification.
Since Converter API 2.0 |
Return Value
Type | Description |
---|---|
ConverterServerJobJobSpec | The old job spec before update. |
Faults
Type | Description |
---|---|
ConverterFirstRunAlreadyStartedFault | A new first runtime is requested, but the job has previously started its first run. |
DuplicateName | The new name already exists in the current folder. |
InvalidName | The new name is not valid. |
NoPermission | Thrown if the user is not authorized for this operation. |
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 Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |