Gcp/monitoring
@swamp/gcp/monitoringv2026.05.25.2
01README
Google Cloud monitoring infrastructure models
02Release Notes
- Updated: uptimecheckips
03Models
@swamp/gcp/monitoring/alertpoliciesv2026.05.25.1alertpolicies.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| alertStrategy? | object | Control over how the notification channels in notification_channels are notified when this alert fires. |
| combiner? | enum | How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED. |
| conditions? | array | A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition. If condition_monitoring_query_language is present, it must be the only condition. |
| creationRecord? | object | Describes a change made to a configuration. |
| displayName? | string | A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don\ |
| documentation? | object | Documentation that is included in the notifications and incidents pertaining to this policy. |
| enabled? | boolean | Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. |
| mutationRecord? | object | Describes a change made to a configuration. |
| name? | string | 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. |
| notificationChannels? | array | Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] |
| severity? | enum | Optional. The severity of an alerting policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. |
| userLabels? | record | User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.Note that Prometheus {alert name} is a valid Prometheus label names (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels), whereas Prom |
| validity? | object | The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). |
fn create()
Create a alertPolicies
fn get(identifier: string)
Get a alertPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the alertPolicies |
fn update()
Update alertPolicies attributes
fn delete(identifier: string)
Delete the alertPolicies
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the alertPolicies |
fn sync()
Sync alertPolicies state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List alertPolicies resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). |
| orderBy? | string | Optional. A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). |
| pageSize? | number | Optional. The maximum number of results to return in a single response. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A description of the conditions under which some aspect of your system is con...
@swamp/gcp/monitoring/alertsv2026.05.25.1alerts.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a alerts
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the alerts |
fn sync()
Sync alerts state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List alerts resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. An alert is returned if there is a match on any fields belonging to the alert or its subfields. |
| orderBy? | string | Optional. A comma-separated list of fields in Alert to use for sorting. The default sort direction is ascending. To specify descending order for a field, add a desc modifier. The following fields are supported: open_time close_timeFor example, close_time desc, open_time will return the alerts closed most recently, with ties broken in the order of older alerts listed first.If the field is not set, the results are sorted by open_time desc. |
| pageSize? | number | Optional. The maximum number of results to return in a single response. If not set to a positive number, at most 50 alerts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An alert is the representation of a violation of an alert policy. It is a rea...
@swamp/gcp/monitoring/groupsv2026.05.25.1groups.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| displayName? | string | A user-assigned name for this group, used only for display purposes. |
| filter? | string | The filter used to determine which monitored resources belong to this group. |
| isCluster? | boolean | If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. |
| name? | string | 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. |
| parentName? | string | The name of the group\ |
fn create()
Create a groups
fn get(identifier: string)
Get a groups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the groups |
fn update()
Update groups attributes
fn delete(identifier: string)
Delete the groups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the groups |
fn sync()
Sync groups state from GCP
fn list(ancestorsOfGroup?: string, childrenOfGroup?: string, descendantsOfGroup?: string, pageSize?: number, maxPages?: number)
List groups resources
| Argument | Type | Description |
|---|---|---|
| ancestorsOfGroup? | string | A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty. |
| childrenOfGroup? | string | A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty. |
| descendantsOfGroup? | string | A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth. |
| pageSize? | number | A positive number that is the maximum number of results to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— The description of a dynamic collection of monitored resources. Each group ha...
@swamp/gcp/monitoring/groups-membersv2026.05.25.1groups_members.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a members
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the members |
fn sync()
Sync members state from GCP
fn list(filter?: string, interval_endTime?: string, interval_startTime?: string, pageSize?: number, maxPages?: number)
List members resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | An optional list filter (https://cloud.google.com/monitoring/api/learn_more#filtering) describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: `resource.type = "gce_instance"` |
| interval_endTime? | string | Required. The end of the time interval. |
| interval_startTime? | string | Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. |
| pageSize? | number | A positive number that is the maximum number of results to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An object representing a resource that can be used for monitoring, logging, b...
@swamp/gcp/monitoring/metricdescriptorsv2026.05.25.1metricdescriptors.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| description? | string | A detailed description of the metric, which can be used in documentation. |
| displayName? | string | A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. |
| labels? | array | The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed. |
| launchStage? | enum | Optional. The launch stage of the metric definition. |
| metadata? | object | Additional annotations that can be used to guide the usage of a metric. |
| metricKind? | enum | Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. |
| monitoredResourceTypes? | array | Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. |
| name? | string | The resource name of the metric descriptor. |
| type? | string | The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" |
| unit? | string | The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want |
| valueType? | enum | Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. |
fn create()
Create a metricDescriptors
fn get(identifier: string)
Get a metricDescriptors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the metricDescriptors |
fn delete(identifier: string)
Delete the metricDescriptors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the metricDescriptors |
fn sync()
Sync metricDescriptors state from GCP
fn list(activeOnly?: boolean, filter?: string, pageSize?: number, maxPages?: number)
List metricDescriptors resources
| Argument | Type | Description |
|---|---|---|
| activeOnly? | boolean | Optional. If true, only metrics and monitored resource types that have recent data (within roughly 25 hours) will be included in the response. - If a metric descriptor enumerates monitored resource types, only the monitored resource types for which the metric type has recent data will be included in the returned metric descriptor, and if none of them have recent data, the metric descriptor will not be returned. - If a metric descriptor does not enumerate the compatible monitored resource types, |
| filter? | string | Optional. If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter (https://cloud.google.com/monitoring/api/v3/filters) specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics (https://cloud.google.com/monitoring/custom-metrics): metric.type = starts_with("custom.googleapis.com/") |
| pageSize? | number | Optional. A positive number that is the maximum number of results to return. The default and maximum value is 10,000. If a page_size <= 0 or > 10,000 is submitted, will instead return a maximum of 10,000 results. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Defines a metric type and its schema. Once a metric descriptor is created, de...
@swamp/gcp/monitoring/monitoredresourcedescriptorsv2026.05.25.1monitoredresourcedescriptors.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a monitoredResourceDescriptors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the monitoredResourceDescriptors |
fn sync()
Sync monitoredResourceDescriptors state from GCP
fn list(filter?: string, pageSize?: number, maxPages?: number)
List monitoredResourceDescriptors resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | An optional filter (https://cloud.google.com/monitoring/api/v3/filters) describing the descriptors to be returned. The filter can reference the descriptor\ |
| pageSize? | number | A positive number that is the maximum number of results to return. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An object that describes the schema of a MonitoredResource object using a typ...
@swamp/gcp/monitoring/notificationchanneldescriptorsv2026.05.25.1notificationchanneldescriptors.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a notificationChannelDescriptors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the notificationChannelDescriptors |
fn sync()
Sync notificationChannelDescriptors state from GCP
fn list(pageSize?: number, maxPages?: number)
List notificationChannelDescriptors resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A description of a notification channel. The descriptor includes the properti...
@swamp/gcp/monitoring/notificationchannelsv2026.05.25.1notificationchannels.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| creationRecord? | object | Describes a change made to a configuration. |
| description? | string | An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters. |
| displayName? | string | An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters. |
| enabled? | boolean | Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future. |
| labels? | record | Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field. |
| mutationRecords? | array | Records of the modification of this channel. |
| name? | string | 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. |
| type? | string | The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. |
| userLabels? | record | User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. |
| verificationStatus? | enum | Indicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific ch |
fn create()
Create a notificationChannels
fn get(identifier: string)
Get a notificationChannels
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the notificationChannels |
fn update()
Update notificationChannels attributes
fn delete(identifier: string)
Delete the notificationChannels
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the notificationChannels |
fn sync()
Sync notificationChannels state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List notificationChannels resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. If provided, this field specifies the criteria that must be met by notification channels to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). |
| orderBy? | string | Optional. A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). |
| pageSize? | number | Optional. The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_verification_code(expireTime?: any)
get verification code
| Argument | Type | Description |
|---|---|---|
| expireTime? | any |
fn send_verification_code()
send verification code
fn verify(code?: any)
verify
| Argument | Type | Description |
|---|---|---|
| code? | any |
Resources
state(infinite)— A NotificationChannel is a medium through which an alert is delivered when a ...
@swamp/gcp/monitoring/servicesv2026.05.25.1services.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| appEngine? | object | App Engine service. Learn more at https://cloud.google.com/appengine. |
| basicService? | object | A well-known service type, defined by its service type and service labels. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). |
| cloudEndpoints? | object | Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints. |
| cloudRun? | object | Cloud Run service. Learn more at https://cloud.google.com/run. |
| clusterIstio? | object | Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type. |
| custom? | object | Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service. |
| displayName? | string | Name used for UI elements listing this Service. |
| gkeNamespace? | object | GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod). |
| gkeService? | object | GKE Service. The "service" here represents a Kubernetes service object (https://kubernetes.io/docs/concepts/services-networking/service). The field names correspond to the resource labels on k8s_service monitored resources (https://cloud.google.com/monitoring/api/resources#tag_k8s_service). |
| gkeWorkload? | object | A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, k8s_container or k8s_pod). |
| istioCanonicalService? | object | Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type. |
| meshIstio? | object | Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type. |
| name? | string | Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] |
| telemetry? | object | Configuration for how to query telemetry on a Service. |
| userLabels? | record | Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value. |
| 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\\-]+ |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a services
fn get(identifier: string)
Get a services
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the services |
fn update()
Update services attributes
fn delete(identifier: string)
Delete the services
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the services |
fn sync()
Sync services state from GCP
fn list(filter?: string, pageSize?: number, maxPages?: number)
List services resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | A filter specifying what Services to return. The filter supports filtering on a particular service-identifier type or one of its attributes.To filter on a particular service-identifier type, the identifier_case refers to which option in the identifier field is populated. For example, the filter identifier_case = "CUSTOM" would match all services with a value for the custom field. Valid options include "CUSTOM", "APP_ENGINE", "MESH_ISTIO", and the other options listed at https://cloud.google.com/ |
| pageSize? | number | A non-negative number that is the maximum number of results to return. When 0, use default page size. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A Service is a discrete, autonomous, and network-accessible unit, designed to...
@swamp/gcp/monitoring/services-servicelevelobjectivesv2026.05.25.1services_servicelevelobjectives.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| calendarPeriod? | enum | A calendar period, semantically "since the start of the current ". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported. |
| displayName? | string | Name used for UI elements listing this SLO. |
| goal? | number | The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.9999. |
| name? | string | Identifier. Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] |
| rollingPeriod? | string | A rolling time period, semantically "in the past ". Must be an integer multiple of 1 day no larger than 30 days. |
| serviceLevelIndicator? | object | A Service-Level Indicator (SLI) describes the "performance" of a service. For some services, the SLI is well-defined. In such cases, the SLI can be described easily by referencing the well-known SLI and providing the needed parameters. Alternatively, a "custom" SLI can be defined with a query to the underlying metric store. An SLI is defined to be good_service / total_service over any queried time interval. The value of performance always falls into the range 0 <= performance <= 1. A custom SLI |
| userLabels? | record | Labels which have been used to annotate the service-level objective. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value. |
| serviceLevelObjectiveId? | string | Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective. If omitted, an id will be generated instead. Must match the pattern ^[a-zA-Z0-9-_:.]+$ |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a serviceLevelObjectives
fn get(identifier: string)
Get a serviceLevelObjectives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the serviceLevelObjectives |
fn update()
Update serviceLevelObjectives attributes
fn delete(identifier: string)
Delete the serviceLevelObjectives
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the serviceLevelObjectives |
fn sync()
Sync serviceLevelObjectives state from GCP
fn list(filter?: string, pageSize?: number, view?: string, maxPages?: number)
List serviceLevelObjectives resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | A filter specifying what ServiceLevelObjectives to return. |
| pageSize? | number | A non-negative number that is the maximum number of results to return. When 0, use default page size. |
| view? | string | View of the ServiceLevelObjectives 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A Service-Level Objective (SLO) describes a level of desired good service. It...
@swamp/gcp/monitoring/snoozesv2026.05.25.1snoozes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| criteria? | object | Criteria specific to the AlertPolicys that this Snooze applies to. The Snooze will suppress alerts that come from one of the AlertPolicys whose names are supplied. |
| displayName? | string | Required. A display name for the Snooze. This can be, at most, 512 unicode characters. |
| interval | object | |
| name? | string | 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. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a snoozes
fn get(identifier: string)
Get a snoozes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the snoozes |
fn update()
Update snoozes attributes
fn sync()
Sync snoozes state from GCP
fn list(filter?: string, pageSize?: number, maxPages?: number)
List snoozes resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" |
| pageSize? | number | Optional. The maximum number of results to return for a single query. The server may further constrain the maximum number of results returned in a single page. The value should be in the range 1, 1000. If the value given is outside this range, the server will decide the number of results to be returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A Snooze will prevent any alerts from being opened, and close any that are al...
@swamp/gcp/monitoring/timeseriesv2026.05.25.1timeseries.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a timeSeries
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the timeSeries |
fn sync()
Sync timeSeries state from GCP
fn list(aggregation_alignmentPeriod?: string, aggregation_crossSeriesReducer?: string, aggregation_groupByFields?: string, aggregation_perSeriesAligner?: string, filter?: string, interval_endTime?: string, interval_startTime?: string, orderBy?: string, pageSize?: number, secondaryAggregation_alignmentPeriod?: string, secondaryAggregation_crossSeriesReducer?: string, secondaryAggregation_groupByFields?: string, secondaryAggregation_perSeriesAligner?: string, view?: string, maxPages?: number)
List timeSeries resources
| Argument | Type | Description |
|---|---|---|
| aggregation_alignmentPeriod? | string | The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the |
| aggregation_crossSeriesReducer? | string | The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must fir |
| aggregation_groupByFields? | string | The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitl |
| aggregation_perSeriesAligner? | string | An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change |
| filter? | string | Required. A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name" |
| interval_endTime? | string | Required. The end of the time interval. |
| interval_startTime? | string | Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. |
| orderBy? | string | Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest). |
| pageSize? | number | A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned. |
| secondaryAggregation_alignmentPeriod? | string | The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the |
| secondaryAggregation_crossSeriesReducer? | string | The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must fir |
| secondaryAggregation_groupByFields? | string | The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitl |
| secondaryAggregation_perSeriesAligner? | string | An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change |
| view? | string | Required. Specifies which information is returned about the time series. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— The Status type defines a logical error model that is suitable for different ...
@swamp/gcp/monitoring/uptimecheckconfigsv2026.05.25.1uptimecheckconfigs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| checkerType? | enum | The type of checkers to use to execute the Uptime check. |
| contentMatchers? | array | The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check. |
| disabled? | boolean | Whether the check is disabled or not. |
| displayName? | string | A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required. |
| httpCheck? | object | Information involved in an HTTP/HTTPS Uptime check request. |
| logCheckFailures? | boolean | To specify whether to log the results of failed probes to Cloud Logging. |
| monitoredResource? | object | An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource\ |
| name? | string | 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. |
| period? | string | How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s. |
| resourceGroup? | object | The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. |
| selectedRegions? | array | The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions. |
| syntheticMonitor? | object | Describes a Synthetic Monitor to be invoked by Uptime. |
| tcpCheck? | object | Information required for a TCP Uptime check request. |
| timeout? | string | The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required. |
| userLabels? | record | User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a uptimeCheckConfigs
fn get(identifier: string)
Get a uptimeCheckConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the uptimeCheckConfigs |
fn update()
Update uptimeCheckConfigs attributes
fn delete(identifier: string)
Delete the uptimeCheckConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the uptimeCheckConfigs |
fn sync()
Sync uptimeCheckConfigs state from GCP
fn list(filter?: string, pageSize?: number, maxPages?: number)
List uptimeCheckConfigs resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | 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). |
| pageSize? | number | 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. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— This message configures which resources and services to monitor for availabil...
@swamp/gcp/monitoring/uptimecheckipsv2026.05.25.2uptimecheckips.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a uptimeCheckIps
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the uptimeCheckIps |
fn sync()
Sync uptimeCheckIps state from GCP
fn list(pageSize?: number, maxPages?: number)
List uptimeCheckIps resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | 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 |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Contains the region, location, and list of IP addresses where checkers in the...
04Previous Versions
2026.05.24.1May 24, 2026
- Updated: timeseries, alertpolicies, alerts, groups, groups_members, metricdescriptors, monitoredresourcedescriptors, notificationchanneldescriptors, notificationchannels, snoozes, uptimecheckconfigs, services, services_servicelevelobjectives, uptimecheckips
2026.05.21.2May 21, 2026
- Updated: timeseries, alertpolicies, alerts, groups, groups_members, metricdescriptors, monitoredresourcedescriptors, notificationchanneldescriptors, notificationchannels, snoozes, uptimecheckconfigs, services, services_servicelevelobjectives, uptimecheckips
2026.05.21.1May 21, 2026
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.05.18.1May 18, 2026
2026.04.23.1Apr 23, 2026
2026.04.04.1Apr 4, 2026
- Updated: alertpolicies, services_servicelevelobjectives
2026.04.03.3Apr 3, 2026
- Updated: timeseries, alertpolicies, alerts, groups, groups_members, metricdescriptors, monitoredresourcedescriptors, notificationchanneldescriptors, notificationchannels, snoozes, uptimecheckconfigs, services, services_servicelevelobjectives, uptimecheckips
2026.04.03.1Apr 3, 2026
- Updated: timeseries, alertpolicies, alerts, groups, groups_members, metricdescriptors, monitoredresourcedescriptors, notificationchanneldescriptors, notificationchannels, snoozes, uptimecheckconfigs, services, services_servicelevelobjectives, uptimecheckips
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: timeseries, alertpolicies, alerts, groups, groups_members, metricdescriptors, monitoredresourcedescriptors, notificationchanneldescriptors, notificationchannels, snoozes, uptimecheckconfigs, services, services_servicelevelobjectives, uptimecheckips
05Stats
A
100 / 100
Downloads
0
Archive size
188.5 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels