com.hp.ov.sdk.rest.client

Interface StorageVolumeTemplateClient

All Known Implementing Classes:

StorageVolumeTemplateClientImpl

public interface StorageVolumeTemplateClient

Method Summary

Modifier and Type	Method and Description
StorageVolumeTemplate	createStorageVolumeTemplate(RestParams params, StorageVolumeTemplate storageVolumeTemplateDto, boolean aSync, boolean useJsonRequest) The module aids in the creation of a storage volume template when provided with the storage volume template details as a StorageVolumeTemplate object or JsonRequest.
String	deleteStorageVolumeTemplate(RestParams params, String resourceId) The module aids in deleting a storage volume template for the specified storage volume template resource identifier.
StorageVolumeTemplateCollection	getAllStorageVolumeTemplates(RestParams params) The module aids in fetching the storage volume template details for all the storage volume templates found under the current HPE OneView.
ConnectableStorageVolumeTemplateCollection	getConnectableVolumeTemplates(RestParams params) This module aids in fetching the storage volume templates that are available on the specified networks based on the storage system port's expected network connectivity.
String	getId(RestParams params, String name) The module aids in fetching the storage volume template resource identifier for the storage volume template name as specified in HPE OneView.
StorageVolumeTemplate	getStorageVolumeTemplate(RestParams params, String resourceId) The module aids in fetching the storage volume template details for the specified storage volume template resource identifier.
StorageVolumeTemplate	getStorageVolumeTemplateByName(RestParams params, String name) The module aids in fetching the storage volume template details for the storage volume template name as specified in HPE OneView.
StorageVolumeTemplate	updateStorageVolumeTemplate(RestParams params, String resourceId, StorageVolumeTemplate storageVolumeTemplateDto, boolean useJsonRequest) The module takes in an StorageVolumeTemplate object or JsonRequest and updates the existing storage volume template based on the resource identifier.

Method Detail

getStorageVolumeTemplate

StorageVolumeTemplate getStorageVolumeTemplate(RestParams params,
                                               String resourceId)

The module aids in fetching the storage volume template details for the specified storage volume template resource identifier.

Parameters:

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

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

Returns:

StorageVolumeTemplate containing the storage volume template details.

getAllStorageVolumeTemplates

StorageVolumeTemplateCollection getAllStorageVolumeTemplates(RestParams params)

The module aids in fetching the storage volume template details for all the storage volume templates found under the current HPE OneView.

Parameters:

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

Returns:

StorageVolumeTemplateCollection containing a collection of storage volume template details.

getStorageVolumeTemplateByName

StorageVolumeTemplate getStorageVolumeTemplateByName(RestParams params,
                                                     String name)

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

Parameters:

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

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

Returns:

StorageVolumeTemplate containing the storage volume template details.

createStorageVolumeTemplate

StorageVolumeTemplate createStorageVolumeTemplate(RestParams params,
                                                  StorageVolumeTemplate storageVolumeTemplateDto,
                                                  boolean aSync,
                                                  boolean useJsonRequest)

The module aids in the creation of a storage volume template when provided with the storage volume template details as a StorageVolumeTemplate object or JsonRequest. It can process the request asynchronously or synchronously, based on the flag input.

Parameters:

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

storageVolumeTemplateDto - Object containing the storage volume template details, used to create a storage volume template.

aSync - Flag input to process request asynchronously or synchronously.

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

Returns:

StorageVolumeTemplate containing the storage volume template details.

updateStorageVolumeTemplate

StorageVolumeTemplate updateStorageVolumeTemplate(RestParams params,
                                                  String resourceId,
                                                  StorageVolumeTemplate storageVolumeTemplateDto,
                                                  boolean useJsonRequest)

The module takes in an StorageVolumeTemplate object or JsonRequest and updates the existing storage volume template based on the resource identifier.

Parameters:

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

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

storageVolumeTemplateDto - This is a object containing the storage volume template details, used to update a storage volume template.

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

Returns:

StorageVolumeTemplate containing the storage volume template details.

deleteStorageVolumeTemplate

String deleteStorageVolumeTemplate(RestParams params,
                                   String resourceId)

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

Parameters:

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

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

Returns:

String Deleted if successful.

getConnectableVolumeTemplates

ConnectableStorageVolumeTemplateCollection getConnectableVolumeTemplates(RestParams params)

This module aids in fetching the storage volume templates that are available on the specified networks based on the storage system port's expected network connectivity. If there are no storage volume templates that meets the specified connectivity criteria, an empty collection will be returned.

Parameters:

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

Returns:

ConnectableStorageVolumeTemplateCollection storage volume templates on the specified networks based on the storage system port.

getId

String getId(RestParams params,
             String name)

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

Parameters:

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

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

Returns:

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