Google Cloud Monitoring v3 API - Class NotificationChannelService.NotificationChannelServiceClient (3.4.0)

Version 3.4.0

• 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

public class NotificationChannelService.NotificationChannelServiceClient : ClientBase<NotificationChannelService.NotificationChannelServiceClient>

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

Client for NotificationChannelService

Inheritance

object > ClientBase > ClientBaseNotificationChannelServiceNotificationChannelServiceClient > NotificationChannelService.NotificationChannelServiceClient

Inherited Members

ClientBase<NotificationChannelService.NotificationChannelServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

NotificationChannelServiceClient()

protected NotificationChannelServiceClient()

Protected parameterless constructor to allow creation of test doubles.

NotificationChannelServiceClient(CallInvoker)

public NotificationChannelServiceClient(CallInvoker callInvoker)

Creates a new client for NotificationChannelService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

NotificationChannelServiceClient(ChannelBase)

public NotificationChannelServiceClient(ChannelBase channel)

Creates a new client for NotificationChannelService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

NotificationChannelServiceClient(ClientBaseConfiguration)

protected NotificationChannelServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateNotificationChannel(CreateNotificationChannelRequest, CallOptions)

public virtual NotificationChannel CreateNotificationChannel(CreateNotificationChannelRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
NotificationChannel	The response received from the server.

CreateNotificationChannel(CreateNotificationChannelRequest, Metadata, DateTime?, CancellationToken)

public virtual NotificationChannel CreateNotificationChannel(CreateNotificationChannelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
NotificationChannel	The response received from the server.

CreateNotificationChannelAsync(CreateNotificationChannelRequest, CallOptions)

public virtual AsyncUnaryCall<NotificationChannel> CreateNotificationChannelAsync(CreateNotificationChannelRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallNotificationChannel	The call object.

CreateNotificationChannelAsync(CreateNotificationChannelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NotificationChannel> CreateNotificationChannelAsync(CreateNotificationChannelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallNotificationChannel	The call object.

DeleteNotificationChannel(DeleteNotificationChannelRequest, CallOptions)

public virtual Empty DeleteNotificationChannel(DeleteNotificationChannelRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteNotificationChannel(DeleteNotificationChannelRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteNotificationChannel(DeleteNotificationChannelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteNotificationChannelAsync(DeleteNotificationChannelRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteNotificationChannelAsync(DeleteNotificationChannelRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteNotificationChannelAsync(DeleteNotificationChannelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteNotificationChannelAsync(DeleteNotificationChannelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GetNotificationChannel(GetNotificationChannelRequest, CallOptions)

public virtual NotificationChannel GetNotificationChannel(GetNotificationChannelRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
NotificationChannel	The response received from the server.

GetNotificationChannel(GetNotificationChannelRequest, Metadata, DateTime?, CancellationToken)

public virtual NotificationChannel GetNotificationChannel(GetNotificationChannelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
NotificationChannel	The response received from the server.

GetNotificationChannelAsync(GetNotificationChannelRequest, CallOptions)

public virtual AsyncUnaryCall<NotificationChannel> GetNotificationChannelAsync(GetNotificationChannelRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallNotificationChannel	The call object.

GetNotificationChannelAsync(GetNotificationChannelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NotificationChannel> GetNotificationChannelAsync(GetNotificationChannelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallNotificationChannel	The call object.

GetNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest, CallOptions)

public virtual NotificationChannelDescriptor GetNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
NotificationChannelDescriptor	The response received from the server.

GetNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest, Metadata, DateTime?, CancellationToken)

public virtual NotificationChannelDescriptor GetNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
NotificationChannelDescriptor	The response received from the server.

GetNotificationChannelDescriptorAsync(GetNotificationChannelDescriptorRequest, CallOptions)

public virtual AsyncUnaryCall<NotificationChannelDescriptor> GetNotificationChannelDescriptorAsync(GetNotificationChannelDescriptorRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallNotificationChannelDescriptor	The call object.

GetNotificationChannelDescriptorAsync(GetNotificationChannelDescriptorRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NotificationChannelDescriptor> GetNotificationChannelDescriptorAsync(GetNotificationChannelDescriptorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallNotificationChannelDescriptor	The call object.

GetNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest, CallOptions)

public virtual GetNotificationChannelVerificationCodeResponse GetNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
GetNotificationChannelVerificationCodeResponse	The response received from the server.

GetNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest, Metadata, DateTime?, CancellationToken)

public virtual GetNotificationChannelVerificationCodeResponse GetNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
GetNotificationChannelVerificationCodeResponse	The response received from the server.

GetNotificationChannelVerificationCodeAsync(GetNotificationChannelVerificationCodeRequest, CallOptions)

public virtual AsyncUnaryCall<GetNotificationChannelVerificationCodeResponse> GetNotificationChannelVerificationCodeAsync(GetNotificationChannelVerificationCodeRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallGetNotificationChannelVerificationCodeResponse	The call object.

GetNotificationChannelVerificationCodeAsync(GetNotificationChannelVerificationCodeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GetNotificationChannelVerificationCodeResponse> GetNotificationChannelVerificationCodeAsync(GetNotificationChannelVerificationCodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallGetNotificationChannelVerificationCodeResponse	The call object.

ListNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest, CallOptions)

public virtual ListNotificationChannelDescriptorsResponse ListNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListNotificationChannelDescriptorsResponse	The response received from the server.

ListNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListNotificationChannelDescriptorsResponse ListNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListNotificationChannelDescriptorsResponse	The response received from the server.

ListNotificationChannelDescriptorsAsync(ListNotificationChannelDescriptorsRequest, CallOptions)

public virtual AsyncUnaryCall<ListNotificationChannelDescriptorsResponse> ListNotificationChannelDescriptorsAsync(ListNotificationChannelDescriptorsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListNotificationChannelDescriptorsResponse	The call object.

ListNotificationChannelDescriptorsAsync(ListNotificationChannelDescriptorsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListNotificationChannelDescriptorsResponse> ListNotificationChannelDescriptorsAsync(ListNotificationChannelDescriptorsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListNotificationChannelDescriptorsResponse	The call object.

ListNotificationChannels(ListNotificationChannelsRequest, CallOptions)

public virtual ListNotificationChannelsResponse ListNotificationChannels(ListNotificationChannelsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListNotificationChannelsResponse	The response received from the server.

ListNotificationChannels(ListNotificationChannelsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListNotificationChannelsResponse ListNotificationChannels(ListNotificationChannelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListNotificationChannelsResponse	The response received from the server.

ListNotificationChannelsAsync(ListNotificationChannelsRequest, CallOptions)

public virtual AsyncUnaryCall<ListNotificationChannelsResponse> ListNotificationChannelsAsync(ListNotificationChannelsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListNotificationChannelsResponse	The call object.

ListNotificationChannelsAsync(ListNotificationChannelsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListNotificationChannelsResponse> ListNotificationChannelsAsync(ListNotificationChannelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListNotificationChannelsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override NotificationChannelService.NotificationChannelServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
NotificationChannelServiceNotificationChannelServiceClient

Overrides

ClientBase<NotificationChannelService.NotificationChannelServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

SendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest, CallOptions)

public virtual Empty SendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

SendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty SendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

SendNotificationChannelVerificationCodeAsync(SendNotificationChannelVerificationCodeRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> SendNotificationChannelVerificationCodeAsync(SendNotificationChannelVerificationCodeRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

SendNotificationChannelVerificationCodeAsync(SendNotificationChannelVerificationCodeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> SendNotificationChannelVerificationCodeAsync(SendNotificationChannelVerificationCodeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

UpdateNotificationChannel(UpdateNotificationChannelRequest, CallOptions)

public virtual NotificationChannel UpdateNotificationChannel(UpdateNotificationChannelRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
NotificationChannel	The response received from the server.

UpdateNotificationChannel(UpdateNotificationChannelRequest, Metadata, DateTime?, CancellationToken)

public virtual NotificationChannel UpdateNotificationChannel(UpdateNotificationChannelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
NotificationChannel	The response received from the server.

UpdateNotificationChannelAsync(UpdateNotificationChannelRequest, CallOptions)

public virtual AsyncUnaryCall<NotificationChannel> UpdateNotificationChannelAsync(UpdateNotificationChannelRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallNotificationChannel	The call object.

UpdateNotificationChannelAsync(UpdateNotificationChannelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NotificationChannel> UpdateNotificationChannelAsync(UpdateNotificationChannelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallNotificationChannel	The call object.

VerifyNotificationChannel(VerifyNotificationChannelRequest, CallOptions)

public virtual NotificationChannel VerifyNotificationChannel(VerifyNotificationChannelRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
NotificationChannel	The response received from the server.

VerifyNotificationChannel(VerifyNotificationChannelRequest, Metadata, DateTime?, CancellationToken)

public virtual NotificationChannel VerifyNotificationChannel(VerifyNotificationChannelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
NotificationChannel	The response received from the server.

VerifyNotificationChannelAsync(VerifyNotificationChannelRequest, CallOptions)

public virtual AsyncUnaryCall<NotificationChannel> VerifyNotificationChannelAsync(VerifyNotificationChannelRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallNotificationChannel	The call object.

VerifyNotificationChannelAsync(VerifyNotificationChannelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NotificationChannel> VerifyNotificationChannelAsync(VerifyNotificationChannelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallNotificationChannel	The call object.