VolumeBackup (OpenStack4j Core 3.3 API)

All Superinterfaces:

ModelEntity, Serializable

All Known Implementing Classes:

CinderVolumeBackup
```
public interface VolumeBackup
extends ModelEntity
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class VolumeBackup.Status
The volume backup Status

Nested Classes
Modifier and Type	Interface and Description
`static class`	`VolumeBackup.Status` The volume backup Status

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getContainer()`
`Date`	`getCreated()`
`String`	`getDescription()`
`String`	`getFailReason()`
`String`	`getId()`
`String`	`getName()`
`int`	`getObjectCount()`
`int`	`getSize()`
`String`	`getSnapshotId()`
`VolumeBackup.Status`	`getStatus()`
`String`	`getVolumeId()`
`String`	`getZone()`
`Boolean`	`hasDependent()`
`Boolean`	`isIncremental()`

- Method Detail
  - getId
```
String getId()
```
  - getName
```
String getName()
```
    Returns:
    
    the name of the Volume Transfer.
  - getDescription
```
String getDescription()
```
    Returns:
    
    the description of the volume backup
  - getVolumeId
```
String getVolumeId()
```
    Returns:
    
    The UUID of the volume.
  - getContainer
```
String getContainer()
```
    Returns:
    
    The container name or null.
  - isIncremental
```
Boolean isIncremental()
```
    Returns:
    
    The backup mode. A valid value is true for incremental backup mode or false for full backup mode
  - getZone
```
String getZone()
```
    Returns:
    
    the zone of availability to use
  - getStatus
```
VolumeBackup.Status getStatus()
```
    Returns:
    
    the status of the volume
  - getSize
```
int getSize()
```
    Returns:
    
    The size of the volume, in gibibytes (GiB).
  - getCreated
```
Date getCreated()
```
    Returns:
    
    the created date of the volume
  - getFailReason
```
String getFailReason()
```
    Returns:
    
    If the backup failed, the reason for the failure. Otherwise, null.
  - getObjectCount
```
int getObjectCount()
```
    Returns:
    
    The number of objects in the backup.
  - hasDependent
```
Boolean hasDependent()
```
    Returns:
    
    True if the backup depends on other backups.
  - getSnapshotId
```
String getSnapshotId()
```
    Returns:
    
    If the backup was created from snapshot, the snapshot id. Otherwise, null.

Interface VolumeBackup

Nested Class Summary

Method Summary

Method Detail

getId

getName

getDescription

getVolumeId

getContainer

isIncremental

getZone

getStatus

getSize

getCreated

getFailReason

getObjectCount

hasDependent

getSnapshotId