@google-cloud/monitoring/build/src/v3/uptime_check_service_client.d.ts

Stackdriver Monitoring API client for Node.js

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 UptimeCheckService API is used to manage (list, create, delete, edit)
 *  Uptime check configurations in the Cloud Monitoring product. An Uptime
 *  check is a piece of configuration that determines which resources and
 *  services to monitor for availability. These configurations can also be
 *  configured interactively by navigating to the [Cloud console]
 *  (https://console.cloud.google.com), selecting the appropriate project,
 *  clicking on "Monitoring" on the left-hand side to navigate to Cloud
 *  Monitoring, and then clicking on "Uptime".
 * @class
 * @memberof v3
 */
export declare class UptimeCheckServiceClient {
    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;
    };
    uptimeCheckServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of UptimeCheckServiceClient.
     *
     * @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 UptimeCheckServiceClient({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 Uptime check configuration.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The Uptime check configuration to retrieve. The format is:
     *
     *       projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_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.UptimeCheckConfig|UptimeCheckConfig}.
     *   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/uptime_check_service.get_uptime_check_config.js</caption>
     * region_tag:monitoring_v3_generated_UptimeCheckService_GetUptimeCheckConfig_async
     */
    getUptimeCheckConfig(request?: protos.google.monitoring.v3.IGetUptimeCheckConfigRequest, options?: CallOptions): Promise<[
        protos.google.monitoring.v3.IUptimeCheckConfig,
        protos.google.monitoring.v3.IGetUptimeCheckConfigRequest | undefined,
        {} | undefined
    ]>;
    getUptimeCheckConfig(request: protos.google.monitoring.v3.IGetUptimeCheckConfigRequest, options: CallOptions, callback: Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.IGetUptimeCheckConfigRequest | null | undefined, {} | null | undefined>): void;
    getUptimeCheckConfig(request: protos.google.monitoring.v3.IGetUptimeCheckConfigRequest, callback: Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.IGetUptimeCheckConfigRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Creates a new Uptime check configuration.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The
     *   [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
     *   to create the Uptime check. The format is:
     *
     *       projects/[PROJECT_ID_OR_NUMBER]
     * @param {google.monitoring.v3.UptimeCheckConfig} request.uptimeCheckConfig
     *   Required. The new Uptime check configuration.
     * @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.UptimeCheckConfig|UptimeCheckConfig}.
     *   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/uptime_check_service.create_uptime_check_config.js</caption>
     * region_tag:monitoring_v3_generated_UptimeCheckService_CreateUptimeCheckConfig_async
     */
    createUptimeCheckConfig(request?: protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest, options?: CallOptions): Promise<[
        protos.google.monitoring.v3.IUptimeCheckConfig,
        protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest | undefined,
        {} | undefined
    ]>;
    createUptimeCheckConfig(request: protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest, options: CallOptions, callback: Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest | null | undefined, {} | null | undefined>): void;
    createUptimeCheckConfig(request: protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest, callback: Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Updates an Uptime check configuration. You can either replace the entire
     * configuration with a new one or replace only certain fields in the current
     * configuration by specifying the fields to be updated via `updateMask`.
     * Returns the updated configuration.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.protobuf.FieldMask} request.updateMask
     *   Optional. If present, only the listed fields in the current Uptime check
     *   configuration are updated with values from the new configuration. If this
     *   field is empty, then the current configuration is completely replaced with
     *   the new configuration.
     * @param {google.monitoring.v3.UptimeCheckConfig} request.uptimeCheckConfig
     *   Required. If an `updateMask` has been specified, this field gives
     *   the values for the set of fields mentioned in the `updateMask`. If an
     *   `updateMask` has not been given, this Uptime check configuration replaces
     *   the current configuration. If a field is mentioned in `updateMask` but
     *   the corresponding field is omitted in this partial Uptime check
     *   configuration, it has the effect of deleting/clearing the field from the
     *   configuration on the server.
     *
     *   The following fields can be updated: `display_name`,
     *   `http_check`, `tcp_check`, `timeout`, `content_matchers`, and
     *   `selected_regions`.
     * @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.UptimeCheckConfig|UptimeCheckConfig}.
     *   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/uptime_check_service.update_uptime_check_config.js</caption>
     * region_tag:monitoring_v3_generated_UptimeCheckService_UpdateUptimeCheckConfig_async
     */
    updateUptimeCheckConfig(request?: protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest, options?: CallOptions): Promise<[
        protos.google.monitoring.v3.IUptimeCheckConfig,
        protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest | undefined,
        {} | undefined
    ]>;
    updateUptimeCheckConfig(request: protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest, options: CallOptions, callback: Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest | null | undefined, {} | null | undefined>): void;
    updateUptimeCheckConfig(request: protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest, callback: Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Deletes an Uptime check configuration. Note that this method will fail
     * if the Uptime check configuration is referenced by an alert policy or
     * other dependent configs that would be rendered invalid by the deletion.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The Uptime check configuration to delete. The format is:
     *
     *       projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_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.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/uptime_check_service.delete_uptime_check_config.js</caption>
     * region_tag:monitoring_v3_generated_UptimeCheckService_DeleteUptimeCheckConfig_async
     */
    deleteUptimeCheckConfig(request?: protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest | undefined,
        {} | undefined
    ]>;
    deleteUptimeCheckConfig(request: protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest | null | undefined, {} | null | undefined>): void;
    deleteUptimeCheckConfig(request: protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest | null | undefined, {} | null | undefined>): void;
    /**
    * Lists the existing valid Uptime check configurations for the project
    * (leaving out any invalid configurations).
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The
    *   [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
    *   Uptime check configurations are listed. The format is:
    *
    *       projects/[PROJECT_ID_OR_NUMBER]
    * @param {string} request.filter
    *   If provided, this field specifies the criteria that must be met by
    *   uptime checks to be included in the response.
    *
    *   For more details, see [Filtering
    *   syntax](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering#filter_syntax).
    * @param {number} request.pageSize
    *   The maximum number of results to return in a single response. The server
    *   may further constrain the maximum number of results returned in a single
    *   page. If the page_size is <=0, the server will decide the number of results
    *   to be returned.
    * @param {string} request.pageToken
    *   If this field is not empty then it must contain the `nextPageToken` value
    *   returned by a previous call to this method.  Using this field causes the
    *   method to return more 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.UptimeCheckConfig|UptimeCheckConfig}.
    *   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 `listUptimeCheckConfigsAsync()`
    *   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.
    */
    listUptimeCheckConfigs(request?: protos.google.monitoring.v3.IListUptimeCheckConfigsRequest, options?: CallOptions): Promise<[
        protos.google.monitoring.v3.IUptimeCheckConfig[],
        protos.google.monitoring.v3.IListUptimeCheckConfigsRequest | null,
        protos.google.monitoring.v3.IListUptimeCheckConfigsResponse
    ]>;
    listUptimeCheckConfigs(request: protos.google.monitoring.v3.IListUptimeCheckConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.monitoring.v3.IListUptimeCheckConfigsRequest, protos.google.monitoring.v3.IListUptimeCheckConfigsResponse | null | undefined, protos.google.monitoring.v3.IUptimeCheckConfig>): void;
    listUptimeCheckConfigs(request: protos.google.monitoring.v3.IListUptimeCheckConfigsRequest, callback: PaginationCallback<protos.google.monitoring.v3.IListUptimeCheckConfigsRequest, protos.google.monitoring.v3.IListUptimeCheckConfigsResponse | null | undefined, protos.google.monitoring.v3.IUptimeCheckConfig>): void;
    /**
     * Equivalent to `listUptimeCheckConfigs`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The
     *   [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
     *   Uptime check configurations are listed. The format is:
     *
     *       projects/[PROJECT_ID_OR_NUMBER]
     * @param {string} request.filter
     *   If provided, this field specifies the criteria that must be met by
     *   uptime checks to be included in the response.
     *
     *   For more details, see [Filtering
     *   syntax](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering#filter_syntax).
     * @param {number} request.pageSize
     *   The maximum number of results to return in a single response. The server
     *   may further constrain the maximum number of results returned in a single
     *   page. If the page_size is <=0, the server will decide the number of results
     *   to be returned.
     * @param {string} request.pageToken
     *   If this field is not empty then it must contain the `nextPageToken` value
     *   returned by a previous call to this method.  Using this field causes the
     *   method to return more 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.UptimeCheckConfig|UptimeCheckConfig} 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 `listUptimeCheckConfigsAsync()`
     *   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.
     */
    listUptimeCheckConfigsStream(request?: protos.google.monitoring.v3.IListUptimeCheckConfigsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listUptimeCheckConfigs`, 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.parent
     *   Required. The
     *   [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
     *   Uptime check configurations are listed. The format is:
     *
     *       projects/[PROJECT_ID_OR_NUMBER]
     * @param {string} request.filter
     *   If provided, this field specifies the criteria that must be met by
     *   uptime checks to be included in the response.
     *
     *   For more details, see [Filtering
     *   syntax](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering#filter_syntax).
     * @param {number} request.pageSize
     *   The maximum number of results to return in a single response. The server
     *   may further constrain the maximum number of results returned in a single
     *   page. If the page_size is <=0, the server will decide the number of results
     *   to be returned.
     * @param {string} request.pageToken
     *   If this field is not empty then it must contain the `nextPageToken` value
     *   returned by a previous call to this method.  Using this field causes the
     *   method to return more 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.UptimeCheckConfig|UptimeCheckConfig}. 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/uptime_check_service.list_uptime_check_configs.js</caption>
     * region_tag:monitoring_v3_generated_UptimeCheckService_ListUptimeCheckConfigs_async
     */
    listUptimeCheckConfigsAsync(request?: protos.google.monitoring.v3.IListUptimeCheckConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.monitoring.v3.IUptimeCheckConfig>;
    /**
    * Returns the list of IP addresses that checkers run from.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {number} request.pageSize
    *   The maximum number of results to return in a single response. The server
    *   may further constrain the maximum number of results returned in a single
    *   page. If the page_size is <=0, the server will decide the number of results
    *   to be returned.
    *   NOTE: this field is not yet implemented
    * @param {string} request.pageToken
    *   If this field is not empty then it must contain the `nextPageToken` value
    *   returned by a previous call to this method.  Using this field causes the
    *   method to return more results from the previous method call.
    *   NOTE: this field is not yet implemented
    * @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.UptimeCheckIp|UptimeCheckIp}.
    *   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 `listUptimeCheckIpsAsync()`
    *   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.
    */
    listUptimeCheckIps(request?: protos.google.monitoring.v3.IListUptimeCheckIpsRequest, options?: CallOptions): Promise<[
        protos.google.monitoring.v3.IUptimeCheckIp[],
        protos.google.monitoring.v3.IListUptimeCheckIpsRequest | null,
        protos.google.monitoring.v3.IListUptimeCheckIpsResponse
    ]>;
    listUptimeCheckIps(request: protos.google.monitoring.v3.IListUptimeCheckIpsRequest, options: CallOptions, callback: PaginationCallback<protos.google.monitoring.v3.IListUptimeCheckIpsRequest, protos.google.monitoring.v3.IListUptimeCheckIpsResponse | null | undefined, protos.google.monitoring.v3.IUptimeCheckIp>): void;
    listUptimeCheckIps(request: protos.google.monitoring.v3.IListUptimeCheckIpsRequest, callback: PaginationCallback<protos.google.monitoring.v3.IListUptimeCheckIpsRequest, protos.google.monitoring.v3.IListUptimeCheckIpsResponse | null | undefined, protos.google.monitoring.v3.IUptimeCheckIp>): void;
    /**
     * Equivalent to `listUptimeCheckIps`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {number} request.pageSize
     *   The maximum number of results to return in a single response. The server
     *   may further constrain the maximum number of results returned in a single
     *   page. If the page_size is <=0, the server will decide the number of results
     *   to be returned.
     *   NOTE: this field is not yet implemented
     * @param {string} request.pageToken
     *   If this field is not empty then it must contain the `nextPageToken` value
     *   returned by a previous call to this method.  Using this field causes the
     *   method to return more results from the previous method call.
     *   NOTE: this field is not yet implemented
     * @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.UptimeCheckIp|UptimeCheckIp} 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 `listUptimeCheckIpsAsync()`
     *   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.
     */
    listUptimeCheckIpsStream(request?: protos.google.monitoring.v3.IListUptimeCheckIpsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listUptimeCheckIps`, 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 {number} request.pageSize
     *   The maximum number of results to return in a single response. The server
     *   may further constrain the maximum number of results returned in a single
     *   page. If the page_size is <=0, the server will decide the number of results
     *   to be returned.
     *   NOTE: this field is not yet implemented
     * @param {string} request.pageToken
     *   If this field is not empty then it must contain the `nextPageToken` value
     *   returned by a previous call to this method.  Using this field causes the
     *   method to return more results from the previous method call.
     *   NOTE: this field is not yet implemented
     * @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.UptimeCheckIp|UptimeCheckIp}. 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/uptime_check_service.list_uptime_check_ips.js</caption>
     * region_tag:monitoring_v3_generated_UptimeCheckService_ListUptimeCheckIps_async
     */
    listUptimeCheckIpsAsync(request?: protos.google.monitoring.v3.IListUptimeCheckIpsRequest, options?: CallOptions): AsyncIterable<protos.google.monitoring.v3.IUptimeCheckIp>;
    /**
     * 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 OrganizationServiceServiceLevelObjective resource.
     *
     * @param {string} organizationServiceServiceLevelObjectiveName
     *   A fully-qualified path representing organization_service_service_level_objective resource.
     * @returns {string} A string representing the service_level_objective.
     */
    matchServiceLevelObjectiveFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName: string): string | number;
    /**
     * Return a fully-qualified organizationUptimeCheckConfig resource name string.
     *
     * @param {string} organization
     * @param {string} uptime_check_config
     * @returns {string} Resource name string.
     */
    organizationUptimeCheckConfigPath(organization: string, uptimeCheckConfig: string): string;
    /**
     * Parse the organization from OrganizationUptimeCheckConfig resource.
     *
     * @param {string} organizationUptimeCheckConfigName
     *   A fully-qualified path representing organization_uptime_check_config resource.
     * @returns {string} A string representing the organization.
     */
    matchOrganizationFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName: string): string | number;
    /**
     * Parse the uptime_check_config from OrganizationUptimeCheckConfig resource.
     *
     * @param {string} organizationUptimeCheckConfigName
     *   A fully-qualified path representing organization_uptime_check_config resource.
     * @returns {string} A string representing the uptime_check_config.
     */
    matchUptimeCheckConfigFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName: string): string | number;
    /**
     * Return a fully-qualified project resource name string.
     *
     * @param {string} project
     * @returns {string} Resource name string.
     */