org.openstack4j.openstack.compute.internal

Class ComputeImageServiceImpl

java.lang.Object

org.openstack4j.openstack.internal.BaseOpenStackService

org.openstack4j.openstack.compute.internal.BaseComputeServices

org.openstack4j.openstack.compute.internal.ComputeImageServiceImpl

All Implemented Interfaces:

ComputeImageService, RestService

public class ComputeImageServiceImpl
extends BaseComputeServices
implements ComputeImageService

Provides access to Compute Images.

Author:

Jeremy Unruh

Nested Class Summary

Nested classes/interfaces inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

BaseOpenStackService.Invocation<R>

Constructor Summary

Constructors

Constructor and Description
ComputeImageServiceImpl()

Method Summary

Modifier and Type	Method and Description
ActionResponse	delete(String imageId) Deletes an Image based on it's identifiers.
ActionResponse	deleteMetaData(String imageId, String... keys) Delete a metadata item from an image
Image	get(String imageId) Finds an Image by the given imageId.
Map<String,String>	getMetaData(String imageId) Gets the metadata for an image
List<? extends Image>	list() Lists Images on an OpenStack Compute EndPoint.
List<? extends Image>	list(boolean detailed) Lists Images on an OpenStack Compute EndPoint.
Map<String,String>	setMetaData(String imageId, Map<String,String> metadata) Sets the metadata for an image

Methods inherited from class org.openstack4j.openstack.compute.internal.BaseComputeServices

invokeAction, invokeActionWithResponse

Methods inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

delete, deleteWithResponse, get, getProvider, getServiceVersion, getXOpenstackRequestId, head, patch, patchWithResponse, post, postWithResponse, put, request, toList, uri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComputeImageServiceImpl

public ComputeImageServiceImpl()

Method Detail

list

public List<? extends Image> list()

Lists Images on an OpenStack Compute EndPoint. By default this method lists in "Detail" which means all major fields are populated for each image. This is equivalent to calling ComputeImageService.list(boolean) with {code}true{code}

Specified by:

list in interface ComputeImageService

Returns:

List of Image

list

public List<? extends Image> list(boolean detailed)

Lists Images on an OpenStack Compute EndPoint. If detailed is false then only Image.getId(), Image.getName() and

Specified by:

list in interface ComputeImageService

Parameters:

detailed - true to populate all properties within each Image, false to include Id, Name and Links only (all other properties will be null)

Returns:

List of Image Image.getLinks() will be populated. True will populate all fields

get

public Image get(String imageId)

Finds an Image by the given imageId.

Specified by:

get in interface ComputeImageService

Parameters:

imageId - the image identifier

Returns:

the specified Image

delete

public ActionResponse delete(String imageId)

Deletes an Image based on it's identifiers. Images created by another user typically cannot be deleted

Specified by:

delete in interface ComputeImageService

Parameters:

imageId - the image identifier

Returns:

the action response

setMetaData

public Map<String,String> setMetaData(String imageId,
                                      Map<String,String> metadata)

Sets the metadata for an image

Specified by:

setMetaData in interface ComputeImageService

Parameters:

imageId - the image identifier

metadata - a Map containing the metadata

Returns:

the metadata as Map

deleteMetaData

public ActionResponse deleteMetaData(String imageId,
                                     String... keys)

Delete a metadata item from an image

Specified by:

deleteMetaData in interface ComputeImageService

Parameters:

imageId - the image identifier

keys - one or more keys/metadata names to remove

Returns:

the action response

getMetaData

public Map<String,String> getMetaData(String imageId)

Gets the metadata for an image

Specified by:

getMetaData in interface ComputeImageService

Parameters:

imageId - the image identifier

Returns:

the metadata as Map