GroupServiceClient

GroupServiceClient

The Group API lets you inspect and manage your groups.

A group is a named filter that is used to identify a collection of monitored resources. Groups are typically used to mirror the physical and/or logical topology of the environment. Because group membership is computed dynamically, monitored resources that are started in the future are automatically placed in matching groups. By using a group to name monitored resources in, for example, an alert policy, the target of that alert policy is updated automatically as monitored resources are added and removed from the infrastructure.

Constructor

new GroupServiceClient(optionsopt)

Construct an instance of GroupServiceClient.

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.

createGroup(request, optionsopt) → {Promise}

Creates a new group.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The project in which to create the group. The format is:

  projects/[PROJECT_ID_OR_NUMBER]
group google.monitoring.v3.Group

Required. A group definition. It is an error to define the name field because the system assigns the name.
validateOnly boolean

If true, validate this request but do not create the group.
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 Group. Please see the documentation for more details and examples.
Example
const [response] = await client.createGroup(request);

deleteGroup(request, optionsopt) → {Promise}

Deletes an existing group.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The group to delete. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
recursive boolean

If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false.
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.deleteGroup(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.

getGroup(request, optionsopt) → {Promise}

Gets a single group.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The group to retrieve. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_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 Group. Please see the documentation for more details and examples.
Example
const [response] = await client.getGroup(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.

listGroupMembers(request, optionsopt) → {Promise}

Lists the monitored resources that are members of a group.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The group whose members are listed. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
pageSize number

A positive number that is the maximum number of results to return.
pageToken string

If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
filter string

An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:

  `resource.type = "gce_instance"`
interval google.monitoring.v3.TimeInterval

An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned.
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 MonitoredResource. 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 listGroupMembersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listGroupMembersAsync(request, optionsopt) → {Object}

Equivalent to listGroupMembers, 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 group whose members are listed. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
pageSize number

A positive number that is the maximum number of results to return.
pageToken string

If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
filter string

An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:

  `resource.type = "gce_instance"`
interval google.monitoring.v3.TimeInterval

An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned.
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 MonitoredResource. 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.listGroupMembersAsync(request);
for await (const response of iterable) {
  // process response
}

listGroupMembersStream(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 group whose members are listed. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
pageSize number

A positive number that is the maximum number of results to return.
pageToken string

If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
filter string

An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:

  `resource.type = "gce_instance"`
interval google.monitoring.v3.TimeInterval

An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing MonitoredResource 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 listGroupMembersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listGroups(request, optionsopt) → {Promise}

Lists the existing groups.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The project whose groups are to be listed. The format is:

  projects/[PROJECT_ID_OR_NUMBER]
childrenOfGroup string

A group name. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty.
ancestorsOfGroup string

A group name. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.
descendantsOfGroup string

A group name. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth.
pageSize number

A positive number that is the maximum number of results to return.
pageToken string

If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
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 Group. 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 listGroupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listGroupsAsync(request, optionsopt) → {Object}

Equivalent to listGroups, 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 whose groups are to be listed. The format is:

  projects/[PROJECT_ID_OR_NUMBER]
childrenOfGroup string

A group name. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty.
ancestorsOfGroup string

A group name. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.
descendantsOfGroup string

A group name. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth.
pageSize number

A positive number that is the maximum number of results to return.
pageToken string

If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
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 Group. 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.listGroupsAsync(request);
for await (const response of iterable) {
  // process response
}

listGroupsStream(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 whose groups are to be listed. The format is:

  projects/[PROJECT_ID_OR_NUMBER]
childrenOfGroup string

A group name. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty.
ancestorsOfGroup string

A group name. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.
descendantsOfGroup string

A group name. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth.
pageSize number

A positive number that is the maximum number of results to return.
pageToken string

If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Group 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 listGroupsAsync() 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.

updateGroup(request, optionsopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
group google.monitoring.v3.Group

Required. The new definition of the group. All fields of the existing group, excepting name, are replaced with the corresponding fields of this group.
validateOnly boolean

If true, validate this request but do not update the existing group.
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 Group. Please see the documentation for more details and examples.
Example
const [response] = await client.updateGroup(request);