com.hp.ov.sdk.rest.client

Interface DataCenterClient

All Known Implementing Classes:

DataCenterClientImpl

public interface DataCenterClient

Method Summary

Modifier and Type	Method and Description
DataCenter	addDataCenter(RestParams params, DataCenter dataCenter) Adds a data center according to the provided DataCenter object.
ResourceCollection<DataCenter>	getAllDataCenters(RestParams params) Retrieves a ResourceCollection<DataCenter> containing details for all the available data centers found under the current HPE OneView.
DataCenter	getDataCenter(RestParams params, String resourceId) Retrieves the DataCenter details for the specified data center.
DataCenter	getDataCenterByName(RestParams params, String name) Retrieves the DataCenter details for the specified data center identified by name.
String	getId(RestParams params, String name) Retrieves the data center resource identifier for the specified data center identified by name.
List<VisualContent>	getVisualContent(RestParams params, String resourceId) Retrieves a List<VisualContent> describing each rack within the data center.
String	removeDataCenter(RestParams params, String resourceId) Removes the DataCenter identified by the given resource identifier.
TaskResourceV2	removeDataCenterByFilter(RestParams params, String filter, boolean aSync) Removes the DataCenter(s) matching the filter.
DataCenter	updateDataCenter(RestParams params, String resourceId, DataCenter dataCenter) Updates a DataCenter identified by the given resource identifier.

Method Detail

getDataCenter

DataCenter getDataCenter(RestParams params,
                         String resourceId)

Retrieves the DataCenter details for the specified data center.

Parameters:

params - structure containing the connection details.

resourceId - data center resource identifier as seen in HPE OneView.

Returns:

DataCenter object containing the details.

getAllDataCenters

ResourceCollection<DataCenter> getAllDataCenters(RestParams params)

Retrieves a ResourceCollection<DataCenter> containing details for all the available data centers found under the current HPE OneView.

Parameters:

params - structure containing the connection details.

Returns:

ResourceCollection<DataCenter> containing the details for all found data centers.

getDataCenterByName

DataCenter getDataCenterByName(RestParams params,
                               String name)

Retrieves the DataCenter details for the specified data center identified by name.

Parameters:

params - structure containing the connection details.

name - data center name as seen in HPE OneView.

Returns:

DataCenter object containing the details.

addDataCenter

DataCenter addDataCenter(RestParams params,
                         DataCenter dataCenter)

Adds a data center according to the provided DataCenter object.

Parameters:

params - structure containing the connection details.

dataCenter - object containing the data center details.

Returns:

DataCenter containing the added data center.

updateDataCenter

DataCenter updateDataCenter(RestParams params,
                            String resourceId,
                            DataCenter dataCenter)

Updates a DataCenter identified by the given resource identifier.

Parameters:

params - structure containing the connection details.

resourceId - data center resource identifier as seen in HPE OneView.

dataCenter - object containing the data center details.

Returns:

DataCenter containing the data center updated.

removeDataCenter

String removeDataCenter(RestParams params,
                        String resourceId)

Removes the DataCenter identified by the given resource identifier.

Parameters:

params - structure containing the connection details.

resourceId - data center resource identifier as seen in HPE OneView.

Returns:

String value containing the result of the process.

removeDataCenterByFilter

TaskResourceV2 removeDataCenterByFilter(RestParams params,
                                        String filter,
                                        boolean aSync)

Removes the DataCenter(s) matching the filter. A filter is required to identify the set of resources to be removed. The actual deletion will proceed asynchronously. Although, the method can process the request asynchronously or synchronously, based on the aSync flag input.

Parameters:

params - structure containing the connection details.

filter - A general filter/query string that narrows the list of resources.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getVisualContent

List<VisualContent> getVisualContent(RestParams params,
                                     String resourceId)

Retrieves a List<VisualContent> describing each rack within the data center.

Parameters:

params - structure containing the connection details.

resourceId - data center resource identifier as seen in HPE OneView.

Returns:

List<VisualContent> containing the details of each rack within the data center.

getId

String getId(RestParams params,
             String name)

Retrieves the data center resource identifier for the specified data center identified by name.

Parameters:

params - structure containing the connection details.

name - data center name as seen in HPE OneView.

Returns:

resource identifier for the data center name as seen in HPE OneView.