Class

VMware_VCloud_SDK_Disk

class VMware_VCloud_SDK_Disk extends VMware_VCloud_SDK_Abstract

Methods

string getEntityId()

Get vCloud ID of the vCloud resource entity from its data object.

 from VMware_VCloud_SDK_Abstract
VMware_VCloud_API_ReferenceType getDiskRef()

Get a reference to a VMware vCloud disk entity.
VMware_VCloud_API_DiskType getDisk()

Get a VMware vCloud disk entity.
string getId()

Constructs vCloud ID of this disk from its UUID.
VMware_VCloud_API_TaskType modify(VMware_VCloud_API_DiskType $disk)

Modify the name, description, and storage profile of a disk.
VMware_VCloud_API_TaskType delete()

Delete a disk.
array|null getAttachedVms()

Retrieve a list of all VMs attached to a disk.
VMware_VCloud_API_OwnerType getOwner()

Retrieve the owner of a disk.
null changeOwner(VMware_VCloud_API_OwnerType $owner)

Change the owner of a disk.
VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null getMetadata(string $key = null, string $domain = null)

Get metadata associated with the disk or metadata associated with the disk for the specified key in the specified domain.
VMware_VCloud_API_TaskType mergeMetadata(VMware_VCloud_API_MetadataType $meta)

Merges the metadata for the disk with the information provided.
VMware_VCloud_API_TaskType setMetadataByKey(string $key, VMware_VCloud_API_MetadataValueType $value, string $domain = null)

Sets the metadata for the particular key in the specified domain for the disk to the value provided.
VMware_VCloud_API_TaskType deleteMetadataByKey(string $key, string $domain = null)

Deletes the metadata for the particular key in the specified domain for the disk.

Details

in VMware_VCloud_SDK_Abstract at line 85
public string getEntityId()

Get vCloud ID of the vCloud resource entity from its data object.

Return Value

string

at line 10
public VMware_VCloud_API_ReferenceType getDiskRef()

Get a reference to a VMware vCloud disk entity.

Return Value

VMware_VCloud_API_ReferenceType

at line 21
public VMware_VCloud_API_DiskType getDisk()

Get a VMware vCloud disk entity.

Return Value

VMware_VCloud_API_DiskType

at line 32
public string getId()

Constructs vCloud ID of this disk from its UUID.

Return Value

string

at line 44
public VMware_VCloud_API_TaskType modify(VMware_VCloud_API_DiskType $disk)

Modify the name, description, and storage profile of a disk.

Parameters

VMware_VCloud_API_DiskType $disk

Return Value

VMware_VCloud_API_TaskType

at line 56
public VMware_VCloud_API_TaskType delete()

Delete a disk.

Return Value

VMware_VCloud_API_TaskType

at line 67
public array|null getAttachedVms()

Retrieve a list of all VMs attached to a disk.

Return Value

array|null VMwareVCloudAPI_ReferenceType object array or null.

at line 80
public VMware_VCloud_API_OwnerType getOwner()

Retrieve the owner of a disk.

Return Value

VMware_VCloud_API_OwnerType

at line 93
public null changeOwner(VMware_VCloud_API_OwnerType $owner)

Change the owner of a disk.

Parameters

VMware_VCloud_API_OwnerType $owner

Return Value

null

at line 110
public VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null getMetadata(string $key = null, string $domain = null)

Get metadata associated with the disk or metadata associated with the disk for the specified key in the specified domain.

Parameters

string $key
string $domain

Return Value

VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null

at line 122
public VMware_VCloud_API_TaskType mergeMetadata(VMware_VCloud_API_MetadataType $meta)

Merges the metadata for the disk with the information provided.

Parameters

VMware_VCloud_API_MetadataType $meta

Return Value

VMware_VCloud_API_TaskType

at line 140
public VMware_VCloud_API_TaskType setMetadataByKey(string $key, VMware_VCloud_API_MetadataValueType $value, string $domain = null)

Sets the metadata for the particular key in the specified domain for the disk to the value provided.

Note: This will replace any existing metadata information.

Parameters

string $key
VMware_VCloud_API_MetadataValueType $value
string $domain

Return Value

VMware_VCloud_API_TaskType

at line 156
public VMware_VCloud_API_TaskType deleteMetadataByKey(string $key, string $domain = null)

Deletes the metadata for the particular key in the specified domain for the disk.

Parameters

string $key
string $domain

Return Value

VMware_VCloud_API_TaskType