org.jclouds.vcloud
Interface VCloudExpressClient

All Superinterfaces:

org.jclouds.vcloud.CommonVCloudClient

public interface VCloudExpressClient
extends org.jclouds.vcloud.CommonVCloudClient

Provides access to VCloud resources via their REST API.

Author:

Adrian Cole

See Also:

Method Summary

org.jclouds.vcloud.domain.Task	cloneVAppInVDC(URI vDC, URI toClone, String newName, CloneVAppOptions... options)
org.jclouds.vcloud.domain.Task	deleteVApp(URI vAppId)
org.jclouds.vcloud.domain.Task	deployVApp(URI vAppId)
VCloudExpressVApp	findVAppInOrgVDCNamed(String orgName, String catalogName, String vAppName)
VCloudExpressVAppTemplate	findVAppTemplateInOrgCatalogNamed(String orgName, String catalogName, String itemName) returns the vapp template corresponding to a catalog item in the catalog associated with the specified name.
VCloudExpressVApp	getVApp(URI vApp)
VCloudExpressVAppTemplate	getVAppTemplate(URI vAppTemplate)
VCloudExpressVApp	instantiateVAppTemplateInVDC(URI vDC, URI template, String appName, InstantiateVAppTemplateOptions... options)
org.jclouds.vcloud.domain.Task	powerOffVApp(URI vAppId) This call powers off the vApp, as specified in the vApp's ovf:Startup element.
org.jclouds.vcloud.domain.Task	powerOnVApp(URI vAppId) This call powers on the vApp, as specified in the vApp's ovf:Startup element.
org.jclouds.vcloud.domain.Task	resetVApp(URI vAppId) This call resets the vApp.
void	shutdownVApp(URI vAppId) This call shuts down the vApp.
org.jclouds.vcloud.domain.Task	suspendVApp(URI vAppId) This call suspends the vApp.
org.jclouds.vcloud.domain.Task	undeployVApp(URI vAppId)

Methods inherited from interface org.jclouds.vcloud.CommonVCloudClient

cancelTask, findCatalogInOrgNamed, findCatalogItemInOrgCatalogNamed, findNetworkInOrgVDCNamed, findOrgNamed, findTasksListInOrgNamed, findVDCInOrgNamed, getCatalog, getCatalogItem, getNetwork, getOrg, getTask, getTasksList, getVDC

Method Detail

instantiateVAppTemplateInVDC

VCloudExpressVApp instantiateVAppTemplateInVDC(URI vDC,
                                               URI template,
                                               String appName,
                                               InstantiateVAppTemplateOptions... options)

cloneVAppInVDC

org.jclouds.vcloud.domain.Task cloneVAppInVDC(URI vDC,
                                              URI toClone,
                                              String newName,
                                              CloneVAppOptions... options)

getVAppTemplate

VCloudExpressVAppTemplate getVAppTemplate(URI vAppTemplate)

findVAppTemplateInOrgCatalogNamed

VCloudExpressVAppTemplate findVAppTemplateInOrgCatalogNamed(@Nullable
                                                            String orgName,
                                                            @Nullable
                                                            String catalogName,
                                                            String itemName)

returns the vapp template corresponding to a catalog item in the catalog associated with the specified name. Note that the org and catalog parameters can be null to choose default.

Parameters:

orgName - organization name, or null for the default

catalogName - catalog name, or null for the default

itemName - item you wish to lookup

Throws:

NoSuchElementException - if you specified an org, catalog, or catalog item name that isn't present

findVAppInOrgVDCNamed

VCloudExpressVApp findVAppInOrgVDCNamed(@Nullable
                                        String orgName,
                                        @Nullable
                                        String catalogName,
                                        String vAppName)

getVApp

VCloudExpressVApp getVApp(URI vApp)

deployVApp

org.jclouds.vcloud.domain.Task deployVApp(URI vAppId)

undeployVApp

org.jclouds.vcloud.domain.Task undeployVApp(URI vAppId)

powerOnVApp

org.jclouds.vcloud.domain.Task powerOnVApp(URI vAppId)

This call powers on the vApp, as specified in the vApp's ovf:Startup element.

powerOffVApp

org.jclouds.vcloud.domain.Task powerOffVApp(URI vAppId)

This call powers off the vApp, as specified in the vApp's ovf:Startup element.

shutdownVApp

void shutdownVApp(URI vAppId)

This call shuts down the vApp.

resetVApp

org.jclouds.vcloud.domain.Task resetVApp(URI vAppId)

This call resets the vApp.

suspendVApp

org.jclouds.vcloud.domain.Task suspendVApp(URI vAppId)

This call suspends the vApp.

deleteVApp

org.jclouds.vcloud.domain.Task deleteVApp(URI vAppId)