com.hp.ov.sdk.rest.client.storage

Interface StorageVolumeClient

All Superinterfaces:

CreatableResource<AddStorageVolume>, DeletableResource, RetrievableResource<StorageVolume>, SearchableResource<StorageVolume>

public interface StorageVolumeClient
extends SearchableResource<StorageVolume>, CreatableResource<AddStorageVolume>, DeletableResource

Nested Class Summary

Nested classes/interfaces inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

SearchableResource.GetByNameRequestInterceptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTACHABLE_URI
static String	REPAIR_FILTER_URI
static String	REPAIR_URI
static String	SNAPSHOTS_URI
static String	STORAGE_VOLUME_URI

Method Summary

Modifier and Type	Method and Description
TaskResource	createSnapshot(String resourceId, StorageVolumeSnapshot snapshot, RequestOption... options) Creates a snapshot for the storage volume specified by the resource identifier.
TaskResource	deleteSnapshot(String storageVolumeId, String snapshotId, RequestOption... options) Deletes a storage volume snapshot from HPE OneView and storage system.
ResourceCollection<StorageVolumeSnapshot>	getAllSnapshots(String resourceId) Returns all snapshots available for an existing storage volume.
ResourceCollection<AttachableStorageVolume>	getAttachableVolumes() Retrieves a ResourceCollection<AttachableStorageVolume> containing details for all the attachable volumes that are connected to the specified networks based on the storage system port's expected network connectivity.
ResourceCollection<ExtraStorageVolume>	getExtraManagedPaths() Returns the list of extra managed storage volume paths.
StorageVolumeSnapshot	getSnapshot(String resourceId, String snapshotId) Retrieves the StorageVolumeSnapshot details for the specified storage volume snapshot.
TaskResource	repairExtraManagedPath(ExtraStorageVolumeRepair repair, RequestOption... options) Removes extra presentations from a specified storage volume on the storage system.
String	update(String resourceId, StorageVolume storageVolume) Updates a StorageVolume identified by the given resource identifier.

Methods inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

getByName

Methods inherited from interface com.hp.ov.sdk.rest.client.common.RetrievableResource

get, get, getAll, getAll, getById

Methods inherited from interface com.hp.ov.sdk.rest.client.common.CreatableResource

create

Methods inherited from interface com.hp.ov.sdk.rest.client.common.DeletableResource

delete

Field Detail

STORAGE_VOLUME_URI

static final String STORAGE_VOLUME_URI

See Also:

Constant Field Values

ATTACHABLE_URI

static final String ATTACHABLE_URI

See Also:

Constant Field Values

REPAIR_URI

static final String REPAIR_URI

See Also:

Constant Field Values

REPAIR_FILTER_URI

static final String REPAIR_FILTER_URI

See Also:

Constant Field Values

SNAPSHOTS_URI

static final String SNAPSHOTS_URI

See Also:

Constant Field Values

Method Detail

update

String update(String resourceId,
              StorageVolume storageVolume)

Updates a StorageVolume identified by the given resource identifier.

Parameters:

resourceId - storage volume resource identifier as seen in HPE OneView.

storageVolume - object containing the storage volume details.

Returns:

String containing the result of the operation.

getAttachableVolumes

ResourceCollection<AttachableStorageVolume> getAttachableVolumes()

Retrieves a ResourceCollection<AttachableStorageVolume> containing details for all the attachable volumes that are connected to the specified networks based on the storage system port's expected network connectivity.

Returns:

ResourceCollection<AttachableStorageVolume> containing the details for all found attachable storage volumes.

getSnapshot

StorageVolumeSnapshot getSnapshot(String resourceId,
                                  String snapshotId)

Retrieves the StorageVolumeSnapshot details for the specified storage volume snapshot.

Parameters:

resourceId - resource identifier for a storage volume as seen in HPE OneView.

snapshotId - resource identifier for the snapshot of the storage volume.

Returns:

StorageVolumeSnapshot or null in case the parameter snapshotId does not match any existing storage volume snapshot.

getAllSnapshots

ResourceCollection<StorageVolumeSnapshot> getAllSnapshots(String resourceId)

Returns all snapshots available for an existing storage volume.

Parameters:

resourceId - resource identifier for the storage volume as seen in HPE OneView.

Returns:

ResourceCollection<StorageVolumeSnapshot> containing the details for all found storage volume snapshots.

createSnapshot

TaskResource createSnapshot(String resourceId,
                            StorageVolumeSnapshot snapshot,
                            RequestOption... options)

Creates a snapshot for the storage volume specified by the resource identifier.

Parameters:

resourceId - resource identifier for a storage volume as seen in HPE OneView.

snapshot - StorageVolumeSnapshot object containing the data to be used during the snapshot creation.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource which returns the task status for the process.

deleteSnapshot

TaskResource deleteSnapshot(String storageVolumeId,
                            String snapshotId,
                            RequestOption... options)

Deletes a storage volume snapshot from HPE OneView and storage system.

Parameters:

storageVolumeId - resource identifier for a storage volume as seen in HPE OneView.

snapshotId - resource identifier for the snapshot of the storage volume.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource which returns the task status for the process.

getExtraManagedPaths

ResourceCollection<ExtraStorageVolume> getExtraManagedPaths()

Returns the list of extra managed storage volume paths.

Returns:

ResourceCollection<ExtraStorageVolume> containing the details for all found extra storage volumes.

repairExtraManagedPath

TaskResource repairExtraManagedPath(ExtraStorageVolumeRepair repair,
                                    RequestOption... options)

Removes extra presentations from a specified storage volume on the storage system.

Parameters:

repair - information about the extra paths to delete.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource which returns the task status for the process.