@google-cloud/monitoring
Version:
Stackdriver Monitoring API client for Node.js
930 lines • 62.8 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* The Group API lets you inspect and manage your
* [groups](#google.monitoring.v3.Group).
*
* 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.
* @class
* @memberof v3
*/
export declare class GroupServiceClient {
private _terminated;
private _opts;
private _providedCustomServicePath;
private _gaxModule;
private _gaxGrpc;
private _protos;
private _defaults;
private _universeDomain;
private _servicePath;
private _log;
auth: gax.GoogleAuth;
descriptors: Descriptors;
warn: (code: string, message: string, warnType?: string) => void;
innerApiCalls: {
[name: string]: Function;
};
pathTemplates: {
[name: string]: gax.PathTemplate;
};
groupServiceStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of GroupServiceClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - 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.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - 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
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new GroupServiceClient({fallback: true}, gax);
* ```
*/
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
/**
* 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 {Promise} A promise that resolves to an authenticated service stub.
*/
initialize(): Promise<{
[name: string]: Function;
}>;
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): string;
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint(): string;
get universeDomain(): string;
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port(): number;
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes(): string[];
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
* Gets a single group.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The group to retrieve. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.monitoring.v3.Group|Group}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v3/group_service.get_group.js</caption>
* region_tag:monitoring_v3_generated_GroupService_GetGroup_async
*/
getGroup(request?: protos.google.monitoring.v3.IGetGroupRequest, options?: CallOptions): Promise<[
protos.google.monitoring.v3.IGroup,
protos.google.monitoring.v3.IGetGroupRequest | undefined,
{} | undefined
]>;
getGroup(request: protos.google.monitoring.v3.IGetGroupRequest, options: CallOptions, callback: Callback<protos.google.monitoring.v3.IGroup, protos.google.monitoring.v3.IGetGroupRequest | null | undefined, {} | null | undefined>): void;
getGroup(request: protos.google.monitoring.v3.IGetGroupRequest, callback: Callback<protos.google.monitoring.v3.IGroup, protos.google.monitoring.v3.IGetGroupRequest | null | undefined, {} | null | undefined>): void;
/**
* Creates a new group.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The
* [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
* to create the group. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]
* @param {google.monitoring.v3.Group} request.group
* Required. A group definition. It is an error to define the `name` field
* because the system assigns the name.
* @param {boolean} request.validateOnly
* If true, validate this request but do not create the group.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.monitoring.v3.Group|Group}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v3/group_service.create_group.js</caption>
* region_tag:monitoring_v3_generated_GroupService_CreateGroup_async
*/
createGroup(request?: protos.google.monitoring.v3.ICreateGroupRequest, options?: CallOptions): Promise<[
protos.google.monitoring.v3.IGroup,
protos.google.monitoring.v3.ICreateGroupRequest | undefined,
{} | undefined
]>;
createGroup(request: protos.google.monitoring.v3.ICreateGroupRequest, options: CallOptions, callback: Callback<protos.google.monitoring.v3.IGroup, protos.google.monitoring.v3.ICreateGroupRequest | null | undefined, {} | null | undefined>): void;
createGroup(request: protos.google.monitoring.v3.ICreateGroupRequest, callback: Callback<protos.google.monitoring.v3.IGroup, protos.google.monitoring.v3.ICreateGroupRequest | null | undefined, {} | null | undefined>): void;
/**
* Updates an existing group.
* You can change any group attributes except `name`.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.monitoring.v3.Group} request.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.
* @param {boolean} request.validateOnly
* If true, validate this request but do not update the existing group.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.monitoring.v3.Group|Group}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v3/group_service.update_group.js</caption>
* region_tag:monitoring_v3_generated_GroupService_UpdateGroup_async
*/
updateGroup(request?: protos.google.monitoring.v3.IUpdateGroupRequest, options?: CallOptions): Promise<[
protos.google.monitoring.v3.IGroup,
protos.google.monitoring.v3.IUpdateGroupRequest | undefined,
{} | undefined
]>;
updateGroup(request: protos.google.monitoring.v3.IUpdateGroupRequest, options: CallOptions, callback: Callback<protos.google.monitoring.v3.IGroup, protos.google.monitoring.v3.IUpdateGroupRequest | null | undefined, {} | null | undefined>): void;
updateGroup(request: protos.google.monitoring.v3.IUpdateGroupRequest, callback: Callback<protos.google.monitoring.v3.IGroup, protos.google.monitoring.v3.IUpdateGroupRequest | null | undefined, {} | null | undefined>): void;
/**
* Deletes an existing group.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The group to delete. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* @param {boolean} request.recursive
* 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.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v3/group_service.delete_group.js</caption>
* region_tag:monitoring_v3_generated_GroupService_DeleteGroup_async
*/
deleteGroup(request?: protos.google.monitoring.v3.IDeleteGroupRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.monitoring.v3.IDeleteGroupRequest | undefined,
{} | undefined
]>;
deleteGroup(request: protos.google.monitoring.v3.IDeleteGroupRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.IDeleteGroupRequest | null | undefined, {} | null | undefined>): void;
deleteGroup(request: protos.google.monitoring.v3.IDeleteGroupRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.IDeleteGroupRequest | null | undefined, {} | null | undefined>): void;
/**
* Lists the existing groups.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The
* [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
* groups are to be listed. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]
* @param {string} request.childrenOfGroup
* 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.
* @param {string} request.ancestorsOfGroup
* 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.
* @param {string} request.descendantsOfGroup
* 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.
* @param {number} request.pageSize
* A positive number that is the maximum number of results to return.
* @param {string} request.pageToken
* 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.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of {@link protos.google.monitoring.v3.Group|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listGroups(request?: protos.google.monitoring.v3.IListGroupsRequest, options?: CallOptions): Promise<[
protos.google.monitoring.v3.IGroup[],
protos.google.monitoring.v3.IListGroupsRequest | null,
protos.google.monitoring.v3.IListGroupsResponse
]>;
listGroups(request: protos.google.monitoring.v3.IListGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.monitoring.v3.IListGroupsRequest, protos.google.monitoring.v3.IListGroupsResponse | null | undefined, protos.google.monitoring.v3.IGroup>): void;
listGroups(request: protos.google.monitoring.v3.IListGroupsRequest, callback: PaginationCallback<protos.google.monitoring.v3.IListGroupsRequest, protos.google.monitoring.v3.IListGroupsResponse | null | undefined, protos.google.monitoring.v3.IGroup>): void;
/**
* Equivalent to `listGroups`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The
* [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
* groups are to be listed. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]
* @param {string} request.childrenOfGroup
* 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.
* @param {string} request.ancestorsOfGroup
* 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.
* @param {string} request.descendantsOfGroup
* 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.
* @param {number} request.pageSize
* A positive number that is the maximum number of results to return.
* @param {string} request.pageToken
* 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.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.monitoring.v3.Group|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listGroupsStream(request?: protos.google.monitoring.v3.IListGroupsRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listGroups`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The
* [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
* groups are to be listed. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]
* @param {string} request.childrenOfGroup
* 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.
* @param {string} request.ancestorsOfGroup
* 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.
* @param {string} request.descendantsOfGroup
* 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.
* @param {number} request.pageSize
* A positive number that is the maximum number of results to return.
* @param {string} request.pageToken
* 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.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.monitoring.v3.Group|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v3/group_service.list_groups.js</caption>
* region_tag:monitoring_v3_generated_GroupService_ListGroups_async
*/
listGroupsAsync(request?: protos.google.monitoring.v3.IListGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.monitoring.v3.IGroup>;
/**
* Lists the monitored resources that are members of a group.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The group whose members are listed. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* @param {number} request.pageSize
* A positive number that is the maximum number of results to return.
* @param {string} request.pageToken
* 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.
* @param {string} request.filter
* An optional [list
* filter](https://cloud.google.com/monitoring/api/learn_more#filtering)
* 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"`
* @param {google.monitoring.v3.TimeInterval} request.interval
* 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.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of {@link protos.google.api.MonitoredResource|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listGroupMembers(request?: protos.google.monitoring.v3.IListGroupMembersRequest, options?: CallOptions): Promise<[
protos.google.api.IMonitoredResource[],
protos.google.monitoring.v3.IListGroupMembersRequest | null,
protos.google.monitoring.v3.IListGroupMembersResponse
]>;
listGroupMembers(request: protos.google.monitoring.v3.IListGroupMembersRequest, options: CallOptions, callback: PaginationCallback<protos.google.monitoring.v3.IListGroupMembersRequest, protos.google.monitoring.v3.IListGroupMembersResponse | null | undefined, protos.google.api.IMonitoredResource>): void;
listGroupMembers(request: protos.google.monitoring.v3.IListGroupMembersRequest, callback: PaginationCallback<protos.google.monitoring.v3.IListGroupMembersRequest, protos.google.monitoring.v3.IListGroupMembersResponse | null | undefined, protos.google.api.IMonitoredResource>): void;
/**
* Equivalent to `listGroupMembers`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The group whose members are listed. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* @param {number} request.pageSize
* A positive number that is the maximum number of results to return.
* @param {string} request.pageToken
* 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.
* @param {string} request.filter
* An optional [list
* filter](https://cloud.google.com/monitoring/api/learn_more#filtering)
* 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"`
* @param {google.monitoring.v3.TimeInterval} request.interval
* 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.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.api.MonitoredResource|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listGroupMembersStream(request?: protos.google.monitoring.v3.IListGroupMembersRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listGroupMembers`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The group whose members are listed. The format is:
*
* projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
* @param {number} request.pageSize
* A positive number that is the maximum number of results to return.
* @param {string} request.pageToken
* 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.
* @param {string} request.filter
* An optional [list
* filter](https://cloud.google.com/monitoring/api/learn_more#filtering)
* 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"`
* @param {google.monitoring.v3.TimeInterval} request.interval
* 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.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.api.MonitoredResource|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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v3/group_service.list_group_members.js</caption>
* region_tag:monitoring_v3_generated_GroupService_ListGroupMembers_async
*/
listGroupMembersAsync(request?: protos.google.monitoring.v3.IListGroupMembersRequest, options?: CallOptions): AsyncIterable<protos.google.api.IMonitoredResource>;
/**
* Return a fully-qualified folderAlertPolicy resource name string.
*
* @param {string} folder
* @param {string} alert_policy
* @returns {string} Resource name string.
*/
folderAlertPolicyPath(folder: string, alertPolicy: string): string;
/**
* Parse the folder from FolderAlertPolicy resource.
*
* @param {string} folderAlertPolicyName
* A fully-qualified path representing folder_alert_policy resource.
* @returns {string} A string representing the folder.
*/
matchFolderFromFolderAlertPolicyName(folderAlertPolicyName: string): string | number;
/**
* Parse the alert_policy from FolderAlertPolicy resource.
*
* @param {string} folderAlertPolicyName
* A fully-qualified path representing folder_alert_policy resource.
* @returns {string} A string representing the alert_policy.
*/
matchAlertPolicyFromFolderAlertPolicyName(folderAlertPolicyName: string): string | number;
/**
* Return a fully-qualified folderAlertPolicyCondition resource name string.
*
* @param {string} folder
* @param {string} alert_policy
* @param {string} condition
* @returns {string} Resource name string.
*/
folderAlertPolicyConditionPath(folder: string, alertPolicy: string, condition: string): string;
/**
* Parse the folder from FolderAlertPolicyCondition resource.
*
* @param {string} folderAlertPolicyConditionName
* A fully-qualified path representing folder_alert_policy_condition resource.
* @returns {string} A string representing the folder.
*/
matchFolderFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName: string): string | number;
/**
* Parse the alert_policy from FolderAlertPolicyCondition resource.
*
* @param {string} folderAlertPolicyConditionName
* A fully-qualified path representing folder_alert_policy_condition resource.
* @returns {string} A string representing the alert_policy.
*/
matchAlertPolicyFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName: string): string | number;
/**
* Parse the condition from FolderAlertPolicyCondition resource.
*
* @param {string} folderAlertPolicyConditionName
* A fully-qualified path representing folder_alert_policy_condition resource.
* @returns {string} A string representing the condition.
*/
matchConditionFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName: string): string | number;
/**
* Return a fully-qualified folderChannelDescriptor resource name string.
*
* @param {string} folder
* @param {string} channel_descriptor
* @returns {string} Resource name string.
*/
folderChannelDescriptorPath(folder: string, channelDescriptor: string): string;
/**
* Parse the folder from FolderChannelDescriptor resource.
*
* @param {string} folderChannelDescriptorName
* A fully-qualified path representing folder_channel_descriptor resource.
* @returns {string} A string representing the folder.
*/
matchFolderFromFolderChannelDescriptorName(folderChannelDescriptorName: string): string | number;
/**
* Parse the channel_descriptor from FolderChannelDescriptor resource.
*
* @param {string} folderChannelDescriptorName
* A fully-qualified path representing folder_channel_descriptor resource.
* @returns {string} A string representing the channel_descriptor.
*/
matchChannelDescriptorFromFolderChannelDescriptorName(folderChannelDescriptorName: string): string | number;
/**
* Return a fully-qualified folderGroup resource name string.
*
* @param {string} folder
* @param {string} group
* @returns {string} Resource name string.
*/
folderGroupPath(folder: string, group: string): string;
/**
* Parse the folder from FolderGroup resource.
*
* @param {string} folderGroupName
* A fully-qualified path representing folder_group resource.
* @returns {string} A string representing the folder.
*/
matchFolderFromFolderGroupName(folderGroupName: string): string | number;
/**
* Parse the group from FolderGroup resource.
*
* @param {string} folderGroupName
* A fully-qualified path representing folder_group resource.
* @returns {string} A string representing the group.
*/
matchGroupFromFolderGroupName(folderGroupName: string): string | number;
/**
* Return a fully-qualified folderNotificationChannel resource name string.
*
* @param {string} folder
* @param {string} notification_channel
* @returns {string} Resource name string.
*/
folderNotificationChannelPath(folder: string, notificationChannel: string): string;
/**
* Parse the folder from FolderNotificationChannel resource.
*
* @param {string} folderNotificationChannelName
* A fully-qualified path representing folder_notification_channel resource.
* @returns {string} A string representing the folder.
*/
matchFolderFromFolderNotificationChannelName(folderNotificationChannelName: string): string | number;
/**
* Parse the notification_channel from FolderNotificationChannel resource.
*
* @param {string} folderNotificationChannelName
* A fully-qualified path representing folder_notification_channel resource.
* @returns {string} A string representing the notification_channel.
*/
matchNotificationChannelFromFolderNotificationChannelName(folderNotificationChannelName: string): string | number;
/**
* Return a fully-qualified folderService resource name string.
*
* @param {string} folder
* @param {string} service
* @returns {string} Resource name string.
*/
folderServicePath(folder: string, service: string): string;
/**
* Parse the folder from FolderService resource.
*
* @param {string} folderServiceName
* A fully-qualified path representing folder_service resource.
* @returns {string} A string representing the folder.
*/
matchFolderFromFolderServiceName(folderServiceName: string): string | number;
/**
* Parse the service from FolderService resource.
*
* @param {string} folderServiceName
* A fully-qualified path representing folder_service resource.
* @returns {string} A string representing the service.
*/
matchServiceFromFolderServiceName(folderServiceName: string): string | number;
/**
* Return a fully-qualified folderServiceServiceLevelObjective resource name string.
*
* @param {string} folder
* @param {string} service
* @param {string} service_level_objective
* @returns {string} Resource name string.
*/
folderServiceServiceLevelObjectivePath(folder: string, service: string, serviceLevelObjective: string): string;
/**
* Parse the folder from FolderServiceServiceLevelObjective resource.
*
* @param {string} folderServiceServiceLevelObjectiveName
* A fully-qualified path representing folder_service_service_level_objective resource.
* @returns {string} A string representing the folder.
*/
matchFolderFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName: string): string | number;
/**
* Parse the service from FolderServiceServiceLevelObjective resource.
*
* @param {string} folderServiceServiceLevelObjectiveName
* A fully-qualified path representing folder_service_service_level_objective resource.
* @returns {string} A string representing the service.
*/
matchServiceFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName: string): string | number;
/**
* Parse the service_level_objective from FolderServiceServiceLevelObjective resource.
*
* @param {string} folderServiceServiceLevelObjectiveName
* A fully-qualified path representing folder_service_service_level_objective resource.
* @returns {string} A string representing the service_level_objective.
*/
matchServiceLevelObjectiveFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName: string): string | number;
/**
* Return a fully-qualified folderUptimeCheckConfig resource name string.
*
* @param {string} folder
* @param {string} uptime_check_config
* @returns {string} Resource name string.
*/
folderUptimeCheckConfigPath(folder: string, uptimeCheckConfig: string): string;
/**
* Parse the folder from FolderUptimeCheckConfig resource.
*
* @param {string} folderUptimeCheckConfigName
* A fully-qualified path representing folder_uptime_check_config resource.
* @returns {string} A string representing the folder.
*/
matchFolderFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName: string): string | number;
/**
* Parse the uptime_check_config from FolderUptimeCheckConfig resource.
*
* @param {string} folderUptimeCheckConfigName
* A fully-qualified path representing folder_uptime_check_config resource.
* @returns {string} A string representing the uptime_check_config.
*/
matchUptimeCheckConfigFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName: string): string | number;
/**
* Return a fully-qualified organizationAlertPolicy resource name string.
*
* @param {string} organization
* @param {string} alert_policy
* @returns {string} Resource name string.
*/
organizationAlertPolicyPath(organization: string, alertPolicy: string): string;
/**
* Parse the organization from OrganizationAlertPolicy resource.
*
* @param {string} organizationAlertPolicyName
* A fully-qualified path representing organization_alert_policy resource.
* @returns {string} A string representing the organization.
*/
matchOrganizationFromOrganizationAlertPolicyName(organizationAlertPolicyName: string): string | number;
/**
* Parse the alert_policy from OrganizationAlertPolicy resource.
*
* @param {string} organizationAlertPolicyName
* A fully-qualified path representing organization_alert_policy resource.
* @returns {string} A string representing the alert_policy.
*/
matchAlertPolicyFromOrganizationAlertPolicyName(organizationAlertPolicyName: string): string | number;
/**
* Return a fully-qualified organizationAlertPolicyCondition resource name string.
*
* @param {string} organization
* @param {string} alert_policy
* @param {string} condition
* @returns {string} Resource name string.
*/
organizationAlertPolicyConditionPath(organization: string, alertPolicy: string, condition: string): string;
/**
* Parse the organization from OrganizationAlertPolicyCondition resource.
*
* @param {string} organizationAlertPolicyConditionName
* A fully-qualified path representing organization_alert_policy_condition resource.
* @returns {string} A string representing the organization.
*/
matchOrganizationFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName: string): string | number;
/**
* Parse the alert_policy from OrganizationAlertPolicyCondition resource.
*
* @param {string} organizationAlertPolicyConditionName
* A fully-qualified path representing organization_alert_policy_condition resource.
* @returns {string} A string representing the alert_policy.
*/
matchAlertPolicyFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName: string): string | number;
/**
* Parse the condition from OrganizationAlertPolicyCondition resource.
*
* @param {string} organizationAlertPolicyConditionName
* A fully-qualified path representing organization_alert_policy_condition resource.
* @returns {string} A string representing the condition.
*/
matchConditionFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName: string): string | number;
/**
* Return a fully-qualified organizationChannelDescriptor resource name string.
*
* @param {string} organization
* @param {string} channel_descriptor
* @returns {string} Resource name string.
*/
organizationChannelDescriptorPath(organization: string, channelDescriptor: string): string;
/**
* Parse the organization from OrganizationChannelDescriptor resource.
*
* @param {string} organizationChannelDescriptorName
* A fully-qualified path representing organization_channel_descriptor resource.
* @returns {string} A string representing the organization.
*/
matchOrganizationFromOrganizationChannelDescriptorName(organizationChannelDescriptorName: string): string | number;
/**
* Parse the channel_descriptor from OrganizationChannelDescriptor resource.
*
* @param {string} organizationChannelDescriptorName
* A fully-qualified path representing organization_channel_descriptor resource.
* @returns {string} A string representing the channel_descriptor.
*/
matchChannelDescriptorFromOrganizationChannelDescriptorName(organizationChannelDescriptorName: string): string | number;
/**
* Return a fully-qualified organizationGroup resource name string.
*
* @param {string} organization
* @param {string} group
* @returns {string} Resource name string.
*/
organizationGroupPath(organization: string, group: string): string;
/**
* Parse the organization from OrganizationGroup resource.
*
* @param {string} organizationGroupName
* A fully-qualified path representing organization_group resource.
* @returns {string} A string representing the organization.
*/
matchOrganizationFromOrganizationGroupName(organizationGroupName: string): string | number;
/**
* Parse the group from OrganizationGroup resource.
*
* @param {string} organizationGroupName
* A fully-qualified path representing organization_group resource.
* @returns {string} A string representing the group.
*/
matchGroupFromOrganizationGroupName(organizationGroupName: string): string | number;
/**
* Return a fully-qualified organizationNotificationChannel resource name string.
*
* @param {string} organization
* @param {string} notification_channel
* @returns {string} Resource name string.
*/
organizationNotificationChannelPath(organization: string, notificationChannel: string): string;
/**
* Parse the organization from OrganizationNotificationChannel resource.
*
* @param {string} organizationNotificationChannelName
* A fully-qualified path representing organization_notification_channel resource.
* @returns {string} A string representing the organization.
*/
matchOrganizationFromOrganizationNotificationChannelName(organizationNotificationChannelName: string): string | number;
/**
* Parse the notification_channel from OrganizationNotificationChannel resource.
*
* @param {string} organizationNotificationChannelName
* A fully-qualified path representing organization_notification_channel resource.
* @returns {string} A string representing the notification_channel.
*/
matchNotificationChannelFromOrganizationNotificationChannelName(organizationNotificationChannelName: string): string | number;
/**
* Return a fully-qualified organizationService resource name string.
*
* @param {string} organization
* @param {string} service
* @returns {string} Resource name string.
*/
organizationServicePath(organization: string, service: string): string;
/**
* Parse the organization from OrganizationService resource.
*
* @param {string} organizationServiceName
* A fully-qualified path representing organization_service resource.
* @returns {string} A string representing the organization.
*/
matchOrganizationFromOrganizationServiceName(organizationServiceName: string): string | number;
/**
* Parse the service from OrganizationService resource.
*
* @param {string} organizationServiceName
* A fully-qualified path representing organization_service resource.
* @returns {string} A string representing the service.
*/
matchServiceFromOrganizationServiceName(organizationServiceName: string): string | number;
/**
* Return a fully-qualified organizationServiceServiceLevelObjective resource name string.
*
* @param {string} organization
* @param {string} service
* @param {string} service_level_objective
* @returns {string} Resource name string.
*/
organizationServiceServiceLevelObjectivePath(organization: string, service: string, serviceLevelObjective: string): string;
/**
* Parse the organization from OrganizationServiceServiceLevelObjective resource.
*
* @param {string} organizationServiceServiceLevelObjectiveName
* A fully-qualified path representing organization_service_service_level_objective resource.
* @returns {string} A string representing the organization.
*/
matchOrganizationFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName: string): string | number;
/**
* Parse the service from OrganizationServiceServiceLevelObjective resource.
*
* @param {string} organizationServiceServiceLevelObjectiveName
* A fully-qualified path representing organization_service_service_level_objective resource.
* @returns {string} A string representing the service.
*/
matchServiceFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName: string): string | number;
/**
* Parse the service_level_objective from OrganizationServiceServiceLevelObject