com.hp.ov.sdk.rest.client.activity

Interface AlertClient

All Superinterfaces:

RetrievableResource<AlertResource>

public interface AlertClient
extends RetrievableResource<AlertResource>

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALERTS_CHANGELOG_URI
static String	ALERTS_URI

Method Summary

Modifier and Type	Method and Description
String	delete(String resourceId) Deletes the AlertResource identified by the given resource identifier.
String	deleteAlertChangeLog(String changeLogId) Deletes the alert change log item identified by changeLogId.
TaskResource	deleteByFilter(String filter, RequestOption... options) Deletes all the AlertResource(s) that match the filter.
AlertResource	update(String resourceId, AlertUpdate 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.RetrievableResource

get, get, getAll, getAll, getById

Field Detail

ALERTS_URI

static final String ALERTS_URI

See Also:

Constant Field Values

ALERTS_CHANGELOG_URI

static final String ALERTS_CHANGELOG_URI

See Also:

Constant Field Values

Method Detail

update

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

the updated AlertResource.

delete

String delete(String resourceId)

Deletes the AlertResource identified by the given resource identifier.

Parameters:

resourceId - resource identifier as seen in HPE OneView.

Returns:

String containing the response of the process.

deleteByFilter

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

Deletes all the AlertResource(s) that match the filter. If no filter is specified all alerts will be deleted (excepted those not permitted). The actual deletion will proceed asynchronously. Although, the method can process the request asynchronously or synchronously, based on the aSync flag input.

Parameters:

filter - A general filter/query 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.

deleteAlertChangeLog

String deleteAlertChangeLog(String changeLogId)

Deletes the alert change log item identified by changeLogId. Only user-entered change logs can be deleted by the user (the change logs generated by the system cannot be deleted by the user). Alerts cleared when processing an event with clearPriorEvents set to true have a system-generated note indicating the automatic clearing of the alerts.

Parameters:

changeLogId - alert change log identifier as seen in HPE OneView.

Returns:

String containing the response of the process.