NotificationChannelServiceClient

NotificationChannelServiceClient

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

Constructor

new NotificationChannelServiceClient(optionsopt)

Construct an instance of NotificationChannelServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint string <optional>

The domain name of the API remote host.

clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.

fallback boolean <optional>

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

createNotificationChannel(request, optionsopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

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.

notificationChannel google.monitoring.v3.NotificationChannel

Required. The definition of the NotificationChannel to create.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing NotificationChannel. Please see the documentation for more details and examples.
Example
const [response] = await client.createNotificationChannel(request);

deleteNotificationChannel(request, optionsopt) → {Promise}

Deletes a notification channel.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

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

  projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
force boolean

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.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deleteNotificationChannel(request);

folderAlertPolicyConditionPath(folder, alert_policy, condition) → {string}

Return a fully-qualified folderAlertPolicyCondition resource name string.

Parameters:
Name Type Description
folder string
alert_policy string
condition string
Returns:
Type Description
string

Resource name string.

folderAlertPolicyPath(folder, alert_policy) → {string}

Return a fully-qualified folderAlertPolicy resource name string.

Parameters:
Name Type Description
folder string
alert_policy string
Returns:
Type Description
string

Resource name string.

folderChannelDescriptorPath(folder, channel_descriptor) → {string}

Return a fully-qualified folderChannelDescriptor resource name string.

Parameters:
Name Type Description
folder string
channel_descriptor string
Returns:
Type Description
string

Resource name string.

folderGroupPath(folder, group) → {string}

Return a fully-qualified folderGroup resource name string.

Parameters:
Name Type Description
folder string
group string
Returns:
Type Description
string

Resource name string.

folderNotificationChannelPath(folder, notification_channel) → {string}

Return a fully-qualified folderNotificationChannel resource name string.

Parameters:
Name Type Description
folder string
notification_channel string
Returns:
Type Description
string

Resource name string.

folderServicePath(folder, service) → {string}

Return a fully-qualified folderService resource name string.

Parameters:
Name Type Description
folder string
service string
Returns:
Type Description
string

Resource name string.

folderServiceServiceLevelObjectivePath(folder, service, service_level_objective) → {string}

Return a fully-qualified folderServiceServiceLevelObjective resource name string.

Parameters:
Name Type Description
folder string
service string
service_level_objective string
Returns:
Type Description
string

Resource name string.

folderUptimeCheckConfigPath(folder, uptime_check_config) → {string}

Return a fully-qualified folderUptimeCheckConfig resource name string.

Parameters:
Name Type Description
folder string
uptime_check_config string
Returns:
Type Description
string

Resource name string.

getNotificationChannel(request, optionsopt) → {Promise}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

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

  projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing NotificationChannel. Please see the documentation for more details and examples.
Example
const [response] = await client.getNotificationChannel(request);

getNotificationChannelDescriptor(request, optionsopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

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

  projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE]
options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
Example
const [response] = await client.getNotificationChannelDescriptor(request);

getNotificationChannelVerificationCode(request, optionsopt) → {Promise}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail.

expireTime google.protobuf.Timestamp

The desired expiration time. If specified, the API will guarantee that the returned code will not be valid after the specified timestamp; however, the API cannot guarantee that the returned code will be valid for at least as long as the requested time (the API puts an upper bound on the amount of time for which a code may be valid). If omitted, a default expiration will be used, which may be less than the max permissible expiration (so specifying an expiration may extend the code's lifetime over omitting an expiration, even though the API does impose an upper limit on the maximum expiration that is permitted).

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
Example
const [response] = await client.getNotificationChannelVerificationCode(request);

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

listNotificationChannelDescriptors(request, optionsopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is:

  projects/[PROJECT_ID_OR_NUMBER]

Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead.

pageSize number

The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.

pageToken string

If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of NotificationChannelDescriptor. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listNotificationChannelDescriptorsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNotificationChannelDescriptorsAsync(request, optionsopt) → {Object}

Equivalent to listNotificationChannelDescriptors, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is:

  projects/[PROJECT_ID_OR_NUMBER]

Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead.

pageSize number

The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.

pageToken string

If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing NotificationChannelDescriptor. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example
const iterable = client.listNotificationChannelDescriptorsAsync(request);
for await (const response of iterable) {
  // process response
}

listNotificationChannelDescriptorsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is:

  projects/[PROJECT_ID_OR_NUMBER]

Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead.

pageSize number

The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.

pageToken string

If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

An object stream which emits an object representing NotificationChannelDescriptor on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listNotificationChannelDescriptorsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNotificationChannels(request, optionsopt) → {Promise}

Lists the notification channels that have been created for the project.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The project on which to execute the request. The format is:

  projects/[PROJECT_ID_OR_NUMBER]

This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation.

filter string

If provided, this field specifies the criteria that must be met by notification channels to be included in the response.

For more details, see sorting and filtering.

orderBy string

A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.

For more details, see sorting and filtering.

pageSize number

The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.

pageToken string

If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of NotificationChannel. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listNotificationChannelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNotificationChannelsAsync(request, optionsopt) → {Object}

Equivalent to listNotificationChannels, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The project on which to execute the request. The format is:

  projects/[PROJECT_ID_OR_NUMBER]

This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation.

filter string

If provided, this field specifies the criteria that must be met by notification channels to be included in the response.

For more details, see sorting and filtering.

orderBy string

A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.

For more details, see sorting and filtering.

pageSize number

The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.

pageToken string

If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing NotificationChannel. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example
const iterable = client.listNotificationChannelsAsync(request);
for await (const response of iterable) {
  // process response
}

listNotificationChannelsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The project on which to execute the request. The format is:

  projects/[PROJECT_ID_OR_NUMBER]

This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation.

filter string

If provided, this field specifies the criteria that must be met by notification channels to be included in the response.

For more details, see sorting and filtering.

orderBy string

A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.

For more details, see sorting and filtering.

pageSize number

The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.

pageToken string

If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

An object stream which emits an object representing NotificationChannel on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listNotificationChannelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchAlertPolicyFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName) → {string}

Parse the alert_policy from FolderAlertPolicyCondition resource.

Parameters:
Name Type Description
folderAlertPolicyConditionName string

A fully-qualified path representing folder_alert_policy_condition resource.

Returns:
Type Description
string

A string representing the alert_policy.

matchAlertPolicyFromFolderAlertPolicyName(folderAlertPolicyName) → {string}

Parse the alert_policy from FolderAlertPolicy resource.

Parameters:
Name Type Description
folderAlertPolicyName string

A fully-qualified path representing folder_alert_policy resource.

Returns:
Type Description
string

A string representing the alert_policy.

matchAlertPolicyFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName) → {string}

Parse the alert_policy from OrganizationAlertPolicyCondition resource.

Parameters:
Name Type Description
organizationAlertPolicyConditionName string

A fully-qualified path representing organization_alert_policy_condition resource.

Returns:
Type Description
string

A string representing the alert_policy.

matchAlertPolicyFromOrganizationAlertPolicyName(organizationAlertPolicyName) → {string}

Parse the alert_policy from OrganizationAlertPolicy resource.

Parameters:
Name Type Description
organizationAlertPolicyName string

A fully-qualified path representing organization_alert_policy resource.

Returns:
Type Description
string

A string representing the alert_policy.

matchAlertPolicyFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName) → {string}

Parse the alert_policy from ProjectAlertPolicyCondition resource.

Parameters:
Name Type Description
projectAlertPolicyConditionName string

A fully-qualified path representing project_alert_policy_condition resource.

Returns:
Type Description
string

A string representing the alert_policy.

matchAlertPolicyFromProjectAlertPolicyName(projectAlertPolicyName) → {string}

Parse the alert_policy from ProjectAlertPolicy resource.

Parameters:
Name Type Description
projectAlertPolicyName string

A fully-qualified path representing project_alert_policy resource.

Returns:
Type Description
string

A string representing the alert_policy.

matchChannelDescriptorFromFolderChannelDescriptorName(folderChannelDescriptorName) → {string}

Parse the channel_descriptor from FolderChannelDescriptor resource.

Parameters:
Name Type Description
folderChannelDescriptorName string

A fully-qualified path representing folder_channel_descriptor resource.

Returns:
Type Description
string

A string representing the channel_descriptor.

matchChannelDescriptorFromOrganizationChannelDescriptorName(organizationChannelDescriptorName) → {string}

Parse the channel_descriptor from OrganizationChannelDescriptor resource.

Parameters:
Name Type Description
organizationChannelDescriptorName string

A fully-qualified path representing organization_channel_descriptor resource.

Returns:
Type Description
string

A string representing the channel_descriptor.

matchChannelDescriptorFromProjectChannelDescriptorName(projectChannelDescriptorName) → {string}

Parse the channel_descriptor from ProjectChannelDescriptor resource.

Parameters:
Name Type Description
projectChannelDescriptorName string

A fully-qualified path representing project_channel_descriptor resource.

Returns:
Type Description
string

A string representing the channel_descriptor.

matchConditionFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName) → {string}

Parse the condition from FolderAlertPolicyCondition resource.

Parameters:
Name Type Description
folderAlertPolicyConditionName string

A fully-qualified path representing folder_alert_policy_condition resource.

Returns:
Type Description
string

A string representing the condition.

matchConditionFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName) → {string}

Parse the condition from OrganizationAlertPolicyCondition resource.

Parameters:
Name Type Description
organizationAlertPolicyConditionName string

A fully-qualified path representing organization_alert_policy_condition resource.

Returns:
Type Description
string

A string representing the condition.

matchConditionFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName) → {string}

Parse the condition from ProjectAlertPolicyCondition resource.

Parameters:
Name Type Description
projectAlertPolicyConditionName string

A fully-qualified path representing project_alert_policy_condition resource.

Returns:
Type Description
string

A string representing the condition.

matchFolderFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName) → {string}

Parse the folder from FolderAlertPolicyCondition resource.

Parameters:
Name Type Description
folderAlertPolicyConditionName string

A fully-qualified path representing folder_alert_policy_condition resource.

Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderAlertPolicyName(folderAlertPolicyName) → {string}

Parse the folder from FolderAlertPolicy resource.

Parameters:
Name Type Description
folderAlertPolicyName string

A fully-qualified path representing folder_alert_policy resource.

Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderChannelDescriptorName(folderChannelDescriptorName) → {string}

Parse the folder from FolderChannelDescriptor resource.

Parameters:
Name Type Description
folderChannelDescriptorName string

A fully-qualified path representing folder_channel_descriptor resource.

Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderGroupName(folderGroupName) → {string}

Parse the folder from FolderGroup resource.

Parameters:
Name Type Description
folderGroupName string

A fully-qualified path representing folder_group resource.

Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderNotificationChannelName(folderNotificationChannelName) → {string}

Parse the folder from FolderNotificationChannel resource.

Parameters:
Name Type Description
folderNotificationChannelName string

A fully-qualified path representing folder_notification_channel resource.

Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderServiceName(folderServiceName) → {string}

Parse the folder from FolderService resource.

Parameters:
Name Type Description
folderServiceName string

A fully-qualified path representing folder_service resource.

Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName) → {string}

Parse the folder from FolderServiceServiceLevelObjective resource.

Parameters:
Name Type Description
folderServiceServiceLevelObjectiveName string

A fully-qualified path representing folder_service_service_level_objective resource.

Returns:
Type Description
string

A string representing the folder.

matchFolderFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName) → {string}

Parse the folder from FolderUptimeCheckConfig resource.

Parameters:
Name Type Description
folderUptimeCheckConfigName string

A fully-qualified path representing folder_uptime_check_config resource.

Returns:
Type Description
string

A string representing the folder.

matchGroupFromFolderGroupName(folderGroupName) → {string}

Parse the group from FolderGroup resource.

Parameters:
Name Type Description
folderGroupName string

A fully-qualified path representing folder_group resource.

Returns:
Type Description
string

A string representing the group.

matchGroupFromOrganizationGroupName(organizationGroupName) → {string}

Parse the group from OrganizationGroup resource.

Parameters:
Name Type Description
organizationGroupName string

A fully-qualified path representing organization_group resource.

Returns:
Type Description
string

A string representing the group.

matchGroupFromProjectGroupName(projectGroupName) → {string}

Parse the group from ProjectGroup resource.

Parameters:
Name Type Description
projectGroupName string

A fully-qualified path representing project_group resource.

Returns:
Type Description
string

A string representing the group.

matchNotificationChannelFromFolderNotificationChannelName(folderNotificationChannelName) → {string}

Parse the notification_channel from FolderNotificationChannel resource.

Parameters:
Name Type Description
folderNotificationChannelName string

A fully-qualified path representing folder_notification_channel resource.

Returns:
Type Description
string

A string representing the notification_channel.

matchNotificationChannelFromOrganizationNotificationChannelName(organizationNotificationChannelName) → {string}

Parse the notification_channel from OrganizationNotificationChannel resource.

Parameters:
Name Type Description
organizationNotificationChannelName string

A fully-qualified path representing organization_notification_channel resource.

Returns:
Type Description
string

A string representing the notification_channel.

matchNotificationChannelFromProjectNotificationChannelName(projectNotificationChannelName) → {string}

Parse the notification_channel from ProjectNotificationChannel resource.

Parameters:
Name Type Description
projectNotificationChannelName string

A fully-qualified path representing project_notification_channel resource.

Returns:
Type Description
string

A string representing the notification_channel.

matchOrganizationFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName) → {string}

Parse the organization from OrganizationAlertPolicyCondition resource.

Parameters:
Name Type Description
organizationAlertPolicyConditionName string

A fully-qualified path representing organization_alert_policy_condition resource.

Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationAlertPolicyName(organizationAlertPolicyName) → {string}

Parse the organization from OrganizationAlertPolicy resource.

Parameters:
Name Type Description
organizationAlertPolicyName string

A fully-qualified path representing organization_alert_policy resource.

Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationChannelDescriptorName(organizationChannelDescriptorName) → {string}

Parse the organization from OrganizationChannelDescriptor resource.

Parameters:
Name Type Description
organizationChannelDescriptorName string

A fully-qualified path representing organization_channel_descriptor resource.

Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationGroupName(organizationGroupName) → {string}

Parse the organization from OrganizationGroup resource.

Parameters:
Name Type Description
organizationGroupName string

A fully-qualified path representing organization_group resource.

Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationNotificationChannelName(organizationNotificationChannelName) → {string}

Parse the organization from OrganizationNotificationChannel resource.

Parameters:
Name Type Description
organizationNotificationChannelName string

A fully-qualified path representing organization_notification_channel resource.

Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationServiceName(organizationServiceName) → {string}

Parse the organization from OrganizationService resource.

Parameters:
Name Type Description
organizationServiceName string

A fully-qualified path representing organization_service resource.

Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName) → {string}

Parse the organization from OrganizationServiceServiceLevelObjective resource.

Parameters:
Name Type Description
organizationServiceServiceLevelObjectiveName string

A fully-qualified path representing organization_service_service_level_objective resource.

Returns:
Type Description
string

A string representing the organization.

matchOrganizationFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName) → {string}

Parse the organization from OrganizationUptimeCheckConfig resource.

Parameters:
Name Type Description
organizationUptimeCheckConfigName string

A fully-qualified path representing organization_uptime_check_config resource.

Returns:
Type Description
string

A string representing the organization.

matchProjectFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName) → {string}

Parse the project from ProjectAlertPolicyCondition resource.

Parameters:
Name Type Description
projectAlertPolicyConditionName string

A fully-qualified path representing project_alert_policy_condition resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectAlertPolicyName(projectAlertPolicyName) → {string}

Parse the project from ProjectAlertPolicy resource.

Parameters:
Name Type Description
projectAlertPolicyName string

A fully-qualified path representing project_alert_policy resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectChannelDescriptorName(projectChannelDescriptorName) → {string}

Parse the project from ProjectChannelDescriptor resource.

Parameters:
Name Type Description
projectChannelDescriptorName string

A fully-qualified path representing project_channel_descriptor resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectGroupName(projectGroupName) → {string}

Parse the project from ProjectGroup resource.

Parameters:
Name Type Description
projectGroupName string

A fully-qualified path representing project_group resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:
Name Type Description
projectName string

A fully-qualified path representing Project resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectNotificationChannelName(projectNotificationChannelName) → {string}

Parse the project from ProjectNotificationChannel resource.

Parameters:
Name Type Description
projectNotificationChannelName string

A fully-qualified path representing project_notification_channel resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectServiceName(projectServiceName) → {string}

Parse the project from ProjectService resource.

Parameters:
Name Type Description
projectServiceName string

A fully-qualified path representing project_service resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName) → {string}

Parse the project from ProjectServiceServiceLevelObjective resource.

Parameters:
Name Type Description
projectServiceServiceLevelObjectiveName string

A fully-qualified path representing project_service_service_level_objective resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName) → {string}

Parse the project from ProjectUptimeCheckConfig resource.

Parameters:
Name Type Description
projectUptimeCheckConfigName string

A fully-qualified path representing project_uptime_check_config resource.

Returns:
Type Description
string

A string representing the project.

matchServiceFromFolderServiceName(folderServiceName) → {string}

Parse the service from FolderService resource.

Parameters:
Name Type Description
folderServiceName string

A fully-qualified path representing folder_service resource.

Returns:
Type Description
string

A string representing the service.

matchServiceFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName) → {string}

Parse the service from FolderServiceServiceLevelObjective resource.

Parameters:
Name Type Description
folderServiceServiceLevelObjectiveName string

A fully-qualified path representing folder_service_service_level_objective resource.

Returns:
Type Description
string

A string representing the service.

matchServiceFromOrganizationServiceName(organizationServiceName) → {string}

Parse the service from OrganizationService resource.

Parameters:
Name Type Description
organizationServiceName string

A fully-qualified path representing organization_service resource.

Returns:
Type Description
string

A string representing the service.

matchServiceFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName) → {string}

Parse the service from OrganizationServiceServiceLevelObjective resource.

Parameters:
Name Type Description
organizationServiceServiceLevelObjectiveName string

A fully-qualified path representing organization_service_service_level_objective resource.

Returns:
Type Description
string

A string representing the service.

matchServiceFromProjectServiceName(projectServiceName) → {string}

Parse the service from ProjectService resource.

Parameters:
Name Type Description
projectServiceName string

A fully-qualified path representing project_service resource.

Returns:
Type Description
string

A string representing the service.

matchServiceFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName) → {string}

Parse the service from ProjectServiceServiceLevelObjective resource.

Parameters:
Name Type Description
projectServiceServiceLevelObjectiveName string

A fully-qualified path representing project_service_service_level_objective resource.

Returns:
Type Description
string

A string representing the service.

matchServiceLevelObjectiveFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName) → {string}

Parse the service_level_objective from FolderServiceServiceLevelObjective resource.

Parameters:
Name Type Description
folderServiceServiceLevelObjectiveName string

A fully-qualified path representing folder_service_service_level_objective resource.

Returns:
Type Description
string

A string representing the service_level_objective.

matchServiceLevelObjectiveFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName) → {string}

Parse the service_level_objective from OrganizationServiceServiceLevelObjective resource.

Parameters:
Name Type Description
organizationServiceServiceLevelObjectiveName string

A fully-qualified path representing organization_service_service_level_objective resource.

Returns:
Type Description
string

A string representing the service_level_objective.

matchServiceLevelObjectiveFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName) → {string}

Parse the service_level_objective from ProjectServiceServiceLevelObjective resource.

Parameters:
Name Type Description
projectServiceServiceLevelObjectiveName string

A fully-qualified path representing project_service_service_level_objective resource.

Returns:
Type Description
string

A string representing the service_level_objective.

matchUptimeCheckConfigFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName) → {string}

Parse the uptime_check_config from FolderUptimeCheckConfig resource.

Parameters:
Name Type Description
folderUptimeCheckConfigName string

A fully-qualified path representing folder_uptime_check_config resource.

Returns:
Type Description
string

A string representing the uptime_check_config.

matchUptimeCheckConfigFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName) → {string}

Parse the uptime_check_config from OrganizationUptimeCheckConfig resource.

Parameters:
Name Type Description
organizationUptimeCheckConfigName string

A fully-qualified path representing organization_uptime_check_config resource.

Returns:
Type Description
string

A string representing the uptime_check_config.

matchUptimeCheckConfigFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName) → {string}

Parse the uptime_check_config from ProjectUptimeCheckConfig resource.

Parameters:
Name Type Description
projectUptimeCheckConfigName string

A fully-qualified path representing project_uptime_check_config resource.

Returns:
Type Description
string

A string representing the uptime_check_config.

organizationAlertPolicyConditionPath(organization, alert_policy, condition) → {string}

Return a fully-qualified organizationAlertPolicyCondition resource name string.

Parameters:
Name Type Description
organization string
alert_policy string
condition string
Returns:
Type Description
string

Resource name string.

organizationAlertPolicyPath(organization, alert_policy) → {string}

Return a fully-qualified organizationAlertPolicy resource name string.

Parameters:
Name Type Description
organization string
alert_policy string
Returns:
Type Description
string

Resource name string.

organizationChannelDescriptorPath(organization, channel_descriptor) → {string}

Return a fully-qualified organizationChannelDescriptor resource name string.

Parameters:
Name Type Description
organization string
channel_descriptor string
Returns:
Type Description
string

Resource name string.

organizationGroupPath(organization, group) → {string}

Return a fully-qualified organizationGroup resource name string.

Parameters:
Name Type Description
organization string
group string
Returns:
Type Description
string

Resource name string.

organizationNotificationChannelPath(organization, notification_channel) → {string}

Return a fully-qualified organizationNotificationChannel resource name string.

Parameters:
Name Type Description
organization string
notification_channel string
Returns:
Type Description
string

Resource name string.

organizationServicePath(organization, service) → {string}

Return a fully-qualified organizationService resource name string.

Parameters:
Name Type Description
organization string
service string
Returns:
Type Description
string

Resource name string.

organizationServiceServiceLevelObjectivePath(organization, service, service_level_objective) → {string}

Return a fully-qualified organizationServiceServiceLevelObjective resource name string.

Parameters:
Name Type Description
organization string
service string
service_level_objective string
Returns:
Type Description
string

Resource name string.

organizationUptimeCheckConfigPath(organization, uptime_check_config) → {string}

Return a fully-qualified organizationUptimeCheckConfig resource name string.

Parameters:
Name Type Description
organization string
uptime_check_config string
Returns:
Type Description
string

Resource name string.

projectAlertPolicyConditionPath(project, alert_policy, condition) → {string}

Return a fully-qualified projectAlertPolicyCondition resource name string.

Parameters:
Name Type Description
project string
alert_policy string
condition string
Returns:
Type Description
string

Resource name string.

projectAlertPolicyPath(project, alert_policy) → {string}

Return a fully-qualified projectAlertPolicy resource name string.

Parameters:
Name Type Description
project string
alert_policy string
Returns:
Type Description
string

Resource name string.

projectChannelDescriptorPath(project, channel_descriptor) → {string}

Return a fully-qualified projectChannelDescriptor resource name string.

Parameters:
Name Type Description
project string
channel_descriptor string
Returns:
Type Description
string

Resource name string.

projectGroupPath(project, group) → {string}

Return a fully-qualified projectGroup resource name string.

Parameters:
Name Type Description
project string
group string
Returns:
Type Description
string

Resource name string.

projectNotificationChannelPath(project, notification_channel) → {string}

Return a fully-qualified projectNotificationChannel resource name string.

Parameters:
Name Type Description
project string
notification_channel string
Returns:
Type Description
string

Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

projectServicePath(project, service) → {string}

Return a fully-qualified projectService resource name string.

Parameters:
Name Type Description
project string
service string
Returns:
Type Description
string

Resource name string.

projectServiceServiceLevelObjectivePath(project, service, service_level_objective) → {string}

Return a fully-qualified projectServiceServiceLevelObjective resource name string.

Parameters:
Name Type Description
project string
service string
service_level_objective string
Returns:
Type Description
string

Resource name string.

projectUptimeCheckConfigPath(project, uptime_check_config) → {string}

Return a fully-qualified projectUptimeCheckConfig resource name string.

Parameters:
Name Type Description
project string
uptime_check_config string
Returns:
Type Description
string

Resource name string.

sendNotificationChannelVerificationCode(request, optionsopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The notification channel to which to send a verification code.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.sendNotificationChannelVerificationCode(request);

updateNotificationChannel(request, optionsopt) → {Promise}

Updates a notification channel. Fields not specified in the field mask remain unchanged.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
updateMask google.protobuf.FieldMask

The fields to update.

notificationChannel google.monitoring.v3.NotificationChannel

Required. A description of the changes to be applied to the specified notification channel. The description must provide a definition for fields to be updated; the names of these fields should also be included in the update_mask.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing NotificationChannel. Please see the documentation for more details and examples.
Example
const [response] = await client.updateNotificationChannel(request);

verifyNotificationChannel(request, optionsopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The notification channel to verify.

code string

Required. The verification code that was delivered to the channel as a result of invoking the SendNotificationChannelVerificationCode API method or that was retrieved from a verified channel via GetNotificationChannelVerificationCode. For example, one might have "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code).

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing NotificationChannel. Please see the documentation for more details and examples.
Example
const [response] = await client.verifyNotificationChannel(request);