com.google.api.services.alertcenter.v1beta1

Class AlertCenter.Alerts

java.lang.Object

com.google.api.services.alertcenter.v1beta1.AlertCenter.Alerts

Enclosing class:

AlertCenter

public class AlertCenter.Alerts
extends Object

The "alerts" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AlertCenter.Alerts.BatchDelete
class	AlertCenter.Alerts.BatchUndelete
class	AlertCenter.Alerts.Delete
class	AlertCenter.Alerts.Feedback The "feedback" collection of methods.
class	AlertCenter.Alerts.Get
class	AlertCenter.Alerts.GetMetadata
class	AlertCenter.Alerts.List
class	AlertCenter.Alerts.Undelete

Constructor Summary

Constructors

Constructor and Description
Alerts()

Method Summary

Modifier and Type	Method and Description
AlertCenter.Alerts.BatchDelete	batchDelete(BatchDeleteAlertsRequest content) Performs batch delete operation on alerts.
AlertCenter.Alerts.BatchUndelete	batchUndelete(BatchUndeleteAlertsRequest content) Performs batch undelete operation on alerts.
AlertCenter.Alerts.Delete	delete(String alertId) Marks the specified alert for deletion.
AlertCenter.Alerts.Feedback	feedback() An accessor for creating requests from the Feedback collection.
AlertCenter.Alerts.Get	get(String alertId) Gets the specified alert.
AlertCenter.Alerts.GetMetadata	getMetadata(String alertId) Returns the metadata of an alert.
AlertCenter.Alerts.List	list() Lists the alerts.
AlertCenter.Alerts.Undelete	undelete(String alertId, UndeleteAlertRequest content) Restores, or "undeletes", an alert that was marked for deletion within the past 30 days.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Alerts

public Alerts()

Method Detail

batchDelete

public AlertCenter.Alerts.BatchDelete batchDelete(BatchDeleteAlertsRequest content)
                                           throws IOException

Performs batch delete operation on alerts. Create a request for the method "alerts.batchDelete". This request holds the parameters needed by the alertcenter server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the BatchDeleteAlertsRequest

Returns:

the request

Throws:

IOException

batchUndelete

public AlertCenter.Alerts.BatchUndelete batchUndelete(BatchUndeleteAlertsRequest content)
                                               throws IOException

Performs batch undelete operation on alerts. Create a request for the method "alerts.batchUndelete". This request holds the parameters needed by the alertcenter server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the BatchUndeleteAlertsRequest

Returns:

the request

Throws:

IOException

delete

public AlertCenter.Alerts.Delete delete(String alertId)
                                 throws IOException

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. Create a request for the method "alerts.delete". This request holds the parameters needed by the alertcenter server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

alertId - Required. The identifier of the alert to delete.

Returns:

the request

Throws:

IOException

get

public AlertCenter.Alerts.Get get(String alertId)
                           throws IOException

Gets the specified alert. Attempting to get a nonexistent alert returns `NOT_FOUND` error. Create a request for the method "alerts.get". This request holds the parameters needed by the alertcenter server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

alertId - Required. The identifier of the alert to retrieve.

Returns:

the request

Throws:

IOException

getMetadata

public AlertCenter.Alerts.GetMetadata getMetadata(String alertId)
                                           throws IOException

Returns the metadata of an alert. Attempting to get metadata for a non-existent alert returns `NOT_FOUND` error. Create a request for the method "alerts.getMetadata". This request holds the parameters needed by the alertcenter server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

list

public AlertCenter.Alerts.List list()
                             throws IOException

Lists the alerts. Create a request for the method "alerts.list". This request holds the parameters needed by the alertcenter server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

undelete

public AlertCenter.Alerts.Undelete undelete(String alertId,
                                            UndeleteAlertRequest content)
                                     throws IOException

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. Create a request for the method "alerts.undelete". This request holds the parameters needed by the alertcenter server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

alertId - Required. The identifier of the alert to undelete.

content - the UndeleteAlertRequest

Returns:

the request

Throws:

IOException

feedback

public AlertCenter.Alerts.Feedback feedback()

An accessor for creating requests from the Feedback collection.

The typical use is:

    AlertCenter alertcenter = new AlertCenter(...);
    AlertCenter.Feedback.List request = alertcenter.feedback().list(parameters ...)
 

Returns:

the resource collection