You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/monitoring_v1.projects.dashboards.html
+96Lines changed: 96 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -111,6 +111,22 @@ <h3>Method Details</h3>
111
111
The object takes the form of:
112
112
113
113
{ # A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
114
+
"annotations": { # Dashboard-level configuration for annotations # Configuration for event annotations to display on this dashboard.
115
+
"defaultResourceNames": [ # Dashboard level defaults for names of logging resources to search for events. Currently only projects are supported. Each individual EventAnnotation may have its own overrides. If both this field and the per annotation field is empty, then the scoping project is used. Limit: 50 projects. For example: “projects/some-project-id”
116
+
"A String",
117
+
],
118
+
"eventAnnotations": [ # List of annotation configurations for this dashboard. Each entry specifies one event type.
119
+
{ # Annotation configuration for one event type on a dashboard
120
+
"displayName": "A String", # Solely for UI display. Should not be used programmatically.
121
+
"enabled": True or False, # Whether or not to show the events on the dashboard by default
122
+
"eventType": "A String", # The type of event to display.
123
+
"filter": "A String", # string filtering the events - event dependant. Example values: "resource.labels.pod_name = 'pod-1'" "protoPayload.authenticationInfo.principalEmail='[email protected]'"
124
+
"resourceNames": [ # Per annotation level override for the names of logging resources to search for events. Currently only projects are supported. If both this field and the per annotation field is empty, it will default to the host project. Limit: 50 projects. For example: “projects/another-project-id”
125
+
"A String",
126
+
],
127
+
},
128
+
],
129
+
},
114
130
"columnLayout": { # A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column. # The content is divided into equally spaced columns and the widgets are arranged vertically.
115
131
"columns": [ # The columns of content to display.
116
132
{ # Defines the layout properties and content for a column.
@@ -2412,6 +2428,22 @@ <h3>Method Details</h3>
2412
2428
An object of the form:
2413
2429
2414
2430
{ # A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
2431
+
"annotations": { # Dashboard-level configuration for annotations # Configuration for event annotations to display on this dashboard.
2432
+
"defaultResourceNames": [ # Dashboard level defaults for names of logging resources to search for events. Currently only projects are supported. Each individual EventAnnotation may have its own overrides. If both this field and the per annotation field is empty, then the scoping project is used. Limit: 50 projects. For example: “projects/some-project-id”
2433
+
"A String",
2434
+
],
2435
+
"eventAnnotations": [ # List of annotation configurations for this dashboard. Each entry specifies one event type.
2436
+
{ # Annotation configuration for one event type on a dashboard
2437
+
"displayName": "A String", # Solely for UI display. Should not be used programmatically.
2438
+
"enabled": True or False, # Whether or not to show the events on the dashboard by default
2439
+
"eventType": "A String", # The type of event to display.
2440
+
"filter": "A String", # string filtering the events - event dependant. Example values: "resource.labels.pod_name = 'pod-1'" "protoPayload.authenticationInfo.principalEmail='[email protected]'"
2441
+
"resourceNames": [ # Per annotation level override for the names of logging resources to search for events. Currently only projects are supported. If both this field and the per annotation field is empty, it will default to the host project. Limit: 50 projects. For example: “projects/another-project-id”
2442
+
"A String",
2443
+
],
2444
+
},
2445
+
],
2446
+
},
2415
2447
"columnLayout": { # A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column. # The content is divided into equally spaced columns and the widgets are arranged vertically.
2416
2448
"columns": [ # The columns of content to display.
2417
2449
{ # Defines the layout properties and content for a column.
@@ -4737,6 +4769,22 @@ <h3>Method Details</h3>
4737
4769
An object of the form:
4738
4770
4739
4771
{ # A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
4772
+
"annotations": { # Dashboard-level configuration for annotations # Configuration for event annotations to display on this dashboard.
4773
+
"defaultResourceNames": [ # Dashboard level defaults for names of logging resources to search for events. Currently only projects are supported. Each individual EventAnnotation may have its own overrides. If both this field and the per annotation field is empty, then the scoping project is used. Limit: 50 projects. For example: “projects/some-project-id”
4774
+
"A String",
4775
+
],
4776
+
"eventAnnotations": [ # List of annotation configurations for this dashboard. Each entry specifies one event type.
4777
+
{ # Annotation configuration for one event type on a dashboard
4778
+
"displayName": "A String", # Solely for UI display. Should not be used programmatically.
4779
+
"enabled": True or False, # Whether or not to show the events on the dashboard by default
4780
+
"eventType": "A String", # The type of event to display.
4781
+
"filter": "A String", # string filtering the events - event dependant. Example values: "resource.labels.pod_name = 'pod-1'" "protoPayload.authenticationInfo.principalEmail='[email protected]'"
4782
+
"resourceNames": [ # Per annotation level override for the names of logging resources to search for events. Currently only projects are supported. If both this field and the per annotation field is empty, it will default to the host project. Limit: 50 projects. For example: “projects/another-project-id”
4783
+
"A String",
4784
+
],
4785
+
},
4786
+
],
4787
+
},
4740
4788
"columnLayout": { # A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column. # The content is divided into equally spaced columns and the widgets are arranged vertically.
4741
4789
"columns": [ # The columns of content to display.
4742
4790
{ # Defines the layout properties and content for a column.
@@ -7048,6 +7096,22 @@ <h3>Method Details</h3>
7048
7096
{ # The ListDashboards request.
7049
7097
"dashboards": [ # The list of requested dashboards.
7050
7098
{ # A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
7099
+
"annotations": { # Dashboard-level configuration for annotations # Configuration for event annotations to display on this dashboard.
7100
+
"defaultResourceNames": [ # Dashboard level defaults for names of logging resources to search for events. Currently only projects are supported. Each individual EventAnnotation may have its own overrides. If both this field and the per annotation field is empty, then the scoping project is used. Limit: 50 projects. For example: “projects/some-project-id”
7101
+
"A String",
7102
+
],
7103
+
"eventAnnotations": [ # List of annotation configurations for this dashboard. Each entry specifies one event type.
7104
+
{ # Annotation configuration for one event type on a dashboard
7105
+
"displayName": "A String", # Solely for UI display. Should not be used programmatically.
7106
+
"enabled": True or False, # Whether or not to show the events on the dashboard by default
7107
+
"eventType": "A String", # The type of event to display.
7108
+
"filter": "A String", # string filtering the events - event dependant. Example values: "resource.labels.pod_name = 'pod-1'" "protoPayload.authenticationInfo.principalEmail='[email protected]'"
7109
+
"resourceNames": [ # Per annotation level override for the names of logging resources to search for events. Currently only projects are supported. If both this field and the per annotation field is empty, it will default to the host project. Limit: 50 projects. For example: “projects/another-project-id”
7110
+
"A String",
7111
+
],
7112
+
},
7113
+
],
7114
+
},
7051
7115
"columnLayout": { # A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column. # The content is divided into equally spaced columns and the widgets are arranged vertically.
7052
7116
"columns": [ # The columns of content to display.
7053
7117
{ # Defines the layout properties and content for a column.
@@ -9367,6 +9431,22 @@ <h3>Method Details</h3>
9367
9431
The object takes the form of:
9368
9432
9369
9433
{ # A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
9434
+
"annotations": { # Dashboard-level configuration for annotations # Configuration for event annotations to display on this dashboard.
9435
+
"defaultResourceNames": [ # Dashboard level defaults for names of logging resources to search for events. Currently only projects are supported. Each individual EventAnnotation may have its own overrides. If both this field and the per annotation field is empty, then the scoping project is used. Limit: 50 projects. For example: “projects/some-project-id”
9436
+
"A String",
9437
+
],
9438
+
"eventAnnotations": [ # List of annotation configurations for this dashboard. Each entry specifies one event type.
9439
+
{ # Annotation configuration for one event type on a dashboard
9440
+
"displayName": "A String", # Solely for UI display. Should not be used programmatically.
9441
+
"enabled": True or False, # Whether or not to show the events on the dashboard by default
9442
+
"eventType": "A String", # The type of event to display.
9443
+
"filter": "A String", # string filtering the events - event dependant. Example values: "resource.labels.pod_name = 'pod-1'" "protoPayload.authenticationInfo.principalEmail='[email protected]'"
9444
+
"resourceNames": [ # Per annotation level override for the names of logging resources to search for events. Currently only projects are supported. If both this field and the per annotation field is empty, it will default to the host project. Limit: 50 projects. For example: “projects/another-project-id”
9445
+
"A String",
9446
+
],
9447
+
},
9448
+
],
9449
+
},
9370
9450
"columnLayout": { # A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column. # The content is divided into equally spaced columns and the widgets are arranged vertically.
9371
9451
"columns": [ # The columns of content to display.
9372
9452
{ # Defines the layout properties and content for a column.
@@ -11668,6 +11748,22 @@ <h3>Method Details</h3>
11668
11748
An object of the form:
11669
11749
11670
11750
{ # A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
11751
+
"annotations": { # Dashboard-level configuration for annotations # Configuration for event annotations to display on this dashboard.
11752
+
"defaultResourceNames": [ # Dashboard level defaults for names of logging resources to search for events. Currently only projects are supported. Each individual EventAnnotation may have its own overrides. If both this field and the per annotation field is empty, then the scoping project is used. Limit: 50 projects. For example: “projects/some-project-id”
11753
+
"A String",
11754
+
],
11755
+
"eventAnnotations": [ # List of annotation configurations for this dashboard. Each entry specifies one event type.
11756
+
{ # Annotation configuration for one event type on a dashboard
11757
+
"displayName": "A String", # Solely for UI display. Should not be used programmatically.
11758
+
"enabled": True or False, # Whether or not to show the events on the dashboard by default
11759
+
"eventType": "A String", # The type of event to display.
11760
+
"filter": "A String", # string filtering the events - event dependant. Example values: "resource.labels.pod_name = 'pod-1'" "protoPayload.authenticationInfo.principalEmail='[email protected]'"
11761
+
"resourceNames": [ # Per annotation level override for the names of logging resources to search for events. Currently only projects are supported. If both this field and the per annotation field is empty, it will default to the host project. Limit: 50 projects. For example: “projects/another-project-id”
11762
+
"A String",
11763
+
],
11764
+
},
11765
+
],
11766
+
},
11671
11767
"columnLayout": { # A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column. # The content is divided into equally spaced columns and the widgets are arranged vertically.
11672
11768
"columns": [ # The columns of content to display.
11673
11769
{ # Defines the layout properties and content for a column.
Copy file name to clipboardExpand all lines: googleapiclient/discovery_cache/documents/monitoring.v1.json
+100-1Lines changed: 100 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -753,7 +753,7 @@
753
753
}
754
754
}
755
755
},
756
-
"revision": "20240427",
756
+
"revision": "20240505",
757
757
"rootUrl": "https://monitoring.googleapis.com/",
758
758
"schemas": {
759
759
"Aggregation": {
@@ -1037,6 +1037,10 @@
1037
1037
"description": "A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.",
1038
1038
"id": "Dashboard",
1039
1039
"properties": {
1040
+
"annotations": {
1041
+
"$ref": "DashboardAnnotations",
1042
+
"description": "Configuration for event annotations to display on this dashboard."
1043
+
},
1040
1044
"columnLayout": {
1041
1045
"$ref": "ColumnLayout",
1042
1046
"description": "The content is divided into equally spaced columns and the widgets are arranged vertically."
@@ -1082,6 +1086,27 @@
1082
1086
},
1083
1087
"type": "object"
1084
1088
},
1089
+
"DashboardAnnotations": {
1090
+
"description": "Dashboard-level configuration for annotations",
1091
+
"id": "DashboardAnnotations",
1092
+
"properties": {
1093
+
"defaultResourceNames": {
1094
+
"description": "Dashboard level defaults for names of logging resources to search for events. Currently only projects are supported. Each individual EventAnnotation may have its own overrides. If both this field and the per annotation field is empty, then the scoping project is used. Limit: 50 projects. For example: \u201cprojects/some-project-id\u201d",
1095
+
"items": {
1096
+
"type": "string"
1097
+
},
1098
+
"type": "array"
1099
+
},
1100
+
"eventAnnotations": {
1101
+
"description": "List of annotation configurations for this dashboard. Each entry specifies one event type.",
1102
+
"items": {
1103
+
"$ref": "EventAnnotation"
1104
+
},
1105
+
"type": "array"
1106
+
}
1107
+
},
1108
+
"type": "object"
1109
+
},
1085
1110
"DashboardFilter": {
1086
1111
"description": "A filter to reduce the amount of data charted in relevant widgets.",
1087
1112
"id": "DashboardFilter",
@@ -1301,6 +1326,80 @@
1301
1326
},
1302
1327
"type": "object"
1303
1328
},
1329
+
"EventAnnotation": {
1330
+
"description": "Annotation configuration for one event type on a dashboard",
1331
+
"id": "EventAnnotation",
1332
+
"properties": {
1333
+
"displayName": {
1334
+
"description": "Solely for UI display. Should not be used programmatically.",
1335
+
"type": "string"
1336
+
},
1337
+
"enabled": {
1338
+
"description": "Whether or not to show the events on the dashboard by default",
1339
+
"type": "boolean"
1340
+
},
1341
+
"eventType": {
1342
+
"description": "The type of event to display.",
1343
+
"enum": [
1344
+
"EVENT_TYPE_UNSPECIFIED",
1345
+
"GKE_WORKLOAD_DEPLOYMENT",
1346
+
"GKE_POD_CRASH",
1347
+
"GKE_POD_UNSCHEDULABLE",
1348
+
"GKE_CONTAINER_CREATION_FAILED",
1349
+
"GKE_CLUSTER_CREATE_DELETE",
1350
+
"GKE_CLUSTER_UPDATE",
1351
+
"GKE_NODE_POOL_UPDATE",
1352
+
"GKE_CLUSTER_AUTOSCALER",
1353
+
"GKE_POD_AUTOSCALER",
1354
+
"VM_TERMINATION",
1355
+
"VM_GUEST_OS_ERROR",
1356
+
"VM_START_FAILED",
1357
+
"MIG_UPDATE",
1358
+
"MIG_AUTOSCALER",
1359
+
"CLOUD_RUN_DEPLOYMENT",
1360
+
"CLOUD_SQL_FAILOVER",
1361
+
"CLOUD_SQL_START_STOP",
1362
+
"CLOUD_SQL_STORAGE",
1363
+
"UPTIME_CHECK_FAILURE"
1364
+
],
1365
+
"enumDescriptions": [
1366
+
"No event type specified.",
1367
+
"Patch/update of GKE workload.",
1368
+
"Crash events for a GKE Pod.",
1369
+
"Scheduling failures for GKE Pods.",
1370
+
"Failure to create a GKE container.",
1371
+
"Create/delete of a GKE cluster.",
1372
+
"Update of a GKE cluster.",
1373
+
"Update of a GKE node pool.",
1374
+
"GKE cluster autoscaler event.",
1375
+
"GKE pod autoscaler event.",
1376
+
"Termination of a virtual machine.",
1377
+
"Guest OS error on a virtual machine.",
1378
+
"Start failure on a virtual machine.",
1379
+
"Update of a managed instance group.",
1380
+
"Autoscaler event for a managed instance group.",
1381
+
"New deployment of a Cloud Run service.",
1382
+
"Failover of a Cloud SQL instance.",
1383
+
"Start/stop of a Cloud SQL instance.",
1384
+
"Storage event for a Cloud SQL instance.",
1385
+
"Failure of a Cloud Monitoring uptime check."
1386
+
],
1387
+
"type": "string"
1388
+
},
1389
+
"filter": {
1390
+
"description": "string filtering the events - event dependant. Example values: \"resource.labels.pod_name = 'pod-1'\"\"protoPayload.authenticationInfo.principalEmail='[email protected]'\"",
1391
+
"type": "string"
1392
+
},
1393
+
"resourceNames": {
1394
+
"description": "Per annotation level override for the names of logging resources to search for events. Currently only projects are supported. If both this field and the per annotation field is empty, it will default to the host project. Limit: 50 projects. For example: \u201cprojects/another-project-id\u201d",
1395
+
"items": {
1396
+
"type": "string"
1397
+
},
1398
+
"type": "array"
1399
+
}
1400
+
},
1401
+
"type": "object"
1402
+
},
1304
1403
"Field": {
1305
1404
"description": "A single field of a message type.",
0 commit comments