Class NotificationChannelServiceClient (3.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public abstract class NotificationChannelServiceClient

NotificationChannelService client wrapper, for convenient use.

Inheritance

Object > NotificationChannelServiceClient

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Remarks

The Notification Channel API provides access to configuration that controls how messages related to incidents are sent.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the NotificationChannelService service, which is a host of "monitoring.googleapis.com" and a port of 443.

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default NotificationChannelService scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

GrpcClient

public virtual NotificationChannelService.NotificationChannelServiceClient GrpcClient { get; }

The underlying gRPC NotificationChannelService client

Property Value
TypeDescription
NotificationChannelService.NotificationChannelServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

Methods

Create()

public static NotificationChannelServiceClient Create()

Synchronously creates a NotificationChannelServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use NotificationChannelServiceClientBuilder.

Returns
TypeDescription
NotificationChannelServiceClient

The created NotificationChannelServiceClient.

CreateAsync(CancellationToken)

public static Task<NotificationChannelServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a NotificationChannelServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use NotificationChannelServiceClientBuilder.

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<NotificationChannelServiceClient>

The task representing the created NotificationChannelServiceClient.

CreateNotificationChannel(IResourceName, NotificationChannel, CallSettings)

public virtual NotificationChannel CreateNotificationChannel(IResourceName name, NotificationChannel notificationChannel, CallSettings callSettings = null)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameIResourceName

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NotificationChannel

The RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = notificationChannelServiceClient.CreateNotificationChannel(name, notificationChannel);

CreateNotificationChannel(FolderName, NotificationChannel, CallSettings)

public virtual NotificationChannel CreateNotificationChannel(FolderName name, NotificationChannel notificationChannel, CallSettings callSettings = null)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameFolderName

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NotificationChannel

The RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
FolderName name = FolderName.FromFolder("[FOLDER]");
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = notificationChannelServiceClient.CreateNotificationChannel(name, notificationChannel);

CreateNotificationChannel(OrganizationName, NotificationChannel, CallSettings)

public virtual NotificationChannel CreateNotificationChannel(OrganizationName name, NotificationChannel notificationChannel, CallSettings callSettings = null)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameOrganizationName

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NotificationChannel

The RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
OrganizationName name = OrganizationName.FromOrganization("[ORGANIZATION]");
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = notificationChannelServiceClient.CreateNotificationChannel(name, notificationChannel);

CreateNotificationChannel(ProjectName, NotificationChannel, CallSettings)

public virtual NotificationChannel CreateNotificationChannel(ProjectName name, NotificationChannel notificationChannel, CallSettings callSettings = null)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameProjectName

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NotificationChannel

The RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
ProjectName name = ProjectName.FromProject("[PROJECT]");
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = notificationChannelServiceClient.CreateNotificationChannel(name, notificationChannel);

CreateNotificationChannel(CreateNotificationChannelRequest, CallSettings)

public virtual 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.

Parameters
NameDescription
requestCreateNotificationChannelRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NotificationChannel

The RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
CreateNotificationChannelRequest request = new CreateNotificationChannelRequest
{
    NotificationChannel = new NotificationChannel(),
    ProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
NotificationChannel response = notificationChannelServiceClient.CreateNotificationChannel(request);

CreateNotificationChannel(String, NotificationChannel, CallSettings)

public virtual NotificationChannel CreateNotificationChannel(string name, NotificationChannel notificationChannel, CallSettings callSettings = null)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameString

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NotificationChannel

The RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]";
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = notificationChannelServiceClient.CreateNotificationChannel(name, notificationChannel);

CreateNotificationChannelAsync(IResourceName, NotificationChannel, CallSettings)

public virtual Task<NotificationChannel> CreateNotificationChannelAsync(IResourceName name, NotificationChannel notificationChannel, CallSettings callSettings = null)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameIResourceName

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = await notificationChannelServiceClient.CreateNotificationChannelAsync(name, notificationChannel);

CreateNotificationChannelAsync(IResourceName, NotificationChannel, CancellationToken)

public virtual Task<NotificationChannel> CreateNotificationChannelAsync(IResourceName name, NotificationChannel notificationChannel, CancellationToken cancellationToken)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameIResourceName

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = await notificationChannelServiceClient.CreateNotificationChannelAsync(name, notificationChannel);

CreateNotificationChannelAsync(FolderName, NotificationChannel, CallSettings)

public virtual Task<NotificationChannel> CreateNotificationChannelAsync(FolderName name, NotificationChannel notificationChannel, CallSettings callSettings = null)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameFolderName

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
FolderName name = FolderName.FromFolder("[FOLDER]");
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = await notificationChannelServiceClient.CreateNotificationChannelAsync(name, notificationChannel);

CreateNotificationChannelAsync(FolderName, NotificationChannel, CancellationToken)

public virtual Task<NotificationChannel> CreateNotificationChannelAsync(FolderName name, NotificationChannel notificationChannel, CancellationToken cancellationToken)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameFolderName

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
FolderName name = FolderName.FromFolder("[FOLDER]");
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = await notificationChannelServiceClient.CreateNotificationChannelAsync(name, notificationChannel);

CreateNotificationChannelAsync(OrganizationName, NotificationChannel, CallSettings)

public virtual Task<NotificationChannel> CreateNotificationChannelAsync(OrganizationName name, NotificationChannel notificationChannel, CallSettings callSettings = null)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameOrganizationName

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName name = OrganizationName.FromOrganization("[ORGANIZATION]");
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = await notificationChannelServiceClient.CreateNotificationChannelAsync(name, notificationChannel);

CreateNotificationChannelAsync(OrganizationName, NotificationChannel, CancellationToken)

public virtual Task<NotificationChannel> CreateNotificationChannelAsync(OrganizationName name, NotificationChannel notificationChannel, CancellationToken cancellationToken)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameOrganizationName

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
OrganizationName name = OrganizationName.FromOrganization("[ORGANIZATION]");
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = await notificationChannelServiceClient.CreateNotificationChannelAsync(name, notificationChannel);

CreateNotificationChannelAsync(ProjectName, NotificationChannel, CallSettings)

public virtual Task<NotificationChannel> CreateNotificationChannelAsync(ProjectName name, NotificationChannel notificationChannel, CallSettings callSettings = null)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameProjectName

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName name = ProjectName.FromProject("[PROJECT]");
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = await notificationChannelServiceClient.CreateNotificationChannelAsync(name, notificationChannel);

CreateNotificationChannelAsync(ProjectName, NotificationChannel, CancellationToken)

public virtual Task<NotificationChannel> CreateNotificationChannelAsync(ProjectName name, NotificationChannel notificationChannel, CancellationToken cancellationToken)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameProjectName

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName name = ProjectName.FromProject("[PROJECT]");
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = await notificationChannelServiceClient.CreateNotificationChannelAsync(name, notificationChannel);

CreateNotificationChannelAsync(CreateNotificationChannelRequest, CallSettings)

public virtual 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.

Parameters
NameDescription
requestCreateNotificationChannelRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CreateNotificationChannelRequest request = new CreateNotificationChannelRequest
{
    NotificationChannel = new NotificationChannel(),
    ProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
NotificationChannel response = await notificationChannelServiceClient.CreateNotificationChannelAsync(request);

CreateNotificationChannelAsync(CreateNotificationChannelRequest, CancellationToken)

public virtual Task<NotificationChannel> CreateNotificationChannelAsync(CreateNotificationChannelRequest request, CancellationToken cancellationToken)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
requestCreateNotificationChannelRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
CreateNotificationChannelRequest request = new CreateNotificationChannelRequest
{
    NotificationChannel = new NotificationChannel(),
    ProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
NotificationChannel response = await notificationChannelServiceClient.CreateNotificationChannelAsync(request);

CreateNotificationChannelAsync(String, NotificationChannel, CallSettings)

public virtual Task<NotificationChannel> CreateNotificationChannelAsync(string name, NotificationChannel notificationChannel, CallSettings callSettings = null)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameString

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]";
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = await notificationChannelServiceClient.CreateNotificationChannelAsync(name, notificationChannel);

CreateNotificationChannelAsync(String, NotificationChannel, CancellationToken)

public virtual Task<NotificationChannel> CreateNotificationChannelAsync(string name, NotificationChannel notificationChannel, CancellationToken cancellationToken)

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

Parameters
NameDescription
nameString

Required. The project 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.

notificationChannelNotificationChannel

Required. The definition of the NotificationChannel to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]";
NotificationChannel notificationChannel = new NotificationChannel();
// Make the request
NotificationChannel response = await notificationChannelServiceClient.CreateNotificationChannelAsync(name, notificationChannel);

DeleteNotificationChannel(IResourceName, Boolean, CallSettings)

public virtual void DeleteNotificationChannel(IResourceName name, bool force, CallSettings callSettings = null)

Deletes a notification channel.

Parameters
NameDescription
nameIResourceName

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

forceBoolean

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
bool force = false;
// Make the request
notificationChannelServiceClient.DeleteNotificationChannel(name, force);

DeleteNotificationChannel(DeleteNotificationChannelRequest, CallSettings)

public virtual void DeleteNotificationChannel(DeleteNotificationChannelRequest request, CallSettings callSettings = null)

Deletes a notification channel.

Parameters
NameDescription
requestDeleteNotificationChannelRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
DeleteNotificationChannelRequest request = new DeleteNotificationChannelRequest
{
    NotificationChannelName = NotificationChannelName.FromProjectNotificationChannel("[PROJECT]", "[NOTIFICATION_CHANNEL]"),
    Force = false,
};
// Make the request
notificationChannelServiceClient.DeleteNotificationChannel(request);

DeleteNotificationChannel(NotificationChannelName, Boolean, CallSettings)

public virtual void DeleteNotificationChannel(NotificationChannelName name, bool force, CallSettings callSettings = null)

Deletes a notification channel.

Parameters
NameDescription
nameNotificationChannelName

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

forceBoolean

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
NotificationChannelName name = NotificationChannelName.FromProjectNotificationChannel("[PROJECT]", "[NOTIFICATION_CHANNEL]");
bool force = false;
// Make the request
notificationChannelServiceClient.DeleteNotificationChannel(name, force);

DeleteNotificationChannel(String, Boolean, CallSettings)

public virtual void DeleteNotificationChannel(string name, bool force, CallSettings callSettings = null)

Deletes a notification channel.

Parameters
NameDescription
nameString

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

forceBoolean

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/notificationChannels/[NOTIFICATION_CHANNEL]";
bool force = false;
// Make the request
notificationChannelServiceClient.DeleteNotificationChannel(name, force);

DeleteNotificationChannelAsync(IResourceName, Boolean, CallSettings)

public virtual Task DeleteNotificationChannelAsync(IResourceName name, bool force, CallSettings callSettings = null)

Deletes a notification channel.

Parameters
NameDescription
nameIResourceName

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

forceBoolean

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
bool force = false;
// Make the request
await notificationChannelServiceClient.DeleteNotificationChannelAsync(name, force);

DeleteNotificationChannelAsync(IResourceName, Boolean, CancellationToken)

public virtual Task DeleteNotificationChannelAsync(IResourceName name, bool force, CancellationToken cancellationToken)

Deletes a notification channel.

Parameters
NameDescription
nameIResourceName

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

forceBoolean

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
bool force = false;
// Make the request
await notificationChannelServiceClient.DeleteNotificationChannelAsync(name, force);

DeleteNotificationChannelAsync(DeleteNotificationChannelRequest, CallSettings)

public virtual Task DeleteNotificationChannelAsync(DeleteNotificationChannelRequest request, CallSettings callSettings = null)

Deletes a notification channel.

Parameters
NameDescription
requestDeleteNotificationChannelRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteNotificationChannelRequest request = new DeleteNotificationChannelRequest
{
    NotificationChannelName = NotificationChannelName.FromProjectNotificationChannel("[PROJECT]", "[NOTIFICATION_CHANNEL]"),
    Force = false,
};
// Make the request
await notificationChannelServiceClient.DeleteNotificationChannelAsync(request);

DeleteNotificationChannelAsync(DeleteNotificationChannelRequest, CancellationToken)

public virtual Task DeleteNotificationChannelAsync(DeleteNotificationChannelRequest request, CancellationToken cancellationToken)

Deletes a notification channel.

Parameters
NameDescription
requestDeleteNotificationChannelRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteNotificationChannelRequest request = new DeleteNotificationChannelRequest
{
    NotificationChannelName = NotificationChannelName.FromProjectNotificationChannel("[PROJECT]", "[NOTIFICATION_CHANNEL]"),
    Force = false,
};
// Make the request
await notificationChannelServiceClient.DeleteNotificationChannelAsync(request);

DeleteNotificationChannelAsync(NotificationChannelName, Boolean, CallSettings)

public virtual Task DeleteNotificationChannelAsync(NotificationChannelName name, bool force, CallSettings callSettings = null)

Deletes a notification channel.

Parameters
NameDescription
nameNotificationChannelName

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

forceBoolean

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
NotificationChannelName name = NotificationChannelName.FromProjectNotificationChannel("[PROJECT]", "[NOTIFICATION_CHANNEL]");
bool force = false;
// Make the request
await notificationChannelServiceClient.DeleteNotificationChannelAsync(name, force);

DeleteNotificationChannelAsync(NotificationChannelName, Boolean, CancellationToken)

public virtual Task DeleteNotificationChannelAsync(NotificationChannelName name, bool force, CancellationToken cancellationToken)

Deletes a notification channel.

Parameters
NameDescription
nameNotificationChannelName

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

forceBoolean

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
NotificationChannelName name = NotificationChannelName.FromProjectNotificationChannel("[PROJECT]", "[NOTIFICATION_CHANNEL]");
bool force = false;
// Make the request
await notificationChannelServiceClient.DeleteNotificationChannelAsync(name, force);

DeleteNotificationChannelAsync(String, Boolean, CallSettings)

public virtual Task DeleteNotificationChannelAsync(string name, bool force, CallSettings callSettings = null)

Deletes a notification channel.

Parameters
NameDescription
nameString

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

forceBoolean

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/notificationChannels/[NOTIFICATION_CHANNEL]";
bool force = false;
// Make the request
await notificationChannelServiceClient.DeleteNotificationChannelAsync(name, force);

DeleteNotificationChannelAsync(String, Boolean, CancellationToken)

public virtual Task DeleteNotificationChannelAsync(string name, bool force, CancellationToken cancellationToken)

Deletes a notification channel.

Parameters
NameDescription
nameString

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

forceBoolean

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/notificationChannels/[NOTIFICATION_CHANNEL]";
bool force = false;
// Make the request
await notificationChannelServiceClient.DeleteNotificationChannelAsync(name, force);

GetNotificationChannel(IResourceName, CallSettings)

public virtual NotificationChannel GetNotificationChannel(IResourceName name, 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
NameDescription
nameIResourceName

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NotificationChannel

The RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
NotificationChannel response = notificationChannelServiceClient.GetNotificationChannel(name);

GetNotificationChannel(GetNotificationChannelRequest, CallSettings)

public virtual 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
NameDescription
requestGetNotificationChannelRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NotificationChannel

The RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
GetNotificationChannelRequest request = new GetNotificationChannelRequest
{
    NotificationChannelName = NotificationChannelName.FromProjectNotificationChannel("[PROJECT]", "[NOTIFICATION_CHANNEL]"),
};
// Make the request
NotificationChannel response = notificationChannelServiceClient.GetNotificationChannel(request);

GetNotificationChannel(NotificationChannelName, CallSettings)

public virtual NotificationChannel GetNotificationChannel(NotificationChannelName name, 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
NameDescription
nameNotificationChannelName

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NotificationChannel

The RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
NotificationChannelName name = NotificationChannelName.FromProjectNotificationChannel("[PROJECT]", "[NOTIFICATION_CHANNEL]");
// Make the request
NotificationChannel response = notificationChannelServiceClient.GetNotificationChannel(name);

GetNotificationChannel(String, CallSettings)

public virtual NotificationChannel GetNotificationChannel(string name, 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
NameDescription
nameString

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
NotificationChannel

The RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = NotificationChannelServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/notificationChannels/[NOTIFICATION_CHANNEL]";
// Make the request
NotificationChannel response = notificationChannelServiceClient.GetNotificationChannel(name);

GetNotificationChannelAsync(IResourceName, CallSettings)

public virtual Task<NotificationChannel> GetNotificationChannelAsync(IResourceName name, 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
NameDescription
nameIResourceName

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
NotificationChannel response = await notificationChannelServiceClient.GetNotificationChannelAsync(name);

GetNotificationChannelAsync(IResourceName, CancellationToken)

public virtual Task<NotificationChannel> GetNotificationChannelAsync(IResourceName name, CancellationToken cancellationToken)

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
NameDescription
nameIResourceName

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
NotificationChannel response = await notificationChannelServiceClient.GetNotificationChannelAsync(name);

GetNotificationChannelAsync(GetNotificationChannelRequest, CallSettings)

public virtual 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
NameDescription
requestGetNotificationChannelRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
GetNotificationChannelRequest request = new GetNotificationChannelRequest
{
    NotificationChannelName = NotificationChannelName.FromProjectNotificationChannel("[PROJECT]", "[NOTIFICATION_CHANNEL]"),
};
// Make the request
NotificationChannel response = await notificationChannelServiceClient.GetNotificationChannelAsync(request);

GetNotificationChannelAsync(GetNotificationChannelRequest, CancellationToken)

public virtual Task<NotificationChannel> GetNotificationChannelAsync(GetNotificationChannelRequest request, CancellationToken cancellationToken)

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
NameDescription
requestGetNotificationChannelRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
GetNotificationChannelRequest request = new GetNotificationChannelRequest
{
    NotificationChannelName = NotificationChannelName.FromProjectNotificationChannel("[PROJECT]", "[NOTIFICATION_CHANNEL]"),
};
// Make the request
NotificationChannel response = await notificationChannelServiceClient.GetNotificationChannelAsync(request);

GetNotificationChannelAsync(NotificationChannelName, CallSettings)

public virtual Task<NotificationChannel> GetNotificationChannelAsync(NotificationChannelName name, 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
NameDescription
nameNotificationChannelName

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
NotificationChannelName name = NotificationChannelName.FromProjectNotificationChannel("[PROJECT]", "[NOTIFICATION_CHANNEL]");
// Make the request
NotificationChannel response = await notificationChannelServiceClient.GetNotificationChannelAsync(name);

GetNotificationChannelAsync(NotificationChannelName, CancellationToken)

public virtual Task<NotificationChannel> GetNotificationChannelAsync(NotificationChannelName name, CancellationToken cancellationToken)

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
NameDescription
nameNotificationChannelName

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
NotificationChannelName name = NotificationChannelName.FromProjectNotificationChannel("[PROJECT]", "[NOTIFICATION_CHANNEL]");
// Make the request
NotificationChannel response = await notificationChannelServiceClient.GetNotificationChannelAsync(name);

GetNotificationChannelAsync(String, CallSettings)

public virtual Task<NotificationChannel> GetNotificationChannelAsync(string name, 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
NameDescription
nameString

Required. The channel for which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<NotificationChannel>

A Task containing the RPC response.

Example
// Create client
NotificationChannelServiceClient notificationChannelServiceClient = await NotificationChannelServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/notificationChannels/[NOTIFICATION_CHANNEL]";
// Make the request
NotificationChannel response = await notificationChannelServiceClient.GetNotificationChannelAsync(name);

GetNotificationChannelAsync(String, CancellationToken)

public virtual Task<NotificationChannel> GetNotificationChannelAsync(string name, CancellationToken cancellationToken)

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 th