VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::cis::task::Info::Builder Class Reference

Builder class for Info. More...

List of all members.

Public Member Functions

 Builder (vmware.vapi.std.LocalizableMessage description, string service, string operation, vmware.cis.task.Status status, bool cancelable)
 Constructor with parameters for the required properties of Info.
Builder SetProgress (vmware.cis.task.Progress progress)
 Progress of the operation.
Builder SetResult (vmware.vapi.data.IDataValue result)
 Result of the operation.
Builder SetParent (string parent)
 Parent of the current task.
Builder SetTarget (vmware.vapi.std.DynamicID target)
 Identifier of the target created by the operation or an existing one the operation performed on.
Builder SetError (vmware.vapi.bindings.ApiError error)
 Description of the error if the operation status is "FAILED".
Builder SetStartTime (global::System.DateTimeOffset?startTime)
 Time when the operation is started.
Builder SetEndTime (global::System.DateTimeOffset?endTime)
 Time when the operation is completed.
Builder SetUser (string user)
 Name of the user who performed the operation.
Info Build ()

Detailed Description

Builder class for Info.


Constructor & Destructor Documentation

vmware::cis::task::Info::Builder::Builder ( vmware.vapi.std.LocalizableMessage  description,
string  service,
string  operation,
vmware.cis.task.Status  status,
bool  cancelable 
) [inline]

Constructor with parameters for the required properties of Info.


Member Function Documentation

Info vmware::cis::task::Info::Builder::Build ( ) [inline]
Builder vmware::cis::task::Info::Builder::SetEndTime ( global::System.DateTimeOffset?  endTime) [inline]

Time when the operation is completed.

This attribute was added in vSphere API 6.7.

Builder vmware::cis::task::Info::Builder::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.

Builder vmware::cis::task::Info::Builder::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 .

Builder vmware::cis::task::Info::Builder::SetProgress ( vmware.cis.task.Progress  progress) [inline]

Progress of the operation.

This attribute was added in vSphere API 6.7.

Builder vmware::cis::task::Info::Builder::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.

Builder vmware::cis::task::Info::Builder::SetStartTime ( global::System.DateTimeOffset?  startTime) [inline]

Time when the operation is started.

This attribute was added in vSphere API 6.7.

Builder vmware::cis::task::Info::Builder::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.

Builder vmware::cis::task::Info::Builder::SetUser ( string  user) [inline]

Name of the user who performed the operation.

This attribute was added in vSphere API 6.7.


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