Skip to content

Commit 5448212

Browse files
feat(monitoring): update the API
#### monitoring:v1 The following keys were added: - schemas.Scorecard.properties.breakdowns.description - schemas.Scorecard.properties.breakdowns.items.$ref - schemas.Scorecard.properties.breakdowns.type - schemas.SingleViewGroup.properties.displayType.description - schemas.SingleViewGroup.properties.displayType.enum - schemas.SingleViewGroup.properties.displayType.enumDescriptions - schemas.SingleViewGroup.properties.displayType.type - schemas.TemplateVariableCondition.description - schemas.TemplateVariableCondition.id - schemas.TemplateVariableCondition.properties.comparator.description - schemas.TemplateVariableCondition.properties.comparator.enum - schemas.TemplateVariableCondition.properties.comparator.enumDescriptions - schemas.TemplateVariableCondition.properties.comparator.type - schemas.TemplateVariableCondition.properties.templateVariable.description - schemas.TemplateVariableCondition.properties.templateVariable.type - schemas.TemplateVariableCondition.properties.templateVariableValue.description - schemas.TemplateVariableCondition.properties.templateVariableValue.type - schemas.TemplateVariableCondition.type - schemas.VisibilityCondition.description - schemas.VisibilityCondition.id - schemas.VisibilityCondition.properties.templateVariableCondition.$ref - schemas.VisibilityCondition.properties.templateVariableCondition.description - schemas.VisibilityCondition.type - schemas.Widget.properties.visibilityCondition.$ref - schemas.Widget.properties.visibilityCondition.description #### monitoring:v3 The following keys were added: - schemas.Criteria.properties.filter.description - schemas.Criteria.properties.filter.type - schemas.UptimeCheckConfig.properties.logCheckFailures.description - schemas.UptimeCheckConfig.properties.logCheckFailures.type The following keys were changed: - resources.projects.resources.snoozes.methods.list.parameters.filter.description - schemas.Criteria.properties.policies.description
1 parent 3b99d33 commit 5448212

File tree

3 files changed

+87
-7
lines changed

3 files changed

+87
-7
lines changed

discovery/monitoring-v1.json

Lines changed: 66 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -753,7 +753,7 @@
753753
}
754754
}
755755
},
756-
"revision": "20241212",
756+
"revision": "20250227",
757757
"rootUrl": "https://monitoring.googleapis.com/",
758758
"schemas": {
759759
"Aggregation": {
@@ -2236,6 +2236,13 @@
22362236
"$ref": "Empty",
22372237
"description": "Will cause the Scorecard to show only the value, with no indicator to its value relative to its thresholds."
22382238
},
2239+
"breakdowns": {
2240+
"description": "Optional. The collection of breakdowns to be applied to the dataset. A breakdown is a way to slice the data. For example, you can break down the data by region.",
2241+
"items": {
2242+
"$ref": "Breakdown"
2243+
},
2244+
"type": "array"
2245+
},
22392246
"dimensions": {
22402247
"description": "Optional. A dimension is a structured label, class, or category for a set of measurements in your data.",
22412248
"items": {
@@ -2290,7 +2297,22 @@
22902297
"SingleViewGroup": {
22912298
"description": "A widget that groups the other widgets by using a dropdown menu. All widgets that are within the area spanned by the grouping widget are considered member widgets.",
22922299
"id": "SingleViewGroup",
2293-
"properties": {},
2300+
"properties": {
2301+
"displayType": {
2302+
"description": "Optional. Determines how the widget selector will be displayed.",
2303+
"enum": [
2304+
"DISPLAY_TYPE_UNSPECIFIED",
2305+
"DROPDOWN",
2306+
"TAB"
2307+
],
2308+
"enumDescriptions": [
2309+
"Display type is not specified, defaults to DROPDOWN.",
2310+
"Renders the widget selector as a dropdown.",
2311+
"Renders the widget selector as a tab list."
2312+
],
2313+
"type": "string"
2314+
}
2315+
},
22942316
"type": "object"
22952317
},
22962318
"SourceContext": {
@@ -2445,6 +2467,33 @@
24452467
},
24462468
"type": "object"
24472469
},
2470+
"TemplateVariableCondition": {
2471+
"description": "A condition whose evaluation is based on the value of a template variable.",
2472+
"id": "TemplateVariableCondition",
2473+
"properties": {
2474+
"comparator": {
2475+
"description": "Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable.",
2476+
"enum": [
2477+
"COMPARATOR_UNSPECIFIED",
2478+
"REGEX_FULL_MATCH"
2479+
],
2480+
"enumDescriptions": [
2481+
"No comparator specified. Behavior defaults to REGEX_FULL_MATCH.",
2482+
"Condition with this comparator evaluates to true when the value of the template variables matches the specified regex."
2483+
],
2484+
"type": "string"
2485+
},
2486+
"templateVariable": {
2487+
"description": "The template variable whose value is evaluated.",
2488+
"type": "string"
2489+
},
2490+
"templateVariableValue": {
2491+
"description": "The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex.",
2492+
"type": "string"
2493+
}
2494+
},
2495+
"type": "object"
2496+
},
24482497
"Text": {
24492498
"description": "A widget that displays textual content.",
24502499
"id": "Text",
@@ -2864,6 +2913,17 @@
28642913
},
28652914
"type": "object"
28662915
},
2916+
"VisibilityCondition": {
2917+
"description": "Condition that determines whether the widget should be displayed.",
2918+
"id": "VisibilityCondition",
2919+
"properties": {
2920+
"templateVariableCondition": {
2921+
"$ref": "TemplateVariableCondition",
2922+
"description": "A condition whose evaluation is based on the value of a template variable."
2923+
}
2924+
},
2925+
"type": "object"
2926+
},
28672927
"Widget": {
28682928
"description": "Widget contains a single dashboard component and configuration of how to present the component in the dashboard.",
28692929
"id": "Widget",
@@ -2924,6 +2984,10 @@
29242984
"description": "Optional. The title of the widget.",
29252985
"type": "string"
29262986
},
2987+
"visibilityCondition": {
2988+
"$ref": "VisibilityCondition",
2989+
"description": "Optional. If set, this widget is rendered only when the condition is evaluated to true."
2990+
},
29272991
"xyChart": {
29282992
"$ref": "XyChart",
29292993
"description": "A chart of time series data."

discovery/monitoring-v3.json

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1720,7 +1720,7 @@
17201720
],
17211721
"parameters": {
17221722
"filter": {
1723-
"description": "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\" ``` ",
1723+
"description": "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\" ",
17241724
"location": "query",
17251725
"type": "string"
17261726
},
@@ -2720,7 +2720,7 @@
27202720
}
27212721
}
27222722
},
2723-
"revision": "20250111",
2723+
"revision": "20250227",
27242724
"rootUrl": "https://monitoring.googleapis.com/",
27252725
"schemas": {
27262726
"Aggregation": {
@@ -3414,8 +3414,12 @@
34143414
"description": "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.",
34153415
"id": "Criteria",
34163416
"properties": {
3417+
"filter": {
3418+
"description": "Optional. The filter string to match on Alert fields when silencing the alerts. It follows the standard https://google.aip.dev/160 syntax. A filter string used to apply the snooze to specific incidents that have matching filter values. Filters can be defined for snoozes that apply to one alerting policy. Filters must be a string formatted as one or more resource labels with specific label values. If multiple resource labels are used, then they must be connected with an AND operator. For example, the following filter applies the snooze to incidents that have an instance ID of 1234567890 and a zone of us-central1-a: resource.labels.instance_id=\"1234567890\" AND resource.labels.zone=\"us-central1-a\" ",
3419+
"type": "string"
3420+
},
34173421
"policies": {
3418-
"description": "The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.",
3422+
"description": "The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time.",
34193423
"items": {
34203424
"type": "string"
34213425
},
@@ -6114,6 +6118,10 @@
61146118
"description": "If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.",
61156119
"type": "boolean"
61166120
},
6121+
"logCheckFailures": {
6122+
"description": "To specify whether to log the results of failed probes to Cloud Logging.",
6123+
"type": "boolean"
6124+
},
61176125
"monitoredResource": {
61186126
"$ref": "MonitoredResource",
61196127
"description": "The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision"

src/apis/monitoring/v3.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,11 @@ export namespace monitoring_v3 {
576576
*/
577577
export interface Schema$Criteria {
578578
/**
579-
* The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
579+
* Optional. The filter string to match on Alert fields when silencing the alerts. It follows the standard https://google.aip.dev/160 syntax. A filter string used to apply the snooze to specific incidents that have matching filter values. Filters can be defined for snoozes that apply to one alerting policy. Filters must be a string formatted as one or more resource labels with specific label values. If multiple resource labels are used, then they must be connected with an AND operator. For example, the following filter applies the snooze to incidents that have an instance ID of 1234567890 and a zone of us-central1-a: resource.labels.instance_id="1234567890" AND resource.labels.zone="us-central1-a"
580+
*/
581+
filter?: string | null;
582+
/**
583+
* The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time.
580584
*/
581585
policies?: string[] | null;
582586
}
@@ -2386,6 +2390,10 @@ export namespace monitoring_v3 {
23862390
* If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.
23872391
*/
23882392
isInternal?: boolean | null;
2393+
/**
2394+
* To specify whether to log the results of failed probes to Cloud Logging.
2395+
*/
2396+
logCheckFailures?: boolean | null;
23892397
/**
23902398
* The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision
23912399
*/
@@ -6232,7 +6240,7 @@ export namespace monitoring_v3 {
62326240
export interface Params$Resource$Projects$Snoozes$List
62336241
extends StandardParameters {
62346242
/**
6235-
* 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" ```
6243+
* 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"
62366244
*/
62376245
filter?: string;
62386246
/**

0 commit comments

Comments
 (0)