com.iland.core.web.rest.api

Interface VappTemplateResource

@Path(value="/vapp-templates")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface VappTemplateResource

Vapp Template Resource Interface v1.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
TaskResponse	deleteMetadataForVappTemplate(String templateUuid, String key) Delete a specific piece of metadata associated with a vapp template by its key.
TaskResponse	deleteVappTemplate(String templateUuid) Delete a Vapp template.
InputStream	download(String templateUuid) Download the vApp template.
TaskResponse	enableVappTemplateDownload(String templateUuid) Enable the download of the vapp template.
VappTemplateDownloadDetailsResponse	getDownloadDetails(String templateUuid) Gets download details for the vApp Template.
MetadataListResponse	getMetadataForVappTemplate(String templateUuid) Retrieve metadata associated with a vapp template.
ProductSectionPropertyListResponse	getProductSectionProperties(String templateUuid) Get the product section properties for the given vApp template.
VappTemplateResponse	getVappTemplate(String templateUuid) Retrieve a vApp Template.
VappTemplateConfigurationResponse	getVappTemplateConfiguration(String templateUuid) Retrieve a vApp Template's detailed configuration.
VappTemplateVmListResponse	getVappTemplateVms(String templateUuid) Retrieve a vApp Template's VMs.
TaskResponse	syncVappTemplate(String templateUuid) Sync a vapp template item belonging to a catalog with its source object.
TaskResponse	updateMetadataForVappTemplate(String templateUuid, List<UpdateMetadataRequest> metadata) Add / update metadata associated with a vapp template.
TaskResponse	updateVappTemplate(String templateUuid, VappTemplateUpdateRequest req) Update a Vapp Template.

Method Detail

getVappTemplate

@GET
 @Path(value="/{templateUuid}")
VappTemplateResponse getVappTemplate(@PathParam(value="templateUuid")
                                                                          String templateUuid)

Retrieve a vApp Template.

Parameters:

templateUuid - vapp template uuid

Returns:

vapp template object

getVappTemplateConfiguration

@GET
 @Path(value="/{templateUuid}/configuration")
VappTemplateConfigurationResponse getVappTemplateConfiguration(@PathParam(value="templateUuid")
                                                                                                                  String templateUuid)

Retrieve a vApp Template's detailed configuration.

Parameters:

templateUuid - vapp template uuid

Returns:

vapp template configuration details

getVappTemplateVms

@GET
 @Path(value="/{templateUuid}/vms")
VappTemplateVmListResponse getVappTemplateVms(@PathParam(value="templateUuid")
                                                                                       String templateUuid)

Retrieve a vApp Template's VMs.

Parameters:

templateUuid - vapp template uuid

Returns:

vapp template vms list

getMetadataForVappTemplate

@GET
 @Path(value="/{templateUuid}/metadata")
MetadataListResponse getMetadataForVappTemplate(@PathParam(value="templateUuid")
                                                                                              String templateUuid)

Retrieve metadata associated with a vapp template.

Parameters:

templateUuid - vapp template uuid

Returns:

list of metadata for the vapp template

updateMetadataForVappTemplate

@PUT
 @Path(value="/{templateUuid}/metadata")
 @Consumes(value="application/json")
TaskResponse updateMetadataForVappTemplate(@PathParam(value="templateUuid")
                                                                                                                              String templateUuid,
                                                                                                                              List<UpdateMetadataRequest> metadata)

Add / update metadata associated with a vapp template.

Parameters:

templateUuid - vapp template uuid

metadata - of instances

Returns:

asynchronous task details

deleteMetadataForVappTemplate

@DELETE
 @Path(value="/{templateUuid}/metadata/{key}")
TaskResponse deleteMetadataForVappTemplate(@PathParam(value="templateUuid")
                                                                                                  String templateUuid,
                                                                                                  @PathParam(value="key")
                                                                                                  String key)

Delete a specific piece of metadata associated with a vapp template by its key.

Parameters:

templateUuid - vapp template uuid

key - metadata key

Returns:

asynchronous task details

updateVappTemplate

@PUT
 @Path(value="/{templateUuid}")
 @Consumes(value="application/json")
TaskResponse updateVappTemplate(@PathParam(value="templateUuid")
                                                                                                          String templateUuid,
                                                                                                          VappTemplateUpdateRequest req)

Update a Vapp Template.

Capable of updating the templates name, and description.

Parameters:

templateUuid - vapp template uuid

req - vapp template update request

Returns:

asynchronous task details

deleteVappTemplate

@DELETE
 @Path(value="/{templateUuid}")
TaskResponse deleteVappTemplate(@PathParam(value="templateUuid")
                                                                        String templateUuid)

Delete a Vapp template.

Parameters:

templateUuid - vapp template uuid

Returns:

asynchronous task details

enableVappTemplateDownload

@POST
 @Path(value="/{templateUuid}/actions/enable-download")
TaskResponse enableVappTemplateDownload(@PathParam(value="templateUuid")
                                                                                                      String templateUuid)

Enable the download of the vapp template. Returns a CoreTask which monitors the progress of the download. Use download(String) endpoint when task progress is synced to download the vapp template.

Parameters:

templateUuid - String vapp template uuid

download

@GET
 @Path(value="/{templateUuid}/download")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+octet-stream")
InputStream download(@PathParam(value="templateUuid")
                                                                                                                                        String templateUuid)

Download the vApp template. enableVappTemplateDownload(String) must be called first and synced before attempting to download.

Parameters:

templateUuid - String vapp template uuid

Returns:

InputStream ova file

getDownloadDetails

@GET
 @Path(value="/{templateUuid}/download-details")
VappTemplateDownloadDetailsResponse getDownloadDetails(@PathParam(value="templateUuid")
                                                                                                             String templateUuid)

Gets download details for the vApp Template. Details include whether the template is enabled for download, and, if enabled, the size and name of the download.

Parameters:

templateUuid - String vapp template uuid

Returns:

the download details

syncVappTemplate

@POST
 @Path(value="/{templateUuid}/actions/sync")
TaskResponse syncVappTemplate(@PathParam(value="templateUuid")
                                                                                 String templateUuid)

Sync a vapp template item belonging to a catalog with its source object.

Parameters:

templateUuid - vapp template uuid to sync

Returns:

asynchronous task details

getProductSectionProperties

@GET
 @Path(value="/{templateUuid}/product-section")
ProductSectionPropertyListResponse getProductSectionProperties(@PathParam(value="templateUuid")
                                                                                                                    String templateUuid)

Get the product section properties for the given vApp template.

Parameters:

templateUuid - the UUID of the vApp template

Returns:

ProductSectionPropertyListResponse a list of product section properties