Alerts
class Alerts extends Resource (View source)
The "alerts" collection of methods.
Typical usage is:
$alertcenterService = new Google\Service\AlertCenter(...);
$alerts = $alertcenterService->alerts;Methods
Performs batch delete operation on alerts. (alerts.batchDelete)
Performs batch undelete operation on alerts. (alerts.batchUndelete)
Marks the specified alert for deletion. An alert that has been marked for
deletion is removed from Alert Center after 30 days. Marking an alert for
deletion has no effect on an alert which has already been marked for
deletion. Attempting to mark a nonexistent alert for deletion results in a
NOT_FOUND error. (alerts.delete)
Gets the specified alert. Attempting to get a nonexistent alert returns
NOT_FOUND error. (alerts.get)
Returns the metadata of an alert. Attempting to get metadata for a non-
existent alert returns NOT_FOUND error. (alerts.getMetadata)
Lists the alerts. (alerts.listAlerts)
Restores, or "undeletes", an alert that was marked for deletion within the
past 30 days. Attempting to undelete an alert which was marked for deletion
over 30 days ago (which has been removed from the Alert Center database) or a
nonexistent alert returns a NOT_FOUND error. Attempting to undelete an
alert which has not been marked for deletion has no effect. (alerts.undelete)
Details
BatchDeleteAlertsResponse
batchDelete(BatchDeleteAlertsRequest $postBody, array $optParams = [])
Performs batch delete operation on alerts. (alerts.batchDelete)
BatchUndeleteAlertsResponse
batchUndelete(BatchUndeleteAlertsRequest $postBody, array $optParams = [])
Performs batch undelete operation on alerts. (alerts.batchUndelete)
AlertcenterEmpty
delete(string $alertId, array $optParams = [])
Marks the specified alert for deletion. An alert that has been marked for
deletion is removed from Alert Center after 30 days. Marking an alert for
deletion has no effect on an alert which has already been marked for
deletion. Attempting to mark a nonexistent alert for deletion results in a
NOT_FOUND error. (alerts.delete)
Alert
get(string $alertId, array $optParams = [])
Gets the specified alert. Attempting to get a nonexistent alert returns
NOT_FOUND error. (alerts.get)
AlertMetadata
getMetadata(string $alertId, array $optParams = [])
Returns the metadata of an alert. Attempting to get metadata for a non-
existent alert returns NOT_FOUND error. (alerts.getMetadata)
ListAlertsResponse
listAlerts(array $optParams = [])
Lists the alerts. (alerts.listAlerts)
Alert
undelete(string $alertId, UndeleteAlertRequest $postBody, array $optParams = [])
Restores, or "undeletes", an alert that was marked for deletion within the
past 30 days. Attempting to undelete an alert which was marked for deletion
over 30 days ago (which has been removed from the Alert Center database) or a
nonexistent alert returns a NOT_FOUND error. Attempting to undelete an
alert which has not been marked for deletion has no effect. (alerts.undelete)