|
VMware vSphere Automation SDK for .NET 7.0.0.1
|
|
VMware vSphere Automation SDK for .NET 7.0.0.1
|
The Info class contains information about a task.
More...
Classes | |
| class | Builder |
| Builder class for Info. More... | |
Public Member Functions | |
| Info () | |
| Generate all-fields constructor only for errors and standard structures that have relevant fields. | |
| vmware.cis.task.Progress | GetProgress () |
| Progress of the operation. | |
| void | SetProgress (vmware.cis.task.Progress progress) |
| Progress of the operation. | |
| vmware.vapi.data.IDataValue | GetResult () |
| Result of the operation. | |
| void | SetResult (vmware.vapi.data.IDataValue result) |
| Result of the operation. | |
| 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 > () |
| T | _ConvertTo< T > () |
| override bool | Equals (object obj) |
| override int | GetHashCode () |
| override string | ToString () |
The Info class contains information about a task.
This class was added in vSphere API 6.7.
| vmware::cis::task::Info::Info | ( | ) | [inline] |
Generate all-fields constructor only for errors and standard structures that have relevant fields.
Creates a default new instance.
| T vmware::cis::task::Info::_ConvertTo< T > | ( | ) | [inline] |
| T | : | vmware.vapi.bindings.IStructure |
| vmware.vapi.data.StructValue vmware::cis::task::Info::_GetDataValue | ( | ) | [inline] |
| vmware.vapi.bindings.type.StructType vmware::cis::task::Info::_GetType | ( | ) | [inline] |
| bool vmware::cis::task::Info::_HasTypeNameOf< T > | ( | ) | [inline] |
| T | : | vmware.vapi.bindings.IStructure |
| void vmware::cis::task::Info::_Validate | ( | ) | [inline] |
| override bool vmware::cis::task::Info::Equals | ( | object | obj | ) | [inline] |
| bool vmware::cis::task::Info::GetCancelable | ( | ) | [inline] |
Flag to indicate whether or not the operation can be cancelled.
The value may change as the operation progresses. This attribute was added in vSphere API 6.7.
| vmware.vapi.std.LocalizableMessage vmware::cis::task::Info::GetDescription | ( | ) | [inline] |
Description of the operation associated with the task.
This attribute was added in vSphere API 6.7.
| global::System.DateTimeOffset vmware::cis::task::Info::GetEndTime | ( | ) | [inline] |
Time when the operation is completed.
This attribute was added in vSphere API 6.7.
| vmware.vapi.bindings.ApiError vmware::cis::task::Info::GetError | ( | ) | [inline] |
Description of the error if the operation status is "FAILED".
This attribute was added in vSphere API 6.7.
| override int vmware::cis::task::Info::GetHashCode | ( | ) | [inline] |
| string vmware::cis::task::Info::GetOperation | ( | ) | [inline] |
Identifier of the operation associated with the task.
This attribute was added in vSphere API 6.7. 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::cis::task::Info::GetParent | ( | ) | [inline] |
Parent of the current task.
This attribute was added in vSphere API 6.7. 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::cis::task::Info::GetProgress | ( | ) | [inline] |
Progress of the operation.
This attribute was added in vSphere API 6.7.
| vmware.vapi.data.IDataValue vmware::cis::task::Info::GetResult | ( | ) | [inline] |
Result of the operation.
If an operation reports partial results before it completes, this field could be set before the CommonInfo.status has the value Status.SUCCEEDED . The value could change as the operation progresses. This attribute was added in vSphere API 6.7.
| string vmware::cis::task::Info::GetService | ( | ) | [inline] |
Identifier of the service containing the operation.
This attribute was added in vSphere API 6.7. 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::cis::task::Info::GetStartTime | ( | ) | [inline] |
Time when the operation is started.
This attribute was added in vSphere API 6.7.
| vmware.cis.task.Status vmware::cis::task::Info::GetStatus | ( | ) | [inline] |
Status of the operation associated with the task.
This attribute was added in vSphere API 6.7.
| vmware.vapi.std.DynamicID vmware::cis::task::Info::GetTarget | ( | ) | [inline] |
Identifier of the target created by the operation or an existing one the operation performed on.
This attribute was added in vSphere API 6.7.
| string vmware::cis::task::Info::GetUser | ( | ) | [inline] |
Name of the user who performed the operation.
This attribute was added in vSphere API 6.7.
| void vmware::cis::task::Info::SetCancelable | ( | bool | cancelable | ) | [inline] |
Flag to indicate whether or not the operation can be cancelled.
The value may change as the operation progresses. This attribute was added in vSphere API 6.7.
| void vmware::cis::task::Info::SetDescription | ( | vmware.vapi.std.LocalizableMessage | description | ) | [inline] |
Description of the operation associated with the task.
This attribute was added in vSphere API 6.7.
| void vmware::cis::task::Info::SetEndTime | ( | global::System.DateTimeOffset? | endTime | ) | [inline] |
Time when the operation is completed.
This attribute was added in vSphere API 6.7.
| void vmware::cis::task::Info::SetError | ( | vmware.vapi.bindings.ApiError | error | ) | [inline] |
Description of the error if the operation status is "FAILED".
This attribute was added in vSphere API 6.7.
| void vmware::cis::task::Info::SetOperation | ( | string | operation | ) | [inline] |
Identifier of the operation associated with the task.
This attribute was added in vSphere API 6.7. 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::cis::task::Info::SetParent | ( | string | parent | ) | [inline] |
Parent of the current task.
This attribute was added in vSphere API 6.7. 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::cis::task::Info::SetProgress | ( | vmware.cis.task.Progress | progress | ) | [inline] |
Progress of the operation.
This attribute was added in vSphere API 6.7.
| void vmware::cis::task::Info::SetResult | ( | vmware.vapi.data.IDataValue | result | ) | [inline] |
Result of the operation.
If an operation reports partial results before it completes, this field could be set before the CommonInfo.status has the value Status.SUCCEEDED . The value could change as the operation progresses. This attribute was added in vSphere API 6.7.
| void vmware::cis::task::Info::SetService | ( | string | service | ) | [inline] |
Identifier of the service containing the operation.
This attribute was added in vSphere API 6.7. 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::cis::task::Info::SetStartTime | ( | global::System.DateTimeOffset? | startTime | ) | [inline] |
Time when the operation is started.
This attribute was added in vSphere API 6.7.
| void vmware::cis::task::Info::SetStatus | ( | vmware.cis.task.Status | status | ) | [inline] |
Status of the operation associated with the task.
This attribute was added in vSphere API 6.7.
| void vmware::cis::task::Info::SetTarget | ( | vmware.vapi.std.DynamicID | target | ) | [inline] |
Identifier of the target created by the operation or an existing one the operation performed on.
This attribute was added in vSphere API 6.7.
| void vmware::cis::task::Info::SetUser | ( | string | user | ) | [inline] |
Name of the user who performed the operation.
This attribute was added in vSphere API 6.7.
| override string vmware::cis::task::Info::ToString | ( | ) | [inline] |
