--- title: "POST /v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus" method: POST path: "/v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus" tags: ["projects"] --- # POST /v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus `POST /v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus` Reports the status of dataflow WorkItems leased by a worker. ## Path parameters - `projectId` string, required - `jobId` string, required ## Request body - ReportWorkItemStatusRequest — Request to report the status of WorkItems. - `unifiedWorkerRequest` object — Untranslated bag-of-bytes WorkProgressUpdateRequest from UnifiedWorker. - `workerId` string — The ID of the worker reporting the WorkItem status. If this does not match the ID of the worker which the Dataflow service believes currently has the lease on the WorkItem, the report will be dropped (with an error response). - `currentWorkerTime` string, google-datetime — The current timestamp at the worker. - `workItemStatuses` WorkItemStatus[] — The order is unimportant, except that the order of the WorkItemServiceState messages in the ReportWorkItemStatusResponse corresponds to the order of WorkItemStatus messages here. - `progress` ApproximateProgress — Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest. - `percentComplete` number, float — Obsolete. - `remainingTime` string, google-duration — Obsolete. - `position` Position — Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. - `end` boolean — Position is past all other positions. Also useful for the end position of an unbounded range. - `concatPosition` ConcatPosition — A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. - `index` integer — Index of the inner source. - `position` Position — recursive - `byteOffset` string, int64 — Position is a byte offset. - `key` string — Position is a string key, ordered lexicographically. - `recordIndex` string, int64 — Position is a record index. - `shufflePosition` string — CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding). - `sourceOperationResponse` SourceOperationResponse — The result of a SourceOperationRequest, specified in ReportWorkItemStatusRequest.source_operation when the work item is completed. - `split` SourceSplitResponse — The response to a SourceSplitRequest. - `bundles` DerivedSource[] — If outcome is SPLITTING_HAPPENED, then this is a list of bundles into which the source was split. Otherwise this field is ignored. This list can be empty, which means the source represents an empty input. - `source` Source — A source that records can be read and decoded from. - `metadata` SourceMetadata — Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. - … - `codec` object — The codec to use to decode data read from the source. - `spec` object — The source to read from, plus its parameters. - `baseSpecs` object[] — While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs). - … - `doesNotNeedSplitting` boolean — Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. - `derivationMode` 'SOURCE_DERIVATION_MODE_UNKNOWN' | 'SOURCE_DERIVATION_MODE_INDEPENDENT' | 'SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT' | 'SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT' — What source to base the produced source on (if any). - `outcome` 'SOURCE_SPLIT_OUTCOME_UNKNOWN' | 'SOURCE_SPLIT_OUTCOME_USE_CURRENT' | 'SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED' — Indicates whether splitting happened and produced a list of bundles. If this is USE_CURRENT_SOURCE_AS_IS, the current source should be processed "as is" without splitting. "bundles" is ignored in this case. If this is SPLITTING_HAPPENED, then "bundles" contains a list of bundles into which the source was split. - `shards` SourceSplitShard[] — DEPRECATED in favor of bundles. - `source` Source — A source that records can be read and decoded from. - `metadata` SourceMetadata — Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. - … - `codec` object — The codec to use to decode data read from the source. - `spec` object — The source to read from, plus its parameters. - `baseSpecs` object[] — While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs). - … - `doesNotNeedSplitting` boolean — Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. - `derivationMode` 'SOURCE_DERIVATION_MODE_UNKNOWN' | 'SOURCE_DERIVATION_MODE_INDEPENDENT' | 'SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT' | 'SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT' — DEPRECATED - `getMetadata` SourceGetMetadataResponse — The result of a SourceGetMetadataOperation. - `metadata` SourceMetadata — Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. - `producesSortedKeys` boolean — Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order. - `infinite` boolean — Specifies that the size of this source is known to be infinite (this is a streaming source). - `estimatedSizeBytes` string, int64 — An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader. - `workItemId` string — Identifies the WorkItem. - `dynamicSourceSplit` DynamicSourceSplit — When a task splits using WorkItemStatus.dynamic_source_split, this message describes the two parts of the split relative to the description of the current task's input. - `residual` DerivedSource — Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split. - `source` Source — A source that records can be read and decoded from. - `metadata` SourceMetadata — Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. - `producesSortedKeys` boolean — Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order. - `infinite` boolean — Specifies that the size of this source is known to be infinite (this is a streaming source). - `estimatedSizeBytes` string, int64 — An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader. - `codec` object — The codec to use to decode data read from the source. - `spec` object — The source to read from, plus its parameters. - `baseSpecs` object[] — While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs). - `doesNotNeedSplitting` boolean — Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. - `derivationMode` 'SOURCE_DERIVATION_MODE_UNKNOWN' | 'SOURCE_DERIVATION_MODE_INDEPENDENT' | 'SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT' | 'SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT' — What source to base the produced source on (if any). - `primary` DerivedSource — Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split. - `source` Source — A source that records can be read and decoded from. - `metadata` SourceMetadata — Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. - `producesSortedKeys` boolean — Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order. - `infinite` boolean — Specifies that the size of this source is known to be infinite (this is a streaming source). - `estimatedSizeBytes` string, int64 — An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader. - `codec` object — The codec to use to decode data read from the source. - `spec` object — The source to read from, plus its parameters. - `baseSpecs` object[] — While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs). - `doesNotNeedSplitting` boolean — Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. - `derivationMode` 'SOURCE_DERIVATION_MODE_UNKNOWN' | 'SOURCE_DERIVATION_MODE_INDEPENDENT' | 'SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT' | 'SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT' — What source to base the produced source on (if any). - `errors` Status[] — Specifies errors which occurred during processing. If errors are provided, and completed = true, then the WorkItem is considered to have failed. - `message` string — A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - `details` object[] — A list of messages that carry the error details. There is a common set of message types for APIs to use. - `code` integer — The status code, which should be an enum value of google.rpc.Code. - `metricUpdates` MetricUpdate[] — DEPRECATED in favor of counter_updates. - `scalar` unknown - `internal` unknown - `updateTime` string, google-datetime — Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API. - `meanSum` unknown - `set` unknown - `gauge` unknown - `kind` string — Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value. - `meanCount` unknown - `trie` unknown - `boundedTrie` unknown - `cumulative` boolean — 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. - `distribution` unknown - `name` MetricStructuredName — Identifies a metric, by describing the source which generated the metric. - `name` string — Worker-defined metric name. - `origin` string — Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK. - `context` object — Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have context['step'] = . Counters associated with PCollections in the SDK will have context['pcollection'] = . - `reportIndex` string, int64 — The report index. When a WorkItem is leased, the lease will contain an initial report index. When a WorkItem's status is reported to the system, the report should be sent with that report index, and the response will contain the index the worker should use for the next report. Reports received with unexpected index values will be rejected by the service. In order to preserve idempotency, the worker should not alter the contents of a report, even if the worker must submit the same report multiple times before getting back a response. The worker should not submit a subsequent report until the response for the previous report had been received from the service. - `requestedLeaseDuration` string, google-duration — Amount of time the worker requests for its lease. - `completed` boolean — True if the WorkItem was completed (successfully or unsuccessfully). - `reportedProgress` ApproximateReportedProgress — A progress measurement of a WorkItem by a worker. - `consumedParallelism` ReportedParallelism — Represents the level of parallelism in a WorkItem's input, reported by the worker. - `isInfinite` boolean — Specifies whether the parallelism is infinite. If true, "value" is ignored. Infinite parallelism means the service will assume that the work item can always be split into more non-empty work items by dynamic splitting. This is a work-around for lack of support for infinity by the current JSON-based Java RPC stack. - `value` number, double — Specifies the level of parallelism in case it is finite. - `position` Position — Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. - `end` boolean — Position is past all other positions. Also useful for the end position of an unbounded range. - `concatPosition` ConcatPosition — A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. - `index` integer — Index of the inner source. - `position` Position — recursive - `byteOffset` string, int64 — Position is a byte offset. - `key` string — Position is a string key, ordered lexicographically. - `recordIndex` string, int64 — Position is a record index. - `shufflePosition` string — CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding). - `fractionConsumed` number, double — Completion as fraction of the input consumed, from 0.0 (beginning, nothing consumed), to 1.0 (end of the input, entire input consumed). - `remainingParallelism` ReportedParallelism — Represents the level of parallelism in a WorkItem's input, reported by the worker. - `isInfinite` boolean — Specifies whether the parallelism is infinite. If true, "value" is ignored. Infinite parallelism means the service will assume that the work item can always be split into more non-empty work items by dynamic splitting. This is a work-around for lack of support for infinity by the current JSON-based Java RPC stack. - `value` number, double — Specifies the level of parallelism in case it is finite. - `sourceFork` SourceFork — DEPRECATED in favor of DynamicSourceSplit. - `primary` SourceSplitShard — DEPRECATED in favor of DerivedSource. - `source` Source — A source that records can be read and decoded from. - `metadata` SourceMetadata — Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. - `producesSortedKeys` boolean — Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order. - `infinite` boolean — Specifies that the size of this source is known to be infinite (this is a streaming source). - `estimatedSizeBytes` string, int64 — An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader. - `codec` object — The codec to use to decode data read from the source. - `spec` object — The source to read from, plus its parameters. - `baseSpecs` object[] — While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs). - `doesNotNeedSplitting` boolean — Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. - `derivationMode` 'SOURCE_DERIVATION_MODE_UNKNOWN' | 'SOURCE_DERIVATION_MODE_INDEPENDENT' | 'SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT' | 'SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT' — DEPRECATED - `residualSource` DerivedSource — Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split. - `source` Source — A source that records can be read and decoded from. - `metadata` SourceMetadata — Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. - `producesSortedKeys` boolean — Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order. - `infinite` boolean — Specifies that the size of this source is known to be infinite (this is a streaming source). - `estimatedSizeBytes` string, int64 — An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader. - `codec` object — The codec to use to decode data read from the source. - `spec` object — The source to read from, plus its parameters. - `baseSpecs` object[] — While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs). - `doesNotNeedSplitting` boolean — Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. - `derivationMode` 'SOURCE_DERIVATION_MODE_UNKNOWN' | 'SOURCE_DERIVATION_MODE_INDEPENDENT' | 'SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT' | 'SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT' — What source to base the produced source on (if any). - `residual` SourceSplitShard — DEPRECATED in favor of DerivedSource. - `source` Source — A source that records can be read and decoded from. - `metadata` SourceMetadata — Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. - `producesSortedKeys` boolean — Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order. - `infinite` boolean — Specifies that the size of this source is known to be infinite (this is a streaming source). - `estimatedSizeBytes` string, int64 — An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader. - `codec` object — The codec to use to decode data read from the source. - `spec` object — The source to read from, plus its parameters. - `baseSpecs` object[] — While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs). - `doesNotNeedSplitting` boolean — Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. - `derivationMode` 'SOURCE_DERIVATION_MODE_UNKNOWN' | 'SOURCE_DERIVATION_MODE_INDEPENDENT' | 'SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT' | 'SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT' — DEPRECATED - `primarySource` DerivedSource — Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split. - `source` Source — A source that records can be read and decoded from. - `metadata` SourceMetadata — Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. - `producesSortedKeys` boolean — Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order. - `infinite` boolean — Specifies that the size of this source is known to be infinite (this is a streaming source). - `estimatedSizeBytes` string, int64 — An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader. - `codec` object — The codec to use to decode data read from the source. - `spec` object — The source to read from, plus its parameters. - `baseSpecs` object[] — While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs). - `doesNotNeedSplitting` boolean — Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. - `derivationMode` 'SOURCE_DERIVATION_MODE_UNKNOWN' | 'SOURCE_DERIVATION_MODE_INDEPENDENT' | 'SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT' | 'SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT' — What source to base the produced source on (if any). - `counterUpdates` CounterUpdate[] — Worker output counters for this WorkItem. - `cumulative` boolean — 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. - `distribution` DistributionUpdate — A metric value representing a distribution. - `count` SplitInt64 — A representation of an int64, n, that is immune to precision loss when encoded in JSON. - `lowBits` integer — The low order bits: n & 0xffffffff. - `highBits` integer — The high order bits, including the sign: n >> 32. - `max` SplitInt64 — A representation of an int64, n, that is immune to precision loss when encoded in JSON. - `lowBits` integer — The low order bits: n & 0xffffffff. - `highBits` integer — The high order bits, including the sign: n >> 32. - `sum` SplitInt64 — A representation of an int64, n, that is immune to precision loss when encoded in JSON. - `lowBits` integer — The low order bits: n & 0xffffffff. - `highBits` integer — The high order bits, including the sign: n >> 32. - `sumOfSquares` number, double — Use a double since the sum of squares is likely to overflow int64. - `min` SplitInt64 — A representation of an int64, n, that is immune to precision loss when encoded in JSON. - `lowBits` integer — The low order bits: n & 0xffffffff. - `highBits` integer — The high order bits, including the sign: n >> 32. - `histogram` Histogram — Histogram of value counts for a distribution. Buckets have an inclusive lower bound and exclusive upper bound and use "1,2,5 bucketing": The first bucket range is from [0,1) and all subsequent bucket boundaries are powers of ten multiplied by 1, 2, or 5. Thus, bucket boundaries are 0, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, ... Negative values are not supported. - `bucketCounts` string[] — Counts of values in each bucket. For efficiency, prefix and trailing buckets with count = 0 are elided. Buckets can store the full range of values of an unsigned long, with ULLONG_MAX falling into the 59th bucket with range [1e19, 2e19). - `firstBucketOffset` integer — Starting index of first stored bucket. The non-inclusive upper-bound of the ith bucket is given by: pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3] - `boundedTrie` BoundedTrie — The message type used for encoding metrics of type bounded trie. - `root` BoundedTrieNode — A single node in a BoundedTrie. - `children` object — Children of this node. Must be empty if truncated is true. - `truncated` boolean — Whether this node has been truncated. A truncated leaf represents possibly many children with the same prefix. - `singleton` string[] — A more efficient representation for metrics consisting of a single value. - `bound` integer — The maximum number of elements to store before truncation. - `stringList` StringList — A metric value representing a list of strings. - `elements` string[] — Elements of the list. - `floatingPoint` number, double — Floating point value for Sum, Max, Min. - `floatingPointMean` FloatingPointMean — A representation of a floating point mean metric contribution. - `sum` number, double — The sum of all values being aggregated. - `count` SplitInt64 — A representation of an int64, n, that is immune to precision loss when encoded in JSON. - `lowBits` integer — The low order bits: n & 0xffffffff. - `highBits` integer — The high order bits, including the sign: n >> 32. - `integer` SplitInt64 — A representation of an int64, n, that is immune to precision loss when encoded in JSON. - `lowBits` integer — The low order bits: n & 0xffffffff. - `highBits` integer — The high order bits, including the sign: n >> 32. - `integerGauge` IntegerGauge — A metric value representing temporal values of a variable. - `value` SplitInt64 — A representation of an int64, n, that is immune to precision loss when encoded in JSON. - `lowBits` integer — The low order bits: n & 0xffffffff. - `highBits` integer — The high order bits, including the sign: n >> 32. - `timestamp` string, google-datetime — The time at which this value was measured. Measured as msecs from epoch. - `shortId` string, int64 — The service-generated short identifier for this counter. The short_id -> (name, metadata) mapping is constant for the lifetime of a job. - `internal` unknown - `floatingPointList` FloatingPointList — A metric value representing a list of floating point numbers. - `elements` number[] — Elements of the list. - `structuredNameAndMetadata` CounterStructuredNameAndMetadata — A single message which encapsulates structured name and metadata for a given counter. - `metadata` CounterMetadata — CounterMetadata includes all static non-name non-value counter attributes. - `description` string — Human-readable description of the counter semantics. - `otherUnits` string — A string referring to the unit type. - `kind` 'INVALID' | 'SUM' | 'MAX' | 'MIN' | 'MEAN' | 'OR' | 'AND' | 'SET' | 'DISTRIBUTION' | 'LATEST_VALUE' — Counter aggregation kind. - `standardUnits` 'BYTES' | 'BYTES_PER_SEC' | 'MILLISECONDS' | 'MICROSECONDS' | 'NANOSECONDS' | 'TIMESTAMP_MSEC' | 'TIMESTAMP_USEC' | 'TIMESTAMP_NSEC' — System defined Units, see above enum. - `name` CounterStructuredName — Identifies a counter within a per-job namespace. Counters whose structured names are the same get merged into a single value for the job. - `name` string — Counter name. Not necessarily globally-unique, but unique within the context of the other fields. Required. - `origin` 'SYSTEM' | 'USER' — One of the standard Origins defined above. - `originNamespace` string — A string containing a more specific namespace of the counter's origin. - `originalStepName` string — System generated name of the original step in the user's graph, before optimization. - `workerId` string — ID of a particular worker. - `portion` 'ALL' | 'KEY' | 'VALUE' — Portion of this counter, either key or value. - `componentStepName` string — Name of the optimized step being executed by the workers. - `executionStepName` string — Name of the stage. An execution step contains multiple component steps. - `originalRequestingStepName` string — The step name requesting an operation, such as GBK. I.e. the ParDo causing a read/write from shuffle to occur, or a read from side inputs. - `inputIndex` integer — Index of an input collection that's being read from/written to as a side input. The index identifies a step's side inputs starting by 1 (e.g. the first side input has input_index 1, the third has input_index 3). Side inputs are identified by a pair of (original_step_name, input_index). This field helps uniquely identify them. - `integerMean` IntegerMean — A representation of an integer mean metric contribution. - `sum` SplitInt64 — A representation of an int64, n, that is immune to precision loss when encoded in JSON. - `lowBits` integer — The low order bits: n & 0xffffffff. - `highBits` integer — The high order bits, including the sign: n >> 32. - `count` SplitInt64 — A representation of an int64, n, that is immune to precision loss when encoded in JSON. - `lowBits` integer — The low order bits: n & 0xffffffff. - `highBits` integer — The high order bits, including the sign: n >> 32. - `boolean` boolean — Boolean value for And, Or. - `integerList` IntegerList — A metric value representing a list of integers. - `elements` SplitInt64[] — Elements of the list. - `lowBits` integer — The low order bits: n & 0xffffffff. - `highBits` integer — The high order bits, including the sign: n >> 32. - `nameAndKind` NameAndKind — Basic metadata about a counter. - `kind` 'INVALID' | 'SUM' | 'MAX' | 'MIN' | 'MEAN' | 'OR' | 'AND' | 'SET' | 'DISTRIBUTION' | 'LATEST_VALUE' — Counter aggregation kind. - `name` string — Name of the counter. - `stopPosition` Position — Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. - `end` boolean — Position is past all other positions. Also useful for the end position of an unbounded range. - `concatPosition` ConcatPosition — A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. - `index` integer — Index of the inner source. - `position` Position — recursive - `byteOffset` string, int64 — Position is a byte offset. - `key` string — Position is a string key, ordered lexicographically. - `recordIndex` string, int64 — Position is a record index. - `shufflePosition` string — CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding). - `totalThrottlerWaitTimeSeconds` number, double — Total time the worker spent being throttled by external systems. - `location` string — The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job. - `projectNumber` string, int64 — Optional. The project number of the project which owns the WorkItem's job. ## Response `200` Successful response --- [API](https://skmtc.dev/google/apis/dataflow.md) · [All operations](https://skmtc.dev/google/apis/dataflow/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/dataflow/revisions/f065de7a0dba/schema)