feat(dataflow): update the api

yoshi-automation · yoshi-automation · commit ca129604e53e · 2022-08-16T07:08:12.000Z
#### dataflow:v1b3

The following keys were added:
- schemas.HotKeyDebuggingInfo (Total Keys: 4)
- schemas.HotKeyInfo (Total Keys: 6)
- schemas.StageSummary.properties.stragglerSummary.$ref (Total Keys: 1)
- schemas.StragglerDebuggingInfo (Total Keys: 3)
- schemas.StragglerInfo (Total Keys: 6)
- schemas.StragglerSummary (Total Keys: 7)
- schemas.WorkItemDetails.properties.stragglerInfo.$ref (Total Keys: 1)
diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html
@@ -1140,6 +1140,12 @@ <h3>Method Details</h3>
       &quot;stageId&quot;: &quot;A String&quot;, # ID of this stage
       &quot;startTime&quot;: &quot;A String&quot;, # Start time of this stage.
       &quot;state&quot;: &quot;A String&quot;, # State of this stage.
+      &quot;stragglerSummary&quot;: { # Summarized straggler identification details. # Straggler summary for this stage.
+        &quot;stragglerCauseCount&quot;: { # Aggregated counts of straggler causes, keyed by the string representation of the StragglerCause enum.
+          &quot;a_key&quot;: &quot;A String&quot;,
+        },
+        &quot;totalStragglerCount&quot;: &quot;A String&quot;, # The total count of stragglers.
+      },
     },
   ],
 }</pre>
diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.stages.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.stages.html
@@ -150,6 +150,22 @@ <h3>Method Details</h3>
           },
           &quot;startTime&quot;: &quot;A String&quot;, # Start time of this work item attempt.
           &quot;state&quot;: &quot;A String&quot;, # State of this work item.
+          &quot;stragglerInfo&quot;: { # Information useful for straggler identification and debugging. # Information about straggler detections for this work item.
+            &quot;causes&quot;: { # The straggler causes, keyed by the string representation of the StragglerCause enum and contains specialized debugging information for each straggler cause.
+              &quot;a_key&quot;: { # Information useful for debugging a straggler. Each type will provide specialized debugging information relevant for a particular cause. The StragglerDebuggingInfo will be 1:1 mapping to the StragglerCause enum.
+                &quot;hotKey&quot;: { # Information useful for debugging a hot key detection. # Hot key debugging details.
+                  &quot;detectedHotKeys&quot;: { # Debugging information for each detected hot key. Keyed by a hash of the key.
+                    &quot;a_key&quot;: { # Information about a hot key.
+                      &quot;hotKeyAge&quot;: &quot;A String&quot;, # The age of the hot key measured from when it was first detected.
+                      &quot;key&quot;: &quot;A String&quot;, # A detected hot key that is causing limited parallelism. This field will be populated only if the following flag is set to true: &quot;--enable_hot_key_logging&quot;.
+                      &quot;keyTruncated&quot;: True or False, # If true, then the above key is truncated and cannot be deserialized. This occurs if the key above is populated and the key size is &gt;5MB.
+                    },
+                  },
+                },
+              },
+            },
+            &quot;startTime&quot;: &quot;A String&quot;, # The time when the work item attempt became a straggler.
+          },
           &quot;taskId&quot;: &quot;A String&quot;, # Name of this work item.
         },
       ],
diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json
@@ -2225,7 +2225,7 @@
       }
     }
   },
-  "revision": "20220726",
+  "revision": "20220806",
   "rootUrl": "https://dataflow.googleapis.com/",
   "schemas": {
     "ApproximateProgress": {
@@ -3560,6 +3560,20 @@
       },
       "type": "object"
     },
+    "HotKeyDebuggingInfo": {
+      "description": "Information useful for debugging a hot key detection.",
+      "id": "HotKeyDebuggingInfo",
+      "properties": {
+        "detectedHotKeys": {
+          "additionalProperties": {
+            "$ref": "HotKeyInfo"
+          },
+          "description": "Debugging information for each detected hot key. Keyed by a hash of the key.",
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
     "HotKeyDetection": {
       "description": "Proto describing a hot key detected on a given WorkItem.",
       "id": "HotKeyDetection",
@@ -3580,6 +3594,26 @@
       },
       "type": "object"
     },
+    "HotKeyInfo": {
+      "description": "Information about a hot key.",
+      "id": "HotKeyInfo",
+      "properties": {
+        "hotKeyAge": {
+          "description": "The age of the hot key measured from when it was first detected.",
+          "format": "google-duration",
+          "type": "string"
+        },
+        "key": {
+          "description": "A detected hot key that is causing limited parallelism. This field will be populated only if the following flag is set to true: \"--enable_hot_key_logging\".",
+          "type": "string"
+        },
+        "keyTruncated": {
+          "description": "If true, then the above key is truncated and cannot be deserialized. This occurs if the key above is populated and the key size is >5MB.",
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
     "InstructionInput": {
       "description": "An input of an instruction, as a reference to an output of a producer instruction.",
       "id": "InstructionInput",
@@ -5924,6 +5958,10 @@
             "Execution of the component was cancelled."
           ],
           "type": "string"
+        },
+        "stragglerSummary": {
+          "$ref": "StragglerSummary",
+          "description": "Straggler summary for this stage."
         }
       },
       "type": "object"
@@ -5993,6 +6031,56 @@
       },
       "type": "object"
     },
+    "StragglerDebuggingInfo": {
+      "description": "Information useful for debugging a straggler. Each type will provide specialized debugging information relevant for a particular cause. The StragglerDebuggingInfo will be 1:1 mapping to the StragglerCause enum.",
+      "id": "StragglerDebuggingInfo",
+      "properties": {
+        "hotKey": {
+          "$ref": "HotKeyDebuggingInfo",
+          "description": "Hot key debugging details."
+        }
+      },
+      "type": "object"
+    },
+    "StragglerInfo": {
+      "description": "Information useful for straggler identification and debugging.",
+      "id": "StragglerInfo",
+      "properties": {
+        "causes": {
+          "additionalProperties": {
+            "$ref": "StragglerDebuggingInfo"
+          },
+          "description": "The straggler causes, keyed by the string representation of the StragglerCause enum and contains specialized debugging information for each straggler cause.",
+          "type": "object"
+        },
+        "startTime": {
+          "description": "The time when the work item attempt became a straggler.",
+          "format": "google-datetime",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "StragglerSummary": {
+      "description": "Summarized straggler identification details.",
+      "id": "StragglerSummary",
+      "properties": {
+        "stragglerCauseCount": {
+          "additionalProperties": {
+            "format": "int64",
+            "type": "string"
+          },
+          "description": "Aggregated counts of straggler causes, keyed by the string representation of the StragglerCause enum.",
+          "type": "object"
+        },
+        "totalStragglerCount": {
+          "description": "The total count of stragglers.",
+          "format": "int64",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "StreamLocation": {
       "description": "Describes a stream of data, either as input to be processed or as output of a streaming Dataflow job.",
       "id": "StreamLocation",
@@ -6599,6 +6687,10 @@
           ],
           "type": "string"
         },
+        "stragglerInfo": {
+          "$ref": "StragglerInfo",
+          "description": "Information about straggler detections for this work item."
+        },
         "taskId": {
           "description": "Name of this work item.",
           "type": "string"
