AlertCenter

import { AlertCenter } from "https://googleapis.deno.dev/v1/alertcenter:v1beta1.ts";

Manages alerts on issues affecting your domain. Note: The current version of this API (v1beta1) is available to all Google Workspace customers.

class AlertCenter {

constructor(client?: CredentialsClient, baseUrl?: string);

async alertsBatchDelete(req: BatchDeleteAlertsRequest): Promise<BatchDeleteAlertsResponse>;

async alertsBatchUndelete(req: BatchUndeleteAlertsRequest): Promise<BatchUndeleteAlertsResponse>;

async alertsDelete(alertId: string, opts?: AlertsDeleteOptions): Promise<Empty>;

async alertsFeedbackCreate(

alertId: string,

req: AlertFeedback,

opts?: AlertsFeedbackCreateOptions,

): Promise<AlertFeedback>;

async alertsFeedbackList(alertId: string, opts?: AlertsFeedbackListOptions): Promise<ListAlertFeedbackResponse>;

async alertsGet(alertId: string, opts?: AlertsGetOptions): Promise<Alert>;

async alertsGetMetadata(alertId: string, opts?: AlertsGetMetadataOptions): Promise<AlertMetadata>;

async alertsList(opts?: AlertsListOptions): Promise<ListAlertsResponse>;

async alertsUndelete(alertId: string, req: UndeleteAlertRequest): Promise<Alert>;

async v1beta1GetSettings(opts?: V1beta1GetSettingsOptions): Promise<Settings>;

async v1beta1UpdateSettings(req: Settings, opts?: V1beta1UpdateSettingsOptions): Promise<Settings>;

}

§Constructors

new AlertCenter(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

alertsBatchDelete(req: BatchDeleteAlertsRequest): Promise<BatchDeleteAlertsResponse>

[src]

Performs batch delete operation on alerts.

alertsBatchUndelete(req: BatchUndeleteAlertsRequest): Promise<BatchUndeleteAlertsResponse>

[src]

Performs batch undelete operation on alerts.

alertsDelete(alertId: string, opts?: AlertsDeleteOptions): Promise<Empty>

[src]

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.

@param alertId

Required. The identifier of the alert to delete.

alertsFeedbackCreate(alertId: string, req: AlertFeedback, opts?: AlertsFeedbackCreateOptions): Promise<AlertFeedback>

[src]

Creates new feedback for an alert. Attempting to create a feedback for a non-existent alert returns NOT_FOUND error. Attempting to create a feedback for an alert that is marked for deletion returns `FAILED_PRECONDITION' error.

@param alertId

Required. The identifier of the alert this feedback belongs to.

alertsFeedbackList(alertId: string, opts?: AlertsFeedbackListOptions): Promise<ListAlertFeedbackResponse>

[src]

Lists all the feedback for an alert. Attempting to list feedbacks for a non-existent alert returns NOT_FOUND error.

@param alertId

Required. The alert identifier. The "-" wildcard could be used to represent all alerts.

alertsGet(alertId: string, opts?: AlertsGetOptions): Promise<Alert>

[src]

Gets the specified alert. Attempting to get a nonexistent alert returns NOT_FOUND error.

@param alertId

Required. The identifier of the alert to retrieve.

alertsGetMetadata(alertId: string, opts?: AlertsGetMetadataOptions): Promise<AlertMetadata>

[src]

Returns the metadata of an alert. Attempting to get metadata for a non-existent alert returns NOT_FOUND error.

@param alertId

Required. The identifier of the alert this metadata belongs to.

alertsList(opts?: AlertsListOptions): Promise<ListAlertsResponse>

[src]

Lists the alerts.

alertsUndelete(alertId: string, req: UndeleteAlertRequest): Promise<Alert>

[src]

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.

@param alertId

Required. The identifier of the alert to undelete.

v1beta1GetSettings(opts?: V1beta1GetSettingsOptions): Promise<Settings>

[src]

Returns customer-level settings.

v1beta1UpdateSettings(req: Settings, opts?: V1beta1UpdateSettingsOptions): Promise<Settings>

[src]

Updates the customer-level settings.