public sealed class NotificationChannelServiceClientImpl : NotificationChannelServiceClientReference documentation and code samples for the Google Cloud Monitoring v3 API class NotificationChannelServiceClientImpl.
NotificationChannelService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Monitoring.V3Assembly
Google.Cloud.Monitoring.V3.dll
Remarks
The Notification Channel API provides access to configuration that controls how messages related to incidents are sent.
Constructors
NotificationChannelServiceClientImpl(NotificationChannelServiceClient, NotificationChannelServiceSettings, ILogger)
public NotificationChannelServiceClientImpl(NotificationChannelService.NotificationChannelServiceClient grpcClient, NotificationChannelServiceSettings settings, ILogger logger)Constructs a client wrapper for the NotificationChannelService service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | NotificationChannelServiceNotificationChannelServiceClientThe underlying gRPC client. |
settings | NotificationChannelServiceSettingsThe base NotificationChannelServiceSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override NotificationChannelService.NotificationChannelServiceClient GrpcClient { get; }The underlying gRPC NotificationChannelService client
| Property Value | |
|---|---|
| Type | Description |
NotificationChannelServiceNotificationChannelServiceClient | |
Methods
CreateNotificationChannel(CreateNotificationChannelRequest, CallSettings)
public override NotificationChannel CreateNotificationChannel(CreateNotificationChannelRequest request, CallSettings callSettings = null)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 | CreateNotificationChannelRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel | The RPC response. |
CreateNotificationChannelAsync(CreateNotificationChannelRequest, CallSettings)
public override Task<NotificationChannel> CreateNotificationChannelAsync(CreateNotificationChannelRequest request, CallSettings callSettings = null)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 | CreateNotificationChannelRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskNotificationChannel | A Task containing the RPC response. |
DeleteNotificationChannel(DeleteNotificationChannelRequest, CallSettings)
public override void DeleteNotificationChannel(DeleteNotificationChannelRequest request, CallSettings callSettings = null)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 | DeleteNotificationChannelRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteNotificationChannelAsync(DeleteNotificationChannelRequest, CallSettings)
public override Task DeleteNotificationChannelAsync(DeleteNotificationChannelRequest request, CallSettings callSettings = null)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 | DeleteNotificationChannelRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
GetNotificationChannel(GetNotificationChannelRequest, CallSettings)
public override NotificationChannel GetNotificationChannel(GetNotificationChannelRequest request, CallSettings callSettings = null)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 | GetNotificationChannelRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel | The RPC response. |
GetNotificationChannelAsync(GetNotificationChannelRequest, CallSettings)
public override Task<NotificationChannel> GetNotificationChannelAsync(GetNotificationChannelRequest request, CallSettings callSettings = null)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 | GetNotificationChannelRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskNotificationChannel | A Task containing the RPC response. |
GetNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest, CallSettings)
public override NotificationChannelDescriptor GetNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest request, CallSettings callSettings = null)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 | GetNotificationChannelDescriptorRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannelDescriptor | The RPC response. |
GetNotificationChannelDescriptorAsync(GetNotificationChannelDescriptorRequest, CallSettings)
public override Task<NotificationChannelDescriptor> GetNotificationChannelDescriptorAsync(GetNotificationChannelDescriptorRequest request, CallSettings callSettings = null)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 | GetNotificationChannelDescriptorRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskNotificationChannelDescriptor | A Task containing the RPC response. |
GetNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest, CallSettings)
public override GetNotificationChannelVerificationCodeResponse GetNotificationChannelVerificationCode(GetNotificationChannelVerificationCodeRequest request, CallSettings callSettings = null)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 | GetNotificationChannelVerificationCodeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
GetNotificationChannelVerificationCodeResponse | The RPC response. |
GetNotificationChannelVerificationCodeAsync(GetNotificationChannelVerificationCodeRequest, CallSettings)
public override Task<GetNotificationChannelVerificationCodeResponse> GetNotificationChannelVerificationCodeAsync(GetNotificationChannelVerificationCodeRequest request, CallSettings callSettings = null)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 | GetNotificationChannelVerificationCodeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskGetNotificationChannelVerificationCodeResponse | A Task containing the RPC response. |
ListNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest, CallSettings)
public override PagedEnumerable<ListNotificationChannelDescriptorsResponse, NotificationChannelDescriptor> ListNotificationChannelDescriptors(ListNotificationChannelDescriptorsRequest request, CallSettings callSettings = null)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 | ListNotificationChannelDescriptorsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListNotificationChannelDescriptorsResponseNotificationChannelDescriptor | A pageable sequence of NotificationChannelDescriptor resources. |
ListNotificationChannelDescriptorsAsync(ListNotificationChannelDescriptorsRequest, CallSettings)
public override PagedAsyncEnumerable<ListNotificationChannelDescriptorsResponse, NotificationChannelDescriptor> ListNotificationChannelDescriptorsAsync(ListNotificationChannelDescriptorsRequest request, CallSettings callSettings = null)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 | ListNotificationChannelDescriptorsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListNotificationChannelDescriptorsResponseNotificationChannelDescriptor | A pageable asynchronous sequence of NotificationChannelDescriptor resources. |
ListNotificationChannels(ListNotificationChannelsRequest, CallSettings)
public override PagedEnumerable<ListNotificationChannelsResponse, NotificationChannel> ListNotificationChannels(ListNotificationChannelsRequest request, CallSettings callSettings = null)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 | ListNotificationChannelsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListNotificationChannelsResponseNotificationChannel | A pageable sequence of NotificationChannel resources. |
ListNotificationChannelsAsync(ListNotificationChannelsRequest, CallSettings)
public override PagedAsyncEnumerable<ListNotificationChannelsResponse, NotificationChannel> ListNotificationChannelsAsync(ListNotificationChannelsRequest request, CallSettings callSettings = null)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 | ListNotificationChannelsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListNotificationChannelsResponseNotificationChannel | A pageable asynchronous sequence of NotificationChannel resources. |
SendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest, CallSettings)
public override void SendNotificationChannelVerificationCode(SendNotificationChannelVerificationCodeRequest request, CallSettings callSettings = null)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 | SendNotificationChannelVerificationCodeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
SendNotificationChannelVerificationCodeAsync(SendNotificationChannelVerificationCodeRequest, CallSettings)
public override Task SendNotificationChannelVerificationCodeAsync(SendNotificationChannelVerificationCodeRequest request, CallSettings callSettings = null)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 | SendNotificationChannelVerificationCodeRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
UpdateNotificationChannel(UpdateNotificationChannelRequest, CallSettings)
public override NotificationChannel UpdateNotificationChannel(UpdateNotificationChannelRequest request, CallSettings callSettings = null)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 | UpdateNotificationChannelRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel | The RPC response. |
UpdateNotificationChannelAsync(UpdateNotificationChannelRequest, CallSettings)
public override Task<NotificationChannel> UpdateNotificationChannelAsync(UpdateNotificationChannelRequest request, CallSettings callSettings = null)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 | UpdateNotificationChannelRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskNotificationChannel | A Task containing the RPC response. |
VerifyNotificationChannel(VerifyNotificationChannelRequest, CallSettings)
public override NotificationChannel VerifyNotificationChannel(VerifyNotificationChannelRequest request, CallSettings callSettings = null)Verifies a NotificationChannel by proving receipt of the code
delivered to the channel as a result of calling
SendNotificationChannelVerificationCode.
| Parameters | |
|---|---|
| Name | Description |
request | VerifyNotificationChannelRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
NotificationChannel | The RPC response. |
VerifyNotificationChannelAsync(VerifyNotificationChannelRequest, CallSettings)
public override Task<NotificationChannel> VerifyNotificationChannelAsync(VerifyNotificationChannelRequest request, CallSettings callSettings = null)Verifies a NotificationChannel by proving receipt of the code
delivered to the channel as a result of calling
SendNotificationChannelVerificationCode.
| Parameters | |
|---|---|
| Name | Description |
request | VerifyNotificationChannelRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskNotificationChannel | A Task containing the RPC response. |