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

Interface PowerDeliveryDeviceClient

All Superinterfaces:

RemovableResource, RetrievableResource<PowerDeliveryDevice>, SearchableResource<PowerDeliveryDevice>

public interface PowerDeliveryDeviceClient
extends SearchableResource<PowerDeliveryDevice>, RemovableResource

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	POWER_DEVICE_DISCOVERY_URI
static String	POWER_DEVICE_POWER_STATE_URI
static String	POWER_DEVICE_REFRESH_STATE_URI
static String	POWER_DEVICE_SYNCHRONOUS_URI
static String	POWER_DEVICE_UID_STATE_URI
static String	POWER_DEVICE_URI
static String	POWER_DEVICE_UTILIZATION_URI

Method Summary

Modifier and Type	Method and Description
TaskResource	add(ImportPdd resource, RequestOption... options) Adds a resource according to the provided resource object.
PowerDeliveryDevice	add(PowerDeliveryDevice resource) Adds a resource according to the provided resource object.
Power	getPowerState(String resourceId) Retrieves the power state details for the specified power delivery device.
Light	getUidState(String resourceId) Retrieves the unit identification (UID) light state details for the specified power delivery device.
UtilizationData	getUtilization(String resourceId) Retrieves the UtilizationData details for the specified power delivery device.
String	remove(String resourceId) Removes the resource identified by the provided resourceId.
TaskResource	removeByFilter(String filter, RequestOption... options) Removes the PowerDeliveryDevice(s) matching the filter.
PowerDeliveryDevice	update(String resourceId, PowerDeliveryDevice powerDeliveryDevice) Updates the resource identified by the resourceId according to the provided resource object.
TaskResource	updatePowerState(String resourceId, OutletState outletState, RequestOption... options) Updates the power state of the power device identified by the provided resource identifier.
TaskResource	updateRefreshState(String resourceId, PowerDeliveryDeviceRefreshRequest refreshState, RequestOption... options) Updates the refresh state of the power device identified by the provided resource identifier.
TaskResource	updateUidState(String resourceId, OutletState outletState, RequestOption... options) Updates the unit identification (UID) light state of the power device identified by the provided resource identifier.

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

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

remove

Field Detail

POWER_DEVICE_URI

static final String POWER_DEVICE_URI

See Also:

Constant Field Values

POWER_DEVICE_DISCOVERY_URI

static final String POWER_DEVICE_DISCOVERY_URI

See Also:

Constant Field Values

POWER_DEVICE_POWER_STATE_URI

static final String POWER_DEVICE_POWER_STATE_URI

See Also:

Constant Field Values

POWER_DEVICE_REFRESH_STATE_URI

static final String POWER_DEVICE_REFRESH_STATE_URI

See Also:

Constant Field Values

POWER_DEVICE_UID_STATE_URI

static final String POWER_DEVICE_UID_STATE_URI

See Also:

Constant Field Values

POWER_DEVICE_UTILIZATION_URI

static final String POWER_DEVICE_UTILIZATION_URI

See Also:

Constant Field Values

POWER_DEVICE_SYNCHRONOUS_URI

static final String POWER_DEVICE_SYNCHRONOUS_URI

See Also:

Constant Field Values

Method Detail

add

TaskResource add(ImportPdd resource,
                 RequestOption... options)

Adds a resource according to the provided resource object.

Parameters:

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

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

Returns:

TaskResource containing the task status for the process.

See Also:

AddableResource.add(Object, RequestOption...)

add

PowerDeliveryDevice add(PowerDeliveryDevice 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 created PowerDeliveryDevice.

update

PowerDeliveryDevice update(String resourceId,
                           PowerDeliveryDevice powerDeliveryDevice)

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

Parameters:

resourceId - resource identifier as seen in HPE OneView.

powerDeliveryDevice - object containing the details of the resource that should be created.

Returns:

the updated PowerDeliveryDevice.

removeByFilter

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

Removes the PowerDeliveryDevice(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.

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.

getPowerState

Power getPowerState(String resourceId)

Retrieves the power state details for the specified power delivery device.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

Returns:

Power object containing the details.

updatePowerState

TaskResource updatePowerState(String resourceId,
                              OutletState outletState,
                              RequestOption... options)

Updates the power state of the power device identified by the provided resource identifier.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

outletState - power state of the power delivery device.

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

Returns:

TaskResource containing the task status for the process.

updateRefreshState

TaskResource updateRefreshState(String resourceId,
                                PowerDeliveryDeviceRefreshRequest refreshState,
                                RequestOption... options)

Updates the refresh state of the power device identified by the provided resource identifier.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

refreshState - refresh state of the power delivery device.

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

Returns:

TaskResource containing the task status for the process.

getUidState

Light getUidState(String resourceId)

Retrieves the unit identification (UID) light state details for the specified power delivery device.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

Returns:

Light object containing the details.

updateUidState

TaskResource updateUidState(String resourceId,
                            OutletState outletState,
                            RequestOption... options)

Updates the unit identification (UID) light state of the power device identified by the provided resource identifier.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

outletState - identification (UID) light state of the power delivery device.

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

Returns:

TaskResource containing the task status for the process.

getUtilization

UtilizationData getUtilization(String resourceId)

Retrieves the UtilizationData details for the specified power delivery device.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

Returns:

UtilizationData object containing the details.