com.hp.ov.sdk.rest.client

Class DataCenterClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.DataCenterClientImpl

All Implemented Interfaces:

DataCenterClient

public class DataCenterClientImpl
extends Object
implements 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.
static DataCenterClient	getClient()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getClient

public static DataCenterClient getClient()

getDataCenter

public DataCenter getDataCenter(RestParams params,
                                String resourceId)

Description copied from interface: DataCenterClient

Retrieves the DataCenter details for the specified data center.

Specified by:

getDataCenter in interface DataCenterClient

Parameters:

params - structure containing the connection details.

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

Returns:

DataCenter object containing the details.

getAllDataCenters

public ResourceCollection<DataCenter> getAllDataCenters(RestParams params)

Description copied from interface: DataCenterClient

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

Specified by:

getAllDataCenters in interface DataCenterClient

Parameters:

params - structure containing the connection details.

Returns:

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

getDataCenterByName

public DataCenter getDataCenterByName(RestParams params,
                                      String name)

Description copied from interface: DataCenterClient

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

Specified by:

getDataCenterByName in interface DataCenterClient

Parameters:

params - structure containing the connection details.

name - data center name as seen in HPE OneView.

Returns:

DataCenter object containing the details.

addDataCenter

public DataCenter addDataCenter(RestParams params,
                                DataCenter dataCenter)

Description copied from interface: DataCenterClient

Adds a data center according to the provided DataCenter object.

Specified by:

addDataCenter in interface DataCenterClient

Parameters:

params - structure containing the connection details.

dataCenter - object containing the data center details.

Returns:

DataCenter containing the added data center.

updateDataCenter

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

Description copied from interface: DataCenterClient

Updates a DataCenter identified by the given resource identifier.

Specified by:

updateDataCenter in interface DataCenterClient

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

public String removeDataCenter(RestParams params,
                               String resourceId)

Description copied from interface: DataCenterClient

Removes the DataCenter identified by the given resource identifier.

Specified by:

removeDataCenter in interface DataCenterClient

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

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

Description copied from interface: DataCenterClient

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.

Specified by:

removeDataCenterByFilter in interface DataCenterClient

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

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

Description copied from interface: DataCenterClient

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

Specified by:

getVisualContent in interface DataCenterClient

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

public String getId(RestParams params,
                    String name)

Description copied from interface: DataCenterClient

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

Specified by:

getId in interface DataCenterClient

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.