org.jclouds.deltacloud

Interface DeltacloudClient

public interface DeltacloudClient

Provides synchronous access to deltacloud.

Author:

Adrian Cole

See Also:

DeltacloudAsyncClient,

Method Summary

Methods

Modifier and Type	Method and Description
Instance	createInstance(String imageId, CreateInstanceOptions... options) Create a new Instance
Set<DeltacloudCollection>	getCollections() The result of this entry-point is a set of entry-points into other collections, such as images, instances, hardware profiles and realms, among others.
HardwareProfile	getHardwareProfile(URI profileHref)
Image	getImage(URI imageHref)
Instance	getInstance(URI instanceHref)
com.google.common.collect.Multimap<Instance.State,Transition>	getInstanceStates()
Realm	getRealm(URI realmHref)
Set<HardwareProfile>	listHardwareProfiles() The hardware profiles collection will return a set of all hardware profiles available to the current user.
Set<Image>	listImages() The images collection will return a set of all images available to the current user.
Set<Instance>	listInstances() The instances collection will return a set of all instances available to the current user.
Set<Realm>	listRealms() The realms collection will return a set of all realms available to the current user.
void	performAction(HttpRequest action) perform a specific action.

Method Detail

getCollections

Set<DeltacloudCollection> getCollections()

The result of this entry-point is a set of entry-points into other collections, such as images, instances, hardware profiles and realms, among others.

Returns:

named links to available collections, or empty set, if no collections are found

getInstanceStates

com.google.common.collect.Multimap<Instance.State,Transition> getInstanceStates()

Returns:

The possible states of an instance, and how to traverse between them

listRealms

Set<Realm> listRealms()

The realms collection will return a set of all realms available to the current user.

Returns:

realms viewable to the user or empty set

getRealm

Realm getRealm(URI realmHref)

Parameters:

realmHref -

Returns:

realm or null, if not found

listImages

Set<Image> listImages()

The images collection will return a set of all images available to the current user.

Returns:

images viewable to the user or empty set

getImage

Image getImage(URI imageHref)

Parameters:

imageHref -

Returns:

image or null, if not found

listHardwareProfiles

Set<HardwareProfile> listHardwareProfiles()

The hardware profiles collection will return a set of all hardware profiles available to the current user.

Returns:

hardware profiles viewable to the user or empty set

getHardwareProfile

HardwareProfile getHardwareProfile(URI profileHref)

Parameters:

profileHref -

Returns:

hardware profile or null, if not found

listInstances

Set<Instance> listInstances()

The instances collection will return a set of all instances available to the current user.

Returns:

instances viewable to the user or empty set

getInstance

Instance getInstance(URI instanceHref)

Parameters:

instanceHref -

Returns:

instance or null, if not found

createInstance

Instance createInstance(String imageId,
                      CreateInstanceOptions... options)

Create a new Instance

Note

If options realmId or hardwareProfileName are not specified, the provider must select reasonable defaults. The architecture of the selected hardware profile must match the architecture of the specified image.

Parameters:

imageId - The identifier (not URL) of the image from which to base the instance

options - includes realm, hardware profile, etc.

Returns:

newly-created instance including a URL to retrieve the instance in the future.

performAction

void performAction(HttpRequest action)

perform a specific action.

Parameters:

action - reference from Instance.getActions()