Class

# VMware_VCloud_SDK_VApp_Abstract

abstract class VMware_VCloud_SDK_VApp_Abstract 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_TaskType | deploy(VMware_VCloud_API_DeployVAppParamsType $params) Deploy the vApp or VM. |
VMware_VCloud_API_TaskType | undeploy(VMware_VCloud_API_UndeployVAppParamsType $params) Undeploy the vApp or VM. |
VMware_VCloud_API_TaskType | delete() Delete the vApp or VM. |
VMware_VCloud_API_TaskType | powerOn() Power on the VM or all Vms contained in the vApp. |
VMware_VCloud_API_TaskType | powerOff() Power off the VM or all VMs contained in the vApp. |
VMware_VCloud_API_TaskType | reset() Reset the VM or all VMs contained in the vApp. |
VMware_VCloud_API_TaskType | reboot() Reboot the VM or all VMs contained in the vApp. |
VMware_VCloud_API_TaskType | suspend() Suspend the VM or all VMs contained in the vApp. |
VMware_VCloud_API_TaskType | discardSuspendedState() Discard suspended state of the VM or all VMs contained in the vApp. |
VMware_VCloud_API_TaskType | shutdown() Shutdown the VM or all VMs contained in the vApp. |
VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null | getMetadata(string $key = null, string $domain = null) Get metadata associated with the vApp/VM or metadata associated with the vApp/VM for the specified key in the specified domain. |
VMware_VCloud_API_TaskType | mergeMetadata(VMware_VCloud_API_MetadataType $meta) Merges the metadata for the vApp or VM 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 vApp or VM 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 vApp or VM. |

## 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 12
`public VMware_VCloud_API_TaskType deploy(VMware_VCloud_API_DeployVAppParamsType $params)`

Deploy the vApp or VM.

#### Parameters

VMware_VCloud_API_DeployVAppParamsType | $params |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 26
`public VMware_VCloud_API_TaskType undeploy(VMware_VCloud_API_UndeployVAppParamsType $params)`

Undeploy the vApp or VM.

#### Parameters

VMware_VCloud_API_UndeployVAppParamsType | $params |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 40
`public VMware_VCloud_API_TaskType delete()`

Delete the vApp or VM.

The vApp or VM has to be powered off and undeployed before it can be deleted.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 53
`public VMware_VCloud_API_TaskType powerOn()`

Power on the VM or all Vms contained in the vApp.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 64
`public VMware_VCloud_API_TaskType powerOff()`

Power off the VM or all VMs contained in the vApp.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 75
`public VMware_VCloud_API_TaskType reset()`

Reset the VM or all VMs contained in the vApp.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 86
`public VMware_VCloud_API_TaskType reboot()`

Reboot the VM or all VMs contained in the vApp.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 97
`public VMware_VCloud_API_TaskType suspend()`

Suspend the VM or all VMs contained in the vApp.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 108
`public VMware_VCloud_API_TaskType discardSuspendedState()`

Discard suspended state of the VM or all VMs contained in the vApp.

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 120
`public VMware_VCloud_API_TaskType shutdown()`

Shutdown the VM or all VMs contained in the vApp.

#### Return Value

VMware_VCloud_API_TaskType |

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

Get metadata associated with the vApp/VM or metadata associated with the vApp/VM 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 147
`public VMware_VCloud_API_TaskType mergeMetadata(VMware_VCloud_API_MetadataType $meta)`

Merges the metadata for the vApp or VM with the information provided.

#### Parameters

VMware_VCloud_API_MetadataType | $meta |

#### Return Value

VMware_VCloud_API_TaskType |

###
at line 166
`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 vApp or VM 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 183
`public VMware_VCloud_API_TaskType deleteMetadataByKey(string $key, string $domain = null)`

Deletes the metadata for the particular key in the specified domain for the vApp or VM.

#### Parameters

string | $key |
string | $domain |

#### Return Value

VMware_VCloud_API_TaskType |