com.hp.ov.sdk.rest.client.facilities

Interface RackClient

All Superinterfaces:

RetrievableResource<Rack>, SearchableResource<Rack>

public interface RackClient
extends SearchableResource<Rack>

Nested Class Summary

Nested classes/interfaces inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

SearchableResource.GetByNameRequestInterceptor

Field Summary

Fields

Modifier and Type	Field and Description
static String	RACK_DEVICE_TOPOLOGY
static String	RACK_URI

Method Summary

Modifier and Type	Method and Description
Rack	add(Rack resource) Adds a resource according to the provided resource object.
TopologyInformation	getDeviceTopology(String resourceId) Retrieves the topology information for the rack resource identified by the provided resourceId.
String	remove(String resourceId) Removes the resource identified by the provided resourceId.
TaskResource	removeByFilter(String filter, RequestOption... options) Removes the Rack(s) matching the filter.
Rack	update(String resourceId, Rack resource) Updates the resource identified by the resourceId according to the provided resource object.

Methods inherited from interface com.hp.ov.sdk.rest.client.common.SearchableResource

getByName

Methods inherited from interface com.hp.ov.sdk.rest.client.common.RetrievableResource

get, get, getAll, getAll, getById

Field Detail

RACK_DEVICE_TOPOLOGY

static final String RACK_DEVICE_TOPOLOGY

See Also:

Constant Field Values

RACK_URI

static final String RACK_URI

See Also:

Constant Field Values

Method Detail

add

Rack add(Rack resource)

Adds a resource according to the provided resource object.

Parameters:

resource - object containing the details of the resource that should be added.

Returns:

the added Rack.

update

Rack update(String resourceId,
            Rack resource)

Updates the resource identified by the resourceId according to the provided resource object.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

resource - object containing the details of the resource that should be updated.

Returns:

the updated Rack.

remove

String remove(String resourceId)

Removes the resource identified by the provided resourceId.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

Returns:

String containing the result of this request.

removeByFilter

TaskResource removeByFilter(String filter,
                            RequestOption... options)

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 TaskTimeout specified.

Parameters:

filter - a general filter string that narrows the list of resources.

options - varargs of RequestOption, which can be used to specify some request options.

Returns:

TaskResource containing the task status for the process.

getDeviceTopology

TopologyInformation getDeviceTopology(String resourceId)

Retrieves the topology information for the rack resource identified by the provided resourceId.

Parameters:

resourceId - rack resource identifier as seen in HPE OneView.

Returns:

TopologyInformation containing the topology information for the rack.