VAppTemplateApi (jclouds 1.5.5 API)

```
public interface VAppTemplateApi
```
Provides synchronous access to VAppTemplate objects.

Author:

Adam Lowe, Adrian Cole

See Also:
VAppTemplateAsyncApi

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`disableDownload(String templateUrn)` Disables the download link to the ovf of a vApp template.
`void`	`disableDownload(URI templateHref)`
`Task`	`edit(String templateUrn, VAppTemplate template)` Modifies only the name/description of a vApp template.
`Task`	`edit(URI templateHref, VAppTemplate template)`
`Task`	`editLeaseSettingsSection(String templateUrn, LeaseSettingsSection section)` Modifies the lease settings section of a vApp or vApp template.
`Task`	`editLeaseSettingsSection(URI templateHref, LeaseSettingsSection section)`
`Task`	`editProductSections(String templateUrn, ProductSectionList sections)` Modifies the product sections of a vApp or vApp template.
`Task`	`editProductSections(URI templateHref, ProductSectionList sections)`
`Task`	`enableDownload(String templateUrn)` Enables downloading of the ovf of a vApp template.
`Task`	`enableDownload(URI templateHref)`
`VAppTemplate`	`get(String templateUrn)` Retrieves a vApp template (can be used also to retrieve a VM from a vApp Template).
`VAppTemplate`	`get(URI templateHref)`
`CustomizationSection`	`getCustomizationSection(String templateUrn)` Retrieves the customization section of a vApp template.
`CustomizationSection`	`getCustomizationSection(URI templateHref)`
`LeaseSettingsSection`	`getLeaseSettingsSection(String templateUrn)` Retrieves the lease settings section of a vApp or vApp template
`LeaseSettingsSection`	`getLeaseSettingsSection(URI templateHref)`
`MetadataApi.Writeable`	`getMetadataApi(String templateUrn)`
`MetadataApi.Writeable`	`getMetadataApi(URI templateHref)`
`NetworkConfigSection`	`getNetworkConfigSection(String templateUrn)` Retrieves the network config section of a vApp or vApp template.
`NetworkConfigSection`	`getNetworkConfigSection(URI templateHref)`
`NetworkSection`	`getNetworkSection(String templateUrn)` Retrieves the network section of a vApp or vApp template.
`NetworkSection`	`getNetworkSection(URI templateHref)`
`Envelope`	`getOvf(String templateUrn)` Retrieves an OVF descriptor of a vApp template.
`Envelope`	`getOvf(URI templateHref)`
`Owner`	`getOwner(String templateUrn)` Retrieves vApp template owner.
`Owner`	`getOwner(URI templateHref)`
`ProductSectionList`	`getProductSections(String templateUrn)` Retrieves VAppTemplate/VM product sections
`ProductSectionList`	`getProductSections(URI templateHref)`
`References`	`getShadowVms(String templateUrn)` GET /vAppTemplate/{id}/shadowVms
`References`	`getShadowVms(URI templateHref)`
`Task`	`remove(String templateUrn)` Deletes a vApp template.
`Task`	`remove(URI templateHref)`

- Method Detail
  - get
```
VAppTemplate get(String templateUrn)
```
    Retrieves a vApp template (can be used also to retrieve a VM from a vApp Template). The vApp could be in one of these statues:
    - FAILED_CREATION(-1) - Transient entity state, e.g., model object is addd but the corresponding VC backing does not exist yet. This is further sub-categorized in the respective entities.
    - UNRESOLVED(0) - Entity is whole, e.g., VM creation is complete and all the required model objects and VC backings are addd.
    - RESOLVED(1) - Entity is resolved.
    - UNKNOWN(6) - Entity state could not be retrieved from the inventory, e.g., VM power state is null.
    - POWERED_OFF(8) - All VMs of the vApp template are powered off.
    - MIXED(10) - vApp template status is set to MIXED when the VMs in the vApp are in different power states.
```
 GET /vAppTemplate/{id}
 
```
    Parameters:
    templateUrn - the String of the template
    
    Returns:
    the requested template
  - get
```
VAppTemplate get(URI templateHref)
```
  - edit
```
Task edit(String templateUrn,
        VAppTemplate template)
```
    Modifies only the name/description of a vApp template.
```
 PUT /vAppTemplate/{id}
 
```
    Parameters:
    templateUrn - the String of the template
    template - the template containing the new name and/or description
    
    Returns:
    the task performing the action. This operation is asynchronous and the user should monitor the returned task status in order to check when it is completed.
  - edit
```
Task edit(URI templateHref,
        VAppTemplate template)
```
  - remove
```
Task remove(String templateUrn)
```
    Deletes a vApp template.
```
 DELETE /vAppTemplate/{id}
 
```
    Parameters:
    templateUrn - the String of the template
    
    Returns:
    the task performing the action. This operation is asynchronous and the user should monitor the returned task status in order to check when it is completed.
  - remove
```
Task remove(URI templateHref)
```
  - disableDownload
```
void disableDownload(String templateUrn)
```
    Disables the download link to the ovf of a vApp template.
```
 POST /vAppTemplate/{id}/action/disableDownload
 
```
    Parameters:
    templateUrn - the String of the template
  - disableDownload
```
void disableDownload(URI templateHref)
```
  - enableDownload
```
Task enableDownload(String templateUrn)
```
    Enables downloading of the ovf of a vApp template.
```
 POST /vAppTemplate/{id}/action/enableDownload
 
```
    Parameters:
    templateUrn - the String of the template
    
    Returns:
    the task performing the action. This operation is asynchronous and the user should monitor the returned task status in order to check when it is completed.
  - enableDownload
```
Task enableDownload(URI templateHref)
```
  - getCustomizationSection
```
CustomizationSection getCustomizationSection(String templateUrn)
```
    Retrieves the customization section of a vApp template.
```
 GET /vAppTemplate/{id}/customizationSection
 
```
    Parameters:
    templateUrn - the String of the template
    
    Returns:
    the customization section
  - getCustomizationSection
```
CustomizationSection getCustomizationSection(URI templateHref)
```
  - getLeaseSettingsSection
```
LeaseSettingsSection getLeaseSettingsSection(String templateUrn)
```
    Retrieves the lease settings section of a vApp or vApp template
```
 GET /vAppTemplate/{id}/leaseSettingsSection
 
```
    Parameters:
    templateUrn - the String of the template
    
    Returns:
    the lease settings
  - getLeaseSettingsSection
```
LeaseSettingsSection getLeaseSettingsSection(URI templateHref)
```
  - editLeaseSettingsSection
```
Task editLeaseSettingsSection(String templateUrn,
                            LeaseSettingsSection section)
```
    Modifies the lease settings section of a vApp or vApp template.
```
 PUT /vAppTemplate/{id}/leaseSettingsSection
 
```
    Parameters:
    templateUrn - the String of the template
    section - the new configuration to apply
    
    Returns:
    the task performing the action. This operation is asynchronous and the user should monitor the returned task status in order to check when it is completed.
  - editLeaseSettingsSection
```
Task editLeaseSettingsSection(URI templateHref,
                            LeaseSettingsSection section)
```
  - getNetworkConfigSection
```
NetworkConfigSection getNetworkConfigSection(String templateUrn)
```
    Retrieves the network config section of a vApp or vApp template.
```
 GET /vAppTemplate/{id}/networkConfigSection
 
```
    Parameters:
    templateUrn - the String of the template
    
    Returns:
    the network config section requested
  - getNetworkConfigSection
```
NetworkConfigSection getNetworkConfigSection(URI templateHref)
```
  - getNetworkSection
```
NetworkSection getNetworkSection(String templateUrn)
```
    Retrieves the network section of a vApp or vApp template.
```
 GET /vAppTemplate/{id}/networkSection
 
```
    Parameters:
    templateUrn - the String of the template
    
    Returns:
    the network section requested
  - getNetworkSection
```
NetworkSection getNetworkSection(URI templateHref)
```
  - getOvf
```
Envelope getOvf(String templateUrn)
```
    Retrieves an OVF descriptor of a vApp template. This OVF represents the vApp template as it is, with all vCloud specific information (like mac address, parent networks, etc). The OVF which could be downloaded by enabling for download will not contain this information. There are no specific states bound to this entity.
```
 GET /vAppTemplate/{id}/ovf
 
```
    Parameters:
    templateUrn - the String of the template
    
    Returns:
    the ovf envelope
  - getOvf
```
Envelope getOvf(URI templateHref)
```
  - getOwner
```
Owner getOwner(String templateUrn)
```
    Retrieves vApp template owner.
```
 GET /vAppTemplate/{id}/owner
 
```
    Parameters:
    templateUrn - the String of the template
    
    Returns:
    the owner of the vApp template
  - getOwner
```
Owner getOwner(URI templateHref)
```
  - getProductSections
```
ProductSectionList getProductSections(String templateUrn)
```
    Retrieves VAppTemplate/VM product sections
```
 GET /vAppTemplate/{id}/productSections
 
```
    Parameters:
    templateUrn - the String of the template
    
    Returns:
    the product sections
  - getProductSections
```
ProductSectionList getProductSections(URI templateHref)
```
  - editProductSections
```
Task editProductSections(String templateUrn,
                       ProductSectionList sections)
```
    Modifies the product sections of a vApp or vApp template.
```
 PUT /vAppTemplate/{id}/productSections
 
```
    Parameters:
    templateUrn - the String of the template
    
    Returns:
    the task performing the action. This operation is asynchronous and the user should monitor the returned task status in order to check when it is completed.
  - editProductSections
```
Task editProductSections(URI templateHref,
                       ProductSectionList sections)
```
  - getShadowVms
```
References getShadowVms(String templateUrn)
```
```
 GET /vAppTemplate/{id}/shadowVms
 
```
    Parameters:
    templateUrn - the String of the template
    
    Returns:
    shadowVM references
  - getShadowVms
```
References getShadowVms(URI templateHref)
```
  - getMetadataApi
```
MetadataApi.Writeable getMetadataApi(String templateUrn)
```
    Returns:
    synchronous access to Metadata features
  - getMetadataApi
```
MetadataApi.Writeable getMetadataApi(URI templateHref)
```

Interface VAppTemplateApi

Method Summary

Method Detail

get

get

edit

edit

remove

remove

disableDownload

disableDownload

enableDownload

enableDownload

getCustomizationSection

getCustomizationSection

getLeaseSettingsSection

getLeaseSettingsSection

editLeaseSettingsSection

editLeaseSettingsSection

getNetworkConfigSection

getNetworkConfigSection

getNetworkSection

getNetworkSection

getOvf

getOvf

getOwner

getOwner

getProductSections

getProductSections

editProductSections

editProductSections

getShadowVms

getShadowVms

getMetadataApi

getMetadataApi