v3.NotificationChannelServiceClient

Parameters

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.

createNotificationChannel(request[, options][, callback]) → Promise

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

const monitoring = require('@google-cloud/monitoring');

const client = new monitoring.v3.NotificationChannelServiceClient({
  // optional auth parameters.
});

const formattedName = client.projectPath('[PROJECT]');
const notificationChannel = {};
const request = {
  name: formattedName,
  notificationChannel: notificationChannel,
};
client.createNotificationChannel(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

  projects/[PROJECT_ID]

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing NotificationChannel. The promise has a method named "cancel" which cancels the ongoing API call.

deleteNotificationChannel(request[, options][, callback]) → Promise

Deletes a notification channel.

const monitoring = require('@google-cloud/monitoring');

const client = new monitoring.v3.NotificationChannelServiceClient({
  // optional auth parameters.
});

const formattedName = client.notificationChannelPath('[PROJECT]', '[NOTIFICATION_CHANNEL]');
client.deleteNotificationChannel({name: formattedName}).catch(err => {
  console.error(err);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

getNotificationChannel(request[, options][, callback]) → 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.

const monitoring = require('@google-cloud/monitoring');

const client = new monitoring.v3.NotificationChannelServiceClient({
  // optional auth parameters.
});

const formattedName = client.notificationChannelPath('[PROJECT]', '[NOTIFICATION_CHANNEL]');
client.getNotificationChannel({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing NotificationChannel. The promise has a method named "cancel" which cancels the ongoing API call.

getNotificationChannelDescriptor(request[, options][, callback]) → Promise

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

const monitoring = require('@google-cloud/monitoring');

const client = new monitoring.v3.NotificationChannelServiceClient({
  // optional auth parameters.
});

const formattedName = client.notificationChannelDescriptorPath('[PROJECT]', '[CHANNEL_DESCRIPTOR]');
client.getNotificationChannelDescriptor({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing NotificationChannelDescriptor. The promise has a method named "cancel" which cancels the ongoing API call.

getProjectId(callback)

Return the project ID used by this class.

listNotificationChannelDescriptors(request[, options][, callback]) → Promise

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

const monitoring = require('@google-cloud/monitoring');

const client = new monitoring.v3.NotificationChannelServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedName = client.projectPath('[PROJECT]');

client.listNotificationChannelDescriptors({name: formattedName})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedName = client.projectPath('[PROJECT]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listNotificationChannelDescriptors(nextRequest, options).then(callback);
  }
}
client.listNotificationChannelDescriptors({name: formattedName}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

  projects/[PROJECT_ID]

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of NotificationChannelDescriptor.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of NotificationChannelDescriptor in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListNotificationChannelDescriptorsResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

listNotificationChannelDescriptorsStream(request[, options]) → Stream

Equivalent to listNotificationChannelDescriptors, but returns a NodeJS Stream object.

This fetches the paged responses for listNotificationChannelDescriptors continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

const monitoring = require('@google-cloud/monitoring');

const client = new monitoring.v3.NotificationChannelServiceClient({
  // optional auth parameters.
});

const formattedName = client.projectPath('[PROJECT]');
client.listNotificationChannelDescriptorsStream({name: formattedName})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

  projects/[PROJECT_ID]

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing NotificationChannelDescriptor on 'data' event.

listNotificationChannels(request[, options][, callback]) → Promise

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

const monitoring = require('@google-cloud/monitoring');

const client = new monitoring.v3.NotificationChannelServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedName = client.projectPath('[PROJECT]');

client.listNotificationChannels({name: formattedName})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedName = client.projectPath('[PROJECT]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listNotificationChannels(nextRequest, options).then(callback);
  }
}
client.listNotificationChannels({name: formattedName}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of NotificationChannel.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of NotificationChannel in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListNotificationChannelsResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

listNotificationChannelsStream(request[, options]) → Stream

Equivalent to listNotificationChannels, but returns a NodeJS Stream object.

This fetches the paged responses for listNotificationChannels continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

const monitoring = require('@google-cloud/monitoring');

const client = new monitoring.v3.NotificationChannelServiceClient({
  // optional auth parameters.
});

const formattedName = client.projectPath('[PROJECT]');
client.listNotificationChannelsStream({name: formattedName})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing NotificationChannel on 'data' event.

matchChannelDescriptorFromNotificationChannelDescriptorName(notificationChannelDescriptorName) → String

Parse the notificationChannelDescriptorName from a notification_channel_descriptor resource.

Returns

String 

• A string representing the channel_descriptor.

matchNotificationChannelFromNotificationChannelName(notificationChannelName) → String

Parse the notificationChannelName from a notification_channel resource.

Returns

String 

• A string representing the notification_channel.

matchProjectFromNotificationChannelDescriptorName(notificationChannelDescriptorName) → String

Parse the notificationChannelDescriptorName from a notification_channel_descriptor resource.

Returns

String 

• A string representing the project.

matchProjectFromNotificationChannelName(notificationChannelName) → String

Parse the notificationChannelName from a notification_channel resource.

Returns

String 

• A string representing the project.

matchProjectFromProjectName(projectName) → String

Parse the projectName from a project resource.

Returns

String 

• A string representing the project.

notificationChannelDescriptorPath(project, channelDescriptor) → String

Return a fully-qualified notification_channel_descriptor resource name string.

Returns

String 

notificationChannelPath(project, notificationChannel) → String

Return a fully-qualified notification_channel resource name string.

Returns

String 

projectPath(project) → String

Return a fully-qualified project resource name string.

Returns

String 

updateNotificationChannel(request[, options][, callback]) → Promise

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

const monitoring = require('@google-cloud/monitoring');

const client = new monitoring.v3.NotificationChannelServiceClient({
  // optional auth parameters.
});

const notificationChannel = {};
client.updateNotificationChannel({notificationChannel: notificationChannel})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing NotificationChannel. The promise has a method named "cancel" which cancels the ongoing API call.