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

Interface DataCenterClient

All Superinterfaces:

RetrievableResource<DataCenter>, SearchableResource<DataCenter>

public interface DataCenterClient
extends SearchableResource<DataCenter>

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	DATA_CENTER_URI
static String	DATA_CENTER_VISUAL_CONTENT_URI

Method Summary

Modifier and Type	Method and Description
DataCenter	add(DataCenter resource) Adds a resource according to the provided resource object.
List<VisualContent>	getVisualContent(String resourceId) Retrieves a List<VisualContent> describing each rack within the data center.
String	remove(String resourceId) Removes the resource identified by the provided resourceId.
TaskResource	removeByFilter(String filter, RequestOption... options) Removes the DataCenter(s) matching the filter.
DataCenter	update(String resourceId, DataCenter 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

DATA_CENTER_URI

static final String DATA_CENTER_URI

See Also:

Constant Field Values

DATA_CENTER_VISUAL_CONTENT_URI

static final String DATA_CENTER_VISUAL_CONTENT_URI

See Also:

Constant Field Values

Method Detail

add

DataCenter add(DataCenter resource)

Adds a resource according to the provided resource object.

Parameters:

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

Returns:

DataCenter object containing the result of this request.

update

DataCenter update(String resourceId,
                  DataCenter 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:

DataCenter 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 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 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.

getVisualContent

List<VisualContent> getVisualContent(String resourceId)

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

Parameters:

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

Returns:

List<VisualContent> containing the details of each rack within the data center.