com.iland.core.web.rest.api

Interface MediaResource

@Path(value="/media")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface MediaResource

Media Resource Interface v1.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
TaskResponse	cloneMedia(String mediaUuid, MediaCloneRequest spec) Clone a given media.
TaskResponse	deleteMedia(String mediaUuid) Delete a Media.
TaskResponse	deleteMetadataForMedia(String mediaUuid, String key) Delete a specific piece of metadata associated with a media by its key.
InputStream	downloadMedia(String mediaUuid) Download a Media as an ISO file.
MediaResponse	getMedia(String mediaUuid) Retrieve media.
MetadataListResponse	getMetadataForMedia(String mediaUuid) Retrieve metadata associated with a media.
TaskResponse	syncMedia(String mediaUuid) Sync a media item belonging to a catalog with its source object
TaskResponse	updateMedia(String mediaUuid, MediaUpdateRequest spec) Update a Media.
TaskResponse	updateMetadataForMedia(String mediaUuid, List<UpdateMetadataRequest> metadata) Add / update metadata associated with a media.

Method Detail

getMedia

@GET
 @Path(value="/{mediaUuid}")
MediaResponse getMedia(@PathParam(value="mediaUuid")
                                                         String mediaUuid)

Retrieve media.

Parameters:

mediaUuid - media uuid

Returns:

media object

getMetadataForMedia

@GET
 @Path(value="/{mediaUuid}/metadata")
MetadataListResponse getMetadataForMedia(@PathParam(value="mediaUuid")
                                                                                    String mediaUuid)

Retrieve metadata associated with a media.

Parameters:

mediaUuid - media uuid

Returns:

list of metadata for the given media

updateMetadataForMedia

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

Add / update metadata associated with a media.

Parameters:

mediaUuid - media uuid

metadata - list of metadata

Returns:

asynchronous task details

deleteMetadataForMedia

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

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

Parameters:

mediaUuid - media uuid

key - metadata key

Returns:

asynchronous task details

updateMedia

@PUT
 @Path(value="/{mediaUuid}")
 @Consumes(value="application/json")
TaskResponse updateMedia(@PathParam(value="mediaUuid")
                                                                                                String mediaUuid,
                                                                                                MediaUpdateRequest spec)

Update a Media.

Capable of updating the media name, description and storage profile.

Parameters:

mediaUuid - media uuid

spec - specification for updating media

Returns:

asynchronous task details

deleteMedia

@DELETE
 @Path(value="/{mediaUuid}")
TaskResponse deleteMedia(@PathParam(value="mediaUuid")
                                                              String mediaUuid)

Delete a Media.

Parameters:

mediaUuid - media uuid

Returns:

asynchronous task details

cloneMedia

@POST
 @Path(value="/{mediaUuid}/actions/clone")
 @Consumes(value="application/json")
TaskResponse cloneMedia(@PathParam(value="mediaUuid")
                                                                                                              String mediaUuid,
                                                                                                              MediaCloneRequest spec)

Clone a given media.

The name of the media as well as the catalog, vDC, and storage profile placement of the newly created media are determined by the parameters submitted in the specification.

If no storage profile is explicitly submitted in the spec, the vDC default storage profile will be used.

Parameters:

mediaUuid - media uuid to clone

spec - specification for cloning media

Returns:

asynchronous task details

downloadMedia

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

Download a Media as an ISO file.

Parameters:

mediaUuid - media uuid

syncMedia

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

Sync a media item belonging to a catalog with its source object

Parameters:

mediaUuid - media uuid to sync

Returns:

asynchronous task details