feat(monitoring): update the api

#### monitoring:v1 The following keys were added: - schemas.Dashboard.properties.annotations.$ref (Total Keys: 1) - schemas.DashboardAnnotations (Total Keys: 6) - schemas.EventAnnotation (Total Keys: 8)
googleapis · May 10, 2024 · 2cdf937 · 2cdf937
1 parent b4ab366
commit 2cdf937
Show file tree

Hide file tree

Showing 3 changed files with 197 additions and 2 deletions.
diff --git a/docs/dyn/monitoring_v1.projects.dashboards.html b/docs/dyn/monitoring_v1.projects.dashboards.html
@@ -111,6 +111,22 @@ <h3>Method Details</h3>
     The object takes the form of:
 
 { # A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
+  &quot;annotations&quot;: { # Dashboard-level configuration for annotations # Configuration for event annotations to display on this dashboard.
+    &quot;defaultResourceNames&quot;: [ # 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”
+      &quot;A String&quot;,
+    ],
+    &quot;eventAnnotations&quot;: [ # List of annotation configurations for this dashboard. Each entry specifies one event type.
+      { # Annotation configuration for one event type on a dashboard
+        &quot;displayName&quot;: &quot;A String&quot;, # Solely for UI display. Should not be used programmatically.
+        &quot;enabled&quot;: True or False, # Whether or not to show the events on the dashboard by default
+        &quot;eventType&quot;: &quot;A String&quot;, # The type of event to display.
+        &quot;filter&quot;: &quot;A String&quot;, # string filtering the events - event dependant. Example values: &quot;resource.labels.pod_name = &#x27;pod-1&#x27;&quot; &quot;protoPayload.authenticationInfo.principalEmail=&#x27;user@example.com&#x27;&quot;
+        &quot;resourceNames&quot;: [ # 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”
+          &quot;A String&quot;,
+        ],
+      },
+    ],
+  },
   &quot;columnLayout&quot;: { # 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.
     &quot;columns&quot;: [ # The columns of content to display.
       { # Defines the layout properties and content for a column.
@@ -2412,6 +2428,22 @@ <h3>Method Details</h3>
   An object of the form:
 
     { # A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
+  &quot;annotations&quot;: { # Dashboard-level configuration for annotations # Configuration for event annotations to display on this dashboard.
+    &quot;defaultResourceNames&quot;: [ # 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”
+      &quot;A String&quot;,
+    ],
+    &quot;eventAnnotations&quot;: [ # List of annotation configurations for this dashboard. Each entry specifies one event type.
+      { # Annotation configuration for one event type on a dashboard
+        &quot;displayName&quot;: &quot;A String&quot;, # Solely for UI display. Should not be used programmatically.
+        &quot;enabled&quot;: True or False, # Whether or not to show the events on the dashboard by default
+        &quot;eventType&quot;: &quot;A String&quot;, # The type of event to display.
+        &quot;filter&quot;: &quot;A String&quot;, # string filtering the events - event dependant. Example values: &quot;resource.labels.pod_name = &#x27;pod-1&#x27;&quot; &quot;protoPayload.authenticationInfo.principalEmail=&#x27;user@example.com&#x27;&quot;
+        &quot;resourceNames&quot;: [ # 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”
+          &quot;A String&quot;,
+        ],
+      },
+    ],
+  },
   &quot;columnLayout&quot;: { # 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.
     &quot;columns&quot;: [ # The columns of content to display.
       { # Defines the layout properties and content for a column.
@@ -4737,6 +4769,22 @@ <h3>Method Details</h3>
   An object of the form:
 
     { # A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
+  &quot;annotations&quot;: { # Dashboard-level configuration for annotations # Configuration for event annotations to display on this dashboard.
+    &quot;defaultResourceNames&quot;: [ # 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”
+      &quot;A String&quot;,
+    ],
+    &quot;eventAnnotations&quot;: [ # List of annotation configurations for this dashboard. Each entry specifies one event type.
+      { # Annotation configuration for one event type on a dashboard
+        &quot;displayName&quot;: &quot;A String&quot;, # Solely for UI display. Should not be used programmatically.
+        &quot;enabled&quot;: True or False, # Whether or not to show the events on the dashboard by default
+        &quot;eventType&quot;: &quot;A String&quot;, # The type of event to display.
+        &quot;filter&quot;: &quot;A String&quot;, # string filtering the events - event dependant. Example values: &quot;resource.labels.pod_name = &#x27;pod-1&#x27;&quot; &quot;protoPayload.authenticationInfo.principalEmail=&#x27;user@example.com&#x27;&quot;
+        &quot;resourceNames&quot;: [ # 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”
+          &quot;A String&quot;,
+        ],
+      },
+    ],
+  },
   &quot;columnLayout&quot;: { # 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.
     &quot;columns&quot;: [ # The columns of content to display.
       { # Defines the layout properties and content for a column.
@@ -7048,6 +7096,22 @@ <h3>Method Details</h3>
     { # The ListDashboards request.
   &quot;dashboards&quot;: [ # The list of requested dashboards.
     { # A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
+      &quot;annotations&quot;: { # Dashboard-level configuration for annotations # Configuration for event annotations to display on this dashboard.
+        &quot;defaultResourceNames&quot;: [ # 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”
+          &quot;A String&quot;,
+        ],
+        &quot;eventAnnotations&quot;: [ # List of annotation configurations for this dashboard. Each entry specifies one event type.
+          { # Annotation configuration for one event type on a dashboard
+            &quot;displayName&quot;: &quot;A String&quot;, # Solely for UI display. Should not be used programmatically.
+            &quot;enabled&quot;: True or False, # Whether or not to show the events on the dashboard by default
+            &quot;eventType&quot;: &quot;A String&quot;, # The type of event to display.
+            &quot;filter&quot;: &quot;A String&quot;, # string filtering the events - event dependant. Example values: &quot;resource.labels.pod_name = &#x27;pod-1&#x27;&quot; &quot;protoPayload.authenticationInfo.principalEmail=&#x27;user@example.com&#x27;&quot;
+            &quot;resourceNames&quot;: [ # 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”
+              &quot;A String&quot;,
+            ],
+          },
+        ],
+      },
       &quot;columnLayout&quot;: { # 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.
         &quot;columns&quot;: [ # The columns of content to display.
           { # Defines the layout properties and content for a column.
@@ -9367,6 +9431,22 @@ <h3>Method Details</h3>
     The object takes the form of:
 
 { # A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
+  &quot;annotations&quot;: { # Dashboard-level configuration for annotations # Configuration for event annotations to display on this dashboard.
+    &quot;defaultResourceNames&quot;: [ # 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”
+      &quot;A String&quot;,
+    ],
+    &quot;eventAnnotations&quot;: [ # List of annotation configurations for this dashboard. Each entry specifies one event type.
+      { # Annotation configuration for one event type on a dashboard
+        &quot;displayName&quot;: &quot;A String&quot;, # Solely for UI display. Should not be used programmatically.
+        &quot;enabled&quot;: True or False, # Whether or not to show the events on the dashboard by default
+        &quot;eventType&quot;: &quot;A String&quot;, # The type of event to display.
+        &quot;filter&quot;: &quot;A String&quot;, # string filtering the events - event dependant. Example values: &quot;resource.labels.pod_name = &#x27;pod-1&#x27;&quot; &quot;protoPayload.authenticationInfo.principalEmail=&#x27;user@example.com&#x27;&quot;
+        &quot;resourceNames&quot;: [ # 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”
+          &quot;A String&quot;,
+        ],
+      },
+    ],
+  },
   &quot;columnLayout&quot;: { # 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.
     &quot;columns&quot;: [ # The columns of content to display.
       { # Defines the layout properties and content for a column.
@@ -11668,6 +11748,22 @@ <h3>Method Details</h3>
   An object of the form:
 
     { # A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
+  &quot;annotations&quot;: { # Dashboard-level configuration for annotations # Configuration for event annotations to display on this dashboard.
+    &quot;defaultResourceNames&quot;: [ # 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”
+      &quot;A String&quot;,
+    ],
+    &quot;eventAnnotations&quot;: [ # List of annotation configurations for this dashboard. Each entry specifies one event type.
+      { # Annotation configuration for one event type on a dashboard
+        &quot;displayName&quot;: &quot;A String&quot;, # Solely for UI display. Should not be used programmatically.
+        &quot;enabled&quot;: True or False, # Whether or not to show the events on the dashboard by default
+        &quot;eventType&quot;: &quot;A String&quot;, # The type of event to display.
+        &quot;filter&quot;: &quot;A String&quot;, # string filtering the events - event dependant. Example values: &quot;resource.labels.pod_name = &#x27;pod-1&#x27;&quot; &quot;protoPayload.authenticationInfo.principalEmail=&#x27;user@example.com&#x27;&quot;
+        &quot;resourceNames&quot;: [ # 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”
+          &quot;A String&quot;,
+        ],
+      },
+    ],
+  },
   &quot;columnLayout&quot;: { # 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.
     &quot;columns&quot;: [ # The columns of content to display.
       { # Defines the layout properties and content for a column.

diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json
@@ -753,7 +753,7 @@
 }
 }
 },
-"revision": "20240427",
+"revision": "20240505",
 "rootUrl": "https://monitoring.googleapis.com/",
 "schemas": {
 "Aggregation": {
@@ -1037,6 +1037,10 @@
 "description": "A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.",
 "id": "Dashboard",
 "properties": {
+"annotations": {
+"$ref": "DashboardAnnotations",
+"description": "Configuration for event annotations to display on this dashboard."
+},
 "columnLayout": {
 "$ref": "ColumnLayout",
 "description": "The content is divided into equally spaced columns and the widgets are arranged vertically."
@@ -1082,6 +1086,27 @@
 },
 "type": "object"
 },
+"DashboardAnnotations": {
+"description": "Dashboard-level configuration for annotations",
+"id": "DashboardAnnotations",
+"properties": {
+"defaultResourceNames": {
+"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 ",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"eventAnnotations": {
+"description": "List of annotation configurations for this dashboard. Each entry specifies one event type.",
+"items": {
+"$ref": "EventAnnotation"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "DashboardFilter": {
 "description": "A filter to reduce the amount of data charted in relevant widgets.",
 "id": "DashboardFilter",
@@ -1301,6 +1326,80 @@
 },
 "type": "object"
 },
+"EventAnnotation": {
+"description": "Annotation configuration for one event type on a dashboard",
+"id": "EventAnnotation",
+"properties": {
+"displayName": {
+"description": "Solely for UI display. Should not be used programmatically.",
+"type": "string"
+},
+"enabled": {
+"description": "Whether or not to show the events on the dashboard by default",
+"type": "boolean"
+},
+"eventType": {
+"description": "The type of event to display.",
+"enum": [
+"EVENT_TYPE_UNSPECIFIED",
+"GKE_WORKLOAD_DEPLOYMENT",
+"GKE_POD_CRASH",
+"GKE_POD_UNSCHEDULABLE",
+"GKE_CONTAINER_CREATION_FAILED",
+"GKE_CLUSTER_CREATE_DELETE",
+"GKE_CLUSTER_UPDATE",
+"GKE_NODE_POOL_UPDATE",
+"GKE_CLUSTER_AUTOSCALER",
+"GKE_POD_AUTOSCALER",
+"VM_TERMINATION",
+"VM_GUEST_OS_ERROR",
+"VM_START_FAILED",
+"MIG_UPDATE",
+"MIG_AUTOSCALER",
+"CLOUD_RUN_DEPLOYMENT",
+"CLOUD_SQL_FAILOVER",
+"CLOUD_SQL_START_STOP",
+"CLOUD_SQL_STORAGE",
+"UPTIME_CHECK_FAILURE"
+],
+"enumDescriptions": [
+"No event type specified.",
+"Patch/update of GKE workload.",
+"Crash events for a GKE Pod.",
+"Scheduling failures for GKE Pods.",
+"Failure to create a GKE container.",
+"Create/delete of a GKE cluster.",
+"Update of a GKE cluster.",
+"Update of a GKE node pool.",
+"GKE cluster autoscaler event.",
+"GKE pod autoscaler event.",
+"Termination of a virtual machine.",
+"Guest OS error on a virtual machine.",
+"Start failure on a virtual machine.",
+"Update of a managed instance group.",
+"Autoscaler event for a managed instance group.",
+"New deployment of a Cloud Run service.",
+"Failover of a Cloud SQL instance.",
+"Start/stop of a Cloud SQL instance.",
+"Storage event for a Cloud SQL instance.",
+"Failure of a Cloud Monitoring uptime check."
+],
+"type": "string"
+},
+"filter": {
+"description": "string filtering the events - event dependant. Example values: \"resource.labels.pod_name = 'pod-1'\" \"protoPayload.authenticationInfo.principalEmail='user@example.com'\" ",
+"type": "string"
+},
+"resourceNames": {
+"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 ",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "Field": {
 "description": "A single field of a message type.",
 "id": "Field",

diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json
@@ -2714,7 +2714,7 @@
 }
 }
 },
-"revision": "20240427",
+"revision": "20240505",
 "rootUrl": "https://monitoring.googleapis.com/",
 "schemas": {
 "Aggregation": {