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