Monitoring

import { Monitoring } from "https://googleapis.deno.dev/v1/monitoring:v3.ts";

Manages your Cloud Monitoring data and configurations.

class Monitoring {

constructor(client?: CredentialsClient, baseUrl?: string);

async foldersTimeSeriesList(name: string, opts?: FoldersTimeSeriesListOptions): Promise<ListTimeSeriesResponse>;

async organizationsTimeSeriesList(name: string, opts?: OrganizationsTimeSeriesListOptions): Promise<ListTimeSeriesResponse>;

async projectsAlertPoliciesCreate(name: string, req: AlertPolicy): Promise<AlertPolicy>;

async projectsAlertPoliciesDelete(name: string): Promise<Empty>;

async projectsAlertPoliciesGet(name: string): Promise<AlertPolicy>;

async projectsAlertPoliciesList(name: string, opts?: ProjectsAlertPoliciesListOptions): Promise<ListAlertPoliciesResponse>;

async projectsAlertPoliciesPatch(

req: AlertPolicy,

opts?: ProjectsAlertPoliciesPatchOptions,

): Promise<AlertPolicy>;

async projectsCollectdTimeSeriesCreate(name: string, req: CreateCollectdTimeSeriesRequest): Promise<CreateCollectdTimeSeriesResponse>;

async projectsGroupsCreate(

req: Group,

opts?: ProjectsGroupsCreateOptions,

): Promise<Group>;

async projectsGroupsDelete(name: string, opts?: ProjectsGroupsDeleteOptions): Promise<Empty>;

async projectsGroupsGet(name: string): Promise<Group>;

async projectsGroupsList(name: string, opts?: ProjectsGroupsListOptions): Promise<ListGroupsResponse>;

async projectsGroupsMembersList(name: string, opts?: ProjectsGroupsMembersListOptions): Promise<ListGroupMembersResponse>;

async projectsGroupsUpdate(

req: Group,

opts?: ProjectsGroupsUpdateOptions,

): Promise<Group>;

async projectsMetricDescriptorsCreate(name: string, req: MetricDescriptor): Promise<MetricDescriptor>;

async projectsMetricDescriptorsDelete(name: string): Promise<Empty>;

async projectsMetricDescriptorsGet(name: string): Promise<MetricDescriptor>;

async projectsMetricDescriptorsList(name: string, opts?: ProjectsMetricDescriptorsListOptions): Promise<ListMetricDescriptorsResponse>;

async projectsMonitoredResourceDescriptorsGet(name: string): Promise<MonitoredResourceDescriptor>;

async projectsMonitoredResourceDescriptorsList(name: string, opts?: ProjectsMonitoredResourceDescriptorsListOptions): Promise<ListMonitoredResourceDescriptorsResponse>;

async projectsNotificationChannelDescriptorsGet(name: string): Promise<NotificationChannelDescriptor>;

async projectsNotificationChannelDescriptorsList(name: string, opts?: ProjectsNotificationChannelDescriptorsListOptions): Promise<ListNotificationChannelDescriptorsResponse>;

async projectsNotificationChannelsCreate(name: string, req: NotificationChannel): Promise<NotificationChannel>;

async projectsNotificationChannelsDelete(name: string, opts?: ProjectsNotificationChannelsDeleteOptions): Promise<Empty>;

async projectsNotificationChannelsGet(name: string): Promise<NotificationChannel>;

async projectsNotificationChannelsGetVerificationCode(name: string, req: GetNotificationChannelVerificationCodeRequest): Promise<GetNotificationChannelVerificationCodeResponse>;

async projectsNotificationChannelsList(name: string, opts?: ProjectsNotificationChannelsListOptions): Promise<ListNotificationChannelsResponse>;

async projectsNotificationChannelsPatch(

req: NotificationChannel,

opts?: ProjectsNotificationChannelsPatchOptions,

): Promise<NotificationChannel>;

async projectsNotificationChannelsSendVerificationCode(name: string, req: SendNotificationChannelVerificationCodeRequest): Promise<Empty>;

async projectsNotificationChannelsVerify(name: string, req: VerifyNotificationChannelRequest): Promise<NotificationChannel>;

async projectsSnoozesCreate(parent: string, req: Snooze): Promise<Snooze>;

async projectsSnoozesGet(name: string): Promise<Snooze>;

async projectsSnoozesList(parent: string, opts?: ProjectsSnoozesListOptions): Promise<ListSnoozesResponse>;

async projectsSnoozesPatch(

req: Snooze,

opts?: ProjectsSnoozesPatchOptions,

): Promise<Snooze>;

async projectsTimeSeriesCreate(name: string, req: CreateTimeSeriesRequest): Promise<Empty>;

async projectsTimeSeriesCreateService(name: string, req: CreateTimeSeriesRequest): Promise<Empty>;

async projectsTimeSeriesList(name: string, opts?: ProjectsTimeSeriesListOptions): Promise<ListTimeSeriesResponse>;

async projectsTimeSeriesQuery(name: string, req: QueryTimeSeriesRequest): Promise<QueryTimeSeriesResponse>;

async projectsUptimeCheckConfigsCreate(parent: string, req: UptimeCheckConfig): Promise<UptimeCheckConfig>;

async projectsUptimeCheckConfigsDelete(name: string): Promise<Empty>;

async projectsUptimeCheckConfigsGet(name: string): Promise<UptimeCheckConfig>;

async projectsUptimeCheckConfigsList(parent: string, opts?: ProjectsUptimeCheckConfigsListOptions): Promise<ListUptimeCheckConfigsResponse>;

async projectsUptimeCheckConfigsPatch(

req: UptimeCheckConfig,

opts?: ProjectsUptimeCheckConfigsPatchOptions,

): Promise<UptimeCheckConfig>;

async servicesCreate(

parent: string,

req: Service,

opts?: ServicesCreateOptions,

): Promise<Service>;

async servicesDelete(name: string): Promise<Empty>;

async servicesGet(name: string): Promise<Service>;

async servicesList(parent: string, opts?: ServicesListOptions): Promise<ListServicesResponse>;

async servicesPatch(

req: Service,

opts?: ServicesPatchOptions,

): Promise<Service>;

async servicesServiceLevelObjectivesCreate(

parent: string,

req: ServiceLevelObjective,

opts?: ServicesServiceLevelObjectivesCreateOptions,

): Promise<ServiceLevelObjective>;

async servicesServiceLevelObjectivesDelete(name: string): Promise<Empty>;

async servicesServiceLevelObjectivesGet(name: string, opts?: ServicesServiceLevelObjectivesGetOptions): Promise<ServiceLevelObjective>;

async servicesServiceLevelObjectivesList(parent: string, opts?: ServicesServiceLevelObjectivesListOptions): Promise<ListServiceLevelObjectivesResponse>;

async servicesServiceLevelObjectivesPatch(

req: ServiceLevelObjective,

opts?: ServicesServiceLevelObjectivesPatchOptions,

): Promise<ServiceLevelObjective>;

async uptimeCheckIpsList(opts?: UptimeCheckIpsListOptions): Promise<ListUptimeCheckIpsResponse>;

}

§Constructors

new Monitoring(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

foldersTimeSeriesList(name: string, opts?: FoldersTimeSeriesListOptions): Promise<ListTimeSeriesResponse>

[src]

Lists time series that match a filter.

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name), organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID]

organizationsTimeSeriesList(name: string, opts?: OrganizationsTimeSeriesListOptions): Promise<ListTimeSeriesResponse>

[src]

Lists time series that match a filter.

@param name

projectsAlertPoliciesCreate(name: string, req: AlertPolicy): Promise<AlertPolicy>

[src]

Creates a new alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a Metrics Scope, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container.

projectsAlertPoliciesDelete(name: string): Promise<Empty>

[src]

Deletes an alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

@param name

Required. The alerting policy to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy.

projectsAlertPoliciesGet(name: string): Promise<AlertPolicy>

[src]

Gets a single alerting policy.

@param name

Required. The alerting policy to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]

projectsAlertPoliciesList(name: string, opts?: ProjectsAlertPoliciesListOptions): Promise<ListAlertPoliciesResponse>

[src]

Lists the existing alerting policies for the workspace.

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose alert policies are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.

projectsAlertPoliciesPatch(name: string, req: AlertPolicy, opts?: ProjectsAlertPoliciesPatchOptions): Promise<AlertPolicy>

[src]

Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

@param name

Identifier. Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.

projectsCollectdTimeSeriesCreate(name: string, req: CreateCollectdTimeSeriesRequest): Promise<CreateCollectdTimeSeriesResponse>

[src]

Cloud Monitoring Agent only: Creates a new time series.This method is only for use by the Cloud Monitoring Agent. Use projects.timeSeries.create instead.

@param name

The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the time series. The format is: projects/[PROJECT_ID_OR_NUMBER]

projectsGroupsCreate(name: string, req: Group, opts?: ProjectsGroupsCreateOptions): Promise<Group>

[src]

Creates a new group.

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the group. The format is: projects/[PROJECT_ID_OR_NUMBER]

projectsGroupsDelete(name: string, opts?: ProjectsGroupsDeleteOptions): Promise<Empty>

[src]

Deletes an existing group.

@param name

Required. The group to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

projectsGroupsGet(name: string): Promise<Group>

[src]

Gets a single group.

@param name

Required. The group to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

projectsGroupsList(name: string, opts?: ProjectsGroupsListOptions): Promise<ListGroupsResponse>

[src]

Lists the existing groups.

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]

projectsGroupsMembersList(name: string, opts?: ProjectsGroupsMembersListOptions): Promise<ListGroupMembersResponse>

[src]

Lists the monitored resources that are members of a group.

@param name

Required. The group whose members are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]

projectsGroupsUpdate(name: string, req: Group, opts?: ProjectsGroupsUpdateOptions): Promise<Group>

[src]

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

@param name

Output only. The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.

projectsMetricDescriptorsCreate(name: string, req: MetricDescriptor): Promise<MetricDescriptor>

[src]

Creates a new metric descriptor. The creation is executed asynchronously. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics). The metric descriptor is updated if it already exists, except that metric labels are never removed.

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: 4 projects/PROJECT_ID_OR_NUMBER

projectsMetricDescriptorsDelete(name: string): Promise<Empty>

[src]

Deletes a metric descriptor. Only user-created custom metrics (https://cloud.google.com/monitoring/custom-metrics) can be deleted.

@param name

Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example of [METRIC_ID] is: "custom.googleapis.com/my_test_metric".

projectsMetricDescriptorsGet(name: string): Promise<MetricDescriptor>

[src]

Gets a single metric descriptor.

@param name

Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example value of [METRIC_ID] is "compute.googleapis.com/instance/disk/read_bytes_count".

projectsMetricDescriptorsList(name: string, opts?: ProjectsMetricDescriptorsListOptions): Promise<ListMetricDescriptorsResponse>

[src]

Lists metric descriptors that match a filter.

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]

projectsMonitoredResourceDescriptorsGet(name: string): Promise<MonitoredResourceDescriptor>

[src]

Gets a single monitored resource descriptor.

@param name

Required. The monitored resource descriptor to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] The [RESOURCE_TYPE] is a predefined type, such as cloudsql_database.

projectsMonitoredResourceDescriptorsList(name: string, opts?: ProjectsMonitoredResourceDescriptorsListOptions): Promise<ListMonitoredResourceDescriptorsResponse>

[src]

Lists monitored resource descriptors that match a filter.

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]

projectsNotificationChannelDescriptorsGet(name: string): Promise<NotificationChannelDescriptor>

[src]

Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.

@param name

Required. The channel type for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE]

projectsNotificationChannelDescriptorsList(name: string, opts?: ProjectsNotificationChannelDescriptorsListOptions): Promise<ListNotificationChannelDescriptorsResponse>

[src]

Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

@param name

Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID_OR_NUMBER] Note that this names (https://cloud.google.com/monitoring/api/v3#project_name) the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead.

projectsNotificationChannelsCreate(name: string, req: NotificationChannel): Promise<NotificationChannel>

[src]

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container into which the channel will be written, this does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel.

projectsNotificationChannelsDelete(name: string, opts?: ProjectsNotificationChannelsDeleteOptions): Promise<Empty>

[src]

Deletes a notification channel.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.

@param name

Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

projectsNotificationChannelsGet(name: string): Promise<NotificationChannel>

[src]

Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method.

@param name

Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

projectsNotificationChannelsGetVerificationCode(name: string, req: GetNotificationChannelVerificationCodeRequest): Promise<GetNotificationChannelVerificationCodeResponse>

[src]

Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been used to put the given channel into the verified state).There is no guarantee that the verification codes returned by this method will be of a similar structure or form as the ones that are delivered to the channel via SendNotificationChannelVerificationCode; while VerifyNotificationChannel() will recognize both the codes delivered via SendNotificationChannelVerificationCode() and returned from GetNotificationChannelVerificationCode(), it is typically the case that the verification codes delivered via SendNotificationChannelVerificationCode() will be shorter and also have a shorter expiration (e.g. codes such as "G-123456") whereas GetVerificationCode() will typically return a much longer, websafe base 64 encoded string that has a longer expiration time.

@param name

Required. The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail.

projectsNotificationChannelsList(name: string, opts?: ProjectsNotificationChannelsListOptions): Promise<ListNotificationChannelsResponse>

[src]

Lists the notification channels that have been created for the project. To list the types of notification channels that are supported, use the ListNotificationChannelDescriptors method.

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation.

projectsNotificationChannelsPatch(name: string, req: NotificationChannel, opts?: ProjectsNotificationChannelsPatchOptions): Promise<NotificationChannel>

[src]

Updates a notification channel. Fields not specified in the field mask remain unchanged.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.

@param name

Identifier. The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.

projectsNotificationChannelsSendVerificationCode(name: string, req: SendNotificationChannelVerificationCodeRequest): Promise<Empty>

[src]

Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel.

@param name

Required. The notification channel to which to send a verification code.

projectsNotificationChannelsVerify(name: string, req: VerifyNotificationChannelRequest): Promise<NotificationChannel>

[src]

Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode.

@param name

Required. The notification channel to verify.

projectsSnoozesCreate(parent: string, req: Snooze): Promise<Snooze>

[src]

Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval.

@param parent

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which a Snooze should be created. The format is: projects/[PROJECT_ID_OR_NUMBER]

projectsSnoozesGet(name: string): Promise<Snooze>

[src]

Retrieves a Snooze by name.

@param name

Required. The ID of the Snooze to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]

projectsSnoozesList(parent: string, opts?: ProjectsSnoozesListOptions): Promise<ListSnoozesResponse>

[src]

Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes.

@param parent

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose Snoozes should be listed. The format is: projects/[PROJECT_ID_OR_NUMBER]

projectsSnoozesPatch(name: string, req: Snooze, opts?: ProjectsSnoozesPatchOptions): Promise<Snooze>

[src]

Updates a Snooze, identified by its name, with the parameters in the given Snooze object.

@param name

Required. Identifier. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system.

projectsTimeSeriesCreate(name: string, req: CreateTimeSeriesRequest): Promise<Empty>

[src]

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response. This method does not support resource locations constraint of an organization policy (https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations#setting_the_organization_policy).

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]

projectsTimeSeriesCreateService(name: string, req: CreateTimeSeriesRequest): Promise<Empty>

[src]

Creates or adds data to one or more service time series. A service time series is a time series for a metric from a Google Cloud service. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response. This endpoint rejects writes to user-defined metrics. This method is only for use by Google Cloud services. Use projects.timeSeries.create instead.

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]

projectsTimeSeriesList(name: string, opts?: ProjectsTimeSeriesListOptions): Promise<ListTimeSeriesResponse>

[src]

Lists time series that match a filter.

@param name

projectsTimeSeriesQuery(name: string, req: QueryTimeSeriesRequest): Promise<QueryTimeSeriesResponse>

[src]

Queries time series by using Monitoring Query Language (MQL). We recommend using PromQL instead of MQL. For more information about the status of MQL, see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql).

@param name

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]

projectsUptimeCheckConfigsCreate(parent: string, req: UptimeCheckConfig): Promise<UptimeCheckConfig>

[src]

Creates a new Uptime check configuration.

@param parent

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER]

projectsUptimeCheckConfigsDelete(name: string): Promise<Empty>

[src]

Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

@param name

Required. The Uptime check configuration to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

projectsUptimeCheckConfigsGet(name: string): Promise<UptimeCheckConfig>

[src]

Gets a single Uptime check configuration.

@param name

Required. The Uptime check configuration to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

projectsUptimeCheckConfigsList(parent: string, opts?: ProjectsUptimeCheckConfigsListOptions): Promise<ListUptimeCheckConfigsResponse>

[src]

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

@param parent

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose Uptime check configurations are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]

projectsUptimeCheckConfigsPatch(name: string, req: UptimeCheckConfig, opts?: ProjectsUptimeCheckConfigsPatchOptions): Promise<UptimeCheckConfig>

[src]

Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration.

@param name

Identifier. A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

servicesCreate(parent: string, req: Service, opts?: ServicesCreateOptions): Promise<Service>

[src]

Create a Service.

@param parent

Required. Resource name (https://cloud.google.com/monitoring/api/v3#project_name) of the parent Metrics Scope. The format is: projects/[PROJECT_ID_OR_NUMBER]

servicesDelete(name: string): Promise<Empty>

[src]

Soft delete this Service.

@param name

Required. Resource name of the Service to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

servicesGet(name: string): Promise<Service>

[src]

Get the named Service.

@param name

Required. Resource name of the Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

servicesList(parent: string, opts?: ServicesListOptions): Promise<ListServicesResponse>

[src]

List Services for this Metrics Scope.

@param parent

Required. Resource name of the parent containing the listed services, either a project (https://cloud.google.com/monitoring/api/v3#project_name) or a Monitoring Metrics Scope. The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]

servicesPatch(name: string, req: Service, opts?: ServicesPatchOptions): Promise<Service>

[src]

Update this Service.

@param name

Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

servicesServiceLevelObjectivesCreate(parent: string, req: ServiceLevelObjective, opts?: ServicesServiceLevelObjectivesCreateOptions): Promise<ServiceLevelObjective>

[src]

Create a ServiceLevelObjective for the given Service.

@param parent

Required. Resource name of the parent Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

servicesServiceLevelObjectivesDelete(name: string): Promise<Empty>

[src]

Delete the given ServiceLevelObjective.

@param name

Required. Resource name of the ServiceLevelObjective to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

servicesServiceLevelObjectivesGet(name: string, opts?: ServicesServiceLevelObjectivesGetOptions): Promise<ServiceLevelObjective>

[src]

Get a ServiceLevelObjective by name.

@param name

Required. Resource name of the ServiceLevelObjective to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

servicesServiceLevelObjectivesList(parent: string, opts?: ServicesServiceLevelObjectivesListOptions): Promise<ListServiceLevelObjectivesResponse>

[src]

List the ServiceLevelObjectives for the given Service.

@param parent

Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Metrics Scope. The formats are: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-

servicesServiceLevelObjectivesPatch(name: string, req: ServiceLevelObjective, opts?: ServicesServiceLevelObjectivesPatchOptions): Promise<ServiceLevelObjective>

[src]

Update the given ServiceLevelObjective.

@param name

Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

uptimeCheckIpsList(opts?: UptimeCheckIpsListOptions): Promise<ListUptimeCheckIpsResponse>

[src]

Returns the list of IP addresses that checkers run from.