com.hp.ov.sdk.rest.client

Interface StoragePoolClient

All Known Implementing Classes:

StoragePoolClientImpl

public interface StoragePoolClient

Method Summary

Modifier and Type	Method and Description
String	createStoragePool(RestParams params, AddStoragePool storagePoolDto, boolean useJsonRequest) The module aids in creation of storage pool when provided with the storage pool details as an AddStoragePool object or JsonRequest.
String	deleteStoragePool(RestParams params, String resourceId) The module aids in deleting a storage pool for the specified storage pool resource identifier.
StoragePoolCollection	getAllStoragePools(RestParams params) The module aids in fetching the storage pool details for all the storage pools found under the current HPE OneView.
String	getId(RestParams params, String name, String storageSystemUri) The module aids in fetching the storage pool resource identifier for the storage pool name as specified in HPE OneView.
StoragePool	getStoragePool(RestParams params, String resourceId) The module aids in fetching the StoragePool details for the specified storage pool resource identifier.
StoragePool	getStoragePoolByName(RestParams params, String name, String storageSystemUri) The module aids in fetching the storage pool details for the storage pool name as specified in HPE OneView.
String	updateStoragePool(RestParams params, String resourceId, StoragePool storagePoolDto, boolean useJsonRequest) This module aids in refreshing the storage pool.

Method Detail

getStoragePool

StoragePool getStoragePool(RestParams params,
                           String resourceId)

The module aids in fetching the StoragePool details for the specified storage pool resource identifier.

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for storage pool as seen in HPE OneView.

Returns:

StoragePool containing the storage pool details.

getAllStoragePools

StoragePoolCollection getAllStoragePools(RestParams params)

The module aids in fetching the storage pool details for all the storage pools found under the current HPE OneView.

Parameters:

params - The RestParams is a structure containing the connection details.

Returns:

StoragePoolCollection containing a collection of storage pool details.

getStoragePoolByName

StoragePool getStoragePoolByName(RestParams params,
                                 String name,
                                 String storageSystemUri)

The module aids in fetching the storage pool details for the storage pool name as specified in HPE OneView.

Parameters:

params - The RestParams is a structure containing the connection details.

name - The name is the storage pool name as seen in HPE OneView.

storageSystemUri - URI of the storage system.

Returns:

StoragePool containing the storage pool details.

createStoragePool

String createStoragePool(RestParams params,
                         AddStoragePool storagePoolDto,
                         boolean useJsonRequest)

The module aids in creation of storage pool when provided with the storage pool details as an AddStoragePool object or JsonRequest.

Parameters:

params - The RestParams is a structure containing the connection details.

storagePoolDto - Object containing the storage pool details, used to create a storage pool.

useJsonRequest - The JsonRequest body is part of AddStoragePool object which takes in a String containing the new storage pool details, which is converted to AddStoragePool object using adaptor and processed.

Returns:

String Created if successful.

updateStoragePool

String updateStoragePool(RestParams params,
                         String resourceId,
                         StoragePool storagePoolDto,
                         boolean useJsonRequest)

This module aids in refreshing the storage pool. To request a refresh of a storage pool, the user must set the "refreshState" attribute to RefreshState.RefreshPending state.

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for storage pool as seen in HPE OneView.

storagePoolDto - Object containing the storage pool details, used to update a storage pool.

useJsonRequest - The JsonRequest body is part of StoragePool object which takes in a String containing the update to be made, which is converted to StoragePool object using an adaptor and processed.

Returns:

String, is Updated if successful.

deleteStoragePool

String deleteStoragePool(RestParams params,
                         String resourceId)

The module aids in deleting a storage pool for the specified storage pool resource identifier.

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for storage pool as seen in HPE OneView.

Returns:

String Deleted if successful.

getId

String getId(RestParams params,
             String name,
             String storageSystemUri)

The module aids in fetching the storage pool resource identifier for the storage pool name as specified in HPE OneView.

Parameters:

params - The RestParams is a structure containing the connection details.

name - The resourceName is the storage pool name as seen in HPE OneView.

storageSystemUri - The uri of the storage system the storage pool is associated with.

Returns:

String which is the resource identifier for the storage pool name as seen in HPE OneView.