class VMware_VCloud_SDK_Media extends VMware_VCloud_SDK_Abstract
| string |
getEntityId()
Get vCloud ID of the vCloud resource entity from its data object. |
from VMware_VCloud_SDK_Abstract |
| VMware_VCloud_API_ReferenceType |
getMediaRef()
Get a reference to a VMware vCloud media entity. |
|
| VMware_VCloud_API_MediaType |
getMedia()
Get a VMware vCloud media entity. |
|
| string |
getId()
Constructs vCloud ID of the media from its UUID. |
|
| VMware_VCloud_API_LinkType|null |
getVdcRef()
Get the link to the container of the media. |
|
| VMware_VCloud_API_VdcType |
getVdc()
Get the container entity, a vDC, of the media |
|
| VMware_VCloud_API_TaskType |
modify(string $name = null, string $description = null)
Modify name and/or description of the media. |
|
| VMware_VCloud_API_TaskType |
delete()
Delete a VMware vCloud virtual media. |
|
| VMware_VCloud_API_LinkType|null |
getCatalogItemLink()
Get a reference to a VMware vCloud catalog entity. |
|
| boolean |
isPartOfCatalogItem()
Returns true if media is in Catalog, otherwise false. |
|
| VMware_VCloud_API_TaskType |
deleteMedia()
Deletes media and its catalog item. |
|
| VMware_VCloud_API_OwnerType |
getOwner()
Get media owner. |
|
| VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null |
getMetadata(string $key = null, string $domain = null)
Get metadata associated with the media or metadata associated with the media for the specified key in the specified domain. |
|
| VMware_VCloud_API_TaskType |
mergeMetadata(VMware_VCloud_API_MetadataType $meta)
Merges the metadata for the media 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 media 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 media. |
|
| VMware_VCloud_API_TaskType |
enableDownload(boolean $wait = true)
Enable downloading for the media. |
|
| null |
downloadMedia(string $destDir = '.')
Download the media as an iso or floppy image. |
|
| null |
downloadMediaByName(string $destDir = '.', string $mediaName)
Download the media as an iso or floppy image. |
public string
getEntityId()
Get vCloud ID of the vCloud resource entity from its data object.
public VMware_VCloud_API_ReferenceType
getMediaRef()
Get a reference to a VMware vCloud media entity.
public VMware_VCloud_API_MediaType
getMedia()
Get a VMware vCloud media entity.
public string
getId()
Constructs vCloud ID of the media from its UUID.
public VMware_VCloud_API_LinkType|null
getVdcRef()
Get the link to the container of the media.
public VMware_VCloud_API_VdcType
getVdc()
Get the container entity, a vDC, of the media
public VMware_VCloud_API_TaskType
modify(string $name = null, string $description = null)
Modify name and/or description of the media.
public VMware_VCloud_API_TaskType
delete()
Delete a VMware vCloud virtual media.
public VMware_VCloud_API_LinkType|null
getCatalogItemLink()
Get a reference to a VMware vCloud catalog entity.
public boolean
isPartOfCatalogItem()
Returns true if media is in Catalog, otherwise false.
public VMware_VCloud_API_TaskType
deleteMedia()
Deletes media and its catalog item.
If the media is attached to a catalog item. Deletes media alone. If the media is not attached to any catalog item.
public VMware_VCloud_API_OwnerType
getOwner()
Get media owner.
public VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null
getMetadata(string $key = null, string $domain = null)
Get metadata associated with the media or metadata associated with the media for the specified key in the specified domain.
public VMware_VCloud_API_TaskType
mergeMetadata(VMware_VCloud_API_MetadataType $meta)
Merges the metadata for the media with the information provided.
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 media to the value provided.
Note: This will replace any existing metadata information.
public VMware_VCloud_API_TaskType
deleteMetadataByKey(string $key, string $domain = null)
Deletes the metadata for the particular key in the specified domain for the media.
public VMware_VCloud_API_TaskType
enableDownload(boolean $wait = true)
Enable downloading for the media.
public null
downloadMedia(string $destDir = '.')
Download the media as an iso or floppy image.
contents are downloaded to the specified location. Before downloading make sure the media is enabled for download. The downloaded media file name will be the same as the current media file name in execution.
public null
downloadMediaByName(string $destDir = '.', string $mediaName)
Download the media as an iso or floppy image.
contents are downloaded to the specified location. Before downloading make sure the media is enabled for download.