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

Interface UnmanagedDeviceClient

All Superinterfaces:

RetrievableResource<UnmanagedDevice>, SearchableResource<UnmanagedDevice>

public interface UnmanagedDeviceClient
extends SearchableResource<UnmanagedDevice>

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	ENVIRONMENT_CONFIGURATION_URI
static String	UNMANAGED_DEVICE_URI

Method Summary

Modifier and Type	Method and Description
UnmanagedDevice	add(UnmanagedDevice resource) Adds a resource according to the provided resource object.
EnvironmentalConfiguration	getEnvironmentalConfiguration(String resourceId) Returns a description of the environmental configuration (supported feature set, calibrated minimum and maximum power, location and dimensions, etc.) of the resource.
String	remove(String resourceId) Removes the resource identified by the provided resourceId.
TaskResource	removeByFilter(String filter, RequestOption... options) Removes the UnmanagedDevice(s) matching the filter.
UnmanagedDevice	update(String resourceId, UnmanagedDevice 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

UNMANAGED_DEVICE_URI

static final String UNMANAGED_DEVICE_URI

See Also:

Constant Field Values

ENVIRONMENT_CONFIGURATION_URI

static final String ENVIRONMENT_CONFIGURATION_URI

See Also:

Constant Field Values

Method Detail

add

UnmanagedDevice add(UnmanagedDevice resource)

Adds a resource according to the provided resource object.

Parameters:

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

Returns:

UnmanagedDevice task containing the result of this request.

update

UnmanagedDevice update(String resourceId,
                       UnmanagedDevice 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 created.

Returns:

UnmanagedDevice object containing the result of this request.

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 UnmanagedDevice(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.

getEnvironmentalConfiguration

EnvironmentalConfiguration getEnvironmentalConfiguration(String resourceId)

Returns a description of the environmental configuration (supported feature set, calibrated minimum and maximum power, location and dimensions, etc.) of the resource.

Parameters:

resourceId - unmanaged device resource identifier as seen in HPE OneView.

Returns:

EnvironmentalConfiguration containing the description of the environmental configuration.