com.google.api.services.monitoring.v3

Class Monitoring.Projects.AlertPolicies

java.lang.Object

com.google.api.services.monitoring.v3.Monitoring.Projects.AlertPolicies

Enclosing class:

Monitoring.Projects

public class Monitoring.Projects.AlertPolicies
extends Object

The "alertPolicies" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Monitoring.Projects.AlertPolicies.Create
class	Monitoring.Projects.AlertPolicies.Delete
class	Monitoring.Projects.AlertPolicies.Get
class	Monitoring.Projects.AlertPolicies.List
class	Monitoring.Projects.AlertPolicies.Patch

Constructor Summary

Constructors

Constructor and Description
AlertPolicies()

Method Summary

Modifier and Type	Method and Description
Monitoring.Projects.AlertPolicies.Create	create(String name, AlertPolicy content) Creates a new alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project.
Monitoring.Projects.AlertPolicies.Delete	delete(String name) Deletes an alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project.
Monitoring.Projects.AlertPolicies.Get	get(String name) Gets a single alerting policy.
Monitoring.Projects.AlertPolicies.List	list(String name) Lists the existing alerting policies for the workspace.
Monitoring.Projects.AlertPolicies.Patch	patch(String name, AlertPolicy content) Updates an alerting policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertPolicies

public AlertPolicies()

Method Detail

create

public Monitoring.Projects.AlertPolicies.Create create(String name,
                                                       AlertPolicy content)
                                                throws IOException

Creates a new alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy. Create a request for the method "alertPolicies.create". This request holds the parameters needed by the monitoring server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a Metrics Scope, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container.

content - the AlertPolicy

Returns:

the request

Throws:

IOException

delete

public Monitoring.Projects.AlertPolicies.Delete delete(String name)
                                                throws IOException

Deletes an alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy. Create a request for the method "alertPolicies.delete". This request holds the parameters needed by the monitoring server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The alerting policy to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy.

Returns:

the request

Throws:

IOException

get

public Monitoring.Projects.AlertPolicies.Get get(String name)
                                          throws IOException

Gets a single alerting policy. Create a request for the method "alertPolicies.get". This request holds the parameters needed by the monitoring server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The alerting policy to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]

Returns:

the request

Throws:

IOException

list

public Monitoring.Projects.AlertPolicies.List list(String name)
                                            throws IOException

Lists the existing alerting policies for the workspace. Create a request for the method "alertPolicies.list". This request holds the parameters needed by the monitoring server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose alert policies are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.

Returns:

the request

Throws:

IOException

patch

public Monitoring.Projects.AlertPolicies.Patch patch(String name,
                                                     AlertPolicy content)
                                              throws IOException

Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy. Create a request for the method "alertPolicies.patch". This request holds the parameters needed by the monitoring server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Identifier. Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.

content - the AlertPolicy

Returns:

the request

Throws:

IOException