All Superinterfaces:

RestService

All Known Implementing Classes:

BlockVolumeBackupServiceImpl
```
public interface BlockVolumeBackupService
extends RestService
```
A backup is a full copy of a volume stored in an external service. A backup can subsequently be restored from the external service to either the same volume that the backup was originally taken from or to a new volume. {@link http://developer.openstack.org/api-ref/block-storage/v2/}

Author:

Huang Yi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`VolumeBackup`	`create(VolumeBackupCreate vbc)`	Create volume backup
`ActionResponse`	`delete(String backupId)`	Delete a specified volume backup
`VolumeBackup`	`get(String backupId)`	Shows information for a specified backup.
`List<? extends VolumeBackup>`	`list()`	Lists detailed information for all Block Storage backups that the tenant who submits the request can access.
`List<? extends VolumeBackup>`	`list(Map<String,String> filteringParams)`	Returns list of Block Storage backups filtered by parameters.
`VolumeBackupRestore`	`restore(String backupId, String name, String volumeId)`	Restore volume from a a specified backup.

- Method Detail
  - list
```
List<? extends VolumeBackup> list()
```
    Lists detailed information for all Block Storage backups that the tenant who submits the request can access.
    
    Returns:
    
    List of VolumeBackup
  - list
```
List<? extends VolumeBackup> list(Map<String,String> filteringParams)
```
    Returns list of Block Storage backups filtered by parameters.
    
    Parameters:
    
    filteringParams - map (name, value) of filtering parameters
  - get
```
VolumeBackup get(String backupId)
```
    Shows information for a specified backup.
    
    Parameters:
    
    backupId - the backup identifier
    
    Returns:
    
    the volume backup or null
  - delete
```
ActionResponse delete(String backupId)
```
    Delete a specified volume backup
    
    Parameters:
    
    backupId - the backup identifier
    
    Returns:
    
    the action response
  - create
```
VolumeBackup create(VolumeBackupCreate vbc)
```
    Create volume backup
    
    Parameters:
    
    vbc - the input for backup creation
    
    Returns:
    
    the volume backup created.
  - restore
```
VolumeBackupRestore restore(String backupId,
                            String name,
                            String volumeId)
```
    Restore volume from a a specified backup. If volumeId is provided, the backup will be restored to existng volume specified by the volume id. Otherwise, a new volume will be created from the backup with assigned volume name.
    
    Parameters:
    
    backupId - the backup identifier
    
    name - the volume name
    
    volumeId - the identified of existing volume

Interface BlockVolumeBackupService

Method Summary

Method Detail

list

list

get

delete

create

restore