Class v3.UptimeCheckServiceClient (5.2.0)

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". v3

Package

@google-cloud/monitoring

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of UptimeCheckServiceClient.

Parameters
Name Description
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: 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); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

uptimeCheckServiceStub

uptimeCheckServiceStub?: Promise<{
        [name: string]: Function;
    }>;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createUptimeCheckConfig(request, options)

createUptimeCheckConfig(request?: protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest, options?: CallOptions): Promise<[
        protos.google.monitoring.v3.IUptimeCheckConfig,
        protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest | undefined,
        {} | undefined
    ]>;

Creates a new Uptime check configuration.

Parameters
Name Description
request ICreateUptimeCheckConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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]
   */
  // const parent = 'abc123'
  /**
   *  Required. The new Uptime check configuration.
   */
  // const uptimeCheckConfig = {}

  // Imports the Monitoring library
  const {UptimeCheckServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new UptimeCheckServiceClient();

  async function callCreateUptimeCheckConfig() {
    // Construct request
    const request = {
      parent,
      uptimeCheckConfig,
    };

    // Run request
    const response = await monitoringClient.createUptimeCheckConfig(request);
    console.log(response);
  }

  callCreateUptimeCheckConfig();

createUptimeCheckConfig(request, options, callback)

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;
Parameters
Name Description
request ICreateUptimeCheckConfigRequest
options CallOptions
callback Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createUptimeCheckConfig(request, callback)

createUptimeCheckConfig(request: protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest, callback: Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateUptimeCheckConfigRequest
callback Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.ICreateUptimeCheckConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteUptimeCheckConfig(request, options)

deleteUptimeCheckConfig(request?: protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest | undefined,
        {} | undefined
    ]>;

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.

Parameters
Name Description
request IDeleteUptimeCheckConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Uptime check configuration to delete. The format is:
   *      projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
   */
  // const name = 'abc123'

  // Imports the Monitoring library
  const {UptimeCheckServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new UptimeCheckServiceClient();

  async function callDeleteUptimeCheckConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await monitoringClient.deleteUptimeCheckConfig(request);
    console.log(response);
  }

  callDeleteUptimeCheckConfig();

deleteUptimeCheckConfig(request, options, callback)

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;
Parameters
Name Description
request IDeleteUptimeCheckConfigRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteUptimeCheckConfig(request, callback)

deleteUptimeCheckConfig(request: protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteUptimeCheckConfigRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.monitoring.v3.IDeleteUptimeCheckConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

folderAlertPolicyConditionPath(folder, alertPolicy, condition)

folderAlertPolicyConditionPath(folder: string, alertPolicy: string, condition: string): string;

Return a fully-qualified folderAlertPolicyCondition resource name string.

Parameters
Name Description
folder string
alertPolicy string
condition string
Returns
Type Description
string

{string} Resource name string.

folderAlertPolicyPath(folder, alertPolicy)

folderAlertPolicyPath(folder: string, alertPolicy: string): string;

Return a fully-qualified folderAlertPolicy resource name string.

Parameters
Name Description
folder string
alertPolicy string
Returns
Type Description
string

{string} Resource name string.

folderChannelDescriptorPath(folder, channelDescriptor)

folderChannelDescriptorPath(folder: string, channelDescriptor: string): string;

Return a fully-qualified folderChannelDescriptor resource name string.

Parameters
Name Description
folder string
channelDescriptor string
Returns
Type Description
string

{string} Resource name string.

folderGroupPath(folder, group)

folderGroupPath(folder: string, group: string): string;

Return a fully-qualified folderGroup resource name string.

Parameters
Name Description
folder string
group string
Returns
Type Description
string

{string} Resource name string.

folderNotificationChannelPath(folder, notificationChannel)

folderNotificationChannelPath(folder: string, notificationChannel: string): string;

Return a fully-qualified folderNotificationChannel resource name string.

Parameters
Name Description
folder string
notificationChannel string
Returns
Type Description
string

{string} Resource name string.

folderServicePath(folder, service)

folderServicePath(folder: string, service: string): string;

Return a fully-qualified folderService resource name string.

Parameters
Name Description
folder string
service string
Returns
Type Description
string

{string} Resource name string.

folderServiceServiceLevelObjectivePath(folder, service, serviceLevelObjective)

folderServiceServiceLevelObjectivePath(folder: string, service: string, serviceLevelObjective: string): string;

Return a fully-qualified folderServiceServiceLevelObjective resource name string.

Parameters
Name Description
folder string
service string
serviceLevelObjective string
Returns
Type Description
string

{string} Resource name string.

folderUptimeCheckConfigPath(folder, uptimeCheckConfig)

folderUptimeCheckConfigPath(folder: string, uptimeCheckConfig: string): string;

Return a fully-qualified folderUptimeCheckConfig resource name string.

Parameters
Name Description
folder string
uptimeCheckConfig string
Returns
Type Description
string

{string} Resource name string.

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

getUptimeCheckConfig(request, options)

getUptimeCheckConfig(request?: protos.google.monitoring.v3.IGetUptimeCheckConfigRequest, options?: CallOptions): Promise<[
        protos.google.monitoring.v3.IUptimeCheckConfig,
        protos.google.monitoring.v3.IGetUptimeCheckConfigRequest | undefined,
        {} | undefined
    ]>;

Gets a single Uptime check configuration.

Parameters
Name Description
request IGetUptimeCheckConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.IGetUptimeCheckConfigRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Uptime check configuration to retrieve. The format is:
   *      projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
   */
  // const name = 'abc123'

  // Imports the Monitoring library
  const {UptimeCheckServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new UptimeCheckServiceClient();

  async function callGetUptimeCheckConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await monitoringClient.getUptimeCheckConfig(request);
    console.log(response);
  }

  callGetUptimeCheckConfig();

getUptimeCheckConfig(request, options, callback)

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;
Parameters
Name Description
request IGetUptimeCheckConfigRequest
options CallOptions
callback Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.IGetUptimeCheckConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getUptimeCheckConfig(request, callback)

getUptimeCheckConfig(request: protos.google.monitoring.v3.IGetUptimeCheckConfigRequest, callback: Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.IGetUptimeCheckConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetUptimeCheckConfigRequest
callback Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.IGetUptimeCheckConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listUptimeCheckConfigs(request, options)

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
    ]>;

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

Parameters
Name Description
request IListUptimeCheckConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.monitoring.v3.IUptimeCheckConfig[], protos.google.monitoring.v3.IListUptimeCheckConfigsRequest | null, protos.google.monitoring.v3.IListUptimeCheckConfigsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 documentation for more details and examples.

listUptimeCheckConfigs(request, options, callback)

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;
Parameters
Name Description
request IListUptimeCheckConfigsRequest
options CallOptions
callback PaginationCallback<protos.google.monitoring.v3.IListUptimeCheckConfigsRequest, protos.google.monitoring.v3.IListUptimeCheckConfigsResponse | null | undefined, protos.google.monitoring.v3.IUptimeCheckConfig>
Returns
Type Description
void

listUptimeCheckConfigs(request, callback)

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;
Parameters
Name Description
request IListUptimeCheckConfigsRequest
callback PaginationCallback<protos.google.monitoring.v3.IListUptimeCheckConfigsRequest, protos.google.monitoring.v3.IListUptimeCheckConfigsResponse | null | undefined, protos.google.monitoring.v3.IUptimeCheckConfig>
Returns
Type Description
void

listUptimeCheckConfigsAsync(request, options)

listUptimeCheckConfigsAsync(request?: protos.google.monitoring.v3.IListUptimeCheckConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.monitoring.v3.IUptimeCheckConfig>;

Equivalent to listUptimeCheckConfigs, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListUptimeCheckConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.monitoring.v3.IUptimeCheckConfig>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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]
   */
  // const parent = 'abc123'
  /**
   *  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).
   */
  // const filter = 'abc123'
  /**
   *  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.="" */="" const="" pagesize="1234" *="" *="" 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.="" */="" const="" pagetoken='abc123' imports="" the="" monitoring="" library="" const="" {uptimecheckserviceclient}="require('@google-cloud/monitoring').v3;" instantiates="" a="" client="" const="" monitoringclient="new" uptimecheckserviceclient();="" async="" function="" calllistuptimecheckconfigs()="" {="" construct="" request="" const="" request="{" parent,="" };="" run="" request="" const="" iterable="monitoringClient.listUptimeCheckConfigsAsync(request);" for="" await="" (const="" response="" of="" iterable)="" {="" console.log(response);="" }="" }="" calllistuptimecheckconfigs();="">

listUptimeCheckConfigsStream(request, options)

listUptimeCheckConfigsStream(request?: protos.google.monitoring.v3.IListUptimeCheckConfigsRequest, options?: CallOptions): Transform;

Equivalent to listUptimeCheckConfigs, but returns a NodeJS Stream object.

Parameters
Name Description
request IListUptimeCheckConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing 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 documentation for more details and examples.

listUptimeCheckIps(request, options)

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
    ]>;

Returns the list of IP addresses that checkers run from.

Parameters
Name Description
request IListUptimeCheckIpsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.monitoring.v3.IUptimeCheckIp[], protos.google.monitoring.v3.IListUptimeCheckIpsRequest | null, protos.google.monitoring.v3.IListUptimeCheckIpsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of 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 documentation for more details and examples.

listUptimeCheckIps(request, options, callback)

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;
Parameters
Name Description
request IListUptimeCheckIpsRequest
options CallOptions
callback PaginationCallback<protos.google.monitoring.v3.IListUptimeCheckIpsRequest, protos.google.monitoring.v3.IListUptimeCheckIpsResponse | null | undefined, protos.google.monitoring.v3.IUptimeCheckIp>
Returns
Type Description
void

listUptimeCheckIps(request, callback)

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;
Parameters
Name Description
request IListUptimeCheckIpsRequest
callback PaginationCallback<protos.google.monitoring.v3.IListUptimeCheckIpsRequest, protos.google.monitoring.v3.IListUptimeCheckIpsResponse | null | undefined, protos.google.monitoring.v3.IUptimeCheckIp>
Returns
Type Description
void

listUptimeCheckIpsAsync(request, options)

listUptimeCheckIpsAsync(request?: protos.google.monitoring.v3.IListUptimeCheckIpsRequest, options?: CallOptions): AsyncIterable<protos.google.monitoring.v3.IUptimeCheckIp>;

Equivalent to listUptimeCheckIps, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListUptimeCheckIpsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.monitoring.v3.IUptimeCheckIp>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing 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 documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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="" */="" const="" pagesize="1234" *="" *="" 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="" */="" const="" pagetoken='abc123' imports="" the="" monitoring="" library="" const="" {uptimecheckserviceclient}="require('@google-cloud/monitoring').v3;" instantiates="" a="" client="" const="" monitoringclient="new" uptimecheckserviceclient();="" async="" function="" calllistuptimecheckips()="" {="" construct="" request="" const="" request="{" };="" run="" request="" const="" iterable="monitoringClient.listUptimeCheckIpsAsync(request);" for="" await="" (const="" response="" of="" iterable)="" {="" console.log(response);="" }="" }="" calllistuptimecheckips();="">

listUptimeCheckIpsStream(request, options)

listUptimeCheckIpsStream(request?: protos.google.monitoring.v3.IListUptimeCheckIpsRequest, options?: CallOptions): Transform;

Equivalent to listUptimeCheckIps, but returns a NodeJS Stream object.

Parameters
Name Description
request IListUptimeCheckIpsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing 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 documentation for more details and examples.

matchAlertPolicyFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName)

matchAlertPolicyFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName: string): string | number;

Parse the alert_policy from FolderAlertPolicyCondition resource.

Parameter
Name Description
folderAlertPolicyConditionName string

A fully-qualified path representing folder_alert_policy_condition resource.
Returns
Type Description
string | number

{string} A string representing the alert_policy.

matchAlertPolicyFromFolderAlertPolicyName(folderAlertPolicyName)

matchAlertPolicyFromFolderAlertPolicyName(folderAlertPolicyName: string): string | number;

Parse the alert_policy from FolderAlertPolicy resource.

Parameter
Name Description
folderAlertPolicyName string

A fully-qualified path representing folder_alert_policy resource.
Returns
Type Description
string | number

{string} A string representing the alert_policy.

matchAlertPolicyFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName)

matchAlertPolicyFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName: string): string | number;

Parse the alert_policy from OrganizationAlertPolicyCondition resource.

Parameter
Name Description
organizationAlertPolicyConditionName string

A fully-qualified path representing organization_alert_policy_condition resource.
Returns
Type Description
string | number

{string} A string representing the alert_policy.

matchAlertPolicyFromOrganizationAlertPolicyName(organizationAlertPolicyName)

matchAlertPolicyFromOrganizationAlertPolicyName(organizationAlertPolicyName: string): string | number;

Parse the alert_policy from OrganizationAlertPolicy resource.

Parameter
Name Description
organizationAlertPolicyName string

A fully-qualified path representing organization_alert_policy resource.
Returns
Type Description
string | number

{string} A string representing the alert_policy.

matchAlertPolicyFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName)

matchAlertPolicyFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName: string): string | number;

Parse the alert_policy from ProjectAlertPolicyCondition resource.

Parameter
Name Description
projectAlertPolicyConditionName string

A fully-qualified path representing project_alert_policy_condition resource.
Returns
Type Description
string | number

{string} A string representing the alert_policy.

matchAlertPolicyFromProjectAlertPolicyName(projectAlertPolicyName)

matchAlertPolicyFromProjectAlertPolicyName(projectAlertPolicyName: string): string | number;

Parse the alert_policy from ProjectAlertPolicy resource.

Parameter
Name Description
projectAlertPolicyName string

A fully-qualified path representing project_alert_policy resource.
Returns
Type Description
string | number

{string} A string representing the alert_policy.

matchChannelDescriptorFromFolderChannelDescriptorName(folderChannelDescriptorName)

matchChannelDescriptorFromFolderChannelDescriptorName(folderChannelDescriptorName: string): string | number;

Parse the channel_descriptor from FolderChannelDescriptor resource.

Parameter
Name Description
folderChannelDescriptorName string

A fully-qualified path representing folder_channel_descriptor resource.
Returns
Type Description
string | number

{string} A string representing the channel_descriptor.

matchChannelDescriptorFromOrganizationChannelDescriptorName(organizationChannelDescriptorName)

matchChannelDescriptorFromOrganizationChannelDescriptorName(organizationChannelDescriptorName: string): string | number;

Parse the channel_descriptor from OrganizationChannelDescriptor resource.

Parameter
Name Description
organizationChannelDescriptorName string

A fully-qualified path representing organization_channel_descriptor resource.
Returns
Type Description
string | number

{string} A string representing the channel_descriptor.

matchChannelDescriptorFromProjectChannelDescriptorName(projectChannelDescriptorName)

matchChannelDescriptorFromProjectChannelDescriptorName(projectChannelDescriptorName: string): string | number;

Parse the channel_descriptor from ProjectChannelDescriptor resource.

Parameter
Name Description
projectChannelDescriptorName string

A fully-qualified path representing project_channel_descriptor resource.
Returns
Type Description
string | number

{string} A string representing the channel_descriptor.

matchConditionFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName)

matchConditionFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName: string): string | number;

Parse the condition from FolderAlertPolicyCondition resource.

Parameter
Name Description
folderAlertPolicyConditionName string

A fully-qualified path representing folder_alert_policy_condition resource.
Returns
Type Description
string | number

{string} A string representing the condition.

matchConditionFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName)

matchConditionFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName: string): string | number;

Parse the condition from OrganizationAlertPolicyCondition resource.

Parameter
Name Description
organizationAlertPolicyConditionName string

A fully-qualified path representing organization_alert_policy_condition resource.
Returns
Type Description
string | number

{string} A string representing the condition.

matchConditionFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName)

matchConditionFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName: string): string | number;

Parse the condition from ProjectAlertPolicyCondition resource.

Parameter
Name Description
projectAlertPolicyConditionName string

A fully-qualified path representing project_alert_policy_condition resource.
Returns
Type Description
string | number

{string} A string representing the condition.

matchFolderFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName)

matchFolderFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName: string): string | number;

Parse the folder from FolderAlertPolicyCondition resource.

Parameter
Name Description
folderAlertPolicyConditionName string

A fully-qualified path representing folder_alert_policy_condition resource.
Returns
Type Description
string | number

{string} A string representing the folder.

matchFolderFromFolderAlertPolicyName(folderAlertPolicyName)

matchFolderFromFolderAlertPolicyName(folderAlertPolicyName: string): string | number;

Parse the folder from FolderAlertPolicy resource.

Parameter
Name Description
folderAlertPolicyName string

A fully-qualified path representing folder_alert_policy resource.
Returns
Type Description
string | number

{string} A string representing the folder.

matchFolderFromFolderChannelDescriptorName(folderChannelDescriptorName)

matchFolderFromFolderChannelDescriptorName(folderChannelDescriptorName: string): string | number;

Parse the folder from FolderChannelDescriptor resource.

Parameter
Name Description
folderChannelDescriptorName string

A fully-qualified path representing folder_channel_descriptor resource.
Returns
Type Description
string | number

{string} A string representing the folder.

matchFolderFromFolderGroupName(folderGroupName)

matchFolderFromFolderGroupName(folderGroupName: string): string | number;

Parse the folder from FolderGroup resource.

Parameter
Name Description
folderGroupName string

A fully-qualified path representing folder_group resource.
Returns
Type Description
string | number

{string} A string representing the folder.

matchFolderFromFolderNotificationChannelName(folderNotificationChannelName)

matchFolderFromFolderNotificationChannelName(folderNotificationChannelName: string): string | number;

Parse the folder from FolderNotificationChannel resource.

Parameter
Name Description
folderNotificationChannelName string

A fully-qualified path representing folder_notification_channel resource.
Returns
Type Description
string | number

{string} A string representing the folder.

matchFolderFromFolderServiceName(folderServiceName)

matchFolderFromFolderServiceName(folderServiceName: string): string | number;

Parse the folder from FolderService resource.

Parameter
Name Description
folderServiceName string

A fully-qualified path representing folder_service resource.
Returns
Type Description
string | number

{string} A string representing the folder.

matchFolderFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName)

matchFolderFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName: string): string | number;

Parse the folder from FolderServiceServiceLevelObjective resource.

Parameter
Name Description
folderServiceServiceLevelObjectiveName string

A fully-qualified path representing folder_service_service_level_objective resource.
Returns
Type Description
string | number

{string} A string representing the folder.

matchFolderFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName)

matchFolderFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName: string): string | number;

Parse the folder from FolderUptimeCheckConfig resource.

Parameter
Name Description
folderUptimeCheckConfigName string

A fully-qualified path representing folder_uptime_check_config resource.
Returns
Type Description
string | number

{string} A string representing the folder.

matchGroupFromFolderGroupName(folderGroupName)

matchGroupFromFolderGroupName(folderGroupName: string): string | number;

Parse the group from FolderGroup resource.

Parameter
Name Description
folderGroupName string

A fully-qualified path representing folder_group resource.
Returns
Type Description
string | number

{string} A string representing the group.

matchGroupFromOrganizationGroupName(organizationGroupName)

matchGroupFromOrganizationGroupName(organizationGroupName: string): string | number;

Parse the group from OrganizationGroup resource.

Parameter
Name Description
organizationGroupName string

A fully-qualified path representing organization_group resource.
Returns
Type Description
string | number

{string} A string representing the group.

matchGroupFromProjectGroupName(projectGroupName)

matchGroupFromProjectGroupName(projectGroupName: string): string | number;

Parse the group from ProjectGroup resource.

Parameter
Name Description
projectGroupName string

A fully-qualified path representing project_group resource.
Returns
Type Description
string | number

{string} A string representing the group.

matchNotificationChannelFromFolderNotificationChannelName(folderNotificationChannelName)

matchNotificationChannelFromFolderNotificationChannelName(folderNotificationChannelName: string): string | number;

Parse the notification_channel from FolderNotificationChannel resource.

Parameter
Name Description
folderNotificationChannelName string

A fully-qualified path representing folder_notification_channel resource.
Returns
Type Description
string | number

{string} A string representing the notification_channel.

matchNotificationChannelFromOrganizationNotificationChannelName(organizationNotificationChannelName)

matchNotificationChannelFromOrganizationNotificationChannelName(organizationNotificationChannelName: string): string | number;

Parse the notification_channel from OrganizationNotificationChannel resource.

Parameter
Name Description
organizationNotificationChannelName string

A fully-qualified path representing organization_notification_channel resource.
Returns
Type Description
string | number

{string} A string representing the notification_channel.

matchNotificationChannelFromProjectNotificationChannelName(projectNotificationChannelName)

matchNotificationChannelFromProjectNotificationChannelName(projectNotificationChannelName: string): string | number;

Parse the notification_channel from ProjectNotificationChannel resource.

Parameter
Name Description
projectNotificationChannelName string

A fully-qualified path representing project_notification_channel resource.
Returns
Type Description
string | number

{string} A string representing the notification_channel.

matchOrganizationFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName)

matchOrganizationFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName: string): string | number;

Parse the organization from OrganizationAlertPolicyCondition resource.

Parameter
Name Description
organizationAlertPolicyConditionName string

A fully-qualified path representing organization_alert_policy_condition resource.
Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationAlertPolicyName(organizationAlertPolicyName)

matchOrganizationFromOrganizationAlertPolicyName(organizationAlertPolicyName: string): string | number;

Parse the organization from OrganizationAlertPolicy resource.

Parameter
Name Description
organizationAlertPolicyName string

A fully-qualified path representing organization_alert_policy resource.
Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationChannelDescriptorName(organizationChannelDescriptorName)

matchOrganizationFromOrganizationChannelDescriptorName(organizationChannelDescriptorName: string): string | number;

Parse the organization from OrganizationChannelDescriptor resource.

Parameter
Name Description
organizationChannelDescriptorName string

A fully-qualified path representing organization_channel_descriptor resource.
Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationGroupName(organizationGroupName)

matchOrganizationFromOrganizationGroupName(organizationGroupName: string): string | number;

Parse the organization from OrganizationGroup resource.

Parameter
Name Description
organizationGroupName string

A fully-qualified path representing organization_group resource.
Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationNotificationChannelName(organizationNotificationChannelName)

matchOrganizationFromOrganizationNotificationChannelName(organizationNotificationChannelName: string): string | number;

Parse the organization from OrganizationNotificationChannel resource.

Parameter
Name Description
organizationNotificationChannelName string

A fully-qualified path representing organization_notification_channel resource.
Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationServiceName(organizationServiceName)

matchOrganizationFromOrganizationServiceName(organizationServiceName: string): string | number;

Parse the organization from OrganizationService resource.

Parameter
Name Description
organizationServiceName string

A fully-qualified path representing organization_service resource.
Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName)

matchOrganizationFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName: string): string | number;

Parse the organization from OrganizationServiceServiceLevelObjective resource.

Parameter
Name Description
organizationServiceServiceLevelObjectiveName string

A fully-qualified path representing organization_service_service_level_objective resource.
Returns
Type Description
string | number

{string} A string representing the organization.

matchOrganizationFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName)

matchOrganizationFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName: string): string | number;

Parse the organization from OrganizationUptimeCheckConfig resource.

Parameter
Name Description
organizationUptimeCheckConfigName string

A fully-qualified path representing organization_uptime_check_config resource.
Returns
Type Description
string | number

{string} A string representing the organization.

matchProjectFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName)

matchProjectFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName: string): string | number;

Parse the project from ProjectAlertPolicyCondition resource.

Parameter
Name Description
projectAlertPolicyConditionName string

A fully-qualified path representing project_alert_policy_condition resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectAlertPolicyName(projectAlertPolicyName)

matchProjectFromProjectAlertPolicyName(projectAlertPolicyName: string): string | number;

Parse the project from ProjectAlertPolicy resource.

Parameter
Name Description
projectAlertPolicyName string

A fully-qualified path representing project_alert_policy resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectChannelDescriptorName(projectChannelDescriptorName)

matchProjectFromProjectChannelDescriptorName(projectChannelDescriptorName: string): string | number;

Parse the project from ProjectChannelDescriptor resource.

Parameter
Name Description
projectChannelDescriptorName string

A fully-qualified path representing project_channel_descriptor resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectGroupName(projectGroupName)

matchProjectFromProjectGroupName(projectGroupName: string): string | number;

Parse the project from ProjectGroup resource.

Parameter
Name Description
projectGroupName string

A fully-qualified path representing project_group resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectNotificationChannelName(projectNotificationChannelName)

matchProjectFromProjectNotificationChannelName(projectNotificationChannelName: string): string | number;

Parse the project from ProjectNotificationChannel resource.

Parameter
Name Description
projectNotificationChannelName string

A fully-qualified path representing project_notification_channel resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectServiceName(projectServiceName)

matchProjectFromProjectServiceName(projectServiceName: string): string | number;

Parse the project from ProjectService resource.

Parameter
Name Description
projectServiceName string

A fully-qualified path representing project_service resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName)

matchProjectFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName: string): string | number;

Parse the project from ProjectServiceServiceLevelObjective resource.

Parameter
Name Description
projectServiceServiceLevelObjectiveName string

A fully-qualified path representing project_service_service_level_objective resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName)

matchProjectFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName: string): string | number;

Parse the project from ProjectUptimeCheckConfig resource.

Parameter
Name Description
projectUptimeCheckConfigName string

A fully-qualified path representing project_uptime_check_config resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromSnoozeName(snoozeName)

matchProjectFromSnoozeName(snoozeName: string): string | number;

Parse the project from Snooze resource.

Parameter
Name Description
snoozeName string

A fully-qualified path representing Snooze resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchServiceFromFolderServiceName(folderServiceName)

matchServiceFromFolderServiceName(folderServiceName: string): string | number;

Parse the service from FolderService resource.

Parameter
Name Description
folderServiceName string

A fully-qualified path representing folder_service resource.
Returns
Type Description
string | number

{string} A string representing the service.

matchServiceFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName)

matchServiceFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName: string): string | number;

Parse the service from FolderServiceServiceLevelObjective resource.

Parameter
Name Description
folderServiceServiceLevelObjectiveName string

A fully-qualified path representing folder_service_service_level_objective resource.
Returns
Type Description
string | number

{string} A string representing the service.

matchServiceFromOrganizationServiceName(organizationServiceName)

matchServiceFromOrganizationServiceName(organizationServiceName: string): string | number;

Parse the service from OrganizationService resource.

Parameter
Name Description
organizationServiceName string

A fully-qualified path representing organization_service resource.
Returns
Type Description
string | number

{string} A string representing the service.

matchServiceFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName)

matchServiceFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName: string): string | number;

Parse the service from OrganizationServiceServiceLevelObjective resource.

Parameter
Name Description
organizationServiceServiceLevelObjectiveName string

A fully-qualified path representing organization_service_service_level_objective resource.
Returns
Type Description
string | number

{string} A string representing the service.

matchServiceFromProjectServiceName(projectServiceName)

matchServiceFromProjectServiceName(projectServiceName: string): string | number;

Parse the service from ProjectService resource.

Parameter
Name Description
projectServiceName string

A fully-qualified path representing project_service resource.
Returns
Type Description
string | number

{string} A string representing the service.

matchServiceFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName)

matchServiceFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName: string): string | number;

Parse the service from ProjectServiceServiceLevelObjective resource.

Parameter
Name Description
projectServiceServiceLevelObjectiveName string

A fully-qualified path representing project_service_service_level_objective resource.
Returns
Type Description
string | number

{string} A string representing the service.

matchServiceLevelObjectiveFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName)

matchServiceLevelObjectiveFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName: string): string | number;

Parse the service_level_objective from FolderServiceServiceLevelObjective resource.

Parameter
Name Description
folderServiceServiceLevelObjectiveName string

A fully-qualified path representing folder_service_service_level_objective resource.
Returns
Type Description
string | number

{string} A string representing the service_level_objective.

matchServiceLevelObjectiveFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName)

matchServiceLevelObjectiveFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName: string): string | number;

Parse the service_level_objective from OrganizationServiceServiceLevelObjective resource.

Parameter
Name Description
organizationServiceServiceLevelObjectiveName string

A fully-qualified path representing organization_service_service_level_objective resource.
Returns
Type Description
string | number

{string} A string representing the service_level_objective.

matchServiceLevelObjectiveFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName)

matchServiceLevelObjectiveFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName: string): string | number;

Parse the service_level_objective from ProjectServiceServiceLevelObjective resource.

Parameter
Name Description
projectServiceServiceLevelObjectiveName string

A fully-qualified path representing project_service_service_level_objective resource.
Returns
Type Description
string | number

{string} A string representing the service_level_objective.

matchSnoozeFromSnoozeName(snoozeName)

matchSnoozeFromSnoozeName(snoozeName: string): string | number;

Parse the snooze from Snooze resource.

Parameter
Name Description
snoozeName string

A fully-qualified path representing Snooze resource.
Returns
Type Description
string | number

{string} A string representing the snooze.

matchUptimeCheckConfigFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName)

matchUptimeCheckConfigFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName: string): string | number;

Parse the uptime_check_config from FolderUptimeCheckConfig resource.

Parameter
Name Description
folderUptimeCheckConfigName string

A fully-qualified path representing folder_uptime_check_config resource.
Returns
Type Description
string | number

{string} A string representing the uptime_check_config.

matchUptimeCheckConfigFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName)

matchUptimeCheckConfigFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName: string): string | number;

Parse the uptime_check_config from OrganizationUptimeCheckConfig resource.

Parameter
Name Description
organizationUptimeCheckConfigName string

A fully-qualified path representing organization_uptime_check_config resource.
Returns
Type Description
string | number

{string} A string representing the uptime_check_config.

matchUptimeCheckConfigFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName)

matchUptimeCheckConfigFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName: string): string | number;

Parse the uptime_check_config from ProjectUptimeCheckConfig resource.

Parameter
Name Description
projectUptimeCheckConfigName string

A fully-qualified path representing project_uptime_check_config resource.
Returns
Type Description
string | number

{string} A string representing the uptime_check_config.

organizationAlertPolicyConditionPath(organization, alertPolicy, condition)

organizationAlertPolicyConditionPath(organization: string, alertPolicy: string, condition: string): string;

Return a fully-qualified organizationAlertPolicyCondition resource name string.

Parameters
Name Description
organization string
alertPolicy string
condition string
Returns
Type Description
string

{string} Resource name string.

organizationAlertPolicyPath(organization, alertPolicy)

organizationAlertPolicyPath(organization: string, alertPolicy: string): string;

Return a fully-qualified organizationAlertPolicy resource name string.

Parameters
Name Description
organization string
alertPolicy string
Returns
Type Description
string

{string} Resource name string.

organizationChannelDescriptorPath(organization, channelDescriptor)

organizationChannelDescriptorPath(organization: string, channelDescriptor: string): string;

Return a fully-qualified organizationChannelDescriptor resource name string.

Parameters
Name Description
organization string
channelDescriptor string
Returns
Type Description
string

{string} Resource name string.

organizationGroupPath(organization, group)

organizationGroupPath(organization: string, group: string): string;

Return a fully-qualified organizationGroup resource name string.

Parameters
Name Description
organization string
group string
Returns
Type Description
string

{string} Resource name string.

organizationNotificationChannelPath(organization, notificationChannel)

organizationNotificationChannelPath(organization: string, notificationChannel: string): string;

Return a fully-qualified organizationNotificationChannel resource name string.

Parameters
Name Description
organization string
notificationChannel string
Returns
Type Description
string

{string} Resource name string.

organizationServicePath(organization, service)

organizationServicePath(organization: string, service: string): string;

Return a fully-qualified organizationService resource name string.

Parameters
Name Description
organization string
service string
Returns
Type Description
string

{string} Resource name string.

organizationServiceServiceLevelObjectivePath(organization, service, serviceLevelObjective)

organizationServiceServiceLevelObjectivePath(organization: string, service: string, serviceLevelObjective: string): string;

Return a fully-qualified organizationServiceServiceLevelObjective resource name string.

Parameters
Name Description
organization string
service string
serviceLevelObjective string
Returns
Type Description
string

{string} Resource name string.

organizationUptimeCheckConfigPath(organization, uptimeCheckConfig)

organizationUptimeCheckConfigPath(organization: string, uptimeCheckConfig: string): string;

Return a fully-qualified organizationUptimeCheckConfig resource name string.

Parameters
Name Description
organization string
uptimeCheckConfig string
Returns
Type Description
string

{string} Resource name string.

projectAlertPolicyConditionPath(project, alertPolicy, condition)

projectAlertPolicyConditionPath(project: string, alertPolicy: string, condition: string): string;

Return a fully-qualified projectAlertPolicyCondition resource name string.

Parameters
Name Description
project string
alertPolicy string
condition string
Returns
Type Description
string

{string} Resource name string.

projectAlertPolicyPath(project, alertPolicy)

projectAlertPolicyPath(project: string, alertPolicy: string): string;

Return a fully-qualified projectAlertPolicy resource name string.

Parameters
Name Description
project string
alertPolicy string
Returns
Type Description
string

{string} Resource name string.

projectChannelDescriptorPath(project, channelDescriptor)

projectChannelDescriptorPath(project: string, channelDescriptor: string): string;

Return a fully-qualified projectChannelDescriptor resource name string.

Parameters
Name Description
project string
channelDescriptor string
Returns
Type Description
string

{string} Resource name string.

projectGroupPath(project, group)

projectGroupPath(project: string, group: string): string;

Return a fully-qualified projectGroup resource name string.

Parameters
Name Description
project string
group string
Returns
Type Description
string

{string} Resource name string.

projectNotificationChannelPath(project, notificationChannel)

projectNotificationChannelPath(project: string, notificationChannel: string): string;

Return a fully-qualified projectNotificationChannel resource name string.

Parameters
Name Description
project string
notificationChannel string
Returns
Type Description
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

projectServicePath(project, service)

projectServicePath(project: string, service: string): string;

Return a fully-qualified projectService resource name string.

Parameters
Name Description
project string
service string
Returns
Type Description
string

{string} Resource name string.

projectServiceServiceLevelObjectivePath(project, service, serviceLevelObjective)

projectServiceServiceLevelObjectivePath(project: string, service: string, serviceLevelObjective: string): string;

Return a fully-qualified projectServiceServiceLevelObjective resource name string.

Parameters
Name Description
project string
service string
serviceLevelObjective string
Returns
Type Description
string

{string} Resource name string.

projectUptimeCheckConfigPath(project, uptimeCheckConfig)

projectUptimeCheckConfigPath(project: string, uptimeCheckConfig: string): string;

Return a fully-qualified projectUptimeCheckConfig resource name string.

Parameters
Name Description
project string
uptimeCheckConfig string
Returns
Type Description
string

{string} Resource name string.

snoozePath(project, snooze)

snoozePath(project: string, snooze: string): string;

Return a fully-qualified snooze resource name string.

Parameters
Name Description
project string
snooze string
Returns
Type Description
string

{string} Resource name string.

updateUptimeCheckConfig(request, options)

updateUptimeCheckConfig(request?: protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest, options?: CallOptions): Promise<[
        protos.google.monitoring.v3.IUptimeCheckConfig,
        protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest | undefined,
        {} | undefined
    ]>;

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.

Parameters
Name Description
request IUpdateUptimeCheckConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const updateMask = {}
  /**
   *  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`.
   */
  // const uptimeCheckConfig = {}

  // Imports the Monitoring library
  const {UptimeCheckServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new UptimeCheckServiceClient();

  async function callUpdateUptimeCheckConfig() {
    // Construct request
    const request = {
      uptimeCheckConfig,
    };

    // Run request
    const response = await monitoringClient.updateUptimeCheckConfig(request);
    console.log(response);
  }

  callUpdateUptimeCheckConfig();

updateUptimeCheckConfig(request, options, callback)

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;
Parameters
Name Description
request IUpdateUptimeCheckConfigRequest
options CallOptions
callback Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateUptimeCheckConfig(request, callback)

updateUptimeCheckConfig(request: protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest, callback: Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateUptimeCheckConfigRequest
callback Callback<protos.google.monitoring.v3.IUptimeCheckConfig, protos.google.monitoring.v3.IUpdateUptimeCheckConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void