org.jclouds.openstack.nova.v2_0.extensions

Interface KeyPairApi

@Beta
 @Consumes(value="application/json")
 @Path(value="/os-keypairs")
public interface KeyPairApi

Provides access to the OpenStack Compute (Nova) Key Pair Extension API.

Method Summary

Modifier and Type	Method and Description
KeyPair	create(String name) Creates a KeyPair.
KeyPair	createWithPublicKey(String name, String publicKey) Creates a KeyPair with a public key.
boolean	delete(String name) Deletes a KeyPair.
KeyPair	get(String name) Gets a specific KeyPair by name.
com.google.common.collect.FluentIterable<KeyPair>	list() Lists all Key Pairs.

Method Detail

list

@Named(value="keypair:list")
 @GET
com.google.common.collect.FluentIterable<KeyPair> list()

Lists all Key Pairs.

Returns:

all Key Pairs

create

@Named(value="keypair:create")
 @POST
 @Produces(value="application/json")
KeyPair create(String name)

Creates a KeyPair.

Returns:

the created KeyPair.

createWithPublicKey

@Named(value="keypair:create")
 @POST
 @Produces(value="application/json")
KeyPair createWithPublicKey(String name,
                                                                                                       String publicKey)

Creates a KeyPair with a public key.

Returns:

the created KeyPair.

get

@Named(value="keypair:get")
 @GET
 @Path(value="/{name}")
 @Consumes(value="application/json")
 @Nullable
KeyPair get(@PathParam(value="name")
                                                                                                                      String name)

Gets a specific KeyPair by name.

Parameters:

name - the name of the KeyPair

Returns:

the specified KeyPair, otherwise null.

delete

@Named(value="keypair:delete")
 @DELETE
 @Path(value="/{name}")
boolean delete(@PathParam(value="name")
                                                                               String name)

Deletes a KeyPair.

Parameters:

name - the name of the KeyPair

Returns:

true if the KeyPair was deleted, otherwise false.