Class VMwareHierarchyObject

Namespace

CENTREL.XIA.Configuration.Types

Assembly

CENTREL.XIA.Configuration.Types.dll

Represents an object within the VMware object hierarchy.

public class VMwareHierarchyObject : GlobalSerializableClassicBase, IComparable<VMwareHierarchyObject>

Inheritance

object

VMwareHierarchyObject

Implements

IComparable<VMwareHierarchyObject>

Constructors

VMwareHierarchyObject()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.VMwareHierarchyObject class.

public VMwareHierarchyObject()

VMwareHierarchyObject(VMwareHierarchyObjectType)

Initializes a new instance of the CENTREL.XIA.Configuration.Types.VMwareHierarchyObject class.

public VMwareHierarchyObject(VMwareHierarchyObjectType objectType)

Parameters

objectType VMwareHierarchyObjectType

The type of object that this represents.

Properties

Children

Gets or sets the child items of this hierarchy object.

public VMwareHierarchyObjectCollection Children { get; set; }

Property Value

VMwareHierarchyObjectCollection

CollectionIndex

Gets the collection index for this item.

[Browsable(false)]
public string CollectionIndex { get; }

Property Value

string

ManagedObjectID

Gets or sets the unique ID for this managed object - for example "group-d1".

public string ManagedObjectID { get; set; }

Property Value

string

Name

Gets or sets the display name of the object in the hierarchy - for example "Datacenters".

public string Name { get; set; }

Property Value

string

ObjectType

Gets or sets the type of object within the hierarchy.

public VMwareHierarchyObjectType ObjectType { get; set; }

Property Value

VMwareHierarchyObjectType

ObjectTypeString

Gets the type of object as a human readable string.

public string ObjectTypeString { get; set; }

Property Value

string

Methods

AddChild(string, string, VMwareHierarchyObjectType)

Adds a new hierarchy object to the child collection of this object.

public VMwareHierarchyObject AddChild(string name, string managedObjectID, VMwareHierarchyObjectType objectType)

Parameters

name string

The display name of the object to add - for example "Datacenters".

managedObjectID string

The unique ID of the managed object to add - for example "group-d1".

objectType VMwareHierarchyObjectType

The CENTREL.XIA.Configuration.Types.VMwareHierarchyObjectType of the managed object to add.

Returns

VMwareHierarchyObject

A CENTREL.XIA.Configuration.Types.VMwareHierarchyObject object.

Clone()

Returns a CENTREL.XIA.Configuration.Types.VMwareHierarchyObject cloned from this object.

public VMwareHierarchyObject Clone()

Returns

VMwareHierarchyObject

A CENTREL.XIA.Configuration.Types.VMwareHierarchyObject.

CompareTo(VMwareHierarchyObject)

Compares two CENTREL.XIA.Configuration.Types.VMwareHierarchyObject objects to allow sorting alphabetically by type and by name.

public int CompareTo(VMwareHierarchyObject other)

Parameters

other VMwareHierarchyObject

The CENTREL.XIA.Configuration.Types.VMwareHierarchyObject to compare to.

Returns

int

The sort order of the two objects.

ResolveObjectType(VMwareHierarchyObjectType)

Resolves the display name for the specified hierarchy object type.

public static string ResolveObjectType(VMwareHierarchyObjectType objectType)

Parameters

objectType VMwareHierarchyObjectType

The CENTREL.XIA.Configuration.Types.VMwareHierarchyObjectType to resolve.

Returns

string

The display name of the specified CENTREL.XIA.Configuration.Types.VMwareHierarchyObjectType.

ToString()

Returns the hierarchy object as a human readable string - for example "DEMO-ESX01 [Host]".

public override string ToString()

Returns

string

The hierarchy object as a human readable string.