com.google.api.services.monitoring.v3

Class Monitoring.Projects.NotificationChannels

java.lang.Object

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

Enclosing class:

Monitoring.Projects

public class Monitoring.Projects.NotificationChannels
extends Object

The "notificationChannels" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Monitoring.Projects.NotificationChannels.Create
class	Monitoring.Projects.NotificationChannels.Delete
class	Monitoring.Projects.NotificationChannels.Get
class	Monitoring.Projects.NotificationChannels.GetVerificationCode
class	Monitoring.Projects.NotificationChannels.List
class	Monitoring.Projects.NotificationChannels.Patch
class	Monitoring.Projects.NotificationChannels.SendVerificationCode
class	Monitoring.Projects.NotificationChannels.Verify

Constructor Summary

Constructors

Constructor and Description
NotificationChannels()

Method Summary

Modifier and Type	Method and Description
Monitoring.Projects.NotificationChannels.Create	create(String name, NotificationChannel content) Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.Design your application to single-thread API calls that modify the state of notification channels in a single project.
Monitoring.Projects.NotificationChannels.Delete	delete(String name) Deletes a notification channel.Design your application to single-thread API calls that modify the state of notification channels in a single project.
Monitoring.Projects.NotificationChannels.Get	get(String name) Gets a single notification channel.
Monitoring.Projects.NotificationChannels.GetVerificationCode	getVerificationCode(String name, GetNotificationChannelVerificationCodeRequest content) Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project.
Monitoring.Projects.NotificationChannels.List	list(String name) Lists the notification channels that have been created for the project.
Monitoring.Projects.NotificationChannels.Patch	patch(String name, NotificationChannel content) Updates a notification channel.
Monitoring.Projects.NotificationChannels.SendVerificationCode	sendVerificationCode(String name, SendNotificationChannelVerificationCodeRequest content) Causes a verification code to be delivered to the channel.
Monitoring.Projects.NotificationChannels.Verify	verify(String name, VerifyNotificationChannelRequest content) Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationChannels

public NotificationChannels()

Method Detail

create

public Monitoring.Projects.NotificationChannels.Create create(String name,
                                                              NotificationChannel content)
                                                       throws IOException

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel. Create a request for the method "notificationChannels.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) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container into which the channel will be written, this does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel.

content - the NotificationChannel

Returns:

the request

Throws:

IOException

delete

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

Deletes a notification channel.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel. Create a request for the method "notificationChannels.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 channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

Returns:

the request

Throws:

IOException

get

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

Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method. Create a request for the method "notificationChannels.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 channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

Returns:

the request

Throws:

IOException

getVerificationCode

public Monitoring.Projects.NotificationChannels.GetVerificationCode getVerificationCode(String name,
                                                                                        GetNotificationChannelVerificationCodeRequest content)
                                                                                 throws IOException

Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been used to put the given channel into the verified state).There is no guarantee that the verification codes returned by this method will be of a similar structure or form as the ones that are delivered to the channel via SendNotificationChannelVerificationCode; while VerifyNotificationChannel() will recognize both the codes delivered via SendNotificationChannelVerificationCode() and returned from GetNotificationChannelVerificationCode(), it is typically the case that the verification codes delivered via SendNotificationChannelVerificationCode() will be shorter and also have a shorter expiration (e.g. codes such as "G-123456") whereas GetVerificationCode() will typically return a much longer, websafe base 64 encoded string that has a longer expiration time. Create a request for the method "notificationChannels.getVerificationCode". 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 notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail.

content - the GetNotificationChannelVerificationCodeRequest

Returns:

the request

Throws:

IOException

list

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

Lists the notification channels that have been created for the project. To list the types of notification channels that are supported, use the ListNotificationChannelDescriptors method. Create a request for the method "notificationChannels.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) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation.

Returns:

the request

Throws:

IOException

patch

public Monitoring.Projects.NotificationChannels.Patch patch(String name,
                                                            NotificationChannel content)
                                                     throws IOException

Updates a notification channel. Fields not specified in the field mask remain unchanged.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel. Create a request for the method "notificationChannels.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. The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.

content - the NotificationChannel

Returns:

the request

Throws:

IOException

sendVerificationCode

public Monitoring.Projects.NotificationChannels.SendVerificationCode sendVerificationCode(String name,
                                                                                          SendNotificationChannelVerificationCodeRequest content)
                                                                                   throws IOException

Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel. Create a request for the method "notificationChannels.sendVerificationCode". 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 notification channel to which to send a verification code.

content - the SendNotificationChannelVerificationCodeRequest

Returns:

the request

Throws:

IOException

verify

public Monitoring.Projects.NotificationChannels.Verify verify(String name,
                                                              VerifyNotificationChannelRequest content)
                                                       throws IOException

Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode. Create a request for the method "notificationChannels.verify". 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 notification channel to verify.

content - the VerifyNotificationChannelRequest

Returns:

the request

Throws:

IOException