org.openstack4j.api.manila

Interface ShareSnapshotService

All Superinterfaces:

RestService

All Known Implementing Classes:

ShareSnapshotServiceImpl

public interface ShareSnapshotService
extends RestService

Share Snapshot Service for Manila SHared Filesystems.

Author:

Daniel Gonzalez Nothnagel

Method Summary

Modifier and Type	Method and Description
ShareSnapshot	create(ShareSnapshotCreate snapshotCreate) Creates a snapshot from a share.
ActionResponse	delete(String snapshotId) Deletes a share snapshot.
ActionResponse	forceDelete(String snapshotId) Administrator only.
ShareSnapshot	get(String snapshotId) Shows details for a share snapshot.
List<? extends ShareSnapshot>	list() Lists all share snapshots.
List<? extends ShareSnapshot>	listDetails() Lists all share snapshots with details.
ActionResponse	resetState(String snapshotId, ShareSnapshot.Status status) Administrator only.
ShareSnapshot	update(String snapshotId, ShareSnapshotUpdateOptions snapshotUpdateOptions) Updates a share snapshot.

Method Detail

create

ShareSnapshot create(ShareSnapshotCreate snapshotCreate)

Creates a snapshot from a share.

Parameters:

snapshotCreate - the snapshot to create

Returns:

the snapshot

list

List<? extends ShareSnapshot> list()

Lists all share snapshots.

Returns:

a list of all snapshots

listDetails

List<? extends ShareSnapshot> listDetails()

Lists all share snapshots with details.

Returns:

a list of all snapshots with details

get

ShareSnapshot get(String snapshotId)

Shows details for a share snapshot.

Parameters:

snapshotId - the snapshot ID

Returns:

the snapshot

update

ShareSnapshot update(String snapshotId,
                     ShareSnapshotUpdateOptions snapshotUpdateOptions)

Updates a share snapshot.

Parameters:

snapshotId - the snapshot ID

snapshotUpdateOptions - the options to update on the snapshot

Returns:

the snapshot

delete

ActionResponse delete(String snapshotId)

Deletes a share snapshot.

Parameters:

snapshotId - the snapshot ID

Returns:

the action response

resetState

ActionResponse resetState(String snapshotId,
                          ShareSnapshot.Status status)

Administrator only. Explicitly updates the state of a share snapshot.

Parameters:

snapshotId - the snapshot ID

status - the status to set

Returns:

the action response

forceDelete

ActionResponse forceDelete(String snapshotId)

Administrator only. Force-deletes a share snapshot in any state.

Parameters:

snapshotId - the snapshot ID

Returns:

the action response