Documentation

Google_Service_AlertCenter_Resource_Alerts extends Google_Service_Resource
in package

The "alerts" collection of methods.

Typical usage is: $alertcenterService = new Google_Service_AlertCenter(...); $alerts = $alertcenterService->alerts;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
batchDelete()  : Google_Service_AlertCenter_BatchDeleteAlertsResponse
Performs batch delete operation on alerts. (alerts.batchDelete)
batchUndelete()  : Google_Service_AlertCenter_BatchUndeleteAlertsResponse
Performs batch undelete operation on alerts. (alerts.batchUndelete)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_AlertCenter_AlertcenterEmpty
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)
get()  : Google_Service_AlertCenter_Alert
Gets the specified alert. Attempting to get a nonexistent alert returns `NOT_FOUND` error. (alerts.get)
getMetadata()  : Google_Service_AlertCenter_AlertMetadata
Returns the metadata of an alert. Attempting to get metadata for a non- existent alert returns `NOT_FOUND` error. (alerts.getMetadata)
listAlerts()  : Google_Service_AlertCenter_ListAlertsResponse
Lists the alerts. (alerts.listAlerts)
undelete()  : Google_Service_AlertCenter_Alert
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)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

batchUndelete()

Performs batch undelete operation on alerts. (alerts.batchUndelete)

public batchUndelete(Google_Service_AlertCenter_BatchUndeleteAlertsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AlertCenter_BatchUndeleteAlertsResponse
Parameters
$postBody : Google_Service_AlertCenter_BatchUndeleteAlertsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AlertCenter_BatchUndeleteAlertsResponse —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

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)

public delete(string $alertId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AlertCenter_AlertcenterEmpty
Parameters
$alertId : string

Required. The identifier of the alert to delete.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string customerId Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.

Return values
Google_Service_AlertCenter_AlertcenterEmpty —

get()

Gets the specified alert. Attempting to get a nonexistent alert returns `NOT_FOUND` error. (alerts.get)

public get(string $alertId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AlertCenter_Alert
Parameters
$alertId : string

Required. The identifier of the alert to retrieve.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string customerId Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.

Return values
Google_Service_AlertCenter_Alert —

getMetadata()

Returns the metadata of an alert. Attempting to get metadata for a non- existent alert returns `NOT_FOUND` error. (alerts.getMetadata)

public getMetadata(string $alertId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AlertCenter_AlertMetadata
Parameters
$alertId : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string customerId Optional. The unique identifier of the G Suite organization account of the customer the alert metadata is associated with. Inferred from the caller identity if not provided.

Return values
Google_Service_AlertCenter_AlertMetadata —

listAlerts()

Lists the alerts. (alerts.listAlerts)

public listAlerts([array<string|int, mixed> $optParams = array() ]) : Google_Service_AlertCenter_ListAlertsResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string customerId Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided.

opt_param

string filter Optional. A query string for filtering alert results. For more details, see [Query filters](/admin-sdk/alertcenter/guides /query-filters) and [Supported query filter fields](/admin- sdk/alertcenter/reference/filter-fields#alerts.list).

opt_param

string orderBy Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using order_by="create_time desc". Currently, supported sorting are create_time asc, create_time desc, update_time desc

opt_param

string pageToken Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field.

opt_param

int pageSize Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.

Return values
Google_Service_AlertCenter_ListAlertsResponse —

undelete()

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)

public undelete(string $alertId, Google_Service_AlertCenter_UndeleteAlertRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AlertCenter_Alert
Parameters
$alertId : string

Required. The identifier of the alert to undelete.

$postBody : Google_Service_AlertCenter_UndeleteAlertRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_AlertCenter_Alert —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results