130 lines
6.2 KiB
Go
130 lines
6.2 KiB
Go
package egoscale
|
|
|
|
// SnapshotState represents the Snapshot.State enum
|
|
//
|
|
// See: https://github.com/apache/cloudstack/blob/master/api/src/main/java/com/cloud/storage/Snapshot.java
|
|
type SnapshotState int
|
|
|
|
//go:generate stringer -type SnapshotState
|
|
const (
|
|
// Allocated ... (TODO)
|
|
Allocated SnapshotState = iota
|
|
// Creating ... (TODO)
|
|
Creating
|
|
// CreatedOnPrimary ... (TODO)
|
|
CreatedOnPrimary
|
|
// BackingUp ... (TODO)
|
|
BackingUp
|
|
// BackedUp ... (TODO)
|
|
BackedUp
|
|
// Copying ... (TODO)
|
|
Copying
|
|
// Destroying ... (TODO)
|
|
Destroying
|
|
// Destroyed ... (TODO)
|
|
Destroyed
|
|
// Error is a state where the user can't see the snapshot while the snapshot may still exist on the storage
|
|
Error
|
|
)
|
|
|
|
// Snapshot represents a volume snapshot
|
|
type Snapshot struct {
|
|
Account string `json:"account,omitempty" doc:"the account associated with the snapshot"`
|
|
AccountID *UUID `json:"accountid,omitempty" doc:"the account ID associated with the snapshot"`
|
|
Created string `json:"created,omitempty" doc:"the date the snapshot was created"`
|
|
Domain string `json:"domain,omitempty" doc:"the domain name of the snapshot's account"`
|
|
DomainID *UUID `json:"domainid,omitempty" doc:"the domain ID of the snapshot's account"`
|
|
ID *UUID `json:"id,omitempty" doc:"ID of the snapshot"`
|
|
IntervalType string `json:"intervaltype,omitempty" doc:"valid types are hourly, daily, weekly, monthy, template, and none."`
|
|
Name string `json:"name,omitempty" doc:"name of the snapshot"`
|
|
PhysicalSize int64 `json:"physicalsize,omitempty" doc:"physical size of the snapshot on image store"`
|
|
Revertable *bool `json:"revertable,omitempty" doc:"indicates whether the underlying storage supports reverting the volume to this snapshot"`
|
|
Size int64 `json:"size,omitempty" doc:"the size of original volume"`
|
|
SnapshotType string `json:"snapshottype,omitempty" doc:"the type of the snapshot"`
|
|
State SnapshotState `json:"state,omitempty" doc:"the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage"`
|
|
Tags []ResourceTag `json:"tags,omitempty" doc:"the list of resource tags associated with snapshot"`
|
|
VolumeID *UUID `json:"volumeid,omitempty" doc:"ID of the disk volume"`
|
|
VolumeName string `json:"volumename,omitempty" doc:"name of the disk volume"`
|
|
VolumeType string `json:"volumetype,omitempty" doc:"type of the disk volume"`
|
|
ZoneID *UUID `json:"zoneid,omitempty" doc:"id of the availability zone"`
|
|
}
|
|
|
|
// ResourceType returns the type of the resource
|
|
func (Snapshot) ResourceType() string {
|
|
return "Snapshot"
|
|
}
|
|
|
|
// CreateSnapshot (Async) creates an instant snapshot of a volume
|
|
type CreateSnapshot struct {
|
|
VolumeID *UUID `json:"volumeid" doc:"The ID of the disk volume"`
|
|
Account string `json:"account,omitempty" doc:"The account of the snapshot. The account parameter must be used with the domainId parameter."`
|
|
DomainID *UUID `json:"domainid,omitempty" doc:"The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume."`
|
|
QuiesceVM *bool `json:"quiescevm,omitempty" doc:"quiesce vm if true"`
|
|
_ bool `name:"createSnapshot" description:"Creates an instant snapshot of a volume."`
|
|
}
|
|
|
|
func (CreateSnapshot) response() interface{} {
|
|
return new(AsyncJobResult)
|
|
}
|
|
|
|
func (CreateSnapshot) asyncResponse() interface{} {
|
|
return new(Snapshot)
|
|
}
|
|
|
|
// ListSnapshots lists the volume snapshots
|
|
type ListSnapshots struct {
|
|
Account string `json:"account,omitempty" doc:"list resources by account. Must be used with the domainId parameter."`
|
|
DomainID *UUID `json:"domainid,omitempty" doc:"list only resources belonging to the domain specified"`
|
|
ID *UUID `json:"id,omitempty" doc:"lists snapshot by snapshot ID"`
|
|
IntervalType string `json:"intervaltype,omitempty" doc:"valid values are HOURLY, DAILY, WEEKLY, and MONTHLY."`
|
|
IsRecursive *bool `json:"isrecursive,omitempty" doc:"defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves."`
|
|
Keyword string `json:"keyword,omitempty" doc:"List by keyword"`
|
|
ListAll *bool `json:"listall,omitempty" doc:"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"`
|
|
Name string `json:"name,omitempty" doc:"lists snapshot by snapshot name"`
|
|
Page int `json:"page,omitempty"`
|
|
PageSize int `json:"pagesize,omitempty"`
|
|
SnapshotType string `json:"snapshottype,omitempty" doc:"valid values are MANUAL or RECURRING."`
|
|
Tags []ResourceTag `json:"tags,omitempty" doc:"List resources by tags (key/value pairs)"`
|
|
VolumeID *UUID `json:"volumeid,omitempty" doc:"the ID of the disk volume"`
|
|
ZoneID *UUID `json:"zoneid,omitempty" doc:"list snapshots by zone id"`
|
|
_ bool `name:"listSnapshots" description:"Lists all available snapshots for the account."`
|
|
}
|
|
|
|
// ListSnapshotsResponse represents a list of volume snapshots
|
|
type ListSnapshotsResponse struct {
|
|
Count int `json:"count"`
|
|
Snapshot []Snapshot `json:"snapshot"`
|
|
}
|
|
|
|
func (ListSnapshots) response() interface{} {
|
|
return new(ListSnapshotsResponse)
|
|
}
|
|
|
|
// DeleteSnapshot (Async) deletes a snapshot of a disk volume
|
|
type DeleteSnapshot struct {
|
|
ID *UUID `json:"id" doc:"The ID of the snapshot"`
|
|
_ bool `name:"deleteSnapshot" description:"Deletes a snapshot of a disk volume."`
|
|
}
|
|
|
|
func (DeleteSnapshot) response() interface{} {
|
|
return new(AsyncJobResult)
|
|
}
|
|
|
|
func (DeleteSnapshot) asyncResponse() interface{} {
|
|
return new(booleanResponse)
|
|
}
|
|
|
|
// RevertSnapshot (Async) reverts a volume snapshot
|
|
type RevertSnapshot struct {
|
|
ID *UUID `json:"id" doc:"The ID of the snapshot"`
|
|
_ bool `name:"revertSnapshot" description:"revert a volume snapshot."`
|
|
}
|
|
|
|
func (RevertSnapshot) response() interface{} {
|
|
return new(AsyncJobResult)
|
|
}
|
|
|
|
func (RevertSnapshot) asyncResponse() interface{} {
|
|
return new(booleanResponse)
|
|
}
|