Skip to content

Commit 7bb3465

Browse files
feat(dataflow): update the api
#### dataflow:v1b3 The following keys were added: - schemas.BoundedTrie (Total Keys: 12) - schemas.CounterUpdate.properties.boundedTrie.$ref (Total Keys: 1) - schemas.MetricUpdate.properties.trie.type (Total Keys: 1)
1 parent 492ad8b commit 7bb3465

6 files changed

+97
-18
lines changed

docs/dyn/dataflow_v1b3.projects.jobs.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1565,7 +1565,7 @@ <h3>Method Details</h3>
15651565
{ # JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. For more information, see [Dataflow job metrics] (https://cloud.google.com/dataflow/docs/guides/using-monitoring-intf). This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.
15661566
&quot;metricTime&quot;: &quot;A String&quot;, # Timestamp as of which metric values are current.
15671567
&quot;metrics&quot;: [ # All metrics for this job.
1568-
{ # Describes the state of a metric.
1568+
{ # Describes the state of a metric. Next ID: 14
15691569
&quot;cumulative&quot;: True or False, # True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
15701570
&quot;distribution&quot;: &quot;&quot;, # A struct value describing properties of a distribution of numeric values.
15711571
&quot;gauge&quot;: &quot;&quot;, # A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.
@@ -1581,7 +1581,8 @@ <h3>Method Details</h3>
15811581
&quot;origin&quot;: &quot;A String&quot;, # Origin (namespace) of metric name. May be blank for user-define metrics; will be &quot;dataflow&quot; for metrics defined by the Dataflow service or SDK.
15821582
},
15831583
&quot;scalar&quot;: &quot;&quot;, # Worker-computed aggregate value for aggregation kinds &quot;Sum&quot;, &quot;Max&quot;, &quot;Min&quot;, &quot;And&quot;, and &quot;Or&quot;. The possible value types are Long, Double, and Boolean.
1584-
&quot;set&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Set&quot; aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric&#x27;s type. All Values in the list must be of the same type.
1584+
&quot;set&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Set&quot; aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, String, or BoundedTrie according to the metric&#x27;s type. All Values in the list must be of the same type.
1585+
&quot;trie&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Trie&quot; aggregation kind. The only possible value type is a BoundedTrieNode.
15851586
&quot;updateTime&quot;: &quot;A String&quot;, # Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
15861587
},
15871588
],

docs/dyn/dataflow_v1b3.projects.jobs.workItems.html

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -723,8 +723,20 @@ <h3>Method Details</h3>
723723
{ # Conveys a worker&#x27;s progress through the work described by a WorkItem.
724724
&quot;completed&quot;: True or False, # True if the WorkItem was completed (successfully or unsuccessfully).
725725
&quot;counterUpdates&quot;: [ # Worker output counters for this WorkItem.
726-
{ # An update to a Counter sent from a worker.
726+
{ # An update to a Counter sent from a worker. Next ID: 17
727727
&quot;boolean&quot;: True or False, # Boolean value for And, Or.
728+
&quot;boundedTrie&quot;: { # The message type used for encoding metrics of type bounded trie. # Bounded trie data
729+
&quot;bound&quot;: 42, # The maximum number of elements to store before truncation.
730+
&quot;root&quot;: { # A single node in a BoundedTrie. # A compact representation of all the elements in this trie.
731+
&quot;children&quot;: { # Children of this node. Must be empty if truncated is true.
732+
&quot;a_key&quot;: # Object with schema name: BoundedTrieNode
733+
},
734+
&quot;truncated&quot;: True or False, # Whether this node has been truncated. A truncated leaf represents possibly many children with the same prefix.
735+
},
736+
&quot;singleton&quot;: [ # A more efficient representation for metrics consisting of a single value.
737+
&quot;A String&quot;,
738+
],
739+
},
728740
&quot;cumulative&quot;: True or False, # True if this counter is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this counter is reported as a delta.
729741
&quot;distribution&quot;: { # A metric value representing a distribution. # Distribution data
730742
&quot;count&quot;: { # A representation of an int64, n, that is immune to precision loss when encoded in JSON. # The count of the number of elements present in the distribution.
@@ -884,7 +896,7 @@ <h3>Method Details</h3>
884896
},
885897
],
886898
&quot;metricUpdates&quot;: [ # DEPRECATED in favor of counter_updates.
887-
{ # Describes the state of a metric.
899+
{ # Describes the state of a metric. Next ID: 14
888900
&quot;cumulative&quot;: True or False, # True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
889901
&quot;distribution&quot;: &quot;&quot;, # A struct value describing properties of a distribution of numeric values.
890902
&quot;gauge&quot;: &quot;&quot;, # A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.
@@ -900,7 +912,8 @@ <h3>Method Details</h3>
900912
&quot;origin&quot;: &quot;A String&quot;, # Origin (namespace) of metric name. May be blank for user-define metrics; will be &quot;dataflow&quot; for metrics defined by the Dataflow service or SDK.
901913
},
902914
&quot;scalar&quot;: &quot;&quot;, # Worker-computed aggregate value for aggregation kinds &quot;Sum&quot;, &quot;Max&quot;, &quot;Min&quot;, &quot;And&quot;, and &quot;Or&quot;. The possible value types are Long, Double, and Boolean.
903-
&quot;set&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Set&quot; aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric&#x27;s type. All Values in the list must be of the same type.
915+
&quot;set&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Set&quot; aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, String, or BoundedTrie according to the metric&#x27;s type. All Values in the list must be of the same type.
916+
&quot;trie&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Trie&quot; aggregation kind. The only possible value type is a BoundedTrieNode.
904917
&quot;updateTime&quot;: &quot;A String&quot;, # Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
905918
},
906919
],

docs/dyn/dataflow_v1b3.projects.locations.jobs.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1195,7 +1195,7 @@ <h3>Method Details</h3>
11951195
{ # Information about a particular execution stage of a job.
11961196
&quot;endTime&quot;: &quot;A String&quot;, # End time of this stage. If the work item is completed, this is the actual end time of the stage. Otherwise, it is the predicted end time.
11971197
&quot;metrics&quot;: [ # Metrics for this stage.
1198-
{ # Describes the state of a metric.
1198+
{ # Describes the state of a metric. Next ID: 14
11991199
&quot;cumulative&quot;: True or False, # True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
12001200
&quot;distribution&quot;: &quot;&quot;, # A struct value describing properties of a distribution of numeric values.
12011201
&quot;gauge&quot;: &quot;&quot;, # A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.
@@ -1211,7 +1211,8 @@ <h3>Method Details</h3>
12111211
&quot;origin&quot;: &quot;A String&quot;, # Origin (namespace) of metric name. May be blank for user-define metrics; will be &quot;dataflow&quot; for metrics defined by the Dataflow service or SDK.
12121212
},
12131213
&quot;scalar&quot;: &quot;&quot;, # Worker-computed aggregate value for aggregation kinds &quot;Sum&quot;, &quot;Max&quot;, &quot;Min&quot;, &quot;And&quot;, and &quot;Or&quot;. The possible value types are Long, Double, and Boolean.
1214-
&quot;set&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Set&quot; aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric&#x27;s type. All Values in the list must be of the same type.
1214+
&quot;set&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Set&quot; aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, String, or BoundedTrie according to the metric&#x27;s type. All Values in the list must be of the same type.
1215+
&quot;trie&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Trie&quot; aggregation kind. The only possible value type is a BoundedTrieNode.
12151216
&quot;updateTime&quot;: &quot;A String&quot;, # Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
12161217
},
12171218
],
@@ -1299,7 +1300,7 @@ <h3>Method Details</h3>
12991300
{ # JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. For more information, see [Dataflow job metrics] (https://cloud.google.com/dataflow/docs/guides/using-monitoring-intf). This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.
13001301
&quot;metricTime&quot;: &quot;A String&quot;, # Timestamp as of which metric values are current.
13011302
&quot;metrics&quot;: [ # All metrics for this job.
1302-
{ # Describes the state of a metric.
1303+
{ # Describes the state of a metric. Next ID: 14
13031304
&quot;cumulative&quot;: True or False, # True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
13041305
&quot;distribution&quot;: &quot;&quot;, # A struct value describing properties of a distribution of numeric values.
13051306
&quot;gauge&quot;: &quot;&quot;, # A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.
@@ -1315,7 +1316,8 @@ <h3>Method Details</h3>
13151316
&quot;origin&quot;: &quot;A String&quot;, # Origin (namespace) of metric name. May be blank for user-define metrics; will be &quot;dataflow&quot; for metrics defined by the Dataflow service or SDK.
13161317
},
13171318
&quot;scalar&quot;: &quot;&quot;, # Worker-computed aggregate value for aggregation kinds &quot;Sum&quot;, &quot;Max&quot;, &quot;Min&quot;, &quot;And&quot;, and &quot;Or&quot;. The possible value types are Long, Double, and Boolean.
1318-
&quot;set&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Set&quot; aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric&#x27;s type. All Values in the list must be of the same type.
1319+
&quot;set&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Set&quot; aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, String, or BoundedTrie according to the metric&#x27;s type. All Values in the list must be of the same type.
1320+
&quot;trie&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Trie&quot; aggregation kind. The only possible value type is a BoundedTrieNode.
13191321
&quot;updateTime&quot;: &quot;A String&quot;, # Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
13201322
},
13211323
],

docs/dyn/dataflow_v1b3.projects.locations.jobs.stages.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h3>Method Details</h3>
119119
&quot;attemptId&quot;: &quot;A String&quot;, # Attempt ID of this work item
120120
&quot;endTime&quot;: &quot;A String&quot;, # End time of this work item attempt. If the work item is completed, this is the actual end time of the work item. Otherwise, it is the predicted end time.
121121
&quot;metrics&quot;: [ # Metrics for this work item.
122-
{ # Describes the state of a metric.
122+
{ # Describes the state of a metric. Next ID: 14
123123
&quot;cumulative&quot;: True or False, # True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
124124
&quot;distribution&quot;: &quot;&quot;, # A struct value describing properties of a distribution of numeric values.
125125
&quot;gauge&quot;: &quot;&quot;, # A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.
@@ -135,7 +135,8 @@ <h3>Method Details</h3>
135135
&quot;origin&quot;: &quot;A String&quot;, # Origin (namespace) of metric name. May be blank for user-define metrics; will be &quot;dataflow&quot; for metrics defined by the Dataflow service or SDK.
136136
},
137137
&quot;scalar&quot;: &quot;&quot;, # Worker-computed aggregate value for aggregation kinds &quot;Sum&quot;, &quot;Max&quot;, &quot;Min&quot;, &quot;And&quot;, and &quot;Or&quot;. The possible value types are Long, Double, and Boolean.
138-
&quot;set&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Set&quot; aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric&#x27;s type. All Values in the list must be of the same type.
138+
&quot;set&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Set&quot; aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, String, or BoundedTrie according to the metric&#x27;s type. All Values in the list must be of the same type.
139+
&quot;trie&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Trie&quot; aggregation kind. The only possible value type is a BoundedTrieNode.
139140
&quot;updateTime&quot;: &quot;A String&quot;, # Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
140141
},
141142
],

docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -725,8 +725,20 @@ <h3>Method Details</h3>
725725
{ # Conveys a worker&#x27;s progress through the work described by a WorkItem.
726726
&quot;completed&quot;: True or False, # True if the WorkItem was completed (successfully or unsuccessfully).
727727
&quot;counterUpdates&quot;: [ # Worker output counters for this WorkItem.
728-
{ # An update to a Counter sent from a worker.
728+
{ # An update to a Counter sent from a worker. Next ID: 17
729729
&quot;boolean&quot;: True or False, # Boolean value for And, Or.
730+
&quot;boundedTrie&quot;: { # The message type used for encoding metrics of type bounded trie. # Bounded trie data
731+
&quot;bound&quot;: 42, # The maximum number of elements to store before truncation.
732+
&quot;root&quot;: { # A single node in a BoundedTrie. # A compact representation of all the elements in this trie.
733+
&quot;children&quot;: { # Children of this node. Must be empty if truncated is true.
734+
&quot;a_key&quot;: # Object with schema name: BoundedTrieNode
735+
},
736+
&quot;truncated&quot;: True or False, # Whether this node has been truncated. A truncated leaf represents possibly many children with the same prefix.
737+
},
738+
&quot;singleton&quot;: [ # A more efficient representation for metrics consisting of a single value.
739+
&quot;A String&quot;,
740+
],
741+
},
730742
&quot;cumulative&quot;: True or False, # True if this counter is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this counter is reported as a delta.
731743
&quot;distribution&quot;: { # A metric value representing a distribution. # Distribution data
732744
&quot;count&quot;: { # A representation of an int64, n, that is immune to precision loss when encoded in JSON. # The count of the number of elements present in the distribution.
@@ -886,7 +898,7 @@ <h3>Method Details</h3>
886898
},
887899
],
888900
&quot;metricUpdates&quot;: [ # DEPRECATED in favor of counter_updates.
889-
{ # Describes the state of a metric.
901+
{ # Describes the state of a metric. Next ID: 14
890902
&quot;cumulative&quot;: True or False, # True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
891903
&quot;distribution&quot;: &quot;&quot;, # A struct value describing properties of a distribution of numeric values.
892904
&quot;gauge&quot;: &quot;&quot;, # A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.
@@ -902,7 +914,8 @@ <h3>Method Details</h3>
902914
&quot;origin&quot;: &quot;A String&quot;, # Origin (namespace) of metric name. May be blank for user-define metrics; will be &quot;dataflow&quot; for metrics defined by the Dataflow service or SDK.
903915
},
904916
&quot;scalar&quot;: &quot;&quot;, # Worker-computed aggregate value for aggregation kinds &quot;Sum&quot;, &quot;Max&quot;, &quot;Min&quot;, &quot;And&quot;, and &quot;Or&quot;. The possible value types are Long, Double, and Boolean.
905-
&quot;set&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Set&quot; aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric&#x27;s type. All Values in the list must be of the same type.
917+
&quot;set&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Set&quot; aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, String, or BoundedTrie according to the metric&#x27;s type. All Values in the list must be of the same type.
918+
&quot;trie&quot;: &quot;&quot;, # Worker-computed aggregate value for the &quot;Trie&quot; aggregation kind. The only possible value type is a BoundedTrieNode.
906919
&quot;updateTime&quot;: &quot;A String&quot;, # Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
907920
},
908921
],

0 commit comments

Comments
 (0)