Constructor

GroupServiceClient

new GroupServiceClient(options)

Construct an instance of GroupServiceClient.

Parameter

options

Optional

object

The configuration object. See the subsequent parameters for more details.

Properties

port

static

The port for this API service.

scopes

static

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

servicePath

static

The DNS address for this API service.

Methods

createGroup

createGroup(request, options, callback) returns Promise

Creates a new group.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Group.

Returns

Promise 

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

Example

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

var client = new monitoring.v3.GroupServiceClient({
  // optional auth parameters.
});

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

deleteGroup

deleteGroup(request, options, callback) returns Promise

Deletes an existing group.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error)

The function which will be called with the result of the API call.

Returns

Promise 

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

Example

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

var client = new monitoring.v3.GroupServiceClient({
  // optional auth parameters.
});

var formattedName = client.groupPath('[PROJECT]', '[GROUP]');
client.deleteGroup({name: formattedName}).catch(err => {
  console.error(err);
});

getGroup

getGroup(request, options, callback) returns Promise

Gets a single group.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Group.

Returns

Promise 

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

Example

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

var client = new monitoring.v3.GroupServiceClient({
  // optional auth parameters.
});

var formattedName = client.groupPath('[PROJECT]', '[GROUP]');
client.getGroup({name: formattedName})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId

getProjectId(callback)

Return the project ID used by this class.

Parameter

callback

function(Error, string)

the callback to be called with the current project Id.

groupPath

groupPath(project, group) returns String

Return a fully-qualified group resource name string.

Parameter

project

String

group

String

Returns

String 

listGroupMembers

listGroupMembers(request, options, callback) returns Promise

Lists the monitored resources that are members of a group.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is Array of MonitoredResource.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListGroupMembersResponse.

Returns

Promise 

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

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of MonitoredResource 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 ListGroupMembersResponse.

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

Example

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

var client = new monitoring.v3.GroupServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
var formattedName = client.groupPath('[PROJECT]', '[GROUP]');

client.listGroupMembers({name: formattedName})
  .then(responses => {
    var resources = responses[0];
    for (let i = 0; i < resources.length; i += 1) {
      // doThingsWith(resources[i])
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
var formattedName = client.groupPath('[PROJECT]', '[GROUP]');


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

listGroupMembersStream

listGroupMembersStream(request, options) returns Stream

Equivalent to listGroupMembers, but returns a NodeJS Stream object.

This fetches the paged responses for listGroupMembers 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.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

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

Example

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

var client = new monitoring.v3.GroupServiceClient({
  // optional auth parameters.
});

var formattedName = client.groupPath('[PROJECT]', '[GROUP]');
client.listGroupMembersStream({name: formattedName})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

listGroups

listGroups(request, options, callback) returns Promise

Lists the existing groups.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is Array of Group.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListGroupsResponse.

Returns

Promise 

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

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of Group 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 ListGroupsResponse.

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

Example

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

var client = new monitoring.v3.GroupServiceClient({
  // optional auth parameters.
});

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

client.listGroups({name: formattedName})
  .then(responses => {
    var resources = responses[0];
    for (let i = 0; i < resources.length; i += 1) {
      // doThingsWith(resources[i])
    }
  })
  .catch(err => {
    console.error(err);
  });

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


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

listGroupsStream

listGroupsStream(request, options) returns Stream

Equivalent to listGroups, but returns a NodeJS Stream object.

This fetches the paged responses for listGroups 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.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

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

Example

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

var client = new monitoring.v3.GroupServiceClient({
  // optional auth parameters.
});

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

matchGroupFromGroupName

matchGroupFromGroupName(groupName) returns String

Parse the groupName from a group resource.

Parameter

groupName

String

A fully-qualified path representing a group resources.

Returns

String 

  • A string representing the group.

matchProjectFromGroupName

matchProjectFromGroupName(groupName) returns String

Parse the groupName from a group resource.

Parameter

groupName

String

A fully-qualified path representing a group resources.

Returns

String 

  • A string representing the project.

matchProjectFromProjectName

matchProjectFromProjectName(projectName) returns String

Parse the projectName from a project resource.

Parameter

projectName

String

A fully-qualified path representing a project resources.

Returns

String 

  • A string representing the project.

projectPath

projectPath(project) returns String

Return a fully-qualified project resource name string.

Parameter

project

String

Returns

String 

updateGroup

updateGroup(request, options, callback) returns Promise

Updates an existing group. You can change any group attributes except name.

Parameter

request

Object

The request object that will be sent.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Group.

Returns

Promise 

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

Example

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

var client = new monitoring.v3.GroupServiceClient({
  // optional auth parameters.
});

var group = {};
client.updateGroup({group: group})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });