vmware::cis::task::Progress Class Reference

The Progress class contains information describe the progress of an operation. More...

List of all members.

Classes
class	Builder
	Builder class for Progress. More...
Public Member Functions
	Progress ()
	Generate all-fields constructor only for errors and standard structures that have relevant fields.
long	GetTotal ()
	Total amount of the work for the operation.
void	SetTotal (long total)
	Total amount of the work for the operation.
long	GetCompleted ()
	The amount of work completed for the operation.
void	SetCompleted (long completed)
	The amount of work completed for the operation.
vmware.vapi.std.LocalizableMessage	GetMessage ()
	Message about the work progress.
void	SetMessage (vmware.vapi.std.LocalizableMessage message)
	Message about the work progress.
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 ()

---

Detailed Description

The Progress class contains information describe the progress of an operation.

This class was added in vSphere API 6.7.

---

Constructor & Destructor Documentation

vmware::cis::task::Progress::Progress

(

)

[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::cis::task::Progress::_ConvertTo< T >

(

)

[inline]

Type Constraints

T

:

vmware.vapi.bindings.IStructure

vmware.vapi.data.StructValue vmware::cis::task::Progress::_GetDataValue

(

)

[inline]

vmware.vapi.bindings.type.StructType vmware::cis::task::Progress::_GetType

(

)

[inline]

bool vmware::cis::task::Progress::_HasTypeNameOf< T >

(

)

[inline]

Type Constraints

T

:

vmware.vapi.bindings.IStructure

void vmware::cis::task::Progress::_Validate

(

)

[inline]

override bool vmware::cis::task::Progress::Equals

(

object

obj

)

[inline]

long vmware::cis::task::Progress::GetCompleted

(

)

[inline]

The amount of work completed for the operation.

The value can only be incremented. This attribute was added in vSphere API 6.7.

override int vmware::cis::task::Progress::GetHashCode

(

)

[inline]

vmware.vapi.std.LocalizableMessage vmware::cis::task::Progress::GetMessage

(

)

[inline]

Message about the work progress.

This attribute was added in vSphere API 6.7.

long vmware::cis::task::Progress::GetTotal

(

)

[inline]

Total amount of the work for the operation.

This attribute was added in vSphere API 6.7.

void vmware::cis::task::Progress::SetCompleted

(

long

completed

)

[inline]

The amount of work completed for the operation.

The value can only be incremented. This attribute was added in vSphere API 6.7.

void vmware::cis::task::Progress::SetMessage

(

vmware.vapi.std.LocalizableMessage

message

)

[inline]

Message about the work progress.

This attribute was added in vSphere API 6.7.

void vmware::cis::task::Progress::SetTotal

(

long

total

)

[inline]

Total amount of the work for the operation.

This attribute was added in vSphere API 6.7.

override string vmware::cis::task::Progress::ToString

(

)

[inline]

---

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

• Progress.cs