VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::appliance::TaskInfo Class Reference

The TaskInfo class contains information about an appliance task and the subtasks of which it consists. More...

List of all members.

Classes

class  Builder
 Builder class for TaskInfo. More...

Public Member Functions

 TaskInfo ()
 Generate all-fields constructor only for errors and standard structures that have relevant fields.
vmware.cis.task.Progress GetProgress ()
 Progress of the task.
void SetProgress (vmware.cis.task.Progress progress)
 Progress of the task.
global::System.Collections.Generic.List
< string > 
GetSubtaskOrder ()
 List of tasks that make up this appliance task in the order they are being run.
void SetSubtaskOrder (global::System.Collections.Generic.List< string > subtaskOrder)
 List of tasks that make up this appliance task in the order they are being run.
global::System.Collections.Generic.Dictionary
< string,
vmware.appliance.SubtaskInfo
GetSubtasks ()
 Information about the subtasks that this appliance task consists of.
void SetSubtasks (global::System.Collections.Generic.Dictionary< string, vmware.appliance.SubtaskInfo > subtasks)
 Information about the subtasks that this appliance task consists of.
vmware.vapi.std.LocalizableMessage GetDescription ()
 Description of the operation associated with the task.
void SetDescription (vmware.vapi.std.LocalizableMessage description)
 Description of the operation associated with the task.
string GetService ()
 Identifier of the service containing the operation.
void SetService (string service)
 Identifier of the service containing the operation.
string GetOperation ()
 Identifier of the operation associated with the task.
void SetOperation (string operation)
 Identifier of the operation associated with the task.
string GetParent ()
 Parent of the current task.
void SetParent (string parent)
 Parent of the current task.
vmware.vapi.std.DynamicID GetTarget ()
 Identifier of the target created by the operation or an existing one the operation performed on.
void SetTarget (vmware.vapi.std.DynamicID target)
 Identifier of the target created by the operation or an existing one the operation performed on.
vmware.cis.task.Status GetStatus ()
 Status of the operation associated with the task.
void SetStatus (vmware.cis.task.Status status)
 Status of the operation associated with the task.
bool GetCancelable ()
 Flag to indicate whether or not the operation can be cancelled.
void SetCancelable (bool cancelable)
 Flag to indicate whether or not the operation can be cancelled.
vmware.vapi.bindings.ApiError GetError ()
 Description of the error if the operation status is "FAILED".
void SetError (vmware.vapi.bindings.ApiError error)
 Description of the error if the operation status is "FAILED".
global::System.DateTimeOffset GetStartTime ()
 Time when the operation is started.
void SetStartTime (global::System.DateTimeOffset?startTime)
 Time when the operation is started.
global::System.DateTimeOffset GetEndTime ()
 Time when the operation is completed.
void SetEndTime (global::System.DateTimeOffset?endTime)
 Time when the operation is completed.
string GetUser ()
 Name of the user who performed the operation.
void SetUser (string user)
 Name of the user who performed the operation.
vmware.vapi.bindings.type.StructType _GetType ()
vmware.vapi.data.StructValue _GetDataValue ()
void _Validate ()
bool _HasTypeNameOf< T > ()
_ConvertTo< T > ()
override bool Equals (object obj)
override int GetHashCode ()
override string ToString ()

Detailed Description

The TaskInfo class contains information about an appliance task and the subtasks of which it consists.

This class was added in vSphere API 6.7.


Constructor & Destructor Documentation

vmware::appliance::TaskInfo::TaskInfo ( ) [inline]

Generate all-fields constructor only for errors and standard structures that have relevant fields.

Creates a default new instance.


Member Function Documentation

T vmware::appliance::TaskInfo::_ConvertTo< T > ( ) [inline]
Type Constraints
T :vmware.vapi.bindings.IStructure 
vmware.vapi.data.StructValue vmware::appliance::TaskInfo::_GetDataValue ( ) [inline]
vmware.vapi.bindings.type.StructType vmware::appliance::TaskInfo::_GetType ( ) [inline]
bool vmware::appliance::TaskInfo::_HasTypeNameOf< T > ( ) [inline]
Type Constraints
T :vmware.vapi.bindings.IStructure 
void vmware::appliance::TaskInfo::_Validate ( ) [inline]
override bool vmware::appliance::TaskInfo::Equals ( object  obj) [inline]
bool vmware::appliance::TaskInfo::GetCancelable ( ) [inline]

Flag to indicate whether or not the operation can be cancelled.

The value may change as the operation progresses.

vmware.vapi.std.LocalizableMessage vmware::appliance::TaskInfo::GetDescription ( ) [inline]

Description of the operation associated with the task.

global::System.DateTimeOffset vmware::appliance::TaskInfo::GetEndTime ( ) [inline]

Time when the operation is completed.

vmware.vapi.bindings.ApiError vmware::appliance::TaskInfo::GetError ( ) [inline]

Description of the error if the operation status is "FAILED".

override int vmware::appliance::TaskInfo::GetHashCode ( ) [inline]
string vmware::appliance::TaskInfo::GetOperation ( ) [inline]

Identifier of the operation associated with the task.

When clients pass a value of this class as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.operation . When methods return a value of this class as a result, the field will be an identifier for the resource type: com.vmware.vapi.operation .

string vmware::appliance::TaskInfo::GetParent ( ) [inline]

Parent of the current task.

When clients pass a value of this class as a parameter, the field must be an identifier for the resource type: com.vmware.cis.task . When methods return a value of this class as a result, the field will be an identifier for the resource type: com.vmware.cis.task .

vmware.cis.task.Progress vmware::appliance::TaskInfo::GetProgress ( ) [inline]

Progress of the task.

This attribute was added in vSphere API 6.7.

string vmware::appliance::TaskInfo::GetService ( ) [inline]

Identifier of the service containing the operation.

When clients pass a value of this class as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.service . When methods return a value of this class as a result, the field will be an identifier for the resource type: com.vmware.vapi.service

global::System.DateTimeOffset vmware::appliance::TaskInfo::GetStartTime ( ) [inline]

Time when the operation is started.

vmware.cis.task.Status vmware::appliance::TaskInfo::GetStatus ( ) [inline]

Status of the operation associated with the task.

global::System.Collections.Generic.List<string> vmware::appliance::TaskInfo::GetSubtaskOrder ( ) [inline]

List of tasks that make up this appliance task in the order they are being run.

This attribute was added in vSphere API 6.7.

global::System.Collections.Generic.Dictionary<string, vmware.appliance.SubtaskInfo> vmware::appliance::TaskInfo::GetSubtasks ( ) [inline]

Information about the subtasks that this appliance task consists of.

This attribute was added in vSphere API 6.7.

vmware.vapi.std.DynamicID vmware::appliance::TaskInfo::GetTarget ( ) [inline]

Identifier of the target created by the operation or an existing one the operation performed on.

string vmware::appliance::TaskInfo::GetUser ( ) [inline]

Name of the user who performed the operation.

void vmware::appliance::TaskInfo::SetCancelable ( bool  cancelable) [inline]

Flag to indicate whether or not the operation can be cancelled.

The value may change as the operation progresses.

void vmware::appliance::TaskInfo::SetDescription ( vmware.vapi.std.LocalizableMessage  description) [inline]

Description of the operation associated with the task.

void vmware::appliance::TaskInfo::SetEndTime ( global::System.DateTimeOffset?  endTime) [inline]

Time when the operation is completed.

void vmware::appliance::TaskInfo::SetError ( vmware.vapi.bindings.ApiError  error) [inline]

Description of the error if the operation status is "FAILED".

void vmware::appliance::TaskInfo::SetOperation ( string  operation) [inline]

Identifier of the operation associated with the task.

When clients pass a value of this class as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.operation . When methods return a value of this class as a result, the field will be an identifier for the resource type: com.vmware.vapi.operation .

void vmware::appliance::TaskInfo::SetParent ( string  parent) [inline]

Parent of the current task.

When clients pass a value of this class as a parameter, the field must be an identifier for the resource type: com.vmware.cis.task . When methods return a value of this class as a result, the field will be an identifier for the resource type: com.vmware.cis.task .

void vmware::appliance::TaskInfo::SetProgress ( vmware.cis.task.Progress  progress) [inline]

Progress of the task.

This attribute was added in vSphere API 6.7.

void vmware::appliance::TaskInfo::SetService ( string  service) [inline]

Identifier of the service containing the operation.

When clients pass a value of this class as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.service . When methods return a value of this class as a result, the field will be an identifier for the resource type: com.vmware.vapi.service

void vmware::appliance::TaskInfo::SetStartTime ( global::System.DateTimeOffset?  startTime) [inline]

Time when the operation is started.

void vmware::appliance::TaskInfo::SetStatus ( vmware.cis.task.Status  status) [inline]

Status of the operation associated with the task.

void vmware::appliance::TaskInfo::SetSubtaskOrder ( global::System.Collections.Generic.List< string >  subtaskOrder) [inline]

List of tasks that make up this appliance task in the order they are being run.

This attribute was added in vSphere API 6.7.

void vmware::appliance::TaskInfo::SetSubtasks ( global::System.Collections.Generic.Dictionary< string, vmware.appliance.SubtaskInfo subtasks) [inline]

Information about the subtasks that this appliance task consists of.

This attribute was added in vSphere API 6.7.

void vmware::appliance::TaskInfo::SetTarget ( vmware.vapi.std.DynamicID  target) [inline]

Identifier of the target created by the operation or an existing one the operation performed on.

void vmware::appliance::TaskInfo::SetUser ( string  user) [inline]

Name of the user who performed the operation.

override string vmware::appliance::TaskInfo::ToString ( ) [inline]

The documentation for this class was generated from the following file: