com.hp.ov.sdk.rest.client

Class RackClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.RackClientImpl

All Implemented Interfaces:

RackClient

public class RackClientImpl
extends Object
implements RackClient

Method Summary

Modifier and Type	Method and Description
Rack	addRack(RestParams params, Rack rack) Adds a rack according to the provided Rack object.
ResourceCollection<Rack>	getAllRacks(RestParams params) Retrieves a ResourceCollection<Rack> containing details for all the available racks found under the current HPE OneView.
static RackClient	getClient()
TopologyInformation	getDeviceTopology(RestParams params, String resourceId) Retrieves the topology information for the rack resource specified by the given identifier.
String	getId(RestParams params, String name) Retrieves the rack resource identifier for the specified rack identified by name.
Rack	getRack(RestParams params, String resourceId) Retrieves the Rack details for the specified rack.
Rack	getRackByName(RestParams params, String name) Retrieves the Rack details for the specified rack identified by name.
String	removeRack(RestParams params, String resourceId) Removes the Rack identified by the given resource identifier.
TaskResourceV2	removeRackByFilter(RestParams params, String filter, boolean aSync) Removes the Rack(s) matching the filter.
Rack	updateRack(RestParams params, String resourceId, Rack rack) Updates a Rack 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 RackClient getClient()

getRack

public Rack getRack(RestParams params,
                    String resourceId)

Description copied from interface: RackClient

Retrieves the Rack details for the specified rack.

Specified by:

getRack in interface RackClient

Parameters:

params - structure containing the connection details.

resourceId - rack resource identifier as seen in HPE OneView.

Returns:

Rack object containing the details.

getAllRacks

public ResourceCollection<Rack> getAllRacks(RestParams params)

Description copied from interface: RackClient

Retrieves a ResourceCollection<Rack> containing details for all the available racks found under the current HPE OneView.

Specified by:

getAllRacks in interface RackClient

Parameters:

params - structure containing the connection details.

Returns:

ResourceCollection<Rack> containing the details for all found racks.

getRackByName

public Rack getRackByName(RestParams params,
                          String name)

Description copied from interface: RackClient

Retrieves the Rack details for the specified rack identified by name.

Specified by:

getRackByName in interface RackClient

Parameters:

params - structure containing the connection details.

name - rack name as seen in HPE OneView.

Returns:

Rack object containing the details.

addRack

public Rack addRack(RestParams params,
                    Rack rack)

Description copied from interface: RackClient

Adds a rack according to the provided Rack object.

Specified by:

addRack in interface RackClient

Parameters:

params - structure containing the connection details.

rack - object containing the rack details.

Returns:

Rack containing the added rack.

updateRack

public Rack updateRack(RestParams params,
                       String resourceId,
                       Rack rack)

Description copied from interface: RackClient

Updates a Rack identified by the given resource identifier.

Specified by:

updateRack in interface RackClient

Parameters:

params - structure containing the connection details.

resourceId - rack resource identifier as seen in HPE OneView.

rack - object containing the rack details.

Returns:

Rack containing the rack updated.

removeRack

public String removeRack(RestParams params,
                         String resourceId)

Description copied from interface: RackClient

Removes the Rack identified by the given resource identifier.

Specified by:

removeRack in interface RackClient

Parameters:

params - structure containing the connection details.

resourceId - rack resource identifier as seen in HPE OneView.

Returns:

String value containing the result of the process.

removeRackByFilter

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

Description copied from interface: RackClient

Removes the Rack(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:

removeRackByFilter in interface RackClient

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.

getDeviceTopology

public TopologyInformation getDeviceTopology(RestParams params,
                                             String resourceId)

Description copied from interface: RackClient

Retrieves the topology information for the rack resource specified by the given identifier.

Specified by:

getDeviceTopology in interface RackClient

Parameters:

params - structure containing the connection details.

resourceId - rack resource identifier as seen in HPE OneView.

Returns:

TopologyInformation containing the topology information for the rack.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: RackClient

Retrieves the rack resource identifier for the specified rack identified by name.

Specified by:

getId in interface RackClient

Parameters:

params - structure containing the connection details.

name - rack name as seen in HPE OneView.

Returns:

resource identifier for the rack name as seen in HPE OneView.