Google Cloud Monitoring v3 API - Class NotificationChannelService.NotificationChannelServiceBase (3.13.0)

Version latest

• 3.13.0 (latest)
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0

[BindServiceMethod(typeof(NotificationChannelService), "BindService")]
public abstract class NotificationChannelService.NotificationChannelServiceBase

Reference documentation and code samples for the Google Cloud Monitoring v3 API class NotificationChannelService.NotificationChannelServiceBase.

Base class for server-side implementations of NotificationChannelService

Inheritance

object > NotificationChannelService.NotificationChannelServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Methods

CreateNotificationChannel(CreateNotificationChannelRequest, ServerCallContext)

public virtual Task<NotificationChannel> CreateNotificationChannel(CreateNotificationChannelRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	CreateNotificationChannelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskNotificationChannel	The response to send back to the client (wrapped by a task).

DeleteNotificationChannel(DeleteNotificationChannelRequest, ServerCallContext)

public virtual Task<Empty> DeleteNotificationChannel(DeleteNotificationChannelRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	DeleteNotificationChannelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

GetNotificationChannel(GetNotificationChannelRequest, ServerCallContext)

public virtual Task<NotificationChannel> GetNotificationChannel(GetNotificationChannelRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	GetNotificationChannelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskNotificationChannel	The response to send back to the client (wrapped by a task).

GetNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest, ServerCallContext)

public virtual Task<NotificationChannelDescriptor> GetNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest request, ServerCallContext context)

Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.

Parameters
Name	Description
request	GetNotificationChannelDescriptorRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskNotificationChannelDescriptor	The response to send back to the client (wrapped by a task).

GetNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest, ServerCallContext)

public virtual Task<GetNotificationChannelVerificationCodeResponse> GetNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	GetNotificationChannelVerificationCodeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGetNotificationChannelVerificationCodeResponse	The response to send back to the client (wrapped by a task).

ListNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest, ServerCallContext)

public virtual Task<ListNotificationChannelDescriptorsResponse> ListNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest request, ServerCallContext context)

Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

Parameters
Name	Description
request	ListNotificationChannelDescriptorsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListNotificationChannelDescriptorsResponse	The response to send back to the client (wrapped by a task).

ListNotificationChannels(ListNotificationChannelsRequest, ServerCallContext)

public virtual Task<ListNotificationChannelsResponse> ListNotificationChannels(ListNotificationChannelsRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	ListNotificationChannelsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListNotificationChannelsResponse	The response to send back to the client (wrapped by a task).

SendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest, ServerCallContext)

public virtual Task<Empty> SendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest request, ServerCallContext context)

Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel.

Parameters
Name	Description
request	SendNotificationChannelVerificationCodeRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

UpdateNotificationChannel(UpdateNotificationChannelRequest, ServerCallContext)

public virtual Task<NotificationChannel> UpdateNotificationChannel(UpdateNotificationChannelRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	UpdateNotificationChannelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskNotificationChannel	The response to send back to the client (wrapped by a task).

VerifyNotificationChannel(VerifyNotificationChannelRequest, ServerCallContext)

public virtual Task<NotificationChannel> VerifyNotificationChannel(VerifyNotificationChannelRequest request, ServerCallContext context)

Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode.

Parameters
Name	Description
request	VerifyNotificationChannelRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskNotificationChannel	The response to send back to the client (wrapped by a task).