VdcApi (jclouds 1.5.8 API)

All Known Subinterfaces:

AdminVdcApi
```
public interface VdcApi
```
Provides synchronous access to a vDC.

Author:

danikov, Adrian Cole

See Also:
VdcAsyncApi

Method Summary

Methods
Modifier and Type	Method and Description
`Media`	`addMedia(String vdcUrn, Media media)` Creates a media (and present upload link for the floppy/iso file).
`Media`	`addMedia(URI vdcHref, Media media)`
`VAppTemplate`	`captureVApp(String vdcUrn, CaptureVAppParams params)` Captures a vApp into vApp template.
`VAppTemplate`	`captureVApp(URI vdcHref, CaptureVAppParams params)`
`Media`	`cloneMedia(String vdcUrn, CloneMediaParams params)` Clones a media into new one.
`Media`	`cloneMedia(URI vdcHref, CloneMediaParams params)`
`VApp`	`cloneVApp(String vdcUrn, CloneVAppParams params)` Clones a vApp into new one.
`VApp`	`cloneVApp(URI vdcHref, CloneVAppParams params)`
`VAppTemplate`	`cloneVAppTemplate(String vdcUrn, CloneVAppTemplateParams params)` Clones a vApp template into new one.
`VAppTemplate`	`cloneVAppTemplate(URI vdcHref, CloneVAppTemplateParams params)`
`VApp`	`composeVApp(String vdcUrn, ComposeVAppParams params)` Composes a new vApp using VMs from other vApps or vApp templates.
`VApp`	`composeVApp(URI vdcHref, ComposeVAppParams params)`
`Vdc`	`get(String vdcUrn)` Retrieves a vdc.
`Vdc`	`get(URI vdcHref)`
`MetadataApi.Readable`	`getMetadataApi(String vdcUrn)`
`MetadataApi.Readable`	`getMetadataApi(URI vdcHref)`
`VApp`	`instantiateVApp(String vdcUrn, InstantiateVAppParams params)` Instantiate a vApp template into a new vApp.
`VApp`	`instantiateVApp(URI vdcHref, InstantiateVAppParams params)`
`VAppTemplate`	`uploadVAppTemplate(String vdcUrn, UploadVAppTemplateParams params)` Uploading vApp template to a vDC.
`VAppTemplate`	`uploadVAppTemplate(URI vdcHref, UploadVAppTemplateParams params)`

- Method Detail
  - get
```
Vdc get(String vdcUrn)
```
    Retrieves a vdc.
    
    Returns:
    the vdc or null if not found
  - get
```
Vdc get(URI vdcHref)
```
  - captureVApp
```
VAppTemplate captureVApp(String vdcUrn,
                       CaptureVAppParams params)
```
    Captures a vApp into vApp template. The status of vApp template will be in UNRESOLVED(0) until the capture task is finished.
    
    Returns:
    a VApp resource which will contain a task. The user should should wait for this task to finish to be able to use the vApp.
  - captureVApp
```
VAppTemplate captureVApp(URI vdcHref,
                       CaptureVAppParams params)
```
  - cloneMedia
```
Media cloneMedia(String vdcUrn,
               CloneMediaParams params)
```
    Clones a media into new one. The status of the returned media is UNRESOLVED(0) until the task for cloning finish.
    
    Returns:
    a Media resource which will contain a task. The user should monitor the contained task status in order to check when it is completed.
  - cloneMedia
```
Media cloneMedia(URI vdcHref,
               CloneMediaParams params)
```
  - cloneVApp
```
VApp cloneVApp(String vdcUrn,
             CloneVAppParams params)
```
    Clones a vApp into new one. The status of vApp will be in UNRESOLVED(0) until the clone task is finished.
    
    Returns:
    a VApp resource which will contain a task. The user should should wait for this task to finish to be able to use the vApp.
  - cloneVApp
```
VApp cloneVApp(URI vdcHref,
             CloneVAppParams params)
```
  - cloneVAppTemplate
```
VAppTemplate cloneVAppTemplate(String vdcUrn,
                             CloneVAppTemplateParams params)
```
    Clones a vApp template into new one. The status of vApp template will be in UNRESOLVED(0) until the clone task is finished.
    
    Returns:
    a VAppTemplate resource which will contain a task. The user should should wait for this task to finish to be able to use the VAppTemplate.
  - cloneVAppTemplate
```
VAppTemplate cloneVAppTemplate(URI vdcHref,
                             CloneVAppTemplateParams params)
```
  - composeVApp
```
VApp composeVApp(String vdcUrn,
               ComposeVAppParams params)
```
    Composes a new vApp using VMs from other vApps or vApp templates. The vCloud API supports composing a vApp from any combination of vApp templates, vApps, or virtual machines. When you compose a vApp, all children of each composition source become peers in the Children collection of the composed vApp. To compose a vApp, a api makes a compose vApp request whose body is a ComposeVAppParams element, includes the following information:
    - An InstantiationParams element that applies to the composed vApp itself and any vApp templates referenced in Item elements.
    - A SourcedItem element for each virtual machine, vApp, or vAppTemplate to include in the composition. Each SourcedItem can contain the following elements:
      
      A required Source element whose href attribute value is a reference to a vApp template, vApp, or VM to include in the composition. If the Source element references a VM, the Item must also include an InstantiationParams element specific to that VM.
      An optional NetworkAssignment element that specifies how the network connections of child VM elements are mapped to vApp networks in the parent.
    If any of the composition items is subject to a EULA, the ComposeVAppParams element must include an AllEULAsAccepted element that has a value of true, indicating that you accept the EULA. Otherwise, composition fails. The composed vApp must be deployed and powered on before it can be used. The status of vApp will be UNRESOLVED(0) until the compose task is finished.
    Returns:
    a VApp resource which will contain a task. The user should should wait for this task to finish to be able to use the vApp.
  - composeVApp
```
VApp composeVApp(URI vdcHref,
               ComposeVAppParams params)
```
  - instantiateVApp
```
VApp instantiateVApp(String vdcUrn,
                   InstantiateVAppParams params)
```
    Instantiate a vApp template into a new vApp. The status of vApp will be in UNRESOLVED(0) until the instantiate task is finished.
```
 POST /vdc/{id}/action/instantiateVAppTemplate
 
```
    Returns:
    a VApp resource which will contain a task. The user should should wait for this task to finish to be able to use the vApp.
  - instantiateVApp
```
VApp instantiateVApp(URI vdcHref,
                   InstantiateVAppParams params)
```
  - uploadVAppTemplate
```
VAppTemplate uploadVAppTemplate(String vdcUrn,
                              UploadVAppTemplateParams params)
```
    Uploading vApp template to a vDC. The operation is separate on several steps:
    1. creating empty vApp template entity
    2. uploading an OVF of vApp template
    3. uploading disks described from the OVF
    4. finishing task for uploading
    The status of vApp template will be NOT_READY(0) until the ovf and all disks are uploaded to the transfer site. After this a task will run on the vApp template uploading. Note that the empty vApp template's getFiles() returns a file of size -1 after step one above, because the descriptor.ovf does not yet exist.
    Returns:
    a VAppTemplate resource which will contain a task. The user should should wait for this task to finish to be able to use the VAppTemplate.
  - uploadVAppTemplate
```
VAppTemplate uploadVAppTemplate(URI vdcHref,
                              UploadVAppTemplateParams params)
```
  - addMedia
```
Media addMedia(String vdcUrn,
             Media media)
```
    Creates a media (and present upload link for the floppy/iso file).
    
    Returns:
    The response will return a link to transfer site to be able to continue with uploading the media.
  - addMedia
```
Media addMedia(URI vdcHref,
             Media media)
```
  - getMetadataApi
```
MetadataApi.Readable getMetadataApi(String vdcUrn)
```
    Returns:
    synchronous access to Metadata.Readable features
  - getMetadataApi
```
MetadataApi.Readable getMetadataApi(URI vdcHref)
```

Interface VdcApi

Method Summary

Method Detail

get

get

captureVApp

captureVApp

cloneMedia

cloneMedia

cloneVApp

cloneVApp

cloneVAppTemplate

cloneVAppTemplate

composeVApp

composeVApp

instantiateVApp

instantiateVApp

uploadVAppTemplate

uploadVAppTemplate

addMedia

addMedia

getMetadataApi

getMetadataApi