Skip to content

Commit 801c824

Browse files
yoshi-automationsofisl
authored andcommitted
feat(monitoring)!: update the API
BREAKING CHANGE: This release has breaking changes. #### monitoring:v1 The following keys were deleted: - schemas.DashboardFilter.properties.applyToNewWidgets.description - schemas.DashboardFilter.properties.applyToNewWidgets.type The following keys were added: - schemas.Scorecard.properties.dimensions.description - schemas.Scorecard.properties.dimensions.items.$ref - schemas.Scorecard.properties.dimensions.type - schemas.Scorecard.properties.measures.description - schemas.Scorecard.properties.measures.items.$ref - schemas.Scorecard.properties.measures.type #### monitoring:v3 The following keys were added: - schemas.Documentation.properties.links.description - schemas.Documentation.properties.links.items.$ref - schemas.Documentation.properties.links.type - schemas.Link.description - schemas.Link.id - schemas.Link.properties.displayName.description - schemas.Link.properties.displayName.type - schemas.Link.properties.url.description - schemas.Link.properties.url.type - schemas.Link.type The following keys were changed: - resources.projects.resources.snoozes.methods.patch.parameters.name.description - schemas.Documentation.properties.content.description - schemas.Documentation.properties.subject.description - schemas.PrometheusQueryLanguageCondition.properties.labels.description - schemas.ServiceLevelObjective.properties.goal.description - schemas.Snooze.properties.name.description
1 parent 405e4c0 commit 801c824

File tree

3 files changed

+67
-18
lines changed

3 files changed

+67
-18
lines changed

discovery/monitoring-v1.json

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -753,7 +753,7 @@
753753
}
754754
}
755755
},
756-
"revision": "20240505",
756+
"revision": "20240616",
757757
"rootUrl": "https://monitoring.googleapis.com/",
758758
"schemas": {
759759
"Aggregation": {
@@ -1111,10 +1111,6 @@
11111111
"description": "A filter to reduce the amount of data charted in relevant widgets.",
11121112
"id": "DashboardFilter",
11131113
"properties": {
1114-
"applyToNewWidgets": {
1115-
"description": "Whether to apply this filter to new widgets by default",
1116-
"type": "boolean"
1117-
},
11181114
"filterType": {
11191115
"description": "The specified filter type",
11201116
"enum": [
@@ -2145,10 +2141,24 @@
21452141
"$ref": "Empty",
21462142
"description": "Will cause the Scorecard to show only the value, with no indicator to its value relative to its thresholds."
21472143
},
2144+
"dimensions": {
2145+
"description": "Optional. A dimension is a structured label, class, or category for a set of measurements in your data.",
2146+
"items": {
2147+
"$ref": "Dimension"
2148+
},
2149+
"type": "array"
2150+
},
21482151
"gaugeView": {
21492152
"$ref": "GaugeView",
21502153
"description": "Will cause the scorecard to show a gauge chart."
21512154
},
2155+
"measures": {
2156+
"description": "Optional. A measure is a measured value of a property in your data. For example, rainfall in inches, number of units sold, revenue gained, etc.",
2157+
"items": {
2158+
"$ref": "Measure"
2159+
},
2160+
"type": "array"
2161+
},
21522162
"sparkChartView": {
21532163
"$ref": "SparkChartView",
21542164
"description": "Will cause the scorecard to show a spark chart."

discovery/monitoring-v3.json

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1758,7 +1758,7 @@
17581758
],
17591759
"parameters": {
17601760
"name": {
1761-
"description": "Required. 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.",
1761+
"description": "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.",
17621762
"location": "path",
17631763
"pattern": "^projects/[^/]+/snoozes/[^/]+$",
17641764
"required": true,
@@ -2714,7 +2714,7 @@
27142714
}
27152715
}
27162716
},
2717-
"revision": "20240526",
2717+
"revision": "20240616",
27182718
"rootUrl": "https://monitoring.googleapis.com/",
27192719
"schemas": {
27202720
"Aggregation": {
@@ -3457,15 +3457,22 @@
34573457
"id": "Documentation",
34583458
"properties": {
34593459
"content": {
3460-
"description": "The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables).",
3460+
"description": "The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).",
34613461
"type": "string"
34623462
},
3463+
"links": {
3464+
"description": "Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.",
3465+
"items": {
3466+
"$ref": "Link"
3467+
},
3468+
"type": "array"
3469+
},
34633470
"mimeType": {
34643471
"description": "The format of the content field. Presently, only the value \"text/markdown\" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information.",
34653472
"type": "string"
34663473
},
34673474
"subject": {
3468-
"description": "Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread (https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit). It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).The contents of the subject line can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). If this field is missing or empty, a default subject line will be generated.",
3475+
"description": "Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread (https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit). It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).The contents of the subject line can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars). If this field is missing or empty, a default subject line will be generated.",
34693476
"type": "string"
34703477
}
34713478
},
@@ -4106,6 +4113,21 @@
41064113
},
41074114
"type": "object"
41084115
},
4116+
"Link": {
4117+
"description": "Links to content such as playbooks, repositories, and other resources.",
4118+
"id": "Link",
4119+
"properties": {
4120+
"displayName": {
4121+
"description": "A short display name for the link. The display name must not be empty or exceed 63 characters. Example: \"playbook\".",
4122+
"type": "string"
4123+
},
4124+
"url": {
4125+
"description": "The url of a webpage. A url can be templatized by using variables in the path or the query parameters. The total length of a URL should not exceed 2083 characters before and after variable expansion. Example: \"https://my_domain.com/playbook?name=${resource.name}\"",
4126+
"type": "string"
4127+
}
4128+
},
4129+
"type": "object"
4130+
},
41094131
"ListAlertPoliciesResponse": {
41104132
"description": "The protocol for the ListAlertPolicies response.",
41114133
"id": "ListAlertPoliciesResponse",
@@ -5158,7 +5180,7 @@
51585180
"additionalProperties": {
51595181
"type": "string"
51605182
},
5161-
"description": "Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). The only available variable names are the names of the labels in the PromQL result, including \"__name__\" and \"value\". \"labels\" may be empty.",
5183+
"description": "Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars). The only available variable names are the names of the labels in the PromQL result, including \"__name__\" and \"value\". \"labels\" may be empty.",
51625184
"type": "object"
51635185
},
51645186
"query": {
@@ -5459,7 +5481,7 @@
54595481
"type": "string"
54605482
},
54615483
"goal": {
5462-
"description": "The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999.",
5484+
"description": "The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.9999.",
54635485
"format": "double",
54645486
"type": "number"
54655487
},
@@ -5503,7 +5525,7 @@
55035525
"description": "Required. The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI."
55045526
},
55055527
"name": {
5506-
"description": "Required. 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.",
5528+
"description": "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.",
55075529
"type": "string"
55085530
}
55095531
},

src/apis/monitoring/v3.ts

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -618,15 +618,19 @@ export namespace monitoring_v3 {
618618
*/
619619
export interface Schema$Documentation {
620620
/**
621-
* The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables).
621+
* The body of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars).
622622
*/
623623
content?: string | null;
624+
/**
625+
* Optional. Links to content such as playbooks, repositories, and other resources. This field can contain up to 3 entries.
626+
*/
627+
links?: Schema$Link[];
624628
/**
625629
* The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information.
626630
*/
627631
mimeType?: string | null;
628632
/**
629-
* Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread (https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit). It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).The contents of the subject line can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). If this field is missing or empty, a default subject line will be generated.
633+
* Optional. The subject line of the notification. The subject line may not exceed 10,240 bytes. In notifications generated by this policy, the contents of the subject line after variable expansion will be truncated to 255 bytes or shorter at the latest UTF-8 character boundary. The 255-byte limit is recommended by this thread (https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit). It is both the limit imposed by some third-party ticketing products and it is common to define textual fields in databases as VARCHAR(255).The contents of the subject line can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars). If this field is missing or empty, a default subject line will be generated.
630634
*/
631635
subject?: string | null;
632636
}
@@ -1068,6 +1072,19 @@ export namespace monitoring_v3 {
10681072
*/
10691073
width?: number | null;
10701074
}
1075+
/**
1076+
* Links to content such as playbooks, repositories, and other resources.
1077+
*/
1078+
export interface Schema$Link {
1079+
/**
1080+
* A short display name for the link. The display name must not be empty or exceed 63 characters. Example: "playbook".
1081+
*/
1082+
displayName?: string | null;
1083+
/**
1084+
* The url of a webpage. A url can be templatized by using variables in the path or the query parameters. The total length of a URL should not exceed 2083 characters before and after variable expansion. Example: "https://my_domain.com/playbook?name=${resource.name\}"
1085+
*/
1086+
url?: string | null;
1087+
}
10711088
/**
10721089
* The protocol for the ListAlertPolicies response.
10731090
*/
@@ -1737,7 +1754,7 @@ export namespace monitoring_v3 {
17371754
*/
17381755
evaluationInterval?: string | null;
17391756
/**
1740-
* Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables). The only available variable names are the names of the labels in the PromQL result, including "__name__" and "value". "labels" may be empty.
1757+
* Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables#doc-vars). The only available variable names are the names of the labels in the PromQL result, including "__name__" and "value". "labels" may be empty.
17411758
*/
17421759
labels?: {[key: string]: string} | null;
17431760
/**
@@ -1947,7 +1964,7 @@ export namespace monitoring_v3 {
19471964
*/
19481965
displayName?: string | null;
19491966
/**
1950-
* The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999.
1967+
* The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.9999.
19511968
*/
19521969
goal?: number | null;
19531970
/**
@@ -1984,7 +2001,7 @@ export namespace monitoring_v3 {
19842001
*/
19852002
interval?: Schema$TimeInterval;
19862003
/**
1987-
* Required. 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.
2004+
* 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.
19882005
*/
19892006
name?: string | null;
19902007
}
@@ -6103,7 +6120,7 @@ export namespace monitoring_v3 {
61036120
export interface Params$Resource$Projects$Snoozes$Patch
61046121
extends StandardParameters {
61056122
/**
6106-
* Required. 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.
6123+
* 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.
61076124
*/
61086125
name?: string;
61096126
/**

0 commit comments

Comments
 (0)