ServiceMonitoringServiceClient

The Cloud Monitoring Service-Oriented Monitoring API has endpoints for managing and querying aspects of a workspace's services. These include the Service's monitored resources, its Service-Level Objectives, and a taxonomy of categorized Health Metrics.

Constructor

new ServiceMonitoringServiceClient(optionsopt)

Construct an instance of ServiceMonitoringServiceClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

close() → {Promise}

Terminate the gRPC channel and close the client.

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

Returns:

Type	Description
Promise	A promise that resolves when the client is closed.

createService(request, optionsopt) → {Promise}

Create a Service.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Resource name of the parent workspace. The format is:

  projects/[PROJECT_ID_OR_NUMBER]

serviceId

string

Optional. The Service id to use for this Service. If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+

service

google.monitoring.v3.Service

Required. The Service to create.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Service. Please see the documentation for more details and examples.

Example

const [response] = await client.createService(request);

createServiceLevelObjective(request, optionsopt) → {Promise}

Create a ServiceLevelObjective for the given Service.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Resource name of the parent Service. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

serviceLevelObjectiveId

string

Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective. If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+

serviceLevelObjective

google.monitoring.v3.ServiceLevelObjective

Required. The ServiceLevelObjective to create. The provided name will be respected if no ServiceLevelObjective exists with this name.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing ServiceLevelObjective. Please see the documentation for more details and examples.

Example

const [response] = await client.createServiceLevelObjective(request);

deleteService(request, optionsopt) → {Promise}

Soft delete this Service.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

name

string

Required. Resource name of the Service to delete. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

options

object

Call options. See CallOptions for more details.

Returns:

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

Example

const [response] = await client.deleteService(request);

deleteServiceLevelObjective(request, optionsopt) → {Promise}

Delete the given ServiceLevelObjective.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

name

string

Required. Resource name of the ServiceLevelObjective to delete. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

options

object

Call options. See CallOptions for more details.

Returns:

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

Example

const [response] = await client.deleteServiceLevelObjective(request);

folderAlertPolicyConditionPath(folder, alert_policy, condition) → {string}

Return a fully-qualified folderAlertPolicyCondition resource name string.

Parameters:

Name	Type	Description
`folder`	string
`alert_policy`	string
`condition`	string

Returns:

Type	Description
string	Resource name string.

folderAlertPolicyPath(folder, alert_policy) → {string}

Return a fully-qualified folderAlertPolicy resource name string.

Parameters:

Name	Type	Description
`folder`	string
`alert_policy`	string

Returns:

Type	Description
string	Resource name string.

folderChannelDescriptorPath(folder, channel_descriptor) → {string}

Return a fully-qualified folderChannelDescriptor resource name string.

Parameters:

Name	Type	Description
`folder`	string
`channel_descriptor`	string

Returns:

Type	Description
string	Resource name string.

folderGroupPath(folder, group) → {string}

Return a fully-qualified folderGroup resource name string.

Parameters:

Name	Type	Description
`folder`	string
`group`	string

Returns:

Type	Description
string	Resource name string.

folderNotificationChannelPath(folder, notification_channel) → {string}

Return a fully-qualified folderNotificationChannel resource name string.

Parameters:

Name	Type	Description
`folder`	string
`notification_channel`	string

Returns:

Type	Description
string	Resource name string.

folderServicePath(folder, service) → {string}

Return a fully-qualified folderService resource name string.

Parameters:

Name	Type	Description
`folder`	string
`service`	string

Returns:

Type	Description
string	Resource name string.

folderServiceServiceLevelObjectivePath(folder, service, service_level_objective) → {string}

Return a fully-qualified folderServiceServiceLevelObjective resource name string.

Parameters:

Name	Type	Description
`folder`	string
`service`	string
`service_level_objective`	string

Returns:

Type	Description
string	Resource name string.

folderUptimeCheckConfigPath(folder, uptime_check_config) → {string}

Return a fully-qualified folderUptimeCheckConfig resource name string.

Parameters:

Name	Type	Description
`folder`	string
`uptime_check_config`	string

Returns:

Type	Description
string	Resource name string.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

getService(request, optionsopt) → {Promise}

Get the named Service.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

name

string

Required. Resource name of the Service. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Service. Please see the documentation for more details and examples.

Example

const [response] = await client.getService(request);

getServiceLevelObjective(request, optionsopt) → {Promise}

Get a ServiceLevelObjective by name.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

name

string

Required. Resource name of the ServiceLevelObjective to get. The format is:

  projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

view

google.monitoring.v3.ServiceLevelObjective.View

View of the ServiceLevelObjective to return. If DEFAULT, return the ServiceLevelObjective as originally defined. If EXPLICIT and the ServiceLevelObjective is defined in terms of a BasicSli, replace the BasicSli with a RequestBasedSli spelling out how the SLI is computed.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing ServiceLevelObjective. Please see the documentation for more details and examples.

Example

const [response] = await client.getServiceLevelObjective(request);

initialize() → {Promise}

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

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

Returns:

Type	Description
Promise	A promise that resolves to an authenticated service stub.

listServiceLevelObjectives(request, optionsopt) → {Promise}

List the ServiceLevelObjectives for the given Service.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Workspace. The formats are: `projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-`
`filter`	string	A filter specifying what `ServiceLevelObjective`s to return.
`pageSize`	number	A non-negative number that is the maximum number of results to return. When 0, use default page size.
`pageToken`	string	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 additional results from the previous method call.
`view`	google.monitoring.v3.ServiceLevelObjective.View	View of the `ServiceLevelObjective`s to return. If `DEFAULT`, return each `ServiceLevelObjective` as originally defined. If `EXPLICIT` and the `ServiceLevelObjective` is defined in terms of a `BasicSli`, replace the `BasicSli` with a `RequestBasedSli` spelling out how the SLI is computed.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Type	Description
Promise	The promise which resolves to an array. The first element of the array is Array of ServiceLevelObjective. 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 `listServiceLevelObjectivesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

Promise

The promise which resolves to an array. The first element of the array is Array of ServiceLevelObjective. 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 listServiceLevelObjectivesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listServiceLevelObjectivesAsync(request, optionsopt) → {Object}

Equivalent to listServiceLevelObjectives, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Workspace. The formats are: `projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-`
`filter`	string	A filter specifying what `ServiceLevelObjective`s to return.
`pageSize`	number	A non-negative number that is the maximum number of results to return. When 0, use default page size.
`pageToken`	string	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 additional results from the previous method call.
`view`	google.monitoring.v3.ServiceLevelObjective.View	View of the `ServiceLevelObjective`s to return. If `DEFAULT`, return each `ServiceLevelObjective` as originally defined. If `EXPLICIT` and the `ServiceLevelObjective` is defined in terms of a `BasicSli`, replace the `BasicSli` with a `RequestBasedSli` spelling out how the SLI is computed.

options

object

Call options. See CallOptions for more details.

Returns:

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

Example

const iterable = client.listServiceLevelObjectivesAsync(request);
for await (const response of iterable) {
  // process response
}

listServiceLevelObjectivesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Workspace. The formats are: `projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-`
`filter`	string	A filter specifying what `ServiceLevelObjective`s to return.
`pageSize`	number	A non-negative number that is the maximum number of results to return. When 0, use default page size.
`pageToken`	string	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 additional results from the previous method call.
`view`	google.monitoring.v3.ServiceLevelObjective.View	View of the `ServiceLevelObjective`s to return. If `DEFAULT`, return each `ServiceLevelObjective` as originally defined. If `EXPLICIT` and the `ServiceLevelObjective` is defined in terms of a `BasicSli`, replace the `BasicSli` with a `RequestBasedSli` spelling out how the SLI is computed.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

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

Stream

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

listServices(request, optionsopt) → {Promise}

List Services for this workspace.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. Resource name of the parent containing the listed services, either a project or a Monitoring Workspace. The formats are: `projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]`
`filter`	string	A filter specifying what `Service`s to return. The filter currently supports the following fields: - `identifier_case` - `app_engine.module_id` - `cloud_endpoints.service` (reserved for future use) - `mesh_istio.mesh_uid` - `mesh_istio.service_namespace` - `mesh_istio.service_name` - `cluster_istio.location` (deprecated) - `cluster_istio.cluster_name` (deprecated) - `cluster_istio.service_namespace` (deprecated) - `cluster_istio.service_name` (deprecated) `identifier_case` refers to which option in the identifier oneof is populated. For example, the filter `identifier_case = "CUSTOM"` would match all services with a value for the `custom` field. Valid options are "CUSTOM", "APP_ENGINE", "MESH_ISTIO", plus "CLUSTER_ISTIO" (deprecated) and "CLOUD_ENDPOINTS" (reserved for future use).
`pageSize`	number	A non-negative number that is the maximum number of results to return. When 0, use default page size.
`pageToken`	string	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 additional results from the previous method call.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Promise

The promise which resolves to an array. The first element of the array is Array of Service. 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 listServicesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listServicesAsync(request, optionsopt) → {Object}

Equivalent to listServices, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. Resource name of the parent containing the listed services, either a project or a Monitoring Workspace. The formats are: `projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]`
`filter`	string	A filter specifying what `Service`s to return. The filter currently supports the following fields: - `identifier_case` - `app_engine.module_id` - `cloud_endpoints.service` (reserved for future use) - `mesh_istio.mesh_uid` - `mesh_istio.service_namespace` - `mesh_istio.service_name` - `cluster_istio.location` (deprecated) - `cluster_istio.cluster_name` (deprecated) - `cluster_istio.service_namespace` (deprecated) - `cluster_istio.service_name` (deprecated) `identifier_case` refers to which option in the identifier oneof is populated. For example, the filter `identifier_case = "CUSTOM"` would match all services with a value for the `custom` field. Valid options are "CUSTOM", "APP_ENGINE", "MESH_ISTIO", plus "CLUSTER_ISTIO" (deprecated) and "CLOUD_ENDPOINTS" (reserved for future use).
`pageSize`	number	A non-negative number that is the maximum number of results to return. When 0, use default page size.
`pageToken`	string	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 additional results from the previous method call.

options

object

Call options. See CallOptions for more details.

Returns:

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

Example

const iterable = client.listServicesAsync(request);
for await (const response of iterable) {
  // process response
}

listServicesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. Resource name of the parent containing the listed services, either a project or a Monitoring Workspace. The formats are: `projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]`
`filter`	string	A filter specifying what `Service`s to return. The filter currently supports the following fields: - `identifier_case` - `app_engine.module_id` - `cloud_endpoints.service` (reserved for future use) - `mesh_istio.mesh_uid` - `mesh_istio.service_namespace` - `mesh_istio.service_name` - `cluster_istio.location` (deprecated) - `cluster_istio.cluster_name` (deprecated) - `cluster_istio.service_namespace` (deprecated) - `cluster_istio.service_name` (deprecated) `identifier_case` refers to which option in the identifier oneof is populated. For example, the filter `identifier_case = "CUSTOM"` would match all services with a value for the `custom` field. Valid options are "CUSTOM", "APP_ENGINE", "MESH_ISTIO", plus "CLUSTER_ISTIO" (deprecated) and "CLOUD_ENDPOINTS" (reserved for future use).
`pageSize`	number	A non-negative number that is the maximum number of results to return. When 0, use default page size.
`pageToken`	string	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 additional results from the previous method call.

options

object

Call options. See CallOptions for more details.

Returns:

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

matchAlertPolicyFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName) → {string}

Parse the alert_policy from FolderAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`folderAlertPolicyConditionName`	string	A fully-qualified path representing folder_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the alert_policy.

matchAlertPolicyFromFolderAlertPolicyName(folderAlertPolicyName) → {string}

Parse the alert_policy from FolderAlertPolicy resource.

Parameters:

Name	Type	Description
`folderAlertPolicyName`	string	A fully-qualified path representing folder_alert_policy resource.

Returns:

Type	Description
string	A string representing the alert_policy.

matchAlertPolicyFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName) → {string}

Parse the alert_policy from OrganizationAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`organizationAlertPolicyConditionName`	string	A fully-qualified path representing organization_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the alert_policy.

matchAlertPolicyFromOrganizationAlertPolicyName(organizationAlertPolicyName) → {string}

Parse the alert_policy from OrganizationAlertPolicy resource.

Parameters:

Name	Type	Description
`organizationAlertPolicyName`	string	A fully-qualified path representing organization_alert_policy resource.

Returns:

Type	Description
string	A string representing the alert_policy.

matchAlertPolicyFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName) → {string}

Parse the alert_policy from ProjectAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`projectAlertPolicyConditionName`	string	A fully-qualified path representing project_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the alert_policy.

matchAlertPolicyFromProjectAlertPolicyName(projectAlertPolicyName) → {string}

Parse the alert_policy from ProjectAlertPolicy resource.

Parameters:

Name	Type	Description
`projectAlertPolicyName`	string	A fully-qualified path representing project_alert_policy resource.

Returns:

Type	Description
string	A string representing the alert_policy.

matchChannelDescriptorFromFolderChannelDescriptorName(folderChannelDescriptorName) → {string}

Parse the channel_descriptor from FolderChannelDescriptor resource.

Parameters:

Name	Type	Description
`folderChannelDescriptorName`	string	A fully-qualified path representing folder_channel_descriptor resource.

Returns:

Type	Description
string	A string representing the channel_descriptor.

matchChannelDescriptorFromOrganizationChannelDescriptorName(organizationChannelDescriptorName) → {string}

Parse the channel_descriptor from OrganizationChannelDescriptor resource.

Parameters:

Name	Type	Description
`organizationChannelDescriptorName`	string	A fully-qualified path representing organization_channel_descriptor resource.

Returns:

Type	Description
string	A string representing the channel_descriptor.

matchChannelDescriptorFromProjectChannelDescriptorName(projectChannelDescriptorName) → {string}

Parse the channel_descriptor from ProjectChannelDescriptor resource.

Parameters:

Name	Type	Description
`projectChannelDescriptorName`	string	A fully-qualified path representing project_channel_descriptor resource.

Returns:

Type	Description
string	A string representing the channel_descriptor.

matchConditionFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName) → {string}

Parse the condition from FolderAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`folderAlertPolicyConditionName`	string	A fully-qualified path representing folder_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the condition.

matchConditionFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName) → {string}

Parse the condition from OrganizationAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`organizationAlertPolicyConditionName`	string	A fully-qualified path representing organization_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the condition.

matchConditionFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName) → {string}

Parse the condition from ProjectAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`projectAlertPolicyConditionName`	string	A fully-qualified path representing project_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the condition.

matchFolderFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName) → {string}

Parse the folder from FolderAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`folderAlertPolicyConditionName`	string	A fully-qualified path representing folder_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderAlertPolicyName(folderAlertPolicyName) → {string}

Parse the folder from FolderAlertPolicy resource.

Parameters:

Name	Type	Description
`folderAlertPolicyName`	string	A fully-qualified path representing folder_alert_policy resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderChannelDescriptorName(folderChannelDescriptorName) → {string}

Parse the folder from FolderChannelDescriptor resource.

Parameters:

Name	Type	Description
`folderChannelDescriptorName`	string	A fully-qualified path representing folder_channel_descriptor resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderGroupName(folderGroupName) → {string}

Parse the folder from FolderGroup resource.

Parameters:

Name	Type	Description
`folderGroupName`	string	A fully-qualified path representing folder_group resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderNotificationChannelName(folderNotificationChannelName) → {string}

Parse the folder from FolderNotificationChannel resource.

Parameters:

Name	Type	Description
`folderNotificationChannelName`	string	A fully-qualified path representing folder_notification_channel resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderServiceName(folderServiceName) → {string}

Parse the folder from FolderService resource.

Parameters:

Name	Type	Description
`folderServiceName`	string	A fully-qualified path representing folder_service resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName) → {string}

Parse the folder from FolderServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`folderServiceServiceLevelObjectiveName`	string	A fully-qualified path representing folder_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName) → {string}

Parse the folder from FolderUptimeCheckConfig resource.

Parameters:

Name	Type	Description
`folderUptimeCheckConfigName`	string	A fully-qualified path representing folder_uptime_check_config resource.

Returns:

Type	Description
string	A string representing the folder.

matchGroupFromFolderGroupName(folderGroupName) → {string}

Parse the group from FolderGroup resource.

Parameters:

Name	Type	Description
`folderGroupName`	string	A fully-qualified path representing folder_group resource.

Returns:

Type	Description
string	A string representing the group.

matchGroupFromOrganizationGroupName(organizationGroupName) → {string}

Parse the group from OrganizationGroup resource.

Parameters:

Name	Type	Description
`organizationGroupName`	string	A fully-qualified path representing organization_group resource.

Returns:

Type	Description
string	A string representing the group.

matchGroupFromProjectGroupName(projectGroupName) → {string}

Parse the group from ProjectGroup resource.

Parameters:

Name	Type	Description
`projectGroupName`	string	A fully-qualified path representing project_group resource.

Returns:

Type	Description
string	A string representing the group.

matchNotificationChannelFromFolderNotificationChannelName(folderNotificationChannelName) → {string}

Parse the notification_channel from FolderNotificationChannel resource.

Parameters:

Name	Type	Description
`folderNotificationChannelName`	string	A fully-qualified path representing folder_notification_channel resource.

Returns:

Type	Description
string	A string representing the notification_channel.

matchNotificationChannelFromOrganizationNotificationChannelName(organizationNotificationChannelName) → {string}

Parse the notification_channel from OrganizationNotificationChannel resource.

Parameters:

Name	Type	Description
`organizationNotificationChannelName`	string	A fully-qualified path representing organization_notification_channel resource.

Returns:

Type	Description
string	A string representing the notification_channel.

matchNotificationChannelFromProjectNotificationChannelName(projectNotificationChannelName) → {string}

Parse the notification_channel from ProjectNotificationChannel resource.

Parameters:

Name	Type	Description
`projectNotificationChannelName`	string	A fully-qualified path representing project_notification_channel resource.

Returns:

Type	Description
string	A string representing the notification_channel.

matchOrganizationFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName) → {string}

Parse the organization from OrganizationAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`organizationAlertPolicyConditionName`	string	A fully-qualified path representing organization_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationAlertPolicyName(organizationAlertPolicyName) → {string}

Parse the organization from OrganizationAlertPolicy resource.

Parameters:

Name	Type	Description
`organizationAlertPolicyName`	string	A fully-qualified path representing organization_alert_policy resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationChannelDescriptorName(organizationChannelDescriptorName) → {string}

Parse the organization from OrganizationChannelDescriptor resource.

Parameters:

Name	Type	Description
`organizationChannelDescriptorName`	string	A fully-qualified path representing organization_channel_descriptor resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationGroupName(organizationGroupName) → {string}

Parse the organization from OrganizationGroup resource.

Parameters:

Name	Type	Description
`organizationGroupName`	string	A fully-qualified path representing organization_group resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationNotificationChannelName(organizationNotificationChannelName) → {string}

Parse the organization from OrganizationNotificationChannel resource.

Parameters:

Name	Type	Description
`organizationNotificationChannelName`	string	A fully-qualified path representing organization_notification_channel resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationServiceName(organizationServiceName) → {string}

Parse the organization from OrganizationService resource.

Parameters:

Name	Type	Description
`organizationServiceName`	string	A fully-qualified path representing organization_service resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName) → {string}

Parse the organization from OrganizationServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`organizationServiceServiceLevelObjectiveName`	string	A fully-qualified path representing organization_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName) → {string}

Parse the organization from OrganizationUptimeCheckConfig resource.

Parameters:

Name	Type	Description
`organizationUptimeCheckConfigName`	string	A fully-qualified path representing organization_uptime_check_config resource.

Returns:

Type	Description
string	A string representing the organization.

matchProjectFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName) → {string}

Parse the project from ProjectAlertPolicyCondition resource.

Parameters:

Name	Type	Description
`projectAlertPolicyConditionName`	string	A fully-qualified path representing project_alert_policy_condition resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectAlertPolicyName(projectAlertPolicyName) → {string}

Parse the project from ProjectAlertPolicy resource.

Parameters:

Name	Type	Description
`projectAlertPolicyName`	string	A fully-qualified path representing project_alert_policy resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectChannelDescriptorName(projectChannelDescriptorName) → {string}

Parse the project from ProjectChannelDescriptor resource.

Parameters:

Name	Type	Description
`projectChannelDescriptorName`	string	A fully-qualified path representing project_channel_descriptor resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectGroupName(projectGroupName) → {string}

Parse the project from ProjectGroup resource.

Parameters:

Name	Type	Description
`projectGroupName`	string	A fully-qualified path representing project_group resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:

Name	Type	Description
`projectName`	string	A fully-qualified path representing Project resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectNotificationChannelName(projectNotificationChannelName) → {string}

Parse the project from ProjectNotificationChannel resource.

Parameters:

Name	Type	Description
`projectNotificationChannelName`	string	A fully-qualified path representing project_notification_channel resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectServiceName(projectServiceName) → {string}

Parse the project from ProjectService resource.

Parameters:

Name	Type	Description
`projectServiceName`	string	A fully-qualified path representing project_service resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName) → {string}

Parse the project from ProjectServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`projectServiceServiceLevelObjectiveName`	string	A fully-qualified path representing project_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName) → {string}

Parse the project from ProjectUptimeCheckConfig resource.

Parameters:

Name	Type	Description
`projectUptimeCheckConfigName`	string	A fully-qualified path representing project_uptime_check_config resource.

Returns:

Type	Description
string	A string representing the project.

matchServiceFromFolderServiceName(folderServiceName) → {string}

Parse the service from FolderService resource.

Parameters:

Name	Type	Description
`folderServiceName`	string	A fully-qualified path representing folder_service resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName) → {string}

Parse the service from FolderServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`folderServiceServiceLevelObjectiveName`	string	A fully-qualified path representing folder_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceFromOrganizationServiceName(organizationServiceName) → {string}

Parse the service from OrganizationService resource.

Parameters:

Name	Type	Description
`organizationServiceName`	string	A fully-qualified path representing organization_service resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName) → {string}

Parse the service from OrganizationServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`organizationServiceServiceLevelObjectiveName`	string	A fully-qualified path representing organization_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceFromProjectServiceName(projectServiceName) → {string}

Parse the service from ProjectService resource.

Parameters:

Name	Type	Description
`projectServiceName`	string	A fully-qualified path representing project_service resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName) → {string}

Parse the service from ProjectServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`projectServiceServiceLevelObjectiveName`	string	A fully-qualified path representing project_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the service.

matchServiceLevelObjectiveFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName) → {string}

Parse the service_level_objective from FolderServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`folderServiceServiceLevelObjectiveName`	string	A fully-qualified path representing folder_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the service_level_objective.

matchServiceLevelObjectiveFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName) → {string}

Parse the service_level_objective from OrganizationServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`organizationServiceServiceLevelObjectiveName`	string	A fully-qualified path representing organization_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the service_level_objective.

matchServiceLevelObjectiveFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName) → {string}

Parse the service_level_objective from ProjectServiceServiceLevelObjective resource.

Parameters:

Name	Type	Description
`projectServiceServiceLevelObjectiveName`	string	A fully-qualified path representing project_service_service_level_objective resource.

Returns:

Type	Description
string	A string representing the service_level_objective.

matchUptimeCheckConfigFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName) → {string}

Parse the uptime_check_config from FolderUptimeCheckConfig resource.

Parameters:

Name	Type	Description
`folderUptimeCheckConfigName`	string	A fully-qualified path representing folder_uptime_check_config resource.

Returns:

Type	Description
string	A string representing the uptime_check_config.

matchUptimeCheckConfigFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName) → {string}

Parse the uptime_check_config from OrganizationUptimeCheckConfig resource.

Parameters:

Name	Type	Description
`organizationUptimeCheckConfigName`	string	A fully-qualified path representing organization_uptime_check_config resource.

Returns:

Type	Description
string	A string representing the uptime_check_config.

matchUptimeCheckConfigFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName) → {string}

Parse the uptime_check_config from ProjectUptimeCheckConfig resource.

Parameters:

Name	Type	Description
`projectUptimeCheckConfigName`	string	A fully-qualified path representing project_uptime_check_config resource.

Returns:

Type	Description
string	A string representing the uptime_check_config.

organizationAlertPolicyConditionPath(organization, alert_policy, condition) → {string}

Return a fully-qualified organizationAlertPolicyCondition resource name string.

Parameters:

Name	Type	Description
`organization`	string
`alert_policy`	string
`condition`	string

Returns:

Type	Description
string	Resource name string.

organizationAlertPolicyPath(organization, alert_policy) → {string}

Return a fully-qualified organizationAlertPolicy resource name string.

Parameters:

Name	Type	Description
`organization`	string
`alert_policy`	string

Returns:

Type	Description
string	Resource name string.

organizationChannelDescriptorPath(organization, channel_descriptor) → {string}

Return a fully-qualified organizationChannelDescriptor resource name string.

Parameters:

Name	Type	Description
`organization`	string
`channel_descriptor`	string

Returns:

Type	Description
string	Resource name string.

organizationGroupPath(organization, group) → {string}

Return a fully-qualified organizationGroup resource name string.

Parameters:

Name	Type	Description
`organization`	string
`group`	string

Returns:

Type	Description
string	Resource name string.

organizationNotificationChannelPath(organization, notification_channel) → {string}

Return a fully-qualified organizationNotificationChannel resource name string.

Parameters:

Name	Type	Description
`organization`	string
`notification_channel`	string

Returns:

Type	Description
string	Resource name string.

organizationServicePath(organization, service) → {string}

Return a fully-qualified organizationService resource name string.

Parameters:

Name	Type	Description
`organization`	string
`service`	string

Returns:

Type	Description
string	Resource name string.

organizationServiceServiceLevelObjectivePath(organization, service, service_level_objective) → {string}

Return a fully-qualified organizationServiceServiceLevelObjective resource name string.

Parameters:

Name	Type	Description
`organization`	string
`service`	string
`service_level_objective`	string

Returns:

Type	Description
string	Resource name string.

organizationUptimeCheckConfigPath(organization, uptime_check_config) → {string}

Return a fully-qualified organizationUptimeCheckConfig resource name string.

Parameters:

Name	Type	Description
`organization`	string
`uptime_check_config`	string

Returns:

Type	Description
string	Resource name string.

projectAlertPolicyConditionPath(project, alert_policy, condition) → {string}

Return a fully-qualified projectAlertPolicyCondition resource name string.

Parameters:

Name	Type	Description
`project`	string
`alert_policy`	string
`condition`	string

Returns:

Type	Description
string	Resource name string.

projectAlertPolicyPath(project, alert_policy) → {string}

Return a fully-qualified projectAlertPolicy resource name string.

Parameters:

Name	Type	Description
`project`	string
`alert_policy`	string

Returns:

Type	Description
string	Resource name string.

projectChannelDescriptorPath(project, channel_descriptor) → {string}

Return a fully-qualified projectChannelDescriptor resource name string.

Parameters:

Name	Type	Description
`project`	string
`channel_descriptor`	string

Returns:

Type	Description
string	Resource name string.

projectGroupPath(project, group) → {string}

Return a fully-qualified projectGroup resource name string.

Parameters:

Name	Type	Description
`project`	string
`group`	string

Returns:

Type	Description
string	Resource name string.

projectNotificationChannelPath(project, notification_channel) → {string}

Return a fully-qualified projectNotificationChannel resource name string.

Parameters:

Name	Type	Description
`project`	string
`notification_channel`	string

Returns:

Type	Description
string	Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

projectServicePath(project, service) → {string}

Return a fully-qualified projectService resource name string.

Parameters:

Name	Type	Description
`project`	string
`service`	string

Returns:

Type	Description
string	Resource name string.

projectServiceServiceLevelObjectivePath(project, service, service_level_objective) → {string}

Return a fully-qualified projectServiceServiceLevelObjective resource name string.

Parameters:

Name	Type	Description
`project`	string
`service`	string
`service_level_objective`	string

Returns:

Type	Description
string	Resource name string.

projectUptimeCheckConfigPath(project, uptime_check_config) → {string}

Return a fully-qualified projectUptimeCheckConfig resource name string.

Parameters:

Name	Type	Description
`project`	string
`uptime_check_config`	string

Returns:

Type	Description
string	Resource name string.

updateService(request, optionsopt) → {Promise}

Update this Service.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`service`	google.monitoring.v3.Service	Required. The `Service` to draw updates from. The given `name` specifies the resource to update.
`updateMask`	google.protobuf.FieldMask	A set of field paths defining which fields to use for the update.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Service. Please see the documentation for more details and examples.

Example

const [response] = await client.updateService(request);

updateServiceLevelObjective(request, optionsopt) → {Promise}

Update the given ServiceLevelObjective.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`serviceLevelObjective`	google.monitoring.v3.ServiceLevelObjective	Required. The `ServiceLevelObjective` to draw updates from. The given `name` specifies the resource to update.
`updateMask`	google.protobuf.FieldMask	A set of field paths defining which fields to use for the update.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing ServiceLevelObjective. Please see the documentation for more details and examples.

Example

const [response] = await client.updateServiceLevelObjective(request);