com.hp.ov.sdk.rest.client

Interface EnclosureGroupClient

All Known Implementing Classes:

EnclosureGroupClientImpl

public interface EnclosureGroupClient

Method Summary

Modifier and Type	Method and Description
EnclosureGroups	createEnclosureGroup(RestParams params, EnclosureGroups enclosureGroupsDto, boolean useJsonRequest) The module aids in the creation of an enclosure group when provided with the enclosure group details as EnclosureGroups object or JsonRequest.
String	deleteEnclosureGroup(RestParams params, String resourceId) The module aids in deleting an enclosure group for the specified enclosure group resource identifier.
EnclosureGroupCollectionV2	getAllEnclosureGroups(RestParams params) The module aids in fetching the enclosure group details for all enclosure groups registered under the current HPE OneView.
String	getConfigurationScript(RestParams params, String resourceId) The module aids in fetching the configuration script for the specified enclosure group resource identifier.
EnclosureGroups	getEnclosureGroup(RestParams params, String resourceId) The module aids in fetching the enclosure group details for the specified enclosure group resource identifier.
EnclosureGroups	getEnclosureGroupByName(RestParams params, String name) The module aids in fetching the enclosure group details for the specified enclosure group name.
String	getId(RestParams params, String name) The module aids in fetching the enclosure group resource identifier for the enclosure group name as specified in HPE OneView.
String	updateConfigurationScript(RestParams params, String resourceId, String scriptData) The module aids in updating the configuration script for the specified enclosure group resource identifier.
EnclosureGroups	updateEnclosureGroup(RestParams params, String resourceId, EnclosureGroups enclosureGroup, boolean useJsonRequest) The module takes in an EnclosureGroups object or JsonRequest and updates the existing enclosure group based on resource identifier.

Method Detail

getEnclosureGroup

EnclosureGroups getEnclosureGroup(RestParams params,
                                  String resourceId)

The module aids in fetching the enclosure group details for the specified enclosure group resource identifier.

Parameters:

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

resourceId - The resource identifier for enclosure group as seen in HPE OneView.

Returns:

EnclosureGroups containing the enclosure group details.

getAllEnclosureGroups

EnclosureGroupCollectionV2 getAllEnclosureGroups(RestParams params)

The module aids in fetching the enclosure group details for all enclosure groups registered under the current HPE OneView.

Parameters:

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

Returns:

EnclosureGroupCollectionV2 containing a collection of enclosure group details.

getEnclosureGroupByName

EnclosureGroups getEnclosureGroupByName(RestParams params,
                                        String name)

The module aids in fetching the enclosure group details for the specified enclosure group name.

Parameters:

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

name - The name is the enclosure group name as seen in HPE OneView.

Returns:

EnclosureGroups containing the enclosure group details.

createEnclosureGroup

EnclosureGroups createEnclosureGroup(RestParams params,
                                     EnclosureGroups enclosureGroupsDto,
                                     boolean useJsonRequest)

The module aids in the creation of an enclosure group when provided with the enclosure group details as EnclosureGroups object or JsonRequest.

Parameters:

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

enclosureGroupsDto - This is an object containing the enclosure group details, used to create an enclosure group.

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

Returns:

EnclosureGroups containing the enclosure group details.

updateEnclosureGroup

EnclosureGroups updateEnclosureGroup(RestParams params,
                                     String resourceId,
                                     EnclosureGroups enclosureGroup,
                                     boolean useJsonRequest)

The module takes in an EnclosureGroups object or JsonRequest and updates the existing enclosure group based on resource identifier.

Parameters:

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

resourceId - The resource identifier for enclosure group as seen in HPE OneView.

enclosureGroup - This is a object containing the update to be made to existing EnclosureGroup pointed to by the above mentioned resource identifier.

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

Returns:

EnclosureGroups containing the enclosure group details.

deleteEnclosureGroup

String deleteEnclosureGroup(RestParams params,
                            String resourceId)

The module aids in deleting an enclosure group for the specified enclosure group resource identifier.

Parameters:

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

resourceId - The resource identifier for enclosure group as seen in HPE OneView.

Returns:

an empty String on successful deletion. Otherwise, returns an error message.

getConfigurationScript

String getConfigurationScript(RestParams params,
                              String resourceId)

The module aids in fetching the configuration script for the specified enclosure group resource identifier.

Parameters:

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

resourceId - The resource identifier for enclosure group as seen in HPE OneView.

Returns:

the configuration script for the specified enclosure group.

updateConfigurationScript

String updateConfigurationScript(RestParams params,
                                 String resourceId,
                                 String scriptData)

The module aids in updating the configuration script for the specified enclosure group resource identifier.

Parameters:

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

resourceId - The resource identifier for enclosure group as seen in HPE OneView.

scriptData - THe script data to be updated for enclosure group.

Returns:

the configuration script for the specified enclosure group.

getId

String getId(RestParams params,
             String name)

The module aids in fetching the enclosure group resource identifier for the enclosure group name as specified in HPE OneView.

Parameters:

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

name - The name is the enclosure group name as seen in HPE OneView.

Returns:

String which is the resource identifier for the enclosure group name as seen in HPE OneView.