VolumeTypeApi (Apache jclouds 2.3.0 API)

```
@Beta
 @Consumes(value="application/json")
 @Path(value="/os-volume-types")
public interface VolumeTypeApi
```
Provides access to the OpenStack Compute (Nova) Volume Type extension API. This extension is no longer supported in OpenStack Liberty. You can use the Block Storage API and endpoint to list volume types, see volume types v2.

See Also:

VolumeApi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`VolumeType`	`create(String name, CreateVolumeTypeOptions... options)` Creates a new volume type
`boolean`	`delete(String id)` Deletes a volume type
`boolean`	`deleteExtraSpec(String id, String key)` Deletes an existing extra spec
`VolumeType`	`get(String id)` Gets a volume type
`String`	`getExtraSpec(String id, String key)` Retrieve a single extra spec value
`Map<String,String>`	`getExtraSpecs(String id)` Gets the extra specs for a volume type
`com.google.common.collect.FluentIterable<VolumeType>`	`list()`
`void`	`updateExtraSpec(String id, String key, String value)` Creates or updates a single extra spec value
`void`	`updateExtraSpecs(String id, Map<String,String> specs)` Creates or updates the extra metadata for a given flavor

Method Detail

list

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

Returns:: set of all volume types

get

@Named(value="volumeType:get")
 @GET
 @Path(value="/{id}")
 @Nullable
VolumeType get(@PathParam(value="id")
                                                                                     String id)

Gets a volume type

Parameters:: id - the id of the volume type to retrieve
Returns:: the requested volume type

create

@Named(value="volumeType:create")
 @POST
 @Produces(value="application/json")
VolumeType create(String name,
                                                                                                CreateVolumeTypeOptions... options)

Creates a new volume type

Parameters:: name - the name of the new volume type; options - optional settings for the new volume type
Returns:: the new volume type

delete

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

Deletes a volume type

Parameters:: id - the id of the volume type to delete

getExtraSpecs

@Named(value="volumeType:getExtraSpecs")
 @GET
 @Path(value="/{id}/extra_specs")
Map<String,String> getExtraSpecs(@PathParam(value="id")
                                                                                                                  String id)

Gets the extra specs for a volume type

Parameters:: id - the id of the volume type
Returns:: the set of extra metadata for the flavor

updateExtraSpecs

@Named(value="volumeType:updateExtraSpecs")
 @POST
 @Path(value="/{id}/extra_specs")
 @Produces(value="application/json")
void updateExtraSpecs(@PathParam(value="id")
                                                                                                                                                String id,
                                                                                                                                                Map<String,String> specs)

Creates or updates the extra metadata for a given flavor

getExtraSpec

@Named(value="volumeType:getExtraSpec")
 @GET
 @Path(value="/{id}/extra_specs/{key}")
 @Nullable
String getExtraSpec(@PathParam(value="id")
                                                                                                                     String id,
                                                                                                                     @PathParam(value="key")
                                                                                                                     String key)

Retrieve a single extra spec value

Parameters:: id - the id of the volume type; key - the key of the extra spec item to retrieve

updateExtraSpec

@Named(value="volumeType:updateExtraSpec")
 @PUT
 @Path(value="/{id}/extra_specs/{key}")
 @Produces(value="application/json")
void updateExtraSpec(@PathParam(value="id")
                                                                                                                                                   String id,
                                                                                                                                                   @PathParam(value="key")
                                                                                                                                                   String key,
                                                                                                                                                   String value)

Creates or updates a single extra spec value

Parameters:: id - the id of the volume type; key - the extra spec key (when creating ensure this does not include whitespace or other difficult characters); value - the new value to store associate with the key

deleteExtraSpec

@Named(value="volumeType:deleteExtraSpec")
 @DELETE
 @Path(value="/{id}/extra_specs/{key}")
boolean deleteExtraSpec(@PathParam(value="id")
                                                                                                                    String id,
                                                                                                                    @PathParam(value="key")
                                                                                                                    String key)

Deletes an existing extra spec

Parameters:: id - the id of the volume type; key - the key of the extra spec to delete

Interface VolumeTypeApi