{ "swagger": "2.0", "info": { "title": "Compute service", "version": "0.1507.0", "description": "Send your API key as a bearer token: `Authorization: Bearer `." }, "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "ApiKey": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Your API key as a bearer token: `Authorization: Bearer `." } }, "security": [ { "ApiKey": [] } ], "paths": { "/compute/v2/compute": { "post": { "operationId": "ComputeService_compute", "summary": "Compute", "tags": [ "Compute Service" ], "description": "Computes the output of the compute graph specified by a ComputeNodeRequest.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/ComputeNodeRequest" }, "required": true, "x-example": { "node": { "type": "ranges", "ranges": { "input": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO" } } } }, "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "context": { "variables": { "": { "type": "double", "double": 1 } }, "functionVariables": { "": { "variables": { "": { "type": "double", "double": 1 } }, "subFunctionVariables": {} } }, "datasetReferences": { "": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } } }, "defaultFillStrategy": { "type": "forwardFill", "forwardFill": { "limit": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } }, "defaultAlignmentStrategy": { "type": "driverSeries", "driverSeries": {} }, "applyDataScopeOffsets": true, "resolveAssetsThroughDatasets": true } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ComputeNodeResponse" }, "x-example": { "type": "range", "range": [ { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "value": { "type": "double", "double": 1 } } ] } } } } }, "/compute/v2/compute/parameterized": { "post": { "operationId": "ComputeService_parameterizedCompute", "summary": "Parameterized compute", "tags": [ "Compute Service" ], "description": "Computes the output of the compute graph specified by a ParameterizedComputeNodeRequest. A parameterized compute request supports multiple values for a single variable, supplied by the ParameterizedContext. Results are returned in the same order of the request.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/ParameterizedComputeNodeRequest" }, "required": true, "x-example": { "node": { "type": "ranges", "ranges": { "input": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO" } } } }, "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "context": { "variables": { "": { "type": "double", "double": 1 } }, "functionVariables": { "": { "variables": { "": { "type": "double", "double": 1 } }, "subFunctionVariables": {} } }, "datasetReferences": { "": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } } }, "defaultFillStrategy": { "type": "forwardFill", "forwardFill": { "limit": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } }, "defaultAlignmentStrategy": { "type": "driverSeries", "driverSeries": {} }, "applyDataScopeOffsets": true, "resolveAssetsThroughDatasets": true }, "parameterizedContext": { "parameterInputs": [ { "variables": { "": { "type": "double", "double": 1 } }, "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "value": { "type": "double", "double": 1 } } } ] } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ParameterizedComputeNodeResponse" }, "x-example": { "results": [ { "type": "success", "success": { "type": "range", "range": [ { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "value": { "type": "double", "double": 1 } } ] } } ] } } } } }, "/compute/v2/compute/units": { "post": { "operationId": "ComputeService_computeUnits", "summary": "Compute units", "tags": [ "Compute Service" ], "description": "Returns the resulting unit for the output of a compute graph. If the resulting unit is equivalent to exactly one existing unit in the system, it will be returned (for example, a series in Coulombs divided by a series in Volts will return an output of Farads). If the output does not have units (for example, a range output,) the unit result will return noUnitAvailable, and if the computation was not successful, corresponding errors are returned.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/ComputeUnitsRequest" }, "required": true, "x-example": { "node": { "type": "ranges", "ranges": { "input": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO" } } } }, "context": { "variables": { "": { "type": "double", "double": 1 } }, "functionVariables": { "": { "variables": { "": { "type": "double", "double": 1 } }, "subFunctionVariables": {} } }, "datasetReferences": { "": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } } }, "defaultFillStrategy": { "type": "forwardFill", "forwardFill": { "limit": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } }, "defaultAlignmentStrategy": { "type": "driverSeries", "driverSeries": {} }, "applyDataScopeOffsets": true, "resolveAssetsThroughDatasets": true } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ComputeUnitResult" }, "x-example": { "type": "single", "single": { "type": "success", "success": "" } } } } } }, "/compute/v2/compute/batch": { "post": { "operationId": "ComputeService_batchComputeWithUnits", "summary": "Batch compute with units", "tags": [ "Compute Service" ], "description": "Computes the output of compute graphs specified by BatchComputeNodeRequest. Results are returned in the same order as the request.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/BatchComputeWithUnitsRequest" }, "required": true, "x-example": { "requests": [ { "node": { "type": "ranges", "ranges": { "input": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO" } } } }, "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "context": { "variables": { "": { "type": "double", "double": 1 } }, "functionVariables": { "": { "variables": { "": { "type": "double", "double": 1 } }, "subFunctionVariables": {} } }, "datasetReferences": { "": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } } }, "defaultFillStrategy": { "type": "forwardFill", "forwardFill": { "limit": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } }, "defaultAlignmentStrategy": { "type": "driverSeries", "driverSeries": {} }, "applyDataScopeOffsets": true, "resolveAssetsThroughDatasets": true } } ] } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchComputeWithUnitsResponse" }, "x-example": { "results": [ { "computeResult": { "type": "success", "success": { "type": "range", "range": [ { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "value": { "type": "double", "double": 1 } } ] } }, "unitResult": { "type": "single", "single": { "type": "success", "success": "" } } } ] } } } } }, "/compute/v2/compute/batch-units": { "post": { "operationId": "ComputeService_batchComputeUnits", "summary": "Batch compute units", "tags": [ "Compute Service" ], "description": "Same as computeUnits, however this endpoint functions on a batch of requests for wire efficiency purposes. An extra note is that this method will serialize underlying classic REST errors into the BatchComputeUnitResult type, meaning callers are required to check for errors explicitly (rather than relying on exceptions being thrown).", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/BatchComputeUnitsRequest" }, "required": true, "x-example": { "requests": [ { "node": { "type": "ranges", "ranges": { "input": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO" } } } }, "context": { "variables": { "": { "type": "double", "double": 1 } }, "functionVariables": { "": { "variables": { "": { "type": "double", "double": 1 } }, "subFunctionVariables": {} } }, "datasetReferences": { "": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } } }, "defaultFillStrategy": { "type": "forwardFill", "forwardFill": { "limit": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } }, "defaultAlignmentStrategy": { "type": "driverSeries", "driverSeries": {} }, "applyDataScopeOffsets": true, "resolveAssetsThroughDatasets": true } } ] } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchComputeUnitResult" }, "x-example": { "results": [ { "type": "single", "single": { "type": "success", "success": "" } } ] } } } } }, "/compute/v2/computeWithUnits": { "post": { "operationId": "ComputeService_computeWithUnits", "summary": "Compute with units", "tags": [ "Compute Service" ], "description": "Computes the output of the compute graph specified by a ComputeNodeRequest, as well as providing the resulting unit for the output of a compute graph. If the resulting unit is equivalent to exactly one existing unit in the system, it will be returned (for example, a series in Coulombs divided by a series in Volts will return an output of Farads). If the output does not have units (for example, a range output,) the unit result will return noUnitAvailable, and if the computation was not successful, corresponding errors are returned.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/ComputeNodeRequest" }, "required": true, "x-example": { "node": { "type": "ranges", "ranges": { "input": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO" } } } }, "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "context": { "variables": { "": { "type": "double", "double": 1 } }, "functionVariables": { "": { "variables": { "": { "type": "double", "double": 1 } }, "subFunctionVariables": {} } }, "datasetReferences": { "": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } } }, "defaultFillStrategy": { "type": "forwardFill", "forwardFill": { "limit": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } }, "defaultAlignmentStrategy": { "type": "driverSeries", "driverSeries": {} }, "applyDataScopeOffsets": true, "resolveAssetsThroughDatasets": true } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ComputeWithUnitsResponse" }, "x-example": { "computeResult": { "type": "range", "range": [ { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "value": { "type": "double", "double": 1 } } ] }, "computeUnit": { "type": "single", "single": { "type": "success", "success": "" } } } } } } }, "/compute/v2/compute/batch/kill": { "post": { "operationId": "ComputeService_batchKillRequests", "summary": "Batch kill requests", "tags": [ "Compute Service" ], "description": "Best-effort cancellation of active compute requests. Each ID should be the request ID that the client originally passed when starting the request. A single request may correspond to one or more underlying operations, all of which will be cancelled.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/BatchKillRequestsRequest" }, "required": true, "x-example": { "requestIds": [ "" ] } } ], "responses": { "204": { "description": "No content." } } } }, "/compute/v2/compute/batch/progress": { "post": { "operationId": "ComputeService_batchGetRequestProgress", "summary": "Batch get request progress", "tags": [ "Compute Service" ], "description": "Returns a point-in-time snapshot of progress for the given active compute requests. Each ID should be the request ID that the client originally passed when starting the request. Intended to be polled (roughly once per second) for requests that have been running longer than the slow-query threshold.\n\nA request with no active queries is not necessarily finished: its underlying queries may not have started yet, the request may be in a post-processing phase, or the request's work may be executed somewhere that does not report progress — in which case it stays inactive for its entire duration. Clients should derive progress from the raw row counters and must not assume monotonicity, since totalRowsApprox can grow while a request runs.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/BatchGetRequestProgressRequest" }, "required": true, "x-example": { "requestIds": [ "" ] } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchGetRequestProgressResponse" }, "x-example": { "progressByRequestId": { "": { "type": "inProgress", "inProgress": { "readRows": 1, "totalRowsApprox": 1 } } } } } } } }, "/compute/v2/compute/quota/usage": { "get": { "operationId": "ComputeService_getQuotaUsage", "summary": "Get quota usage", "tags": [ "Compute Service" ], "description": "Returns the calling user's compute quota usage for their current organization, one entry per quota window. Returns no intervals when quotas are not enabled for the organization.", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetQuotaUsageResponse" }, "x-example": { "intervals": [ { "durationSeconds": 1, "currentWindow": { "startTime": "2026-01-01T00:00:00Z", "endTime": "2026-01-01T00:00:00Z" }, "resources": [ { "resource": "READ_ROWS", "used": 1, "limit": 1 } ] } ] } } } } } }, "definitions": { "Empty": { "type": "object", "properties": {} }, "NumericPropertyPredicate": { "description": "Matches resources that have a numeric value for the named property and whose value satisfies the operator. NEQ excludes resources that lack the property or store a string value under the same name.", "type": "object", "properties": { "name": { "type": "string", "x-alias": "PropertyName" }, "value": { "type": "number", "format": "double" }, "operator": { "$ref": "#/definitions/PropertyComparisonOperator" } }, "required": [ "name", "value", "operator" ] }, "NumericPropertyRangeOperator": { "type": "string", "enum": [ "BETWEEN", "NOT_BETWEEN" ] }, "NumericPropertyRangePredicate": { "description": "Inclusive range on a numeric property. At least one bound is required. BETWEEN: min <= x <= max. An absent bound is unbounded on that side. NOT_BETWEEN: x < min OR x > max. An absent bound drops that side. Both operators require a numeric value for `name`. Missing properties and string values never match. Bounds are closed [min, max] to match the number chip (is between / is not between), not half-open.", "type": "object", "properties": { "name": { "type": "string", "x-alias": "PropertyName" }, "min": { "type": "number", "format": "double" }, "max": { "type": "number", "format": "double" }, "operator": { "$ref": "#/definitions/NumericPropertyRangeOperator" } }, "required": [ "name", "operator" ] }, "PropertyComparisonOperator": { "type": "string", "enum": [ "EQ", "NEQ", "GT", "GTE", "LT", "LTE" ] }, "SerializableError": { "description": "A SerializableError is a representation of a ServiceException that exists to send error results to clients as part of a response object when directly throwing an exception is undesirable.", "type": "object", "properties": { "name": { "type": "string" }, "message": { "type": "string" }, "errorInstanceId": { "type": "string" }, "statusCode": { "type": "integer", "format": "int32" }, "params": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "name", "errorInstanceId", "statusCode" ] }, "SetOperator": { "type": "string", "enum": [ "AND", "OR" ] }, "TimeUnit": { "type": "string", "enum": [ "DAYS", "HOURS", "MINUTES", "SECONDS", "MILLISECONDS", "MICROSECONDS", "NANOSECONDS" ] }, "Timestamp": { "description": "Deprecated for new APIs. Use google.protobuf.Timestamp for absolute instants in proto APIs.\n\nThis legacy nanosecond precision timestamp type is represented by an epoch time in seconds and a nanosecond offset. The nanosecond offset is from the start of the epoch second, so must be less than 1 billion.", "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "nanos": { "type": "integer", "format": "int64" } }, "required": [ "seconds", "nanos" ] }, "Abs": { "description": "Computes the absolute value of each point in the series.", "type": "object", "properties": { "x": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series." } }, "required": [ "x" ] }, "AbsoluteThreshold": { "description": "Threshold defined as a real number corresponding the unit of a series.", "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Allowed spread, in the series' own unit." } }, "required": [ "value" ] }, "AbsoluteTimestampSeries": { "description": "Replaces values in a series with the absolute timestamps.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Series" }, "timeUnit": { "allOf": [ { "$ref": "#/definitions/TimeUnit" } ], "description": "The time unit used to define the output values. Throws an error if nanosecond or finer." } }, "required": [ "input", "timeUnit" ] }, "Acos": { "description": "Computes the arccosine of each value, returning radians.", "type": "object", "properties": { "x": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (values in [-1, 1])." } }, "required": [ "x" ] }, "Add": { "description": "Adds two numeric series pointwise.", "type": "object", "properties": { "left": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Left-hand operand." }, "right": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Right-hand operand." } }, "required": [ "left", "right" ] }, "AfterPersistenceWindow": { "description": "The first point in the output range will be the first point after the condition has been true for the min duration and min points.", "type": "object", "properties": {} }, "AggregateEnumSeries": { "description": "Aggregates values with duplicate timestamps in the input series values into a single value using the specified aggregation function.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "function": { "$ref": "#/definitions/EnumAggregationFunction" } }, "required": [ "input", "function" ] }, "AggregateNumericSeries": { "description": "DEPRECATED. Use a dedicated group-by-and-aggregate nodes instead.\n\nAggregates values with duplicate timestamps in the input series values into a single value using the specified aggregation function.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "function": { "$ref": "#/definitions/NumericAggregationFunction" }, "groupByTags": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true, "description": "Tags to group by for the aggregation. If left empty, the tags to group by will be equivalent to those in the input series. If specified, the result will be grouped ONLY by the specified tags. The tags specified here MUST be a (non-strict) subset of the input series's group by tags." }, "aggregateByAllGroupings": { "type": "boolean", "description": "This field's purpose is to distinguish between the two flavors of groupByTags being empty. It has no effect when groupByTags is non-empty. When true and groupByTags is empty, aggregate across all series in the input. When false and groupByTags is empty, the result will be grouped by the same tags as the input series." }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "If provided, interpolates values at timestamps where the input series has values before aggregating. If not provided, only aggregates when timestamps match exactly (existing behavior).", "x-deprecated": "Setting interpolation on this node is deprecated." } }, "required": [ "input", "function" ] }, "AggregateUnderRangesSeries": { "description": "Aggregates the input series under the ranges in the provided ranges series, and outputs a new series with one point at the start of each range, where the value is the aggregation result. If a range has no points, no point will be produced for it. If a range has no start, the point produced for it will be at the start of the compute request range.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "ranges": { "$ref": "#/definitions/RangeSeries" }, "operation": { "allOf": [ { "$ref": "#/definitions/NumericAggregationFunction" } ], "x-deprecated": "Use a dedicated group-by-and-aggregate node instead (coming in a follow-up PR). This field is retained as required for backwards compatibility with existing callers." } }, "required": [ "input", "ranges", "operation" ] }, "AggregationBuilder": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "rollingTime", "rollingPoints", "groupBy" ] }, "rollingTime": { "$ref": "#/definitions/RollingTimeAggregationBuilder" }, "rollingPoints": { "$ref": "#/definitions/RollingPointsAggregationBuilder" }, "groupBy": { "$ref": "#/definitions/GroupByAggregationBuilder" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "rollingTime", "rollingTime": { "input": { "type": "raw", "raw": { "name": "string" } }, "window": { "type": "reference", "reference": { "name": "string" } } } } }, "Alignment": { "description": "Specifies how to set the timestamp grid for multi-input operations.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "driverSeries", "union" ] }, "driverSeries": { "$ref": "#/definitions/DriverSeries" }, "union": { "$ref": "#/definitions/Union" } }, "required": [ "type" ], "example": { "type": "driverSeries", "driverSeries": {} } }, "AlignmentConfiguration": { "type": "object", "properties": { "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "The interpolation rules to use when aligning the non-driver series." }, "driverSeries": { "allOf": [ { "$ref": "#/definitions/AlignmentDriverSeries" } ], "description": "The series whose timestamps drive alignment." } }, "required": [ "interpolationConfiguration", "driverSeries" ] }, "AlignmentDriverSeries": { "type": "string", "enum": [ "FIRST", "SECOND" ] }, "AllowNegativeValues": { "type": "object", "properties": {} }, "AnchorAlignedDataset": { "description": "Aligns each anchored portion of the input dataset onto a common anchor timestamp while preserving grouping tags. Without a `reference` the selected anchor becomes timestamp zero, so the output is in a relative time domain; with a `reference` the anchors are aligned onto the referenced portion's anchor and the output stays in the input's absolute time domain. Currently run boundary, event, and range anchors are supported, and every storage-backed leaf of the input must resolve to run-backed branches.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/Dataset" } ], "description": "The dataset to align." }, "anchor": { "allOf": [ { "$ref": "#/definitions/DatasetAnchor" } ], "description": "Selects the timestamp each anchored portion of the input is aligned by." }, "reference": { "allOf": [ { "$ref": "#/definitions/AnchorReference" } ], "description": "When present, each anchor is aligned onto the referenced anchor timestamp instead of onto timestamp zero, so output remains in the input's absolute time domain and the referenced portion is unshifted. When absent, the selected anchor becomes timestamp zero." } }, "required": [ "input", "anchor" ] }, "AnchorReference": { "description": "Selects the anchor timestamp every other anchor is aligned onto.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "earliestAnchor" ] }, "earliestAnchor": { "allOf": [ { "$ref": "#/definitions/EarliestAnchorReference" } ], "description": "Aligns every anchor onto the earliest anchor resolved from the input, so the earliest-anchored run is unshifted and every other run shifts backwards onto it." } }, "required": [ "type" ], "example": { "type": "earliestAnchor", "earliestAnchor": {} } }, "AndSeries": { "description": "Combines two boolean series point-wise using logical AND, producing true where both inputs are true and false otherwise.", "type": "object", "properties": { "left": { "$ref": "#/definitions/BooleanSeries" }, "right": { "$ref": "#/definitions/BooleanSeries" } }, "required": [ "left", "right" ] }, "ApproximateThresholdOperator": { "type": "string", "enum": [ "EQUAL_TO", "NOT_EQUAL_TO" ] }, "ApproximateThresholdRanges": { "description": "Produces a list of ranges for which the threshold condition is satisfied.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "threshold": { "$ref": "#/definitions/DoubleConstant" }, "tolerance": { "$ref": "#/definitions/DoubleConstant" }, "operator": { "$ref": "#/definitions/ApproximateThresholdOperator" }, "persistenceWindowConfiguration": { "$ref": "#/definitions/PersistenceWindowConfiguration" } }, "required": [ "input", "threshold", "tolerance", "operator" ] }, "ArithmeticSeries": { "type": "object", "properties": { "inputs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/NumericSeries" }, "x-map-key": "LocalVariableName" }, "expression": { "type": "string" }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Defaults to forward fill interpolation with a 1s interpolation radius", "x-deprecated": "Setting interpolation on this node is deprecated." } }, "required": [ "expression" ] }, "ArraySeries": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "numeric1d", "enum1d" ] }, "numeric1d": { "$ref": "#/definitions/Numeric1dArraySeries" }, "enum1d": { "$ref": "#/definitions/Enum1dArraySeries" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "numeric1d", "numeric1d": { "type": "channel", "channel": { "type": "dataSource", "dataSource": { "dataSourceRid": { "type": "literal", "literal": "string" }, "channel": { "type": "literal", "literal": "string" }, "tags": { "key": { "type": "literal", "literal": "string" } }, "tagFilters": { "type": "single", "single": { "key": { "type": "literal", "literal": "string" }, "values": [ { "type": "literal", "literal": "string" } ], "operator": "IN" } }, "tagsToGroupBy": [ "string" ], "groupByTags": [ { "type": "literal", "literal": "string" } ] } } } } }, "ArrowArrayPlot": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "bucketedNumeric", "bucketedEnum" ] }, "bucketedNumeric": { "$ref": "#/definitions/BucketedNumericArrayPlot" }, "bucketedEnum": { "$ref": "#/definitions/BucketedEnumArrayPlot" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "bucketedNumeric", "bucketedNumeric": { "arrowBinary": "string", "groupByKeys": [ "string" ] } } }, "ArrowPlot": { "description": "A generic Arrow IPC plot response. Used for all Arrow-serialized plot types (numeric, bucketed numeric, enum, bucketed enum, struct, bucketed struct, full resolution, and bucketed multivariate).", "type": "object", "properties": { "arrowBinary": { "type": "string", "format": "byte", "description": "The raw binary containing an Arrow IPC stream." }, "groupByKeys": { "type": "array", "items": { "type": "string" }, "description": "This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel." }, "nextPageToken": { "allOf": [ { "$ref": "#/definitions/PageToken" } ], "description": "Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as `pageToken` and keep the pageSize sign unchanged. Returned only when this response contains exactly `abs(pageSize)` points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction." } }, "required": [ "arrowBinary" ] }, "Asin": { "description": "Computes the arcsine of each value, returning radians.", "type": "object", "properties": { "x": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (values in [-1, 1])." } }, "required": [ "x" ] }, "Asset": { "description": "Asset reference for `Dataset.asset`. The `rid` field accepts either a literal asset RID or a `StringConstant` reference resolved from `Context`.", "type": "object", "properties": { "rid": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "Resource identifier of an asset" } }, "required": [ "rid" ] }, "AssetChannel": { "type": "object", "properties": { "assetRid": { "$ref": "#/definitions/StringConstant" }, "dataScopeName": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "Used to disambiguate when multiple data scopes within this asset contain channels with the same name." }, "channel": { "$ref": "#/definitions/StringConstant" }, "additionalTags": { "type": "object", "additionalProperties": { "$ref": "#/definitions/StringConstant" }, "x-deprecated": "Use additionalTagFilters" }, "additionalTagFilters": { "allOf": [ { "$ref": "#/definitions/TagFilters" } ], "description": "Tags to filter the channel by, in addition to tag filters defined for a given Asset data scope. Throws on collisions with tag keys already defined for the given Asset data scope. Only returns points that match both sets of tag filters. For log series, include arg filters here in addition to tag filters." }, "tagsToGroupBy": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "x-deprecated": "Use groupByTags instead. Throws if both tagsToGroupBy and groupByTags are specified." }, "groupByTags": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true, "description": "Tags that the channel should be grouped by. If this is non-empty a grouped result will be returned with an entry for each grouping. Only one of tagsToGroupBy and groupByTags should be specified." } }, "required": [ "assetRid", "dataScopeName", "channel" ] }, "AssetsSearchTarget": { "description": "Search assets. Each match expands to one grouping per data scope on that asset.", "type": "object", "properties": { "query": { "allOf": [ { "$ref": "#/definitions/ResourceSearchQuery" } ], "description": "Predicate tree used to filter matching assets." } }, "required": [ "query" ] }, "Atan2": { "description": "Computes the two-argument arctangent atan2(y, x) using signs to determine the quadrant.", "type": "object", "properties": { "y": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Y-coordinate series." }, "x": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "X-coordinate series." } }, "required": [ "y", "x" ] }, "Average": { "description": "A average that gives the same weight to each observation inside the time window", "type": "object", "properties": {} }, "BandPassConfiguration": { "type": "object", "properties": { "lowPassbandFrequency": { "$ref": "#/definitions/DoubleConstant" }, "highPassbandFrequency": { "$ref": "#/definitions/DoubleConstant" } }, "required": [ "lowPassbandFrequency", "highPassbandFrequency" ] }, "BandStopConfiguration": { "type": "object", "properties": { "lowStopbandFrequency": { "$ref": "#/definitions/DoubleConstant" }, "highStopbandFrequency": { "$ref": "#/definitions/DoubleConstant" } }, "required": [ "lowStopbandFrequency", "highStopbandFrequency" ] }, "BatchComputeUnitResult": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/ComputeUnitResult" } } } }, "BatchComputeUnitsRequest": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/definitions/ComputeUnitsRequest" } } }, "example": { "requests": [ { "node": { "type": "ranges", "ranges": { "input": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO" } } } }, "context": { "variables": { "": { "type": "double", "double": 1 } }, "functionVariables": { "": { "variables": { "": { "type": "double", "double": 1 } }, "subFunctionVariables": {} } }, "datasetReferences": { "": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } } }, "defaultFillStrategy": { "type": "forwardFill", "forwardFill": { "limit": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } }, "defaultAlignmentStrategy": { "type": "driverSeries", "driverSeries": {} }, "applyDataScopeOffsets": true, "resolveAssetsThroughDatasets": true } } ] } }, "BatchComputeWithUnitsRequest": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/definitions/ComputeNodeRequest" } } }, "example": { "requests": [ { "node": { "type": "ranges", "ranges": { "input": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO" } } } }, "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "context": { "variables": { "": { "type": "double", "double": 1 } }, "functionVariables": { "": { "variables": { "": { "type": "double", "double": 1 } }, "subFunctionVariables": {} } }, "datasetReferences": { "": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } } }, "defaultFillStrategy": { "type": "forwardFill", "forwardFill": { "limit": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } }, "defaultAlignmentStrategy": { "type": "driverSeries", "driverSeries": {} }, "applyDataScopeOffsets": true, "resolveAssetsThroughDatasets": true } } ] } }, "BatchComputeWithUnitsResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/ComputeWithUnitsResult" } } } }, "BatchGetRequestProgressRequest": { "type": "object", "properties": { "requestIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Limited to 300 IDs per call." } }, "example": { "requestIds": [ "" ] } }, "BatchGetRequestProgressResponse": { "type": "object", "properties": { "progressByRequestId": { "type": "object", "additionalProperties": { "$ref": "#/definitions/RequestProgress" }, "description": "Contains an entry for every requested request ID." } } }, "BatchKillRequestsRequest": { "type": "object", "properties": { "requestIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "requestIds": [ "" ] } }, "BinaryArithmeticOperation": { "type": "string", "enum": [ "ATAN2" ], "x-enum-descriptions": { "ATAN2": "Calculates the angle measure between the x-axis and a ray from the origin to a point (input2, input1) in radians. Note the order of arguments." } }, "BinaryArithmeticSeries": { "description": "Applies a point-wise transformation to a pair of series.", "type": "object", "properties": { "input1": { "$ref": "#/definitions/NumericSeries" }, "input2": { "$ref": "#/definitions/NumericSeries" }, "operation": { "$ref": "#/definitions/BinaryArithmeticOperation" }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Defaults to forward fill interpolation with a 1s interpolation radius", "x-deprecated": "Setting interpolation on this node is deprecated." } }, "required": [ "input1", "input2", "operation" ] }, "BitAnd": { "description": "Applies a bitwise AND between each value (cast to int64) and the operand.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (values cast to int64)." }, "operand": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The value to AND with each point." } }, "required": [ "input", "operand" ] }, "BitAndFunction": { "type": "object", "properties": { "operand": { "type": "integer", "format": "int64" } }, "required": [ "operand" ] }, "BitOperationFunction": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "and", "or", "xor", "shiftRight", "shiftLeft", "bitTest" ] }, "and": { "$ref": "#/definitions/BitAndFunction" }, "or": { "$ref": "#/definitions/BitOrFunction" }, "xor": { "$ref": "#/definitions/BitXorFunction" }, "shiftRight": { "$ref": "#/definitions/BitShiftRightFunction" }, "shiftLeft": { "$ref": "#/definitions/BitShiftLeftFunction" }, "bitTest": { "$ref": "#/definitions/BitTestFunction" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "and", "and": { "operand": 1 } } }, "BitOperationSeries": { "description": "Casts input series values to long before applying the bitwise operation.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "function": { "$ref": "#/definitions/BitOperationFunction" } }, "required": [ "input", "function" ] }, "BitOr": { "description": "Applies a bitwise OR between each value (cast to int64) and the operand.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (values cast to int64)." }, "operand": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The value to OR with each point." } }, "required": [ "input", "operand" ] }, "BitOrFunction": { "type": "object", "properties": { "operand": { "type": "integer", "format": "int64" } }, "required": [ "operand" ] }, "BitShiftLeft": { "description": "Left-shifts the bits in each value (cast to int64) by the given number of positions.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (values cast to int64)." }, "operand": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Number of positions to shift left." } }, "required": [ "input", "operand" ] }, "BitShiftLeftFunction": { "description": "Shifts the bits in each value left according to the given operand.", "type": "object", "properties": { "operand": { "type": "integer", "format": "int32" } }, "required": [ "operand" ] }, "BitShiftRight": { "description": "Right-shifts the bits in each value (cast to int64) by the given number of positions.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (values cast to int64)." }, "operand": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Number of positions to shift right." } }, "required": [ "input", "operand" ] }, "BitShiftRightFunction": { "description": "Right shifts the bits in each value right according to the given operand.", "type": "object", "properties": { "operand": { "type": "integer", "format": "int32" } }, "required": [ "operand" ] }, "BitTest": { "description": "Returns the bit at the specified index for each value (cast to int64), where index 0 is the least significant bit.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (values cast to int64)." }, "index": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Zero-based bit index, where 0 is the least significant bit." } }, "required": [ "input", "index" ] }, "BitTestFunction": { "description": "Returns the bit at the specified index, where the right-most bit has index 0.", "type": "object", "properties": { "index": { "type": "integer", "format": "int32" } }, "required": [ "index" ] }, "BitXor": { "description": "Applies a bitwise XOR between each value (cast to int64) and the operand.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (values cast to int64)." }, "operand": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The value to XOR with each point." } }, "required": [ "input", "operand" ] }, "BitXorFunction": { "type": "object", "properties": { "operand": { "type": "integer", "format": "int64" } }, "required": [ "operand" ] }, "Bode": { "description": "Returns the bode magnitude and phase of a system's frequency response.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "output": { "$ref": "#/definitions/NumericSeries" }, "alignmentConfiguration": { "allOf": [ { "$ref": "#/definitions/AlignmentConfiguration" } ], "description": "When present, aligns one Bode input to the other using the configured interpolation and driver series before estimating the frequency response. When absent, Bode preserves the existing strict behavior and requires the input and output value arrays to have equal length. For Bode, FIRST uses the input timestamps and SECOND uses the output timestamps." }, "stftOptions": { "$ref": "#/definitions/StftOptions" }, "magnitudeScaling": { "allOf": [ { "$ref": "#/definitions/MagnitudeScaling" } ], "description": "The scaling to apply to the output magnitude. Defaults to MAGNITUDE_DB_20 if not specified." }, "outputFrequencyType": { "allOf": [ { "$ref": "#/definitions/OutputFrequencyType" } ], "description": "The type of the output frequency. Defaults to LINEAR if not specified." }, "unwrapPhase": { "type": "boolean", "description": "Unwrap the phase of the output. Defaults to true if not specified." } }, "required": [ "input", "output" ] }, "BooleanRanges": { "description": "Produces ranges spanning the regions where a boolean input is true.\n\nThe condition is evaluated point-wise at each aligned timestamp; the numeric series it compares are aligned against each other the same way arithmetic between them would be.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/BooleanSeries" } ], "description": "The condition whose true regions become ranges." }, "minPoints": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Minimum number of matching points. Defaults to 1." }, "minDuration": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Minimum matching duration. Defaults to one nanosecond." }, "rangeStart": { "allOf": [ { "$ref": "#/definitions/RangeStart" } ], "description": "Selects whether the output begins at the first match or after persistence is satisfied." } }, "required": [ "input" ] }, "BooleanSeries": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "greaterThan", "lessThan", "equalTo", "notEqualTo", "greaterThanOrEqualTo", "lessThanOrEqualTo", "and", "or" ] }, "greaterThan": { "$ref": "#/definitions/GreaterThanSeries" }, "lessThan": { "$ref": "#/definitions/LessThanSeries" }, "equalTo": { "$ref": "#/definitions/EqualToSeries" }, "notEqualTo": { "$ref": "#/definitions/NotEqualToSeries" }, "greaterThanOrEqualTo": { "$ref": "#/definitions/GreaterThanOrEqualToSeries" }, "lessThanOrEqualTo": { "$ref": "#/definitions/LessThanOrEqualToSeries" }, "and": { "$ref": "#/definitions/AndSeries" }, "or": { "$ref": "#/definitions/OrSeries" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "greaterThan", "greaterThan": { "left": { "type": "abs", "abs": {} }, "right": { "type": "abs", "abs": {} } } } }, "BucketedCartesian3dPlot": { "type": "object", "properties": { "buckets": { "type": "array", "items": { "$ref": "#/definitions/Cartesian3dBucket" } } } }, "BucketedCartesianPlot": { "type": "object", "properties": { "buckets": { "type": "array", "items": { "$ref": "#/definitions/CartesianBucket" } } } }, "BucketedEnumArrayPlot": { "description": "The array is flattened out into a an arrow stream of bucketed primitive results, with an extra column to indicate the index of the array that the bucket corresponds to.", "type": "object", "properties": { "arrowBinary": { "type": "string", "format": "byte", "description": "The raw binary containing Arrow IPC stream for a bucketed N-dimensional enum array plot." }, "groupByKeys": { "type": "array", "items": { "type": "string" }, "description": "This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel." } }, "required": [ "arrowBinary" ] }, "BucketedEnumPlot": { "type": "object", "properties": { "timestamps": { "type": "array", "items": { "$ref": "#/definitions/Timestamp" }, "description": "The end of the bucket, exclusive." }, "buckets": { "type": "array", "items": { "$ref": "#/definitions/EnumBucket" } }, "categories": { "type": "array", "items": { "type": "string" } } } }, "BucketedFrequencyDomainPlot": { "description": "A bucketed/decimated frequency domain plot where multiple frequency bins have been aggregated.", "type": "object", "properties": { "buckets": { "type": "array", "items": { "$ref": "#/definitions/FrequencyBucket" } } } }, "BucketedMultivariatePlot": { "type": "object", "properties": { "buckets": { "type": "array", "items": { "$ref": "#/definitions/MultivariateBucket" } }, "groupByKeys": { "type": "array", "items": { "type": "string" }, "description": "This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel." } } }, "BucketedNumericArrayPlot": { "description": "The array is flattened out into a an arrow stream of bucketed primitive results, with an extra column to indicate the index of the array that the bucket corresponds to.", "type": "object", "properties": { "arrowBinary": { "type": "string", "format": "byte", "description": "The raw binary containing Arrow IPC stream for a bucketed N-dimensional numeric array plot." }, "groupByKeys": { "type": "array", "items": { "type": "string" }, "description": "This field specifies the tags that the final output is grouped by. When you combine multiple channels, this list represents the superset of all group by keys used across every individual channel." } }, "required": [ "arrowBinary" ] }, "BucketedNumericPlot": { "type": "object", "properties": { "timestamps": { "type": "array", "items": { "$ref": "#/definitions/Timestamp" }, "description": "The end of the bucket, exclusive." }, "buckets": { "type": "array", "items": { "$ref": "#/definitions/NumericBucket" } } } }, "BuiltInCurveFit": { "description": "A closed-form curve fit (exponential, logarithmic, or power) of the enclosing target (`y`) against the chosen independent variable (`x`): either sample time (a `time` variable) or another series (a `numeric` variable).", "type": "object", "properties": { "independentVariable": { "allOf": [ { "$ref": "#/definitions/CurveFitVariable" } ], "description": "The `x` axis the target is fit against — either relative sample time or another series." } }, "required": [ "independentVariable" ] }, "BuiltinConstant": { "description": "A system-defined constant referenceable by name. The server resolves the symbol to its numeric value during query resolution.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "math", "physical" ] }, "math": { "$ref": "#/definitions/MathConstant" }, "physical": { "$ref": "#/definitions/PhysicalConstant" } }, "required": [ "type" ], "example": { "type": "math", "math": "PI" } }, "Cartesian": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "scatter" ] }, "scatter": { "$ref": "#/definitions/Scatter" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "scatter", "scatter": { "x": { "type": "abs", "abs": {} }, "y": { "type": "abs", "abs": {} } } } }, "Cartesian3d": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "scatter3d" ] }, "scatter3d": { "$ref": "#/definitions/Scatter3d" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "scatter3d", "scatter3d": { "x": { "type": "abs", "abs": {} }, "y": { "type": "abs", "abs": {} }, "z": { "type": "abs", "abs": {} }, "driverSeries": "X" } } }, "Cartesian3dBounds": { "description": "Min/max bounds of an XYZ Cartesian plot, inclusive.", "type": "object", "properties": { "minX": { "$ref": "#/definitions/DoubleConstant" }, "maxX": { "$ref": "#/definitions/DoubleConstant" }, "minY": { "$ref": "#/definitions/DoubleConstant" }, "maxY": { "$ref": "#/definitions/DoubleConstant" }, "minZ": { "$ref": "#/definitions/DoubleConstant" }, "maxZ": { "$ref": "#/definitions/DoubleConstant" } }, "required": [ "minX", "maxX", "minY", "maxY", "minZ", "maxZ" ] }, "Cartesian3dBucket": { "type": "object", "properties": { "minX": { "type": "number", "format": "double", "x-deprecated": "Switching to point-based min/maxes" }, "maxX": { "type": "number", "format": "double", "x-deprecated": "Switching to point-based min/maxes" }, "meanX": { "type": "number", "format": "double" }, "minY": { "type": "number", "format": "double", "x-deprecated": "Switching to point-based min/maxes" }, "maxY": { "type": "number", "format": "double", "x-deprecated": "Switching to point-based min/maxes" }, "meanY": { "type": "number", "format": "double" }, "minZ": { "type": "number", "format": "double", "x-deprecated": "Switching to point-based min/maxes" }, "maxZ": { "type": "number", "format": "double", "x-deprecated": "Switching to point-based min/maxes" }, "meanZ": { "type": "number", "format": "double" }, "minXPoint": { "$ref": "#/definitions/Point3d" }, "maxXPoint": { "$ref": "#/definitions/Point3d" }, "minYPoint": { "$ref": "#/definitions/Point3d" }, "maxYPoint": { "$ref": "#/definitions/Point3d" }, "minZPoint": { "$ref": "#/definitions/Point3d" }, "maxZPoint": { "$ref": "#/definitions/Point3d" }, "minTimestamp": { "$ref": "#/definitions/Timestamp" }, "maxTimestamp": { "$ref": "#/definitions/Timestamp" }, "count": { "type": "integer", "format": "int64" } }, "required": [ "meanX", "meanY", "meanZ", "minXPoint", "maxXPoint", "minYPoint", "maxYPoint", "minZPoint", "maxZPoint", "minTimestamp", "maxTimestamp", "count" ] }, "Cartesian3dUnitResult": { "type": "object", "properties": { "x": { "$ref": "#/definitions/UnitResult" }, "y": { "$ref": "#/definitions/UnitResult" }, "z": { "$ref": "#/definitions/UnitResult" } }, "required": [ "x", "y", "z" ] }, "CartesianBounds": { "description": "Min/max bounds of an XY Cartesian plot, inclusive.", "type": "object", "properties": { "minX": { "$ref": "#/definitions/DoubleConstant" }, "maxX": { "$ref": "#/definitions/DoubleConstant" }, "minY": { "$ref": "#/definitions/DoubleConstant" }, "maxY": { "$ref": "#/definitions/DoubleConstant" } }, "required": [ "minX", "maxX", "minY", "maxY" ] }, "CartesianBucket": { "type": "object", "properties": { "minX": { "type": "number", "format": "double" }, "maxX": { "type": "number", "format": "double" }, "minY": { "type": "number", "format": "double" }, "maxY": { "type": "number", "format": "double" }, "minTimestamp": { "$ref": "#/definitions/Timestamp" }, "maxTimestamp": { "$ref": "#/definitions/Timestamp" }, "count": { "type": "integer", "format": "int64" } }, "required": [ "minX", "maxX", "minY", "maxY", "minTimestamp", "maxTimestamp", "count" ] }, "CartesianPlot": { "type": "object", "properties": { "timestamps": { "type": "array", "items": { "$ref": "#/definitions/Timestamp" } }, "xValues": { "type": "array", "items": { "type": "number", "format": "double" } }, "yValues": { "type": "array", "items": { "type": "number", "format": "double" } } } }, "CartesianUnitResult": { "type": "object", "properties": { "x": { "$ref": "#/definitions/UnitResult" }, "y": { "$ref": "#/definitions/UnitResult" } }, "required": [ "x", "y" ] }, "CategoricalEqualityRangesV2": { "description": "Produces ranges where all categorical inputs are equal or are not all equal.", "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/EnumSeries" }, "description": "The series compared against each other. At least two are required." }, "minPoints": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Minimum number of matching points. Defaults to 1." }, "minDuration": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Minimum matching duration. Defaults to one nanosecond." }, "rangeStart": { "allOf": [ { "$ref": "#/definitions/RangeStart" } ], "description": "Selects whether the output begins at the first match or after persistence is satisfied." }, "equalityOperator": { "$ref": "#/definitions/EqualityOperator" } }, "required": [ "equalityOperator" ] }, "CategoricalOnChangeRangesV2": { "description": "Produces a zero-duration range whenever a categorical input changes value.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" } }, "required": [ "input" ] }, "CategoricalStaleRangesV2": { "description": "Produces ranges where a categorical input has no data for at least a duration.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "threshold": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Minimum gap without data that produces an output range." } }, "required": [ "input", "threshold" ] }, "CategoryFilterRangesV2": { "description": "Produces ranges where a categorical input matches a set of values.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "values": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "description": "Category labels matched against each input point." }, "minPoints": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Minimum number of matching points. Defaults to 1." }, "minDuration": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Minimum matching duration. Defaults to one nanosecond." }, "rangeStart": { "allOf": [ { "$ref": "#/definitions/RangeStart" } ], "description": "Selects whether the output begins at the first match or after persistence is satisfied." }, "operator": { "$ref": "#/definitions/EnumFilterOperator" } }, "required": [ "input", "operator" ] }, "ChannelSeries": { "description": "Deprecated: prefer SelectSeries-based nodes with an explicit dataset (or `VariableValue.series` when binding a series to a variable), which select from an arbitrary dataset and let the consuming node decide the series type.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "dataSource", "asset", "run" ] }, "dataSource": { "$ref": "#/definitions/DataSourceChannel" }, "asset": { "$ref": "#/definitions/AssetChannel" }, "run": { "$ref": "#/definitions/RunChannel" } }, "required": [ "type" ], "example": { "type": "dataSource", "dataSource": { "dataSourceRid": { "type": "literal", "literal": "string" }, "channel": { "type": "literal", "literal": "string" }, "tags": { "key": { "type": "literal", "literal": "string" } }, "tagFilters": { "type": "single", "single": { "key": { "type": "literal", "literal": "string" }, "values": [ { "type": "literal", "literal": "string" } ], "operator": "IN" } }, "tagsToGroupBy": [ "string" ], "groupByTags": [ { "type": "literal", "literal": "string" } ] } } }, "CombineStructSeries": { "description": "Combines named input series into one struct-valued series. Each map key becomes a field name in the resulting struct; a downstream UDF receives the struct as a JSON object keyed by these names and parses it itself. Alignment uses the interpolation configuration before producing row-aligned values.", "type": "object", "properties": { "inputs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Series" }, "description": "Input series keyed by struct field name." }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Optional interpolation rules used when aligning input series before combining them.", "x-deprecated": "Setting interpolation on this node is deprecated." } } }, "CombinedDataset": { "description": "Combines multiple datasets into a single dataset by taking the union of all points from each input (akin to SQL {@code UNION ALL}). Duplicate timestamps are preserved rather than merged; callers that need aggregation should wrap the selected series downstream.", "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/Dataset" }, "description": "The datasets to combine." } } }, "CompactEnumPoint": { "type": "object", "properties": { "timestamp": { "$ref": "#/definitions/Timestamp" }, "value": { "type": "integer", "format": "int32" } }, "required": [ "timestamp", "value" ] }, "ComputableNode": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "ranges", "series", "value", "cartesian", "cartesian3d", "frequency", "frequencyV2", "spectrogram", "histogram", "curveV2", "curve", "multivariate" ] }, "ranges": { "$ref": "#/definitions/SummarizeRanges" }, "series": { "$ref": "#/definitions/SummarizeSeries" }, "value": { "$ref": "#/definitions/SelectValue" }, "cartesian": { "$ref": "#/definitions/SummarizeCartesian" }, "cartesian3d": { "$ref": "#/definitions/SummarizeCartesian3d" }, "frequency": { "$ref": "#/definitions/FrequencyDomain" }, "frequencyV2": { "$ref": "#/definitions/FrequencyDomainV2" }, "spectrogram": { "$ref": "#/definitions/Spectrogram" }, "histogram": { "$ref": "#/definitions/Histogram" }, "curveV2": { "$ref": "#/definitions/CurveFitV2" }, "curve": { "$ref": "#/definitions/CurveFit" }, "multivariate": { "$ref": "#/definitions/SummarizeMultivariate" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "ranges", "ranges": { "input": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO", "persistenceWindowConfiguration": { "minPoints": { "type": "literal", "literal": 1 }, "minDuration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } }, "outputRangeStart": { "type": "firstPointMatchingCondition", "firstPointMatchingCondition": {} } } } }, "maxRanges": 1 } } }, "ComputeNode": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "enum", "numeric", "log", "ranges", "array", "struct", "curveFit", "curveV2", "video", "raw" ] }, "enum": { "$ref": "#/definitions/EnumSeries" }, "numeric": { "$ref": "#/definitions/NumericSeries" }, "log": { "$ref": "#/definitions/LogSeries" }, "ranges": { "$ref": "#/definitions/RangeSeries" }, "array": { "$ref": "#/definitions/ArraySeries" }, "struct": { "$ref": "#/definitions/StructSeries" }, "curveFit": { "allOf": [ { "$ref": "#/definitions/CurveFit" } ], "description": "Deprecated: use `curveV2` (CurveFitV2) instead." }, "curveV2": { "$ref": "#/definitions/CurveFitV2" }, "video": { "$ref": "#/definitions/Reference" }, "raw": { "allOf": [ { "$ref": "#/definitions/Reference" } ], "x-deprecated": "wrap raw references in a typed compute node." } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "enum", "enum": { "type": "aggregate", "aggregate": { "function": "MIN" } } } }, "ComputeNodeRequest": { "type": "object", "properties": { "node": { "$ref": "#/definitions/ComputableNode" }, "start": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "The start of the time range (inclusive)." }, "end": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "The end of the time range (inclusive)." }, "context": { "$ref": "#/definitions/Context" }, "sourceRid": { "type": "string", "format": "rid", "description": "Optional RID identifying the resource that initiated this query (e.g. workbook/notebook RID, checklist RID, dataset RID). Used for observability only — trusted as-is, no permission checks are performed on this value." }, "requestId": { "type": "string", "format": "uuid", "description": "Optional UUID to provide as a handle to selectively cancel the execution of this compute request." } }, "required": [ "node", "start", "end", "context" ], "example": { "node": { "type": "ranges", "ranges": { "input": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO" } } } }, "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "context": { "variables": { "": { "type": "double", "double": 1 } }, "functionVariables": { "": { "variables": { "": { "type": "double", "double": 1 } }, "subFunctionVariables": {} } }, "datasetReferences": { "": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } } }, "defaultFillStrategy": { "type": "forwardFill", "forwardFill": { "limit": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } }, "defaultAlignmentStrategy": { "type": "driverSeries", "driverSeries": {} }, "applyDataScopeOffsets": true, "resolveAssetsThroughDatasets": true } } }, "ComputeNodeResponse": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "range", "rangesSummary", "rangeValue", "numeric", "bucketedNumeric", "numericPoint", "singlePoint", "arrowNumeric", "arrowBucketedNumeric", "enum", "enumPoint", "bucketedEnum", "arrowEnum", "arrowBucketedEnum", "pagedLog", "logPoint", "arrowLog", "cartesian", "bucketedCartesian", "bucketedCartesian3d", "frequencyDomain", "frequencyDomainV2", "spectrogram", "bucketedFrequencyDomain", "numericHistogram", "enumHistogram", "curveFit", "curveFitV2", "grouped", "array", "bucketedStruct", "arrowStruct", "fullResolution", "arrowBucketedMultivariate", "multivariate" ] }, "range": { "type": "array", "items": { "$ref": "#/definitions/Range" } }, "rangesSummary": { "$ref": "#/definitions/RangesSummary" }, "rangeValue": { "$ref": "#/definitions/Range" }, "numeric": { "$ref": "#/definitions/NumericPlot" }, "bucketedNumeric": { "$ref": "#/definitions/BucketedNumericPlot" }, "numericPoint": { "$ref": "#/definitions/NumericPoint" }, "singlePoint": { "$ref": "#/definitions/SinglePoint" }, "arrowNumeric": { "$ref": "#/definitions/ArrowPlot" }, "arrowBucketedNumeric": { "$ref": "#/definitions/ArrowPlot" }, "enum": { "$ref": "#/definitions/EnumPlot" }, "enumPoint": { "$ref": "#/definitions/EnumPoint" }, "bucketedEnum": { "$ref": "#/definitions/BucketedEnumPlot" }, "arrowEnum": { "$ref": "#/definitions/ArrowPlot" }, "arrowBucketedEnum": { "$ref": "#/definitions/ArrowPlot" }, "pagedLog": { "$ref": "#/definitions/PagedLogPlot" }, "logPoint": { "$ref": "#/definitions/LogPoint" }, "arrowLog": { "$ref": "#/definitions/ArrowPlot" }, "cartesian": { "$ref": "#/definitions/CartesianPlot" }, "bucketedCartesian": { "$ref": "#/definitions/BucketedCartesianPlot" }, "bucketedCartesian3d": { "$ref": "#/definitions/BucketedCartesian3dPlot" }, "frequencyDomain": { "$ref": "#/definitions/FrequencyDomainPlot" }, "frequencyDomainV2": { "$ref": "#/definitions/FrequencyDomainPlotV2" }, "spectrogram": { "$ref": "#/definitions/SpectrogramPlot" }, "bucketedFrequencyDomain": { "$ref": "#/definitions/BucketedFrequencyDomainPlot" }, "numericHistogram": { "$ref": "#/definitions/NumericHistogramPlot" }, "enumHistogram": { "$ref": "#/definitions/EnumHistogramPlot" }, "curveFit": { "allOf": [ { "$ref": "#/definitions/CurveFitResult" } ], "description": "Deprecated: use `curveFitV2` (CurveFitResultV2) instead. Returned only for deprecated CurveFit requests." }, "curveFitV2": { "$ref": "#/definitions/CurveFitResultV2" }, "grouped": { "$ref": "#/definitions/GroupedComputeNodeResponses" }, "array": { "$ref": "#/definitions/ArrowArrayPlot" }, "bucketedStruct": { "$ref": "#/definitions/ArrowPlot" }, "arrowStruct": { "$ref": "#/definitions/ArrowPlot" }, "fullResolution": { "$ref": "#/definitions/ArrowPlot" }, "arrowBucketedMultivariate": { "$ref": "#/definitions/ArrowPlot" }, "multivariate": { "$ref": "#/definitions/BucketedMultivariatePlot" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "range", "range": [ { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "value": { "type": "double", "double": 1 } } ] } }, "ComputeNodeResult": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "success", "error" ] }, "success": { "$ref": "#/definitions/ComputeNodeResponse" }, "error": { "$ref": "#/definitions/ErrorResult" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "success", "success": { "type": "range", "range": [ { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "value": { "type": "double", "double": 1 } } ] } } }, "ComputeNodeWithContext": { "type": "object", "properties": { "seriesNode": { "$ref": "#/definitions/ComputeNode" }, "context": { "$ref": "#/definitions/Context" } }, "required": [ "seriesNode", "context" ] }, "ComputeUnitResult": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "single", "cartesian", "cartesian3d", "multivariate" ] }, "single": { "$ref": "#/definitions/UnitResult" }, "cartesian": { "$ref": "#/definitions/CartesianUnitResult" }, "cartesian3d": { "$ref": "#/definitions/Cartesian3dUnitResult" }, "multivariate": { "$ref": "#/definitions/MultivariateUnitResult" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "single", "single": { "type": "success", "success": "string" } } }, "ComputeUnitsRequest": { "type": "object", "properties": { "node": { "$ref": "#/definitions/ComputableNode" }, "context": { "$ref": "#/definitions/Context" } }, "required": [ "node", "context" ], "example": { "node": { "type": "ranges", "ranges": { "input": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO" } } } }, "context": { "variables": { "": { "type": "double", "double": 1 } }, "functionVariables": { "": { "variables": { "": { "type": "double", "double": 1 } }, "subFunctionVariables": {} } }, "datasetReferences": { "": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } } }, "defaultFillStrategy": { "type": "forwardFill", "forwardFill": { "limit": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } }, "defaultAlignmentStrategy": { "type": "driverSeries", "driverSeries": {} }, "applyDataScopeOffsets": true, "resolveAssetsThroughDatasets": true } } }, "ComputeWithUnitsResponse": { "type": "object", "properties": { "computeResult": { "$ref": "#/definitions/ComputeNodeResponse" }, "computeUnit": { "$ref": "#/definitions/ComputeUnitResult" } }, "required": [ "computeResult", "computeUnit" ] }, "ComputeWithUnitsResult": { "type": "object", "properties": { "computeResult": { "$ref": "#/definitions/ComputeNodeResult" }, "unitResult": { "$ref": "#/definitions/ComputeUnitResult" } }, "required": [ "computeResult", "unitResult" ] }, "ConstantNumericSeries": { "description": "A synthetic series that produces a constant value across the entire time range.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "double" ] }, "double": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Create from a floating-point constant." } }, "required": [ "type" ], "example": { "type": "double", "double": { "type": "literal", "literal": 1 } } }, "ContainsSeries": { "description": "Maps each log line to 1.0 when `operator` matches it and 0.0 otherwise.", "type": "object", "properties": { "input": { "$ref": "#/definitions/LogSeries" }, "operator": { "$ref": "#/definitions/LogFilterOperator" } }, "required": [ "input", "operator" ] }, "Context": { "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": { "$ref": "#/definitions/VariableValue" }, "x-map-key": "VariableName" }, "functionVariables": { "type": "object", "additionalProperties": { "$ref": "#/definitions/FunctionVariables" }, "x-map-key": "FunctionReference", "x-deprecated": "This field is deprecated and will be removed in a future version." }, "datasetReferences": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Dataset" }, "x-map-key": "DatasetReferenceName", "description": "Named datasets looked up by `DatasetReference` nodes in the compute tree." }, "defaultFillStrategy": { "allOf": [ { "$ref": "#/definitions/FillStrategy" } ], "description": "Default fill strategy applied at every multi-input alignment boundary where no per-node interpolationConfiguration is specified. When absent, falls back to the server-configured default (forward fill with a 1 second fill limit)." }, "defaultAlignmentStrategy": { "allOf": [ { "$ref": "#/definitions/Alignment" } ], "description": "Default alignment strategy applied at every multi-input alignment boundary where no per-node alignment strategy is specified. When absent, falls back to the server default (driver-series alignment)." }, "applyDataScopeOffsets": { "type": "boolean", "description": "When true, dataset resolution applies each data scope's persisted offset as a time shift, and the client must not pre-apply those offsets itself. When absent or false, scope offsets are left to the client, preserving behavior for legacy clients that inject equivalent timeShift nodes into the compute request. Read from the context in scope at resolution time." }, "resolveAssetsThroughDatasets": { "type": "boolean", "description": "When true, `Dataset.asset`, the asset-typed sources of `Dataset.run`, and asset or run search expand through each asset's mirrored derived dataset instead of its data scopes. Branches then carry the dataset's declared channel-search split tag keys in place of the reserved `DATA_SCOPE` tag, so callers must filter and group on those keys; the definition's own time shifts apply regardless of `applyDataScopeOffsets`; and an asset with no mirrored dataset resolves to no data. When absent or false, assets expand from their data scopes as before." } } }, "Cos": { "description": "Computes the trigonometric cosine of each value (input in radians).", "type": "object", "properties": { "x": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (radians)." } }, "required": [ "x" ] }, "Count": { "description": "The number of points inside the time window.", "type": "object", "properties": {} }, "Cpsd": { "description": "Returns the cross-spectral density magnitude and phase of the two input series.", "type": "object", "properties": { "x": { "$ref": "#/definitions/NumericSeries" }, "y": { "$ref": "#/definitions/NumericSeries" }, "stftOptions": { "$ref": "#/definitions/StftOptions" }, "magnitudeScaling": { "allOf": [ { "$ref": "#/definitions/MagnitudeScaling" } ], "description": "The scaling to apply to the output magnitude. Defaults to MAGNITUDE_DB_10 if not specified." }, "outputFrequencyType": { "allOf": [ { "$ref": "#/definitions/OutputFrequencyType" } ], "description": "The type of the output frequency. Defaults to LINEAR if not specified. Changing the output frequency type may also rescale the magnitude of the output in order to ensure the density of the output is consistent." }, "unwrapPhase": { "type": "boolean", "description": "Unwrap the phase of the output. Defaults to true if not specified." }, "outputPhaseUnit": { "allOf": [ { "$ref": "#/definitions/OutputPhaseUnit" } ], "description": "The unit of the output phase. Defaults to RADIANS if not specified." } }, "required": [ "x", "y" ] }, "CumulativeSumSeries": { "description": "Calculates the running total of the series values.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "startTimestamp": { "$ref": "#/definitions/TimestampConstant" } }, "required": [ "input", "startTimestamp" ] }, "CurveFit": { "description": "Deprecated: use CurveFitV2 instead.", "type": "object", "properties": { "curveFitPlotType": { "$ref": "#/definitions/CurveFitPlotType" }, "curveFitDetails": { "$ref": "#/definitions/CurveFitDetails" }, "curveFitOptions": { "$ref": "#/definitions/CurveFitOptions" } }, "required": [ "curveFitPlotType", "curveFitDetails", "curveFitOptions" ] }, "CurveFitBoundsConfiguration": { "type": "object", "properties": { "min": { "$ref": "#/definitions/DoubleConstant" }, "max": { "$ref": "#/definitions/DoubleConstant" } } }, "CurveFitDetails": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "exponential", "logarithmic", "polynomial", "power" ] }, "exponential": { "$ref": "#/definitions/ExponentialCurve" }, "logarithmic": { "$ref": "#/definitions/LogarithmicCurve" }, "polynomial": { "$ref": "#/definitions/PolynomialCurve" }, "power": { "$ref": "#/definitions/PowerCurve" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "exponential", "exponential": {} } }, "CurveFitOptions": { "type": "object", "properties": { "startTime": { "$ref": "#/definitions/TimestampConstant" }, "endTime": { "$ref": "#/definitions/TimestampConstant" } }, "required": [ "startTime", "endTime" ] }, "CurveFitPlotType": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "timeSeries", "scatter" ] }, "timeSeries": { "$ref": "#/definitions/TimeSeriesCurveFit" }, "scatter": { "$ref": "#/definitions/ScatterCurveFit" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "timeSeries", "timeSeries": { "series": { "type": "abs", "abs": {} }, "options": { "timeUnit": "DAYS" } } } }, "CurveFitRange": { "type": "object", "properties": { "startTime": { "$ref": "#/definitions/TimestampConstant" }, "endTime": { "$ref": "#/definitions/TimestampConstant" } }, "required": [ "startTime", "endTime" ] }, "CurveFitResult": { "type": "object", "properties": { "r2": { "type": "number", "format": "double", "description": "R^2 (coefficient of determination) for the fit curve, a normalized measure of how well the curve fits the data. Usually ranges from 0 to 1, with higher indicating better fit (points closer to fit line)." }, "mae": { "type": "number", "format": "double", "description": "Mean Absolute Error (MAE) - the average of the absolute differences between predicted and actual values. Measured in the same units as the y-values." }, "mse": { "type": "number", "format": "double", "description": "Mean Squared Error (MSE) - the average of the squared differences between predicted and actual values. Measured in the squared units of the y-values." }, "rmse": { "type": "number", "format": "double", "description": "Root Mean Squared Error (RMSE) - the square root of the mean squared error. Measured in the same units as the y-values." }, "maxAbsoluteError": { "type": "number", "format": "double", "description": "Maximum Absolute Error - the largest absolute difference between any predicted and actual value. Measured in the same units as the y-values." }, "sampleCount": { "type": "integer", "format": "int32", "description": "The number of data points used in the curve fitting calculation." }, "curveResultDetails": { "allOf": [ { "$ref": "#/definitions/CurveResultDetails" } ], "description": "Description of the fit curve." } }, "required": [ "r2", "mae", "mse", "rmse", "maxAbsoluteError", "sampleCount", "curveResultDetails" ] }, "CurveFitResultV2": { "type": "object", "properties": { "r2": { "type": "number", "format": "double", "description": "R^2 (coefficient of determination) for the fit curve, a normalized measure of how well the curve fits the data. Usually ranges from 0 to 1, with higher indicating better fit (points closer to fit line)." }, "mae": { "type": "number", "format": "double", "description": "Mean Absolute Error (MAE) - the average of the absolute differences between predicted and actual values. Measured in the same units as the y-values." }, "mse": { "type": "number", "format": "double", "description": "Mean Squared Error (MSE) - the average of the squared differences between predicted and actual values. Measured in the squared units of the y-values." }, "rmse": { "type": "number", "format": "double", "description": "Root Mean Squared Error (RMSE) - the square root of the mean squared error. Measured in the same units as the y-values." }, "maxAbsoluteError": { "type": "number", "format": "double", "description": "Maximum Absolute Error - the largest absolute difference between any predicted and actual value. Measured in the same units as the y-values." }, "sampleCount": { "type": "integer", "format": "int32", "description": "The number of data points used in the curve fitting calculation." }, "curveResultDetails": { "allOf": [ { "$ref": "#/definitions/CurveResultDetailsV2" } ], "description": "Description of the fit curve." } }, "required": [ "r2", "mae", "mse", "rmse", "maxAbsoluteError", "sampleCount", "curveResultDetails" ] }, "CurveFitSeriesVariable": { "type": "object", "properties": { "series": { "$ref": "#/definitions/NumericSeries" }, "boundsConfig": { "allOf": [ { "$ref": "#/definitions/CurveFitBoundsConfiguration" } ], "description": "Optional inclusive bounds selecting which variable samples are fit. Samples outside the bounds are excluded." } }, "required": [ "series" ] }, "CurveFitTarget": { "description": "The series a curve is fit against (the `y` of the fit). Modeled as a union so additional target types can be added in the future; today the only arm is a numeric series.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "numeric" ] }, "numeric": { "$ref": "#/definitions/CurveFitSeriesVariable" } }, "required": [ "type" ], "example": { "type": "numeric", "numeric": { "series": { "type": "abs", "abs": {} }, "boundsConfig": { "min": { "type": "literal", "literal": 1 }, "max": { "type": "literal", "literal": 1 } } } } }, "CurveFitTimeVariable": { "type": "object", "properties": { "timeUnit": { "allOf": [ { "$ref": "#/definitions/TimeUnit" } ], "description": "The unit of the time variable in the formula expression. If not specified, the time unit is assumed to be seconds." } } }, "CurveFitV2": { "type": "object", "properties": { "target": { "allOf": [ { "$ref": "#/definitions/CurveFitTarget" } ], "description": "Target to fit the equation against." }, "fitRange": { "allOf": [ { "$ref": "#/definitions/CurveFitRange" } ], "description": "The range to fit the curve over" }, "curveToFit": { "allOf": [ { "$ref": "#/definitions/CurveFitV2Details" } ], "description": "The curve type to fit against the target series." } }, "required": [ "target", "fitRange", "curveToFit" ] }, "CurveFitV2Details": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "exponential", "logarithmic", "polynomial", "power", "custom" ] }, "exponential": { "$ref": "#/definitions/BuiltInCurveFit" }, "logarithmic": { "$ref": "#/definitions/BuiltInCurveFit" }, "polynomial": { "$ref": "#/definitions/PolynomialCurveFit" }, "power": { "$ref": "#/definitions/BuiltInCurveFit" }, "custom": { "$ref": "#/definitions/CustomCurveFit" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "exponential", "exponential": { "independentVariable": { "type": "numeric", "numeric": { "series": { "type": "abs", "abs": {} }, "boundsConfig": { "min": { "type": "literal", "literal": 1 }, "max": { "type": "literal", "literal": 1 } } } } } } }, "CurveFitVariable": { "description": "A series a curve fit reads from: another numeric series, or the target's own sample timestamps. Used both as the named formula inputs of a custom fit and as the independent (`x`) axis of a built-in fit.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "numeric", "time" ] }, "numeric": { "$ref": "#/definitions/CurveFitSeriesVariable" }, "time": { "$ref": "#/definitions/CurveFitTimeVariable" } }, "required": [ "type" ], "example": { "type": "numeric", "numeric": { "series": { "type": "abs", "abs": {} }, "boundsConfig": { "min": { "type": "literal", "literal": 1 }, "max": { "type": "literal", "literal": 1 } } } } }, "CurveResultDetails": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "exponential", "logarithmic", "polynomial", "power" ] }, "exponential": { "$ref": "#/definitions/ExponentialResultDetails" }, "logarithmic": { "$ref": "#/definitions/LogarithmicResultDetails" }, "polynomial": { "$ref": "#/definitions/PolynomialResultDetails" }, "power": { "$ref": "#/definitions/PowerResultDetails" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "exponential", "exponential": { "a": 1, "b": 1 } } }, "CurveResultDetailsV2": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "exponential", "logarithmic", "polynomial", "power", "custom" ] }, "exponential": { "$ref": "#/definitions/ExponentialResultDetails" }, "logarithmic": { "$ref": "#/definitions/LogarithmicResultDetails" }, "polynomial": { "$ref": "#/definitions/PolynomialResultDetails" }, "power": { "$ref": "#/definitions/PowerResultDetails" }, "custom": { "$ref": "#/definitions/CustomCurveResultDetails" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "exponential", "exponential": { "a": 1, "b": 1 } } }, "CustomCurveFit": { "type": "object", "properties": { "formula": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "A mathematical expression in terms of variable and parameter names, e.g. `a * x + b * sin(x)`. Variable names must match keys in the `variables` map; parameter names must match keys in the `parameters` map." }, "variables": { "type": "object", "additionalProperties": { "$ref": "#/definitions/CurveFitVariable" }, "x-map-key": "LocalVariableName", "description": "Named input series referenced in the formula. Keys must match the variable names used in the formula expression." }, "parameters": { "type": "object", "additionalProperties": { "$ref": "#/definitions/DoubleConstant" }, "description": "Named fitting parameters and their initial guesses. Keys must match the parameter names used in the formula expression; values are the starting points passed to the optimizer. The target the curve is fit against is the `y` of the enclosing curve fit (the timeSeries series values, or the scatter `y` series)." } }, "required": [ "formula" ] }, "CustomCurveResultDetails": { "description": "The result of fitting a custom curve, containing the optimized values for each named parameter.", "type": "object", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "description": "Optimized parameter values produced by the curve fit. Keys match the parameter names provided in the request." }, "converged": { "type": "boolean", "description": "Whether the optimizer converged to a solution within its iteration limit. When false, the returned parameters are the best estimate found before the iteration cap was reached and did not satisfy the solver's convergence tolerances." }, "iterations": { "type": "integer", "format": "int32", "description": "Number of iterations the solver completed." } }, "required": [ "converged", "iterations" ] }, "DataSourceAndChannel": { "type": "object", "properties": { "dataSourceRid": { "type": "string", "format": "rid", "x-alias": "DataSourceRid" }, "channel": { "type": "string" } }, "required": [ "dataSourceRid", "channel" ] }, "DataSourceChannel": { "type": "object", "properties": { "dataSourceRid": { "$ref": "#/definitions/StringConstant" }, "channel": { "$ref": "#/definitions/StringConstant" }, "tags": { "type": "object", "additionalProperties": { "$ref": "#/definitions/StringConstant" }, "x-deprecated": "Use tagFilters" }, "tagFilters": { "allOf": [ { "$ref": "#/definitions/TagFilters" } ], "description": "Tags to filter the channel by. Only returns points from the channel where tag values match the provided expression. For log series, include arg filters here in addition to tag filters." }, "tagsToGroupBy": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "x-deprecated": "Use groupByTags instead. Throws if both tagsToGroupBy and groupByTags are specified." }, "groupByTags": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true, "description": "Tags that the channel should be grouped by. If this is non-empty a grouped result will be returned with an entry for each grouping. Only one of tagsToGroupBy and groupByTags should be specified." } }, "required": [ "dataSourceRid", "channel" ] }, "Dataset": { "description": "A logical bundle of named series. For the time being, columns are each a time series (series name + tags). A dataset is either rooted in persisted data (asset or dataset) or defined as a transformation of another dataset.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "asset", "run", "saved", "search", "combine", "tag", "filter", "timeShift", "alignByAnchor", "withSeries", "dropSeries", "reference", "withDimensions" ] }, "asset": { "allOf": [ { "$ref": "#/definitions/Asset" } ], "description": "Single asset. Expands to one grouping per data scope on the asset. Groupings are tagged by `assetRid` and `dataScope` so callers can safely compose multiple assets with `combine`." }, "run": { "allOf": [ { "$ref": "#/definitions/Run" } ], "description": "Single run. Expands to one grouping per data source attached to the run: asset-typed sources contribute one grouping per data scope on the asset; dataset-typed sources contribute one grouping per dataset. Groupings are tagged by `runRid` and `dataScope`; asset-typed groupings additionally carry `assetRid` so callers can safely compose multiple runs with `combine`." }, "saved": { "$ref": "#/definitions/SavedDataset" }, "search": { "$ref": "#/definitions/SearchDataset" }, "combine": { "$ref": "#/definitions/CombinedDataset" }, "tag": { "$ref": "#/definitions/TaggedDataset" }, "filter": { "$ref": "#/definitions/FilteredDataset" }, "timeShift": { "$ref": "#/definitions/TimeShiftedDataset" }, "alignByAnchor": { "$ref": "#/definitions/AnchorAlignedDataset" }, "withSeries": { "$ref": "#/definitions/WithSeriesDataset" }, "dropSeries": { "$ref": "#/definitions/DropSeriesDataset" }, "reference": { "$ref": "#/definitions/DatasetReference" }, "withDimensions": { "$ref": "#/definitions/DimensionsDataset" } }, "required": [ "type" ], "example": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "string" } } } }, "DatasetAnchor": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "run" ] }, "run": { "allOf": [ { "$ref": "#/definitions/IntervalAnchor" } ], "description": "Uses the start or end of each run as its anchor. The input dataset must resolve exclusively to run-backed branches." } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "run", "run": { "type": "intervalStart", "intervalStart": {} } } }, "DatasetReference": { "description": "References a named dataset in `Context.datasetReferences`.", "type": "object", "properties": { "name": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "Name of the dataset reference to resolve from the context." } }, "required": [ "name" ] }, "DecimateStrategy": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "resolution", "buckets" ] }, "resolution": { "$ref": "#/definitions/DecimateWithResolution" }, "buckets": { "$ref": "#/definitions/DecimateWithBuckets" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "resolution", "resolution": { "resolution": 1 } } }, "DecimateWithBuckets": { "type": "object", "properties": { "buckets": { "type": "integer", "format": "int32", "description": "Number of points to generate in the output series." } }, "required": [ "buckets" ] }, "DecimateWithResolution": { "type": "object", "properties": { "resolution": { "type": "integer", "format": "int64", "description": "Resolution of the output series specifying time interval between decimated points, in nanoseconds." } }, "required": [ "resolution" ] }, "DerivativeSeries": { "description": "Calculates the rate of change between subsequent points.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "timeUnit": { "allOf": [ { "$ref": "#/definitions/TimeUnit" } ], "description": "Time unit used to calculate the derivative. Defaults to seconds if not specified." }, "negativeValuesConfiguration": { "allOf": [ { "$ref": "#/definitions/NegativeValueConfiguration" } ], "description": "Defines the strategy for handling negative output values. Defaults to allowNegativeValues if not specified." } }, "required": [ "input" ] }, "DerivedSeries": { "description": "Represents a derived series within a compute graph. This is a series that is derived from a function within a module.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "function" ] }, "function": { "$ref": "#/definitions/FunctionDerivedSeries" } }, "required": [ "type" ], "example": { "type": "function", "function": { "moduleName": { "type": "literal", "literal": "string" }, "functionName": { "type": "literal", "literal": "string" }, "versionReference": { "type": "pinned", "pinned": { "version": { "type": "literal", "literal": "string" } } }, "functionArgs": { "key": { "type": "variable", "variable": "string" } } } } }, "DetrendType": { "description": "The type of detrending to apply to the signal. When absent, will default to the detrend behavior for that function.", "type": "string", "enum": [ "CONSTANT", "LINEAR", "NO_OP" ], "x-enum-descriptions": { "CONSTANT": "Removes the mean value of the signal.", "LINEAR": "Removes a best-fit linear trend from the signal.", "NO_OP": "Does not perform any detrending." } }, "Dimension": { "description": "A value derived per asset or run, injected as a tag.", "type": "object", "properties": { "tagKey": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "The tag key to inject the value under. Defaults to the key derived by `value`." }, "value": { "allOf": [ { "$ref": "#/definitions/DimensionValue" } ], "description": "The value to inject." } }, "required": [ "value" ] }, "DimensionValue": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "stringProperty", "identity" ] }, "stringProperty": { "allOf": [ { "$ref": "#/definitions/StringPropertyDimension" } ], "description": "The value of a string property on the asset or run." }, "identity": { "allOf": [ { "$ref": "#/definitions/IdentityDimension" } ], "description": "The value of an asset's primary key under one of its types." } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "stringProperty", "stringProperty": { "propertyName": { "type": "literal", "literal": "string" } } } }, "DimensionsDataset": { "description": "Injects one tag per dimension onto every series of the underlying dataset, valued from the asset or run the series belongs to. This makes resource metadata usable as a grouping, filtering and aggregation dimension with `selectTags`, tag predicates and `groupByTags`. Group by the dimension together with `ASSET_RID` (or `RUN_RID`) to keep each resource separate, or by the dimension alone to pivot so that resources sharing a value fall into one group.\n\nDimensions are only supported on asset and run branches. Any other branch, such as a saved dataset or a derived series from `withSeries`, gets the reserved value `NOMINAL_ABSENT` for every dimension. To group derived series by a dimension, apply `withDimensions` to the `withSeries` input instead, so that the series they are computed from carry the dimension tags. A dimension tag replaces a series tag with the same key.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/Dataset" } ], "description": "The underlying dataset to tag." }, "dimensions": { "type": "array", "items": { "$ref": "#/definitions/Dimension" }, "description": "The dimensions to inject. Must not be empty, must have at most 10 entries, and every dimension must have a distinct tag key. A tag key must not be a `ReservedTagKey`, start with `EVENT_LABEL_PREFIX:`, or start with `NOMINAL_`." } }, "required": [ "input" ] }, "Divide": { "description": "Divides left by right pointwise.", "type": "object", "properties": { "left": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Numerator." }, "right": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Denominator." } }, "required": [ "left", "right" ] }, "DoubleConstant": { "description": "A floating-point constant that can be a literal value, a named variable reference, or a named builtin constant.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "literal", "variable", "builtin" ] }, "literal": { "type": "number", "format": "double", "description": "Create from a literal floating-point value." }, "variable": { "type": "string", "x-alias": "VariableName", "description": "Create from a named reference name." }, "builtin": { "allOf": [ { "$ref": "#/definitions/BuiltinConstant" } ], "description": "Create from a named builtin constant; the server resolves the numeric value." } }, "required": [ "type" ], "example": { "type": "literal", "literal": 1 } }, "DriverSeries": { "description": "Uses the driver series timestamps as the alignment grid.", "type": "object", "properties": {} }, "DriverSeries3d": { "type": "string", "enum": [ "X", "Y", "Z" ] }, "DropSeriesDataset": { "description": "Removes series from the base dataset by name: raw and derived series alike are no longer selectable under those names. Dropping a name absent from `input` has no effect. Combined with `WithSeriesDataset`, which can expose a series under another name, this renames a series: `dropSeries(withSeries(input, [newName = select(oldName)]), [oldName])`.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/Dataset" } ], "description": "The base dataset to drop series from." }, "names": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "description": "Names of the series to drop." } }, "required": [ "input" ] }, "compute.api.Duration": { "description": "A length of time. Can be constructed from literal values in various units or composed via arithmetic. Used for window sizes, time shifts, persistence thresholds, and resampling intervals.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "reference", "nanoseconds", "milliseconds", "seconds", "minutes", "hours", "days", "add", "subtract", "negate" ] }, "reference": { "$ref": "#/definitions/Reference" }, "nanoseconds": { "$ref": "#/definitions/DurationNanoseconds" }, "milliseconds": { "$ref": "#/definitions/DurationMilliseconds" }, "seconds": { "$ref": "#/definitions/DurationSeconds" }, "minutes": { "$ref": "#/definitions/DurationMinutes" }, "hours": { "$ref": "#/definitions/DurationHours" }, "days": { "$ref": "#/definitions/DurationDays" }, "add": { "$ref": "#/definitions/DurationAdd" }, "subtract": { "$ref": "#/definitions/DurationSubtract" }, "negate": { "$ref": "#/definitions/DurationNegate" } }, "required": [ "type" ], "example": { "type": "reference", "reference": { "name": "string" } } }, "DurationAdd": { "description": "The sum of two durations.", "type": "object", "properties": { "left": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "First duration." }, "right": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Second duration." } }, "required": [ "left", "right" ] }, "DurationConstant": { "description": "A duration constant that can be a literal value or a named variable reference.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "literal", "variable" ] }, "literal": { "allOf": [ { "$ref": "#/definitions/run.api.Duration" } ], "description": "Create from a literal duration value." }, "variable": { "type": "string", "x-alias": "VariableName", "description": "Create from a named reference name." } }, "required": [ "type" ], "example": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } }, "DurationDays": { "description": "Constructs a duration from a number of days.", "type": "object", "properties": { "days": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The number of days." } }, "required": [ "days" ] }, "DurationFilterRanges": { "description": "Filters a list of ranges down to only those satisfying a threshold condition on the range's duration.", "type": "object", "properties": { "input": { "$ref": "#/definitions/RangeSeries" }, "threshold": { "$ref": "#/definitions/DurationConstant" }, "operator": { "$ref": "#/definitions/ThresholdOperator" }, "unboundedBehavior": { "$ref": "#/definitions/UnboundedBehavior" } }, "required": [ "input", "threshold", "operator" ] }, "DurationFilterRangesV2": { "description": "Filters ranges by duration using an authored Duration expression.", "type": "object", "properties": { "input": { "$ref": "#/definitions/RangeSeries" }, "duration": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "The duration each input range is compared against." }, "unboundedBehavior": { "allOf": [ { "$ref": "#/definitions/UnboundedBehavior" } ], "description": "How a range with an open start or end is measured. Defaults to treating the missing bound as the edge of the compute request window." }, "comparison": { "$ref": "#/definitions/ThresholdOperator" } }, "required": [ "input", "duration", "comparison" ] }, "DurationHours": { "description": "Constructs a duration from a number of hours.", "type": "object", "properties": { "hours": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The number of hours." } }, "required": [ "hours" ] }, "DurationMilliseconds": { "description": "Constructs a duration from a number of milliseconds.", "type": "object", "properties": { "milliseconds": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The number of milliseconds." } }, "required": [ "milliseconds" ] }, "DurationMinutes": { "description": "Constructs a duration from a number of minutes.", "type": "object", "properties": { "minutes": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The number of minutes." } }, "required": [ "minutes" ] }, "DurationNanoseconds": { "description": "Constructs a duration from a number of nanoseconds. Limited to values within the 32-bit integer range (~2.1 billion ns, or ~2.1 seconds). For larger durations, use DurationSeconds or DurationMilliseconds.", "type": "object", "properties": { "nanoseconds": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The number of nanoseconds." } }, "required": [ "nanoseconds" ] }, "DurationNegate": { "description": "Negates a duration (reverses its sign).", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "The duration to negate." } }, "required": [ "input" ] }, "DurationSeconds": { "description": "Constructs a duration from a number of seconds.", "type": "object", "properties": { "seconds": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The number of seconds." } }, "required": [ "seconds" ] }, "DurationSubtract": { "description": "The difference of two durations (left minus right).", "type": "object", "properties": { "left": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Duration to subtract from." }, "right": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Duration to subtract." } }, "required": [ "left", "right" ] }, "EarliestAnchorReference": { "description": "Selects the earliest anchor resolved from the input.", "type": "object", "properties": {} }, "Enum1dArraySelectTagsSeries": { "description": "Subsets the tag dimensions of the input enum 1d array series to the given tag keys. Preserves the input series' cardinality: points that share the selected keys but differ on dropped keys remain distinct.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Enum1dArraySeries" }, "tagKeys": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true } }, "required": [ "input" ] }, "Enum1dArraySeries": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "channel", "raw", "derived", "selectEnum1dArray", "extractFromStruct", "toStartOfInterval", "timeShift", "filterByTag", "selectTags" ] }, "channel": { "$ref": "#/definitions/ChannelSeries" }, "raw": { "$ref": "#/definitions/Reference" }, "derived": { "$ref": "#/definitions/DerivedSeries" }, "selectEnum1dArray": { "$ref": "#/definitions/SelectSeries" }, "extractFromStruct": { "$ref": "#/definitions/ExtractEnum1dArrayFromStructSeries" }, "toStartOfInterval": { "$ref": "#/definitions/Enum1dArrayToStartOfIntervalSeries" }, "timeShift": { "$ref": "#/definitions/Enum1dArrayTimeShiftSeries" }, "filterByTag": { "$ref": "#/definitions/Enum1dArrayTagFilterSeries" }, "selectTags": { "$ref": "#/definitions/Enum1dArraySelectTagsSeries" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "channel", "channel": { "type": "dataSource", "dataSource": { "dataSourceRid": { "type": "literal", "literal": "string" }, "channel": { "type": "literal", "literal": "string" }, "tags": { "key": { "type": "literal", "literal": "string" } }, "tagFilters": { "type": "single", "single": { "key": { "type": "literal", "literal": "string" }, "values": [ { "type": "literal", "literal": "string" } ], "operator": "IN" } }, "tagsToGroupBy": [ "string" ], "groupByTags": [ { "type": "literal", "literal": "string" } ] } } } }, "Enum1dArrayTagFilterSeries": { "description": "Applies a tag predicate to the enum 1d array series produced by input.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Enum1dArraySeries" }, "predicate": { "$ref": "#/definitions/TagPredicate" } }, "required": [ "input", "predicate" ] }, "Enum1dArrayTimeShiftSeries": { "type": "object", "properties": { "input": { "$ref": "#/definitions/Enum1dArraySeries" }, "duration": { "$ref": "#/definitions/DurationConstant" } }, "required": [ "input", "duration" ] }, "Enum1dArrayToStartOfIntervalSeries": { "description": "Snaps each point's timestamp to the start of its enclosing fixed-size time bucket. Buckets are epoch-aligned: a point at timestamp `t` (nanoseconds) is rewritten to `floor(t / window) * window`. Values and tag groupings are preserved; aggregation of points that collide on the snapped timestamp is the responsibility of downstream nodes.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Enum1dArraySeries" }, "window": { "$ref": "#/definitions/compute.api.Duration" } }, "required": [ "input", "window" ] }, "EnumAggregation": { "description": "Aggregates an input series using an enum aggregation operator. Rolling aggregation builders are not supported; only the group-by shape is accepted at resolution time. `Min` and `Max` require a categorical input series. `Udf` also accepts a numeric input, which reaches the function as `Vec`; a categorical input reaches it as `Vec`.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/AggregationBuilder" } ], "description": "The aggregation shape to apply the operator over. Only the group-by shape is supported; rolling builders are rejected at resolution time. The Python `enum_aggregation(...)` sugar form is categorical-only. Numeric builders expose the UDF-only `enum_udf(...)` and `rust_enum_udf(...)` terminals instead." }, "operator": { "allOf": [ { "$ref": "#/definitions/EnumAggregationOperator" } ], "description": "The enum reduction applied to each group (min, max, or a user-defined function)." } }, "required": [ "input", "operator" ] }, "EnumAggregationFunction": { "description": "Aggregates duplicate timestamps on a single enum series. For aggregating across tag groupings, use `EnumSeries.enumAggregation` with `aggregation.AggregationBuilder.groupBy`.", "type": "string", "enum": [ "MIN", "MAX" ] }, "EnumAggregationOperator": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "min", "max", "udf" ] }, "min": { "$ref": "#/definitions/Empty" }, "max": { "$ref": "#/definitions/Empty" }, "udf": { "$ref": "#/definitions/EnumAggregationUdf" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "min", "min": {} } }, "EnumAggregationUdf": { "description": "A user-defined enum aggregation. The supported ABI is a Rust function with one vector input and a `String` return value. Numeric input series use `Vec` and enum input series use `Vec`.", "type": "object", "properties": { "source": { "$ref": "#/definitions/UdfSource" } }, "required": [ "source" ] }, "EnumBucket": { "type": "object", "properties": { "histogram": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" }, "description": "The map of values within the bucket to their frequency." }, "firstPoint": { "$ref": "#/definitions/CompactEnumPoint" }, "lastPoint": { "allOf": [ { "$ref": "#/definitions/CompactEnumPoint" } ], "description": "Will be empty if the bucket only has a single point." } }, "required": [ "firstPoint" ] }, "EnumConstantResampleInterpolationConfiguration": { "description": "Fills all empty resample intervals with a single constant value.\n\nIf a resampled time interval (bucket) contains no data points from the input, it will be assigned the specified 'constant' as a default value. This applies to gaps at the start of the series, between data points, and at the end.", "type": "object", "properties": { "constant": { "$ref": "#/definitions/StringConstant" } }, "required": [ "constant" ] }, "EnumCountDuplicateSeries": { "description": "Counts the number of points along each timestamp in the input series.", "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/EnumSeries" } } } }, "EnumFilterOperator": { "type": "string", "enum": [ "IS_IN", "IS_NOT_IN", "MATCHES_ANY_REGEX" ], "x-enum-descriptions": { "IS_IN": "True when the value is contained in the set.", "IS_NOT_IN": "True when the value is not contained in the set.", "MATCHES_ANY_REGEX": "True when the value matches at least one pattern in the set. Values are RE2 regular expressions, anchored to the entire string." } }, "EnumFilterRanges": { "description": "Produces a list of ranges for which the filter condition is satisfied.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "operator": { "$ref": "#/definitions/EnumFilterOperator" }, "values": { "allOf": [ { "$ref": "#/definitions/StringSetConstant" } ], "description": "The set of literal values (for IS_IN / IS_NOT_IN) or RE2 regex patterns (for MATCHES_ANY_REGEX) to match against." }, "persistenceWindowConfiguration": { "$ref": "#/definitions/PersistenceWindowConfiguration" } }, "required": [ "input", "operator", "values" ] }, "EnumFilterTransformationSeries": { "description": "Outputs categorical input values that fall within the supplied ranges.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "filter": { "allOf": [ { "$ref": "#/definitions/RangeSeries" } ], "description": "Keeps only input points whose timestamp falls inside one of these ranges." } }, "required": [ "input", "filter" ] }, "EnumHistogramBucket": { "description": "A bucket in an enum histogram representing all the counts for a specific enumerated value, across all input series.", "type": "object", "properties": { "value": { "type": "string", "description": "The value of the enum as a string" }, "countsByChannel": { "type": "object", "additionalProperties": { "$ref": "#/definitions/HistogramChannelCount" }, "x-map-key": "VariableName" } }, "required": [ "value" ] }, "EnumHistogramNode": { "type": "object", "properties": { "inputs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/EnumSeries" }, "x-map-key": "VariableName" } } }, "EnumHistogramPlot": { "type": "object", "properties": { "buckets": { "type": "array", "items": { "$ref": "#/definitions/EnumHistogramBucket" } } } }, "EnumMultivariateAggregation": { "description": "Aggregations for enum series in multivariate queries.", "type": "string", "enum": [ "MODE" ] }, "EnumNthPointDownsampleSeries": { "description": "Keeps every Nth row of the timestamp-ordered input, per series. No grid arithmetic, no interpolation, no boundary handling. Output count is ceil(input_count / n) per series. Caller is responsible for choosing n consistent with the input's sample rate; output spacing is only uniform when the input is.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "n": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Keep every Nth point starting from the earliest in each series. Must be >= 1." } }, "required": [ "input", "n" ] }, "EnumPlot": { "type": "object", "properties": { "timestamps": { "type": "array", "items": { "$ref": "#/definitions/Timestamp" } }, "values": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "categories": { "type": "array", "items": { "type": "string" } }, "nextPageToken": { "allOf": [ { "$ref": "#/definitions/PageToken" } ], "description": "Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as `pageToken` and keep the pageSize sign unchanged. Returned only when this response contains exactly `abs(pageSize)` points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction." } } }, "EnumPoint": { "type": "object", "properties": { "timestamp": { "$ref": "#/definitions/Timestamp" }, "value": { "type": "string" } }, "required": [ "timestamp", "value" ] }, "EnumResampleConfiguration": { "type": "object", "properties": { "interval": { "allOf": [ { "$ref": "#/definitions/DurationConstant" } ], "description": "Interval between resampled points" }, "interpolation": { "allOf": [ { "$ref": "#/definitions/EnumResampleInterpolationConfiguration" } ], "description": "Interpolation strategy to use (defaults to forward fill)." } }, "required": [ "interval" ] }, "EnumResampleInterpolationConfiguration": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "forwardFillResampleInterpolationConfiguration", "constantResampleInterpolationConfiguration" ] }, "forwardFillResampleInterpolationConfiguration": { "$ref": "#/definitions/ForwardFillResampleInterpolationConfiguration" }, "constantResampleInterpolationConfiguration": { "$ref": "#/definitions/EnumConstantResampleInterpolationConfiguration" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "forwardFillResampleInterpolationConfiguration", "forwardFillResampleInterpolationConfiguration": {} } }, "EnumResampleSeries": { "description": "Resamples the input series to a new resolution using interpolation. Outputs data for timestamps corresponding to the defined frequency. Based on interpolation strategy, determines range of timestamps to output data for and interpolates values where necessary.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "resampleConfiguration": { "allOf": [ { "$ref": "#/definitions/EnumResampleConfiguration" } ], "description": "The interval at which to resample the series and interpolation strategy" } }, "required": [ "input", "resampleConfiguration" ] }, "EnumResampleSeriesV2": { "description": "Resamples categorical points at the authored interval using forward-fill interpolation.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "interval": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Interval at which to resample." } }, "required": [ "input", "interval" ] }, "EnumSelectTagsSeries": { "description": "Subsets the tag dimensions of the input enum series to the given tag keys. Preserves the input series' cardinality: points that share the selected keys but differ on dropped keys remain distinct.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "tagKeys": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true } }, "required": [ "input" ] }, "EnumSeries": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "aggregate", "raw", "channel", "derived", "resample", "resampleV2", "nthPointDownsample", "timeRangeFilter", "timeShift", "timeShiftV2", "union", "filterTransformation", "valueMap", "select1dArrayIndex", "extractFromStruct", "eventAggregation", "enumAggregation", "selectEnum", "selectCategoricalProperty", "filterByTag", "selectTags", "scalarUdf", "toStartOfInterval" ] }, "aggregate": { "allOf": [ { "$ref": "#/definitions/AggregateEnumSeries" } ], "x-deprecated": "AggregateEnumSeries is deprecated. Use `enumAggregation` with `aggregation.GroupByAggregationBuilder` instead." }, "raw": { "$ref": "#/definitions/Reference" }, "channel": { "$ref": "#/definitions/ChannelSeries" }, "derived": { "$ref": "#/definitions/DerivedSeries" }, "resample": { "$ref": "#/definitions/EnumResampleSeries" }, "resampleV2": { "$ref": "#/definitions/EnumResampleSeriesV2" }, "nthPointDownsample": { "$ref": "#/definitions/EnumNthPointDownsampleSeries" }, "timeRangeFilter": { "$ref": "#/definitions/EnumTimeRangeFilterSeries" }, "timeShift": { "$ref": "#/definitions/EnumTimeShiftSeries" }, "timeShiftV2": { "$ref": "#/definitions/EnumTimeShiftSeriesV2" }, "union": { "$ref": "#/definitions/EnumUnionSeries" }, "filterTransformation": { "$ref": "#/definitions/EnumFilterTransformationSeries" }, "valueMap": { "$ref": "#/definitions/ValueMapSeries" }, "select1dArrayIndex": { "$ref": "#/definitions/SelectIndexFrom1dEnumArraySeries" }, "extractFromStruct": { "$ref": "#/definitions/ExtractEnumFromStructSeries" }, "eventAggregation": { "$ref": "#/definitions/EventsEnumSeries" }, "enumAggregation": { "$ref": "#/definitions/EnumAggregation" }, "selectEnum": { "$ref": "#/definitions/SelectSeries" }, "selectCategoricalProperty": { "$ref": "#/definitions/SelectProperty" }, "filterByTag": { "$ref": "#/definitions/EnumTagFilterSeries" }, "selectTags": { "$ref": "#/definitions/EnumSelectTagsSeries" }, "scalarUdf": { "$ref": "#/definitions/ScalarUdfSeries" }, "toStartOfInterval": { "$ref": "#/definitions/EnumToStartOfIntervalSeries" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "aggregate", "aggregate": { "function": "MIN" } } }, "EnumSeriesEqualityRanges": { "description": "Produces a list of ranges for which provided enum series are all equal (or are not all equal).", "type": "object", "properties": { "input": { "type": "array", "items": { "$ref": "#/definitions/EnumSeries" } }, "equalityOperator": { "$ref": "#/definitions/EqualityOperator" }, "persistenceWindowConfiguration": { "$ref": "#/definitions/PersistenceWindowConfiguration" }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Defaults to forward fill interpolation with a 1s interpolation radius", "x-deprecated": "Setting interpolation on this node is deprecated." } }, "required": [ "equalityOperator" ] }, "EnumTagFilterSeries": { "description": "Applies a tag predicate to the enum series produced by input.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "predicate": { "$ref": "#/definitions/TagPredicate" } }, "required": [ "input", "predicate" ] }, "EnumTimeRangeFilterSeries": { "description": "Filters the series to points within the specified time range.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "startTime": { "allOf": [ { "$ref": "#/definitions/TimestampConstant" } ], "description": "Represents the start time (inclusive) of the time range." }, "endTime": { "allOf": [ { "$ref": "#/definitions/TimestampConstant" } ], "description": "Represents the end time (inclusive) of the time range." } }, "required": [ "input" ] }, "EnumTimeShiftSeries": { "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "duration": { "$ref": "#/definitions/DurationConstant" } }, "required": [ "input", "duration" ] }, "EnumTimeShiftSeriesV2": { "description": "Shifts the timestamps in the input series by the resolved duration.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "duration": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Duration to shift the input series by." } }, "required": [ "input", "duration" ] }, "EnumToNumericSeries": { "description": "Maps an enumerated series to a numeric series by mapping each string value to a double.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "mapping": { "type": "object", "additionalProperties": { "$ref": "#/definitions/DoubleConstant" }, "description": "The mapping from enum values to doubles." }, "defaultValue": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The value to use for enum values not present in the mapping. If not specified, points with unmapped enum values will be dropped." } }, "required": [ "input" ] }, "EnumToStartOfIntervalSeries": { "description": "Snaps each point's timestamp to the start of its enclosing fixed-size time bucket. Buckets are epoch-aligned: a point at timestamp `t` (nanoseconds) is rewritten to `floor(t / window) * window`. Values and tag groupings are preserved; aggregation of points that collide on the snapped timestamp is the responsibility of downstream nodes.", "type": "object", "properties": { "input": { "$ref": "#/definitions/EnumSeries" }, "window": { "$ref": "#/definitions/compute.api.Duration" } }, "required": [ "input", "window" ] }, "EnumUnionOperation": { "type": "string", "enum": [ "THROW", "MAX", "MIN" ], "x-enum-descriptions": { "THROW": "Throws an exception if two series contain points with a duplicate timestamp.", "MAX": "Aggregates duplicates by String MAX.", "MIN": "Aggregates duplicates by String MIN." } }, "EnumUnionSeries": { "description": "Combines multiple enum series together and outputs a single series. The strategy to merge input values with the same timestamp together is specified in the operation field.", "type": "object", "properties": { "input": { "type": "array", "items": { "$ref": "#/definitions/EnumSeries" } }, "operation": { "allOf": [ { "$ref": "#/definitions/EnumUnionOperation" } ], "description": "The strategy to merge points with duplicate timestamps." } }, "required": [ "operation" ] }, "EqualToSeries": { "description": "Compares two numeric series point-wise, producing true where left == right and false otherwise.", "type": "object", "properties": { "left": { "$ref": "#/definitions/NumericSeries" }, "right": { "$ref": "#/definitions/NumericSeries" } }, "required": [ "left", "right" ] }, "EqualityOperator": { "type": "string", "enum": [ "ALL_EQUAL", "NOT_ALL_EQUAL" ] }, "ErrorResult": { "type": "object", "properties": { "errorType": { "type": "string", "x-alias": "ErrorType" }, "code": { "type": "integer", "format": "int32", "x-alias": "ErrorCode" } }, "required": [ "errorType", "code" ] }, "EventAnchor": { "description": "Uses the start timestamp of the event at the configured zero-based index from this query whose event time lies in the anchor window [start, end), or [start, +infinity) when the end is absent. The window is the run bounds for a run anchor. Shares the wire shape of `numeric.EventTimeShift`, which tagByIntervals time shifts use; a separate type so dataset anchors evolve independently.", "type": "object", "properties": { "query": { "$ref": "#/definitions/ComputeEventQuery" }, "index": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Zero-based event index after sorting. Defaults to zero and must be non-negative." }, "sortOrder": { "allOf": [ { "$ref": "#/definitions/EventSortOrder" } ], "description": "Ordering by event start timestamp before selecting the index. Defaults to ASC." } }, "required": [ "query" ] }, "EventIntervalSource": { "description": "Intervals come from an event query. Each event defines [timestamp, timestamp+duration).", "type": "object", "properties": { "query": { "$ref": "#/definitions/ComputeEventQuery" }, "tagBy": { "type": "array", "items": { "$ref": "#/definitions/EventTagSource" }, "description": "Non-empty ordered list of tag sources. Each contributes a tag key-value pair per event interval." } }, "required": [ "query" ] }, "EventLabelTag": { "type": "object", "properties": { "label": { "$ref": "#/definitions/StringConstant" } }, "required": [ "label" ] }, "EventLevelTag": { "type": "object", "properties": {} }, "EventPropertyTag": { "type": "object", "properties": { "propertyName": { "$ref": "#/definitions/StringConstant" } }, "required": [ "propertyName" ] }, "EventSortOrder": { "type": "string", "enum": [ "ASC", "DESC" ] }, "EventTagSource": { "description": "A dimension contributing a tag key-value pair per event interval.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "intervalIndex", "level", "property", "label", "rangeStartTimestamp" ] }, "intervalIndex": { "$ref": "#/definitions/IntervalIndexTag" }, "level": { "$ref": "#/definitions/EventLevelTag" }, "property": { "$ref": "#/definitions/EventPropertyTag" }, "label": { "$ref": "#/definitions/EventLabelTag" }, "rangeStartTimestamp": { "$ref": "#/definitions/IntervalStartTimestampTag" } }, "required": [ "type" ], "example": { "type": "intervalIndex", "intervalIndex": {} } }, "EventTimeShift": { "description": "Shift by the start timestamp of the event at the configured zero-based index from this query whose event time lies in the anchor window [start, end), or [start, +infinity) when the end is absent. The window is the tagging interval for tagByIntervals and the run bounds for a run anchor. The query may differ from the query that produced a tagging interval.", "type": "object", "properties": { "query": { "$ref": "#/definitions/ComputeEventQuery" }, "index": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Zero-based event index after sorting. Defaults to zero and must be non-negative." }, "sortOrder": { "allOf": [ { "$ref": "#/definitions/EventSortOrder" } ], "description": "Ordering by event start timestamp before selecting the index. Defaults to ASC." } }, "required": [ "query" ] }, "EventsEnumSeries": { "description": "Queries events and emits an enum series where each data point corresponds to an event and the enum value is derived from a single event field (property, label, etc).", "type": "object", "properties": { "query": { "$ref": "#/definitions/ComputeEventQuery" }, "valueSource": { "$ref": "#/definitions/EventsEnumValueSource" } }, "required": [ "query", "valueSource" ] }, "EventsEnumValueSource": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "property", "level" ] }, "property": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "Name of the event property whose value should be used as the enum value." }, "level": { "allOf": [ { "$ref": "#/definitions/Empty" } ], "description": "The event level (INFO, FLAG, VIOLATION, SUCCESS). This field corresponds to the event type." } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "property", "property": { "type": "literal", "literal": "string" } } }, "EventsSearchRanges": { "description": "Produces a range series with a range for each event matching the query. Throws if there are more than 1,000 results.", "type": "object", "properties": { "query": { "$ref": "#/definitions/ComputeEventQuery" } }, "required": [ "query" ] }, "EveryNthPerSeriesSampling": { "description": "Returns every Nth timestamp-ordered point from each distinct series.", "type": "object", "properties": { "n": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Keep every Nth point starting from the earliest in each series. Must be > 1." } }, "required": [ "n" ] }, "ExcludeNegativeValues": { "type": "object", "properties": {} }, "ExponentialCurve": { "type": "object", "properties": {} }, "ExponentialResultDetails": { "description": "y = a * e^(b * x)", "type": "object", "properties": { "a": { "type": "number", "format": "double" }, "b": { "type": "number", "format": "double" } }, "required": [ "a", "b" ] }, "ExtractEnum1dArrayFromStructSeries": { "type": "object", "properties": { "input": { "$ref": "#/definitions/StructSeries" }, "fieldPath": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" } } }, "required": [ "input" ] }, "ExtractEnumFromStructSeries": { "type": "object", "properties": { "input": { "$ref": "#/definitions/StructSeries" }, "fieldPath": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "description": "Path segments that are joined to locate a nested enum field. Use dots to traverse objects (e.g. `a.b.c`) and 0-based brackets to index into arrays (e.g. `items[0].value`). A bare numeric name like `0` refers to an object key named \"0\"; use `[0]` to index into an array. Rows where the path is invalid or resolves to a nested object rather than a scalar are filtered out." } }, "required": [ "input" ] }, "ExtractNumeric1dArrayFromStructSeries": { "type": "object", "properties": { "input": { "$ref": "#/definitions/StructSeries" }, "fieldPath": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" } } }, "required": [ "input" ] }, "ExtractNumericFromStructSeries": { "type": "object", "properties": { "input": { "$ref": "#/definitions/StructSeries" }, "fieldPath": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "description": "Path segments that are joined to locate a nested numeric field. Use dots to traverse objects (e.g. `a.b.c`) and 0-based brackets to index into arrays (e.g. `items[0].value`). A bare numeric name like `0` refers to an object key named \"0\"; use [0] to index into an array. Rows where the path is invalid or the value cannot be converted to the specified type are filtered out." }, "dataType": { "allOf": [ { "$ref": "#/definitions/NumericDataType" } ], "description": "The type the numeric data will be cast to, defaults to FLOAT64" } }, "required": [ "input" ] }, "ExtractStructFromStructSeries": { "type": "object", "properties": { "input": { "$ref": "#/definitions/StructSeries" }, "fieldPath": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "description": "Path segments that are joined to locate a nested struct field. Use dots to traverse objects (e.g. `a.b.c`) and 0-based brackets to index into arrays (e.g. `items[0].value`). A bare numeric name like `0` refers to an object key named \"0\"; use [0] to index into an array. Returns an empty struct when the path does not resolve to a valid JSON object." } }, "required": [ "input" ] }, "ExtremaRangesV2": { "description": "Produces ranges for the selected extrema type.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "minimumProminence": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The minimum topographic prominence for an extrema to be returned." }, "selection": { "$ref": "#/definitions/PeakType" } }, "required": [ "input", "selection" ] }, "Fft": { "description": "Returns the single sided amplitude spectrum of the input series.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "window": { "allOf": [ { "$ref": "#/definitions/FftWindow" } ], "description": "Window function applied to the input series. Defaults to RECT is not specified." }, "summarizationStrategy": { "allOf": [ { "$ref": "#/definitions/FrequencySummarizationStrategy" } ], "description": "Strategy to downsample the output frequency spectrum." }, "nfft": { "type": "integer", "format": "int32", "description": "Length of the FFT. When nfft < input length, the input is truncated to the first nfft samples before windowing and transforming. When nfft > input length, the windowed input is zero-padded up to nfft before transforming. When nfft is unset, defaults to the input length, producing the same result as setting nfft to the input length. The output contains nfft/2 + 1 single-sided frequency bins with spacing fs/nfft. For best performance, prefer a power of 2 (e.g. 512, 1024, 2048)." } }, "required": [ "input" ] }, "FftWindow": { "type": "string", "enum": [ "BLACKMAN", "HANN", "HAMMING", "RECT" ] }, "FillLimit": { "description": "How far forward in time a sample's value may be carried.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "duration" ] }, "duration": { "$ref": "#/definitions/DurationConstant" } }, "required": [ "type" ], "example": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } }, "FillStrategy": { "description": "Default strategy for filling gaps when aligning multi-input series.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "forwardFill" ] }, "forwardFill": { "$ref": "#/definitions/ForwardFill" } }, "required": [ "type" ], "example": { "type": "forwardFill", "forwardFill": { "limit": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } } }, "FilterByExpressionSeries": { "description": "Keeps points from the base series where the boolean expression evaluates to true. Only outputs timestamps where all input series have an entry for that timestamp, or a value can be filled using the interpolation configuration.", "type": "object", "properties": { "base": { "type": "string", "x-alias": "LocalVariableName", "description": "The variable name for the series that will be returned by this filter. The expression can filter points conditional on multiple series. The base defines which series' points will be returned after applying all the filters." }, "inputs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/NumericSeries" }, "x-map-key": "LocalVariableName", "description": "A map containing all the numeric series present in the expression." }, "expression": { "type": "string", "description": "An expression that evaluates to a boolean. For example - a > 5." }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Defaults to forward fill interpolation with a 1s interpolation radius", "x-deprecated": "Setting interpolation on this node is deprecated." } }, "required": [ "base", "expression" ] }, "FilteredDataset": { "description": "Applies a conjunctive tag predicate to the series produced by the inner dataset. Resolved by threading tag filters into channel specs and folding against known tag assignments; does not add a resolved numeric node.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/Dataset" } ], "description": "The underlying dataset to filter." }, "predicate": { "allOf": [ { "$ref": "#/definitions/TagPredicate" } ], "description": "Conjunctive tag predicate used to keep matching series." } }, "required": [ "input", "predicate" ] }, "FirstPointMatchingCondition": { "description": "The first point in the output range will be the first point where the condition evaluates to true.", "type": "object", "properties": {} }, "FloorDivide": { "description": "Divides left by right pointwise and rounds down to the nearest integer.", "type": "object", "properties": { "left": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Numerator." }, "right": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Denominator." } }, "required": [ "left", "right" ] }, "ForwardFill": { "description": "At each grid point, carries the most recent prior sample value forward. The value is held only up to the configured `limit`; grid points with no prior sample within that window are left empty.", "type": "object", "properties": { "limit": { "$ref": "#/definitions/FillLimit" } }, "required": [ "limit" ] }, "ForwardFillInterpolation": { "type": "object", "properties": { "interpolationRadius": { "$ref": "#/definitions/DurationConstant" } }, "required": [ "interpolationRadius" ] }, "ForwardFillResampleInterpolationConfiguration": { "description": "Forward fill interpolation for resampling. Rounds the earliest and latest timestamp up to the nearest interval multiple and generates timestamps at the given interval between the new earliest and latest timestamps. For every timestamp in the resampled timestamps, takes the last known value before the timestamp as the value.", "type": "object", "properties": {} }, "FrequencyBucket": { "description": "A single bucket in a bucketed frequency domain plot.", "type": "object", "properties": { "frequencyStart": { "type": "number", "format": "double", "description": "The start frequency of this bucket (inclusive)." }, "frequencyEnd": { "type": "number", "format": "double", "description": "The end frequency of this bucket (exclusive)." }, "frequencyCenter": { "type": "number", "format": "double", "description": "The center frequency of this bucket." }, "minAmplitude": { "type": "number", "format": "double", "description": "The minimum amplitude value in this bucket." }, "maxAmplitude": { "type": "number", "format": "double", "description": "The maximum amplitude value in this bucket." }, "meanAmplitude": { "type": "number", "format": "double", "description": "The mean amplitude value in this bucket." }, "count": { "type": "integer", "format": "int64", "description": "The number of original frequency points that were aggregated into this bucket." }, "firstPoint": { "allOf": [ { "$ref": "#/definitions/FrequencyPoint" } ], "description": "The first point (lowest frequency) in this bucket." }, "lastPoint": { "allOf": [ { "$ref": "#/definitions/FrequencyPoint" } ], "description": "The last point (highest frequency) in this bucket. Will be empty if the bucket only has a single point." } }, "required": [ "frequencyStart", "frequencyEnd", "frequencyCenter", "minAmplitude", "maxAmplitude", "meanAmplitude", "count", "firstPoint" ] }, "FrequencyDecimateWithBuckets": { "type": "object", "properties": { "buckets": { "type": "integer", "format": "int32", "description": "Target number of frequency bins/buckets." }, "minFrequency": { "type": "number", "format": "double", "description": "Optional minimum frequency bound. When set, frequencies below this value are excluded before bucketing, increasing resolution within the requested range. This bound is inclusive. The bound uses the same unit as the transform's output frequency." }, "maxFrequency": { "type": "number", "format": "double", "description": "Optional maximum frequency bound. When set, frequencies above this value are excluded before bucketing, increasing resolution within the requested range. This bound is exclusive. The bound uses the same unit as the transform's output frequency." } }, "required": [ "buckets" ] }, "FrequencyDomain": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "fft", "periodogram" ] }, "fft": { "$ref": "#/definitions/Fft" }, "periodogram": { "$ref": "#/definitions/Periodogram" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "fft", "fft": { "input": { "type": "abs", "abs": {} }, "window": "BLACKMAN", "summarizationStrategy": { "type": "buckets", "buckets": { "buckets": 1, "minFrequency": 1, "maxFrequency": 1 } }, "nfft": 1 } } }, "FrequencyDomainPlot": { "type": "object", "properties": { "frequencies": { "type": "array", "items": { "type": "number", "format": "double" } }, "amplitudes": { "type": "array", "items": { "type": "number", "format": "double" } } } }, "FrequencyDomainPlotComplex": { "type": "object", "properties": { "frequencies": { "type": "array", "items": { "type": "number", "format": "double" } }, "real": { "type": "array", "items": { "type": "number", "format": "double" } }, "imaginary": { "type": "array", "items": { "type": "number", "format": "double" } } } }, "FrequencyDomainPlotMagnitudeAndPhase": { "type": "object", "properties": { "frequencies": { "type": "array", "items": { "type": "number", "format": "double" } }, "magnitudes": { "type": "array", "items": { "type": "number", "format": "double" } }, "phases": { "type": "array", "items": { "type": "number", "format": "double" } } } }, "FrequencyDomainPlotV2": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "real", "complex", "magnitudeAndPhase" ] }, "real": { "$ref": "#/definitions/FrequencyDomainPlot" }, "complex": { "$ref": "#/definitions/FrequencyDomainPlotComplex" }, "magnitudeAndPhase": { "$ref": "#/definitions/FrequencyDomainPlotMagnitudeAndPhase" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "real", "real": { "frequencies": [ 1 ], "amplitudes": [ 1 ] } } }, "FrequencyDomainV2": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "fft", "psd", "cpsd", "nyquist", "bode" ] }, "fft": { "$ref": "#/definitions/Fft" }, "psd": { "$ref": "#/definitions/Psd" }, "cpsd": { "$ref": "#/definitions/Cpsd" }, "nyquist": { "$ref": "#/definitions/Nyquist" }, "bode": { "$ref": "#/definitions/Bode" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "fft", "fft": { "input": { "type": "abs", "abs": {} }, "window": "BLACKMAN", "summarizationStrategy": { "type": "buckets", "buckets": { "buckets": 1, "minFrequency": 1, "maxFrequency": 1 } }, "nfft": 1 } } }, "FrequencyPoint": { "description": "A single point in a frequency domain plot.", "type": "object", "properties": { "frequency": { "type": "number", "format": "double" }, "amplitude": { "type": "number", "format": "double" } }, "required": [ "frequency", "amplitude" ] }, "FrequencySummarizationStrategy": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "buckets" ] }, "buckets": { "$ref": "#/definitions/FrequencyDecimateWithBuckets" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "buckets", "buckets": { "buckets": 1, "minFrequency": 1, "maxFrequency": 1 } } }, "FunctionDerivedSeries": { "description": "A reference to a derived series resulting from applying a function to a set of arguments.", "type": "object", "properties": { "moduleName": { "$ref": "#/definitions/StringConstant" }, "functionName": { "$ref": "#/definitions/StringConstant" }, "versionReference": { "$ref": "#/definitions/ModuleVersionReference" }, "functionArgs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/FunctionParameterValue" }, "x-map-key": "FunctionParameterName", "description": "Map of function input names to their values. The function inputs must match the function's parameter names and types. An input must be specified for each of the referenced function's parameters." } }, "required": [ "moduleName", "functionName", "versionReference" ] }, "FunctionParameterValue": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "variable", "value" ] }, "variable": { "type": "string", "x-alias": "VariableName" }, "value": { "$ref": "#/definitions/VariableValue" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "variable", "variable": "string" } }, "FunctionVariables": { "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": { "$ref": "#/definitions/VariableValue" }, "x-map-key": "VariableName" }, "subFunctionVariables": { "type": "object", "additionalProperties": { "$ref": "#/definitions/FunctionVariables" }, "x-map-key": "FunctionReference" } } }, "GetQuotaUsageResponse": { "type": "object", "properties": { "intervals": { "type": "array", "items": { "$ref": "#/definitions/QuotaIntervalUsage" }, "description": "One entry per quota window, ordered by ascending duration. Empty when quotas are not enabled for the organization or the user has no recorded usage yet." } } }, "GreaterThanOrEqualToSeries": { "description": "Compares two numeric series point-wise, producing true where left >= right and false otherwise.", "type": "object", "properties": { "left": { "$ref": "#/definitions/NumericSeries" }, "right": { "$ref": "#/definitions/NumericSeries" } }, "required": [ "left", "right" ] }, "GreaterThanSeries": { "description": "Compares two numeric series point-wise, producing true where left > right and false otherwise.", "type": "object", "properties": { "left": { "$ref": "#/definitions/NumericSeries" }, "right": { "$ref": "#/definitions/NumericSeries" } }, "required": [ "left", "right" ] }, "GroupByAggregationBuilder": { "description": "Groups points by a tag selection and a timestamp policy and applies the operator.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/Series" } ], "description": "The series to group and aggregate." }, "tags": { "allOf": [ { "$ref": "#/definitions/GroupByTags" } ], "description": "Selects which tag keys form the grouping key: `GroupByTags.Current()` keeps the input series' currently selected tags, or `GroupByTags.Subset([...])` restricts the grouping to a subset of them." }, "timestamp": { "allOf": [ { "$ref": "#/definitions/GroupByTimestamp" } ], "description": "Selects how timestamps participate in the grouping key: `GroupByTimestamp.Current()` groups on existing timestamps, and `GroupByTimestamp.Every(duration)` buckets points into fixed-size, epoch-aligned tumbling windows." }, "alignment": { "allOf": [ { "$ref": "#/definitions/GroupByAlignment" } ], "description": "Optionally aligns source tag groups that map to the same output tag group before aggregation. Alignment is currently supported only with `GroupByTimestamp.Current()` and built-in numeric aggregation operators." } }, "required": [ "input", "tags", "timestamp" ] }, "GroupByAlignment": { "description": "Selects how source tag groups are aligned before aggregation.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "contextDefaults" ] }, "contextDefaults": { "allOf": [ { "$ref": "#/definitions/Empty" } ], "description": "Use the compute context's `defaultAlignmentStrategy` and `defaultFillStrategy`." } }, "required": [ "type" ], "example": { "type": "contextDefaults", "contextDefaults": {} } }, "GroupBySubsetTags": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true, "description": "Tag keys to group by." } } }, "GroupByTags": { "description": "Selects which tag keys form the grouping key.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "current", "subset" ] }, "current": { "allOf": [ { "$ref": "#/definitions/Empty" } ], "description": "Group by the tags currently selected on the input series." }, "subset": { "allOf": [ { "$ref": "#/definitions/GroupBySubsetTags" } ], "description": "Group by exactly the listed tag keys. Must be a (non-strict) subset of the input series's currently selected tags." } }, "required": [ "type" ], "example": { "type": "current", "current": {} } }, "GroupByTimestamp": { "description": "Selects how timestamps participate in the grouping key.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "current", "every" ] }, "current": { "allOf": [ { "$ref": "#/definitions/Empty" } ], "description": "Use the current timestamps." }, "every": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Bucket timestamps into a tumbling fixed-size, epoch-aligned window. A point at timestamp `t` (nanoseconds) falls into the bucket `[floor(t / window) * window, +window)`, and one aggregated point is emitted per bucket per tag grouping at the bucket start timestamp." } }, "required": [ "type" ], "example": { "type": "current", "current": {} } }, "GroupWithinRangesSeriesV2": { "description": "Aggregates the input series within each supplied range and emits one point at the range start. Empty ranges emit no point, and ranges without a start use the compute request start.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "ranges": { "allOf": [ { "$ref": "#/definitions/RangeSeries" } ], "description": "One output point is emitted per range, at the range's start." }, "aggregation": { "$ref": "#/definitions/NumericAggregationOperator" } }, "required": [ "input", "ranges", "aggregation" ] }, "GroupedComputeNodeResponse": { "type": "object", "properties": { "grouping": { "$ref": "#/definitions/Grouping" }, "response": { "$ref": "#/definitions/ComputeNodeResponse" } }, "required": [ "grouping", "response" ] }, "GroupedComputeNodeResponses": { "description": "Contains a `ComputeNodeResponse` for each applicable grouping along with metadata describing the grouping. All the contained `ComputeNodeResponse`s are guaranteed to be of the same type.", "type": "object", "properties": { "responses": { "type": "array", "items": { "$ref": "#/definitions/GroupedComputeNodeResponse" }, "uniqueItems": true } } }, "Grouping": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "tagsWithValues" ] }, "tagsWithValues": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A grouping identified by a specific instantiation of tag keys and values." } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "tagsWithValues", "tagsWithValues": { "key": "string" } } }, "HashSubsampleSampling": { "description": "Keeps approximately 1/N of raw points via a stateless hash of each point's timestamp.", "type": "object", "properties": { "n": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Keep approximately one out of every N points. Must be > 1." } }, "required": [ "n" ] }, "HighPassConfiguration": { "type": "object", "properties": { "cutoffFrequency": { "$ref": "#/definitions/DoubleConstant" } }, "required": [ "cutoffFrequency" ] }, "Histogram": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "numeric", "enum" ] }, "numeric": { "$ref": "#/definitions/NumericHistogramNode" }, "enum": { "$ref": "#/definitions/EnumHistogramNode" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "numeric", "numeric": { "inputs": { "key": { "type": "abs", "abs": {} } }, "bucketStrategy": { "type": "bucketCount", "bucketCount": { "type": "literal", "literal": 1 } } } } }, "HistogramChannelCount": { "description": "The count of the value in the bucket for the specific channel.", "type": "object", "properties": { "count": { "type": "integer", "format": "int64" } }, "required": [ "count" ] }, "IdentityDimension": { "description": "Injects the value of a type's primary key, under a tag key equal to the primary key's property name by default. The primary key is read when the query runs, so it follows changes to the type. Only asset branches of an asset with the type have a value; every other branch, including run branches, gets the reserved value `NOMINAL_ABSENT`.", "type": "object", "properties": { "typeRid": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "Resource identifier of the type whose primary key identifies the asset." } }, "required": [ "typeRid" ] }, "IncompatibleUnitOperation": { "description": "Attempted an incompatible operation of units.", "type": "object", "properties": { "operation": { "$ref": "#/definitions/UnitOperation" }, "units": { "type": "array", "items": { "type": "string", "x-alias": "UnitSymbol" } } }, "required": [ "operation" ] }, "IntegerConstant": { "description": "An integer constant that can be a literal value or a named variable reference.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "literal", "variable" ] }, "literal": { "type": "integer", "format": "int32", "description": "Create from a literal integer value." }, "variable": { "type": "string", "x-alias": "VariableName", "description": "Create from a named reference name." } }, "required": [ "type" ], "example": { "type": "literal", "literal": 1 } }, "IntegralSeries": { "description": "Calculates the running sum of the area underneath a series using the trapezoidal rule.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "startTimestamp": { "$ref": "#/definitions/TimestampConstant" }, "timeUnit": { "allOf": [ { "$ref": "#/definitions/TimeUnit" } ], "description": "Time unit used to calculate the integral. Defaults to seconds if not specified." } }, "required": [ "input", "startTimestamp" ] }, "InterpolationConfiguration": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "forwardFillInterpolation" ] }, "forwardFillInterpolation": { "$ref": "#/definitions/ForwardFillInterpolation" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "forwardFillInterpolation", "forwardFillInterpolation": { "interpolationRadius": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } }, "IntersectRanges": { "description": "Produces the intersection of the input ranges: the ranges of time covered by every input. For best performance, pass inputs in the order in which they should be evaluated, listing the ranges that are cheapest to compute first.", "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/RangeSeries" } } } }, "IntervalAnchor": { "description": "Selects which boundary of an interval to use as its anchor.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "intervalStart", "intervalEnd", "eventInInterval", "rangeInInterval" ] }, "intervalStart": { "allOf": [ { "$ref": "#/definitions/IntervalStartTimeShift" } ], "description": "Uses the interval's start timestamp." }, "intervalEnd": { "allOf": [ { "$ref": "#/definitions/IntervalEndTimeShift" } ], "description": "Uses the interval's end timestamp." }, "eventInInterval": { "$ref": "#/definitions/EventAnchor" }, "rangeInInterval": { "$ref": "#/definitions/RangesAnchor" } }, "required": [ "type" ], "example": { "type": "intervalStart", "intervalStart": {} } }, "IntervalEndTimeShift": { "description": "Shift by each tagging interval's resolved end; resolution throws if end is missing.", "type": "object", "properties": {} }, "IntervalIndexTag": { "type": "object", "properties": {} }, "IntervalSource": { "description": "Where the intervals come from and how each is labeled.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "events", "ranges" ] }, "events": { "$ref": "#/definitions/EventIntervalSource" }, "ranges": { "$ref": "#/definitions/RangeIntervalSource" } }, "required": [ "type" ], "example": { "type": "events", "events": { "query": { "type": "searchText", "searchText": { "type": "literal", "literal": "string" } }, "tagBy": [ { "type": "intervalIndex", "intervalIndex": {} } ] } } }, "IntervalStartTimeShift": { "description": "Shift by each tagging interval's resolved start; resolution throws if start is missing.", "type": "object", "properties": {} }, "IntervalStartTimestampTag": { "type": "object", "properties": {} }, "LessThanOrEqualToSeries": { "description": "Compares two numeric series point-wise, producing true where left <= right and false otherwise.", "type": "object", "properties": { "left": { "$ref": "#/definitions/NumericSeries" }, "right": { "$ref": "#/definitions/NumericSeries" } }, "required": [ "left", "right" ] }, "LessThanSeries": { "description": "Compares two numeric series point-wise, producing true where left < right and false otherwise.", "type": "object", "properties": { "left": { "$ref": "#/definitions/NumericSeries" }, "right": { "$ref": "#/definitions/NumericSeries" } }, "required": [ "left", "right" ] }, "LiteralRange": { "description": "A literal range of values.", "type": "object", "properties": { "startTimestamp": { "$ref": "#/definitions/TimestampConstant" }, "endTimestamp": { "$ref": "#/definitions/TimestampConstant" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LiteralRanges": { "description": "A list of literal ranges.", "type": "object", "properties": { "literalRanges": { "type": "array", "items": { "$ref": "#/definitions/LiteralRange" } } } }, "Ln": { "description": "Computes the natural logarithm (base e) of each value.", "type": "object", "properties": { "x": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (positive values)." } }, "required": [ "x" ] }, "Log10": { "description": "Computes the base-10 logarithm of each value.", "type": "object", "properties": { "x": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (positive values)." } }, "required": [ "x" ] }, "LogArgFilterOperator": { "description": "Matches against a single log arg.", "type": "object", "properties": { "key": { "$ref": "#/definitions/StringConstant" }, "operator": { "$ref": "#/definitions/LogRegexFilterOperator" } }, "required": [ "key", "operator" ] }, "LogExactMatchCaseInsensitiveFilter": { "description": "Filters points such that the log message in each point contains an exact case-insensitive match of the provided token.", "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ] }, "LogFilterOperator": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "regexFilter", "exactMatchCaseInsensitiveFilter", "arg", "and", "or", "not" ] }, "regexFilter": { "$ref": "#/definitions/LogRegexFilterOperator" }, "exactMatchCaseInsensitiveFilter": { "$ref": "#/definitions/LogExactMatchCaseInsensitiveFilter" }, "arg": { "$ref": "#/definitions/LogArgFilterOperator" }, "and": { "type": "array", "items": { "$ref": "#/definitions/LogFilterOperator" } }, "or": { "type": "array", "items": { "$ref": "#/definitions/LogFilterOperator" } }, "not": { "$ref": "#/definitions/LogFilterOperator" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "regexFilter", "regexFilter": { "regex": "string" } } }, "LogFilterSeries": { "description": "Outputs only values of the log plot that satisfy the filter.", "type": "object", "properties": { "input": { "$ref": "#/definitions/LogSeries" }, "operator": { "$ref": "#/definitions/LogFilterOperator" } }, "required": [ "input", "operator" ] }, "LogPoint": { "type": "object", "properties": { "timestamp": { "$ref": "#/definitions/Timestamp" }, "value": { "$ref": "#/definitions/LogValue" } }, "required": [ "timestamp", "value" ] }, "LogRegexFilterOperator": { "description": "Matches a text value against the given re2 regular expression. Regular expression syntax: https://github.com/google/re2/wiki/Syntax.", "type": "object", "properties": { "regex": { "type": "string" } }, "required": [ "regex" ] }, "LogSelectTagsSeries": { "description": "Subsets the tag dimensions of the input log series to the given tag keys. Preserves the input series' cardinality: points that share the selected keys but differ on dropped keys remain distinct.", "type": "object", "properties": { "input": { "$ref": "#/definitions/LogSeries" }, "tagKeys": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true } }, "required": [ "input" ] }, "LogSeries": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "raw", "channel", "derived", "selectLogs", "union", "filter", "timeShift", "toStartOfInterval", "filterByTag", "selectTags" ] }, "raw": { "$ref": "#/definitions/Reference" }, "channel": { "$ref": "#/definitions/ChannelSeries" }, "derived": { "$ref": "#/definitions/DerivedSeries" }, "selectLogs": { "$ref": "#/definitions/SelectSeries" }, "union": { "$ref": "#/definitions/LogUnionSeries" }, "filter": { "$ref": "#/definitions/LogFilterSeries" }, "timeShift": { "$ref": "#/definitions/LogTimeShiftSeries" }, "toStartOfInterval": { "$ref": "#/definitions/LogToStartOfIntervalSeries" }, "filterByTag": { "$ref": "#/definitions/LogTagFilterSeries" }, "selectTags": { "$ref": "#/definitions/LogSelectTagsSeries" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "raw", "raw": { "name": "string" } } }, "LogTagFilterSeries": { "description": "Applies a tag predicate to the log series produced by input.", "type": "object", "properties": { "input": { "$ref": "#/definitions/LogSeries" }, "predicate": { "$ref": "#/definitions/TagPredicate" } }, "required": [ "input", "predicate" ] }, "LogTimeShiftSeries": { "type": "object", "properties": { "input": { "$ref": "#/definitions/LogSeries" }, "duration": { "$ref": "#/definitions/DurationConstant" } }, "required": [ "input", "duration" ] }, "LogToStartOfIntervalSeries": { "description": "Snaps each point's timestamp to the start of its enclosing fixed-size time bucket. Buckets are epoch-aligned: a point at timestamp `t` (nanoseconds) is rewritten to `floor(t / window) * window`. Values and tag groupings are preserved; aggregation of points that collide on the snapped timestamp is the responsibility of downstream nodes.", "type": "object", "properties": { "input": { "$ref": "#/definitions/LogSeries" }, "window": { "$ref": "#/definitions/compute.api.Duration" } }, "required": [ "input", "window" ] }, "LogUnionOperation": { "type": "string", "enum": [ "KEEP_ALL" ], "x-enum-descriptions": { "KEEP_ALL": "Keeps all points if multiple series contain points with a duplicate timestamp." } }, "LogUnionSeries": { "description": "Combines multiple log series together and outputs a single series. The strategy to merge input values with the same timestamp together is specified in the operation field.", "type": "object", "properties": { "input": { "type": "array", "items": { "$ref": "#/definitions/LogSeries" } }, "operation": { "allOf": [ { "$ref": "#/definitions/LogUnionOperation" } ], "description": "The strategy to merge points with duplicate timestamps." } }, "required": [ "operation" ] }, "LogValue": { "type": "object", "properties": { "message": { "type": "string" }, "args": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "string", "format": "uuid" } }, "required": [ "message", "id" ] }, "LogarithmicCurve": { "type": "object", "properties": {} }, "LogarithmicResultDetails": { "description": "y = a * ln(x) + b", "type": "object", "properties": { "a": { "type": "number", "format": "double" }, "b": { "type": "number", "format": "double" } }, "required": [ "a", "b" ] }, "LowPassConfiguration": { "type": "object", "properties": { "cutoffFrequency": { "$ref": "#/definitions/DoubleConstant" } }, "required": [ "cutoffFrequency" ] }, "LttbStrategy": { "type": "object", "properties": { "maxPointsPerGroup": { "type": "integer", "format": "int32", "description": "Maximum number of selected points to return for each group. Must be positive and no greater than 10,000." } }, "required": [ "maxPointsPerGroup" ] }, "MagnitudeScaling": { "type": "string", "enum": [ "LINEAR", "MAGNITUDE_DB_10", "MAGNITUDE_DB_20" ], "x-enum-descriptions": { "LINEAR": "Linear scaling of the magnitude.", "MAGNITUDE_DB_10": "Scales the magnitude via 10 * log10(magnitude).", "MAGNITUDE_DB_20": "Scales the magnitude via 20 * log10(magnitude)." } }, "MathConstant": { "description": "Math constants referenceable by name.", "type": "string", "enum": [ "PI", "TAU", "E" ], "x-enum-descriptions": { "PI": "The circle constant π (dimensionless).", "TAU": "The circle constant τ = 2π (dimensionless).", "E": "Euler's number e (dimensionless)." } }, "MaxSeries": { "description": "For every timestamp specified in the input series, outputs a value that is the maximum for that timestamp across all input series. Only outputs timestamps where all input series have an entry for that timestamp, subject to interpolation.", "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/NumericSeries" }, "description": "Input series across which to take the pointwise maximum" }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Defaults to forward fill interpolation with a 1s interpolation radius", "x-deprecated": "Setting interpolation on this node is deprecated." } } }, "Maximum": { "description": "The maximum value of points inside the time window.", "type": "object", "properties": {} }, "MeanSeries": { "description": "For every timestamp specified in the input series, outputs a value that is the mean for that timestamp across all input series. Only outputs timestamps where all input series have an entry for that timestamp, subject to interpolation.", "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/NumericSeries" }, "description": "Input series across which to take the pointwise mean" }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Defaults to forward fill interpolation with a 1s interpolation radius", "x-deprecated": "Setting interpolation on this node is deprecated." } } }, "MinMaxThresholdOperator": { "type": "string", "enum": [ "OUTSIDE_BOUNDS", "OUTSIDE_OR_EQUAL_TO_BOUNDS", "INSIDE_BOUNDS", "INSIDE_OR_EQUAL_TO_BOUNDS" ] }, "MinMaxThresholdRanges": { "description": "Produces a list of ranges for which the threshold condition is satisfied.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "lowerBound": { "$ref": "#/definitions/DoubleConstant" }, "upperBound": { "$ref": "#/definitions/DoubleConstant" }, "operator": { "$ref": "#/definitions/MinMaxThresholdOperator" }, "persistenceWindowConfiguration": { "$ref": "#/definitions/PersistenceWindowConfiguration" } }, "required": [ "input", "lowerBound", "upperBound", "operator" ] }, "MinSeries": { "description": "For every timestamp specified in the input series, outputs a value that is the minimum for that timestamp across all input series. Only outputs timestamps where all input series have an entry for that timestamp, subject to interpolation.", "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/NumericSeries" }, "description": "Input series across which to take the pointwise minimum" }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Defaults to forward fill interpolation with a 1s interpolation radius", "x-deprecated": "Setting interpolation on this node is deprecated." } } }, "Minimum": { "description": "The minimum value of points inside the time window.", "type": "object", "properties": {} }, "ModuleVersionReference": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "pinned" ] }, "pinned": { "$ref": "#/definitions/PinnedModuleVersionReference" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "pinned", "pinned": { "version": { "type": "literal", "literal": "string" } } } }, "Modulo": { "description": "Computes the remainder of left divided by right pointwise.", "type": "object", "properties": { "left": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Dividend." }, "right": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Divisor." } }, "required": [ "left", "right" ] }, "Multiply": { "description": "Multiplies two numeric series pointwise.", "type": "object", "properties": { "left": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Left-hand operand." }, "right": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Right-hand operand." } }, "required": [ "left", "right" ] }, "MultivariateBucket": { "type": "object", "properties": { "timestamp": { "$ref": "#/definitions/Timestamp" }, "values": { "type": "array", "items": { "$ref": "#/definitions/Value" }, "description": "Values for each input series in the bucket." } }, "required": [ "timestamp" ] }, "MultivariateEnumInput": { "type": "object", "properties": { "series": { "$ref": "#/definitions/EnumSeries" }, "aggregations": { "type": "array", "items": { "$ref": "#/definitions/EnumMultivariateAggregation" } } }, "required": [ "series" ] }, "MultivariateInput": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "numeric", "enum" ] }, "numeric": { "$ref": "#/definitions/MultivariateNumericInput" }, "enum": { "$ref": "#/definitions/MultivariateEnumInput" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "numeric", "numeric": { "series": { "type": "abs", "abs": {} }, "aggregations": [ "MEAN" ] } } }, "MultivariateNumericInput": { "type": "object", "properties": { "series": { "$ref": "#/definitions/NumericSeries" }, "aggregations": { "type": "array", "items": { "$ref": "#/definitions/NumericMultivariateAggregation" } } }, "required": [ "series" ] }, "MultivariateUnitResult": { "type": "object", "properties": { "units": { "type": "array", "items": { "$ref": "#/definitions/UnitResult" } } } }, "NamedSeries": { "type": "object", "properties": { "name": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "Name of the new derived series." }, "definition": { "allOf": [ { "$ref": "#/definitions/Series" } ], "description": "Compute expression defining the series values." } }, "required": [ "name", "definition" ] }, "Negate": { "description": "Negates each value in the series pointwise (multiplies by -1).", "type": "object", "properties": { "x": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series." } }, "required": [ "x" ] }, "NegativeValueConfiguration": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "allowNegativeValues", "setNegativeValuesToZero", "excludeNegativeValues" ] }, "allowNegativeValues": { "allOf": [ { "$ref": "#/definitions/AllowNegativeValues" } ], "description": "Include negative output values" }, "setNegativeValuesToZero": { "allOf": [ { "$ref": "#/definitions/SetNegativeValuesToZero" } ], "description": "Set negative output values to zero" }, "excludeNegativeValues": { "allOf": [ { "$ref": "#/definitions/ExcludeNegativeValues" } ], "description": "Exclude points with negative output values" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "allowNegativeValues", "allowNegativeValues": {} } }, "NotEqualToSeries": { "description": "Compares two numeric series point-wise, producing true where left != right and false otherwise.", "type": "object", "properties": { "left": { "$ref": "#/definitions/NumericSeries" }, "right": { "$ref": "#/definitions/NumericSeries" } }, "required": [ "left", "right" ] }, "NotRanges": { "description": "The not ranges node will invert the ranges, filling the negative space in time.", "type": "object", "properties": { "input": { "$ref": "#/definitions/RangeSeries" } }, "required": [ "input" ] }, "NthRange": { "description": "Select the Nth range (0-indexed) from a range series.", "type": "object", "properties": { "input": { "$ref": "#/definitions/RangeSeries" }, "index": { "$ref": "#/definitions/IntegerConstant" }, "sortOrder": { "$ref": "#/definitions/RangeSortOrder" } }, "required": [ "input", "index", "sortOrder" ] }, "Numeric1dArraySelectTagsSeries": { "description": "Subsets the tag dimensions of the input numeric 1d array series to the given tag keys. Preserves the input series' cardinality: points that share the selected keys but differ on dropped keys remain distinct.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Numeric1dArraySeries" }, "tagKeys": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true } }, "required": [ "input" ] }, "Numeric1dArraySeries": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "channel", "raw", "derived", "selectNumeric1dArray", "extractFromStruct", "toStartOfInterval", "timeShift", "filterByTag", "selectTags" ] }, "channel": { "$ref": "#/definitions/ChannelSeries" }, "raw": { "$ref": "#/definitions/Reference" }, "derived": { "$ref": "#/definitions/DerivedSeries" }, "selectNumeric1dArray": { "$ref": "#/definitions/SelectSeries" }, "extractFromStruct": { "$ref": "#/definitions/ExtractNumeric1dArrayFromStructSeries" }, "toStartOfInterval": { "$ref": "#/definitions/Numeric1dArrayToStartOfIntervalSeries" }, "timeShift": { "$ref": "#/definitions/Numeric1dArrayTimeShiftSeries" }, "filterByTag": { "$ref": "#/definitions/Numeric1dArrayTagFilterSeries" }, "selectTags": { "$ref": "#/definitions/Numeric1dArraySelectTagsSeries" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "channel", "channel": { "type": "dataSource", "dataSource": { "dataSourceRid": { "type": "literal", "literal": "string" }, "channel": { "type": "literal", "literal": "string" }, "tags": { "key": { "type": "literal", "literal": "string" } }, "tagFilters": { "type": "single", "single": { "key": { "type": "literal", "literal": "string" }, "values": [ { "type": "literal", "literal": "string" } ], "operator": "IN" } }, "tagsToGroupBy": [ "string" ], "groupByTags": [ { "type": "literal", "literal": "string" } ] } } } }, "Numeric1dArrayTagFilterSeries": { "description": "Applies a tag predicate to the numeric 1d array series produced by input.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Numeric1dArraySeries" }, "predicate": { "$ref": "#/definitions/TagPredicate" } }, "required": [ "input", "predicate" ] }, "Numeric1dArrayTimeShiftSeries": { "type": "object", "properties": { "input": { "$ref": "#/definitions/Numeric1dArraySeries" }, "duration": { "$ref": "#/definitions/DurationConstant" } }, "required": [ "input", "duration" ] }, "Numeric1dArrayToStartOfIntervalSeries": { "description": "Snaps each point's timestamp to the start of its enclosing fixed-size time bucket. Buckets are epoch-aligned: a point at timestamp `t` (nanoseconds) is rewritten to `floor(t / window) * window`. Values and tag groupings are preserved; aggregation of points that collide on the snapped timestamp is the responsibility of downstream nodes.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Numeric1dArraySeries" }, "window": { "$ref": "#/definitions/compute.api.Duration" } }, "required": [ "input", "window" ] }, "NumericAggregation": { "description": "Aggregates an input series using the given operator. The shape of the aggregation (rolling time window, rolling point-count window, or group by) is selected by the aggregation builder passed as `input`. The operator must be compatible with that builder's series, producing a numeric output: count reduces a series of any type, whereas SUM requires a numeric series.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/AggregationBuilder" } ], "description": "The aggregation shape to apply the operator over: a rolling time window, a rolling point-count window, or a group-by." }, "operator": { "allOf": [ { "$ref": "#/definitions/NumericAggregationOperator" } ], "description": "The reduction applied to each window or group (e.g. sum, mean, percentile). Must be compatible with the input series, producing a numeric output: Count works on any input series, whereas reductions like Sum require a numeric series." } }, "required": [ "input", "operator" ] }, "NumericAggregationFunction": { "description": "DEPRECATED. Use `NumericAggregationOperator` instead.", "type": "string", "enum": [ "SUM", "MEAN", "MIN", "MAX", "COUNT", "STANDARD_DEVIATION", "ROOT_MEAN_SQUARE" ] }, "NumericAggregationOperator": { "description": "Unified numeric aggregation used across rolling windows, plain aggregates, range aggregates, union merges, and per-bucket summarization.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "sum", "average", "min", "max", "count", "standardDeviation", "rootMeanSquare", "percentile", "udf" ] }, "sum": { "$ref": "#/definitions/Summation" }, "average": { "$ref": "#/definitions/Average" }, "min": { "$ref": "#/definitions/Minimum" }, "max": { "$ref": "#/definitions/Maximum" }, "count": { "$ref": "#/definitions/Count" }, "standardDeviation": { "$ref": "#/definitions/StandardDeviation" }, "rootMeanSquare": { "$ref": "#/definitions/RootMeanSquare" }, "percentile": { "$ref": "#/definitions/Percentile" }, "udf": { "$ref": "#/definitions/NumericAggregationUdf" } }, "required": [ "type" ], "example": { "type": "sum", "sum": {} } }, "NumericAggregationUdf": { "description": "A user-defined numeric aggregation. The aggregation builder controls grouping/windowing. Supported Rust entrypoints accept grouped value vectors, optionally with leading sample timestamps, and return either one numeric value or timestamped numeric point(s), e.g. `fn rms(values: Vec) -> f64`, `fn energy(timestamp_ns: Vec, values: Vec) -> f64`, `fn first(timestamp_ns: Vec, values: Vec) -> (i64, f64)`, or `fn passthrough(timestamp_ns: Vec, values: Vec) -> Vec<(i64, f64)>`. The value vector's element type follows the aggregated series: `Vec` for a numeric series, and `Vec` for a categorical or struct series, where each struct row arrives as a JSON object. A UDF over a combined struct series may instead take one vector per named struct field it needs, e.g. `fn mean_product(channel0: Vec, channel1: Vec) -> f64`. Parameter names select the fields, so a subset of the struct's fields in any order is accepted.", "type": "object", "properties": { "source": { "$ref": "#/definitions/UdfSource" } }, "required": [ "source" ] }, "NumericApproximateFilterSeries": { "description": "Outputs the values of the numeric plot value that are approximately equal to the threshold value.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "threshold": { "$ref": "#/definitions/DoubleConstant" }, "tolerance": { "$ref": "#/definitions/DoubleConstant" }, "operator": { "$ref": "#/definitions/ApproximateThresholdOperator" } }, "required": [ "input", "threshold", "tolerance", "operator" ] }, "NumericBucket": { "type": "object", "properties": { "min": { "type": "number", "format": "double" }, "max": { "type": "number", "format": "double" }, "mean": { "type": "number", "format": "double" }, "count": { "type": "integer", "format": "int64" }, "variance": { "type": "number", "format": "double", "description": "The population variance of the bucket. If the bucket has only one value, this will be 0." }, "firstPoint": { "$ref": "#/definitions/NumericPoint" }, "lastPoint": { "allOf": [ { "$ref": "#/definitions/NumericPoint" } ], "description": "Will be empty if the bucket only has a single point." }, "aggregations": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "description": "Additional per-bucket aggregations that have no dedicated field above, keyed by the output column name requested via `numericAggregations` or `numericOutputFieldsV2` (e.g. `sum`, `standardDeviation`, `rootMeanSquare`, `p50`). Empty when no additional aggregations were requested." } } }, "NumericConstantResampleInterpolationConfiguration": { "description": "Fills all empty resample intervals with a single constant value.\n\nIf a resampled time interval (bucket) contains no data points from the input, it will be assigned the specified 'constant' as a default value. This applies to gaps at the start of the series, between data points, and at the end.", "type": "object", "properties": { "constant": { "$ref": "#/definitions/DoubleConstant" } }, "required": [ "constant" ] }, "NumericDataType": { "description": "Supported numeric data types for value casting.", "type": "string", "enum": [ "INT64", "FLOAT64", "UINT64" ] }, "NumericEqualityRangesV2": { "description": "Produces ranges where all numeric inputs are equal or are not all equal.", "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/NumericSeries" }, "description": "The series compared against each other. At least two are required." }, "tolerance": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Maximum spread between the inputs still counted as equal. Defaults to zero, i.e. exact equality." }, "minPoints": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Minimum number of matching points. Defaults to 1." }, "minDuration": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Minimum matching duration. Defaults to one nanosecond." }, "rangeStart": { "allOf": [ { "$ref": "#/definitions/RangeStart" } ], "description": "Selects whether the output begins at the first match or after persistence is satisfied." }, "equalityOperator": { "$ref": "#/definitions/EqualityOperator" } }, "required": [ "equalityOperator" ] }, "NumericFilterTransformationSeries": { "description": "Outputs the input points whose timestamps fall within the supplied ranges.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "filter": { "allOf": [ { "$ref": "#/definitions/RangeSeries" } ], "description": "Keeps input points whose timestamps fall inside any of these ranges." } }, "required": [ "input", "filter" ] }, "NumericFilterWhereSeries": { "description": "Outputs numeric input values where the provided Boolean expression evaluates to true.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "condition": { "allOf": [ { "$ref": "#/definitions/BooleanSeries" } ], "description": "Condition evaluated point-wise at each input timestamp. A point is only kept where the condition is true." } }, "required": [ "input", "condition" ] }, "NumericHistogramBucket": { "description": "A bucket in a numeric histogram representing a range of values, and the counts of values in that range across all input series.", "type": "object", "properties": { "lowerBound": { "type": "number", "format": "double", "description": "The lower bound of the bucket, inclusive" }, "upperBound": { "type": "number", "format": "double", "description": "The upper bound of the bucket, exclusive" }, "countsByChannel": { "type": "object", "additionalProperties": { "$ref": "#/definitions/HistogramChannelCount" }, "x-map-key": "VariableName" }, "buckets": { "type": "object", "additionalProperties": { "$ref": "#/definitions/HistogramChannelCount" }, "x-map-key": "VariableName", "x-deprecated": "Use countsByChannel instead" } }, "required": [ "lowerBound", "upperBound" ] }, "NumericHistogramBucketStrategy": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "bucketCount", "bucketWidthAndOffset" ] }, "bucketCount": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The number of buckets to use in the histogram. Width is automatically calculated from the range of the input series, with the lower and upper bounds of the histogram being multiples of the width." }, "bucketWidthAndOffset": { "$ref": "#/definitions/NumericHistogramBucketWidthAndOffset" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "bucketCount", "bucketCount": { "type": "literal", "literal": 1 } } }, "NumericHistogramBucketWidthAndOffset": { "type": "object", "properties": { "width": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The width of each bucket. If offset is not specified, the left and right bounds of each bucket are multiples of the width. If offset is specified, the left and right bounds of each bucket are shifted right by the offset value." }, "offset": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The rightward shift to apply to the left and right bounds of each bucket. If not specified, the offset will be 0. The offset must be non-negative." } }, "required": [ "width" ] }, "NumericHistogramNode": { "type": "object", "properties": { "inputs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/NumericSeries" }, "x-map-key": "VariableName" }, "bucketStrategy": { "$ref": "#/definitions/NumericHistogramBucketStrategy" } } }, "NumericHistogramPlot": { "type": "object", "properties": { "buckets": { "type": "array", "items": { "$ref": "#/definitions/NumericHistogramBucket" } } } }, "NumericIfElseSeries": { "description": "Selects between two numeric series point-wise based on a boolean condition series. For every aligned timestamp, emits the value from `trueValue` where `condition` is true, and the value from `falseValue` otherwise.", "type": "object", "properties": { "condition": { "allOf": [ { "$ref": "#/definitions/BooleanSeries" } ], "description": "Boolean series evaluated at each point to choose between the `trueValue` and `falseValue` branches." }, "trueValue": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Value emitted at points where `condition` is true." }, "falseValue": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Value emitted at points where `condition` is false." } }, "required": [ "condition", "trueValue", "falseValue" ] }, "NumericLargestTriangleThreeBucketsSeries": { "description": "Applies Largest-Triangle-Three-Buckets to a numeric time series for visualization-oriented downsampling. The algorithm preserves the first and last points, partitions the remaining input points based on the requested output count, and selects points that preserve the visual shape of the series. Results are selected input timestamp/value points, not fixed-width bucket aggregate rows.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "maxPointsToReturn": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Maximum number of selected points to return. Must be positive and no greater than 10,000." } }, "required": [ "input", "maxPointsToReturn" ] }, "NumericMultivariateAggregation": { "type": "string", "enum": [ "MEAN", "MIN", "MAX", "FIRST", "LAST" ] }, "NumericNanFilter": { "description": "Removes points where the value is NaN from the input series.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series." } }, "required": [ "input" ] }, "NumericNthPointDownsampleSeries": { "description": "Keeps every Nth row of the timestamp-ordered input, per series. No grid arithmetic, no interpolation, no boundary handling. Output count is ceil(input_count / n) per series. Caller is responsible for choosing n consistent with the input's sample rate; output spacing is only uniform when the input is.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "n": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Keep every Nth point starting from the earliest in each series. Must be >= 1." } }, "required": [ "input", "n" ] }, "NumericOutputField": { "type": "string", "enum": [ "MIN", "MAX", "MEAN", "COUNT", "VARIANCE", "FIRST_POINT", "LAST_POINT" ] }, "NumericOutputFieldV2": { "description": "Numeric bucket output field requested by the caller.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "field", "percentile" ] }, "field": { "$ref": "#/definitions/NumericOutputFieldV2Name" }, "percentile": { "$ref": "#/definitions/NumericOutputPercentile" } }, "required": [ "type" ], "example": { "type": "field", "field": "MIN" } }, "NumericOutputFieldV2Name": { "type": "string", "enum": [ "MIN", "MAX", "MEAN", "COUNT", "VARIANCE", "FIRST_POINT", "LAST_POINT", "SUM", "STANDARD_DEVIATION", "ROOT_MEAN_SQUARE" ] }, "NumericOutputPercentile": { "type": "object", "properties": { "percentile": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Percentile to compute, in range [0, 1]." }, "outputName": { "type": "string", "description": "Optional output column name. Defaults to pXX, e.g. p95 for 0.95." } }, "required": [ "percentile" ] }, "NumericPlot": { "type": "object", "properties": { "timestamps": { "type": "array", "items": { "$ref": "#/definitions/Timestamp" } }, "values": { "type": "array", "items": { "type": "number", "format": "double" } }, "nextPageToken": { "allOf": [ { "$ref": "#/definitions/PageToken" } ], "description": "Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as `pageToken` and keep the pageSize sign unchanged. Returned only when this response contains exactly `abs(pageSize)` points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction." } } }, "NumericPoint": { "type": "object", "properties": { "timestamp": { "$ref": "#/definitions/Timestamp" }, "value": { "type": "number", "format": "double" } }, "required": [ "timestamp", "value" ] }, "NumericResampleConfiguration": { "type": "object", "properties": { "interval": { "allOf": [ { "$ref": "#/definitions/DurationConstant" } ], "description": "Interval between resampled points" }, "interpolation": { "allOf": [ { "$ref": "#/definitions/NumericResampleInterpolationConfiguration" } ], "description": "Interpolation strategy to use (defaults to forward fill)." } }, "required": [ "interval" ] }, "NumericResampleInterpolationConfiguration": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "forwardFillResampleInterpolationConfiguration", "constantResampleInterpolationConfiguration" ] }, "forwardFillResampleInterpolationConfiguration": { "$ref": "#/definitions/ForwardFillResampleInterpolationConfiguration" }, "constantResampleInterpolationConfiguration": { "$ref": "#/definitions/NumericConstantResampleInterpolationConfiguration" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "forwardFillResampleInterpolationConfiguration", "forwardFillResampleInterpolationConfiguration": {} } }, "NumericResampleSeries": { "description": "Resamples the input series to a new resolution using interpolation. Outputs data for timestamps corresponding to the defined frequency. Based on interpolation strategy, determines range of timestamps to output data for and interpolates values where necessary.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "resampleConfiguration": { "allOf": [ { "$ref": "#/definitions/NumericResampleConfiguration" } ], "description": "The interpolation strategy and interval at which to resample the series" } }, "required": [ "input", "resampleConfiguration" ] }, "NumericResampleSeriesV2": { "description": "Resamples the input series at the authored interval using forward-fill.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "interval": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Interval at which to resample." } }, "required": [ "input", "interval" ] }, "NumericSelectTagsSeries": { "description": "Subsets the tag dimensions of the input numeric series to the given tag keys. Preserves the input series' cardinality: points that share the selected keys but differ on dropped keys remain distinct.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "tagKeys": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true } }, "required": [ "input" ] }, "NumericSeries": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "abs", "negate", "cos", "sin", "tan", "acos", "asin", "ln", "log10", "sqrt", "add", "subtract", "multiply", "divide", "floorDivide", "power", "modulo", "atan2", "max", "mean", "min", "sum", "union", "product", "constant", "selectNewestPoints", "selectNumeric", "selectNumericProperty", "selectOldestPoints", "bitAnd", "bitOr", "bitXor", "bitShiftRight", "bitShiftLeft", "bitTest", "ifElse", "numericAggregation", "countDuplicate", "cumulativeSum", "derivative", "integral", "zScore", "raw", "derived", "resample", "resampleV2", "nthPointDownsample", "largestTriangleThreeBuckets", "signalFilter", "timeDifference", "absoluteTimestamp", "timeRangeFilter", "timeShift", "timeShiftV2", "unitConversion", "unitOverride", "valueDifference", "filterTransformation", "filterWhere", "thresholdFilter", "approximateFilter", "dropNan", "select1dArrayIndex", "aggregateUnderRanges", "rangeDuration", "groupWithinRangesV2", "filterByExpression", "scalarUdf", "enumToNumeric", "contains", "refprop", "refpropV2", "extractFromStruct", "tagByIntervals", "filterByTag", "selectTags", "toStartOfInterval", "phaseUnwrap", "aggregate", "rollingOperation", "bitOperation", "channel", "offset", "scale", "arithmetic", "unaryArithmetic", "binaryArithmetic" ] }, "abs": { "$ref": "#/definitions/Abs" }, "negate": { "$ref": "#/definitions/Negate" }, "cos": { "$ref": "#/definitions/Cos" }, "sin": { "$ref": "#/definitions/Sin" }, "tan": { "$ref": "#/definitions/Tan" }, "acos": { "$ref": "#/definitions/Acos" }, "asin": { "$ref": "#/definitions/Asin" }, "ln": { "$ref": "#/definitions/Ln" }, "log10": { "$ref": "#/definitions/Log10" }, "sqrt": { "$ref": "#/definitions/Sqrt" }, "add": { "$ref": "#/definitions/Add" }, "subtract": { "$ref": "#/definitions/Subtract" }, "multiply": { "$ref": "#/definitions/Multiply" }, "divide": { "$ref": "#/definitions/Divide" }, "floorDivide": { "$ref": "#/definitions/FloorDivide" }, "power": { "$ref": "#/definitions/Power" }, "modulo": { "$ref": "#/definitions/Modulo" }, "atan2": { "$ref": "#/definitions/Atan2" }, "max": { "$ref": "#/definitions/MaxSeries" }, "mean": { "$ref": "#/definitions/MeanSeries" }, "min": { "$ref": "#/definitions/MinSeries" }, "sum": { "$ref": "#/definitions/SumSeries" }, "union": { "$ref": "#/definitions/NumericUnionSeries" }, "product": { "$ref": "#/definitions/ProductSeries" }, "constant": { "$ref": "#/definitions/ConstantNumericSeries" }, "selectNewestPoints": { "$ref": "#/definitions/SelectNewestPointsSeries" }, "selectNumeric": { "$ref": "#/definitions/SelectSeries" }, "selectNumericProperty": { "$ref": "#/definitions/SelectProperty" }, "selectOldestPoints": { "$ref": "#/definitions/SelectOldestPointsSeries" }, "bitAnd": { "$ref": "#/definitions/BitAnd" }, "bitOr": { "$ref": "#/definitions/BitOr" }, "bitXor": { "$ref": "#/definitions/BitXor" }, "bitShiftRight": { "$ref": "#/definitions/BitShiftRight" }, "bitShiftLeft": { "$ref": "#/definitions/BitShiftLeft" }, "bitTest": { "$ref": "#/definitions/BitTest" }, "ifElse": { "$ref": "#/definitions/NumericIfElseSeries" }, "numericAggregation": { "$ref": "#/definitions/NumericAggregation" }, "countDuplicate": { "$ref": "#/definitions/EnumCountDuplicateSeries" }, "cumulativeSum": { "$ref": "#/definitions/CumulativeSumSeries" }, "derivative": { "$ref": "#/definitions/DerivativeSeries" }, "integral": { "$ref": "#/definitions/IntegralSeries" }, "zScore": { "$ref": "#/definitions/ZscoreSeries" }, "raw": { "$ref": "#/definitions/Reference" }, "derived": { "$ref": "#/definitions/DerivedSeries" }, "resample": { "$ref": "#/definitions/NumericResampleSeries" }, "resampleV2": { "$ref": "#/definitions/NumericResampleSeriesV2" }, "nthPointDownsample": { "$ref": "#/definitions/NumericNthPointDownsampleSeries" }, "largestTriangleThreeBuckets": { "$ref": "#/definitions/NumericLargestTriangleThreeBucketsSeries" }, "signalFilter": { "$ref": "#/definitions/SignalFilterSeries" }, "timeDifference": { "$ref": "#/definitions/TimeDifferenceSeries" }, "absoluteTimestamp": { "$ref": "#/definitions/AbsoluteTimestampSeries" }, "timeRangeFilter": { "$ref": "#/definitions/NumericTimeRangeFilterSeries" }, "timeShift": { "$ref": "#/definitions/NumericTimeShiftSeries" }, "timeShiftV2": { "$ref": "#/definitions/NumericTimeShiftSeriesV2" }, "unitConversion": { "$ref": "#/definitions/UnitConversionSeries" }, "unitOverride": { "$ref": "#/definitions/UnitOverrideSeries" }, "valueDifference": { "$ref": "#/definitions/ValueDifferenceSeries" }, "filterTransformation": { "$ref": "#/definitions/NumericFilterTransformationSeries" }, "filterWhere": { "$ref": "#/definitions/NumericFilterWhereSeries" }, "thresholdFilter": { "$ref": "#/definitions/NumericThresholdFilterSeries" }, "approximateFilter": { "$ref": "#/definitions/NumericApproximateFilterSeries" }, "dropNan": { "$ref": "#/definitions/NumericNanFilter" }, "select1dArrayIndex": { "$ref": "#/definitions/SelectIndexFrom1dNumericArraySeries" }, "aggregateUnderRanges": { "$ref": "#/definitions/AggregateUnderRangesSeries" }, "rangeDuration": { "$ref": "#/definitions/RangeDurationSeries" }, "groupWithinRangesV2": { "$ref": "#/definitions/GroupWithinRangesSeriesV2" }, "filterByExpression": { "$ref": "#/definitions/FilterByExpressionSeries" }, "scalarUdf": { "$ref": "#/definitions/ScalarUdfSeries" }, "enumToNumeric": { "$ref": "#/definitions/EnumToNumericSeries" }, "contains": { "$ref": "#/definitions/ContainsSeries" }, "refprop": { "$ref": "#/definitions/RefpropSeries" }, "refpropV2": { "$ref": "#/definitions/RefpropSeriesV2" }, "extractFromStruct": { "$ref": "#/definitions/ExtractNumericFromStructSeries" }, "tagByIntervals": { "$ref": "#/definitions/TagByIntervalsSeries" }, "filterByTag": { "$ref": "#/definitions/NumericTagFilterSeries" }, "selectTags": { "$ref": "#/definitions/NumericSelectTagsSeries" }, "toStartOfInterval": { "$ref": "#/definitions/NumericToStartOfIntervalSeries" }, "phaseUnwrap": { "$ref": "#/definitions/PhaseUnwrapSeries" }, "aggregate": { "allOf": [ { "$ref": "#/definitions/AggregateNumericSeries" } ], "x-deprecated": "AggregateNumericSeries is deprecated. Use `numericAggregation` with `aggregation.GroupByAggregationBuilder` instead." }, "rollingOperation": { "allOf": [ { "$ref": "#/definitions/RollingOperationSeries" } ], "x-deprecated": "RollingOperationSeries is deprecated. Use `numericAggregation` with `aggregation.RollingTimeAggregationBuilder` instead." }, "bitOperation": { "allOf": [ { "$ref": "#/definitions/BitOperationSeries" } ], "x-deprecated": "BitOperationSeries is deprecated in favor of individual nodes for each operation." }, "channel": { "allOf": [ { "$ref": "#/definitions/ChannelSeries" } ], "x-deprecated": "Deprecated in favor of the SelectSeries node" }, "offset": { "allOf": [ { "$ref": "#/definitions/OffsetSeries" } ], "x-deprecated": "OffsetSeries is deprecated in favor of add with a constant." }, "scale": { "allOf": [ { "$ref": "#/definitions/ScaleSeries" } ], "x-deprecated": "ScaleSeries is deprecated in favor of multiply with a constant." }, "arithmetic": { "allOf": [ { "$ref": "#/definitions/ArithmeticSeries" } ], "x-deprecated": "ArithmeticSeries is deprecated in favor of individual nodes for each operation." }, "unaryArithmetic": { "allOf": [ { "$ref": "#/definitions/UnaryArithmeticSeries" } ], "x-deprecated": "UnaryArithmeticSeries is deprecated in favor of individual nodes for each operation." }, "binaryArithmetic": { "allOf": [ { "$ref": "#/definitions/BinaryArithmeticSeries" } ], "x-deprecated": "BinaryArithmeticSeries is deprecated in favor of individual nodes for each operation." } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "abs", "abs": {} } }, "NumericStaleRangesV2": { "description": "Produces ranges where a numeric input has no data for at least a duration.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "threshold": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Minimum gap without data that produces an output range." } }, "required": [ "input", "threshold" ] }, "NumericTagFilterSeries": { "description": "Applies a tag predicate to the numeric series produced by input.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "predicate": { "$ref": "#/definitions/TagPredicate" } }, "required": [ "input", "predicate" ] }, "NumericThresholdFilterSeries": { "description": "Outputs only the values of the numeric plot value that satisfy the threshold condition.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "threshold": { "$ref": "#/definitions/DoubleConstant" }, "operator": { "$ref": "#/definitions/ThresholdOperator" } }, "required": [ "input", "threshold", "operator" ] }, "NumericTimeRangeFilterSeries": { "description": "Filters the series to points within the specified time range.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "startTime": { "allOf": [ { "$ref": "#/definitions/TimestampConstant" } ], "description": "Represents the start time (inclusive) of the time range." }, "endTime": { "allOf": [ { "$ref": "#/definitions/TimestampConstant" } ], "description": "Represents the end time (inclusive) of the time range." } }, "required": [ "input" ] }, "NumericTimeShiftSeries": { "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "duration": { "$ref": "#/definitions/DurationConstant" } }, "required": [ "input", "duration" ] }, "NumericTimeShiftSeriesV2": { "description": "Shifts the timestamps in the input series by the resolved duration.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "duration": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Duration to shift the input series by." } }, "required": [ "input", "duration" ] }, "NumericToStartOfIntervalSeries": { "description": "Snaps each point's timestamp to the start of its enclosing fixed-size time bucket. Buckets are epoch-aligned: a point at timestamp `t` (nanoseconds) is rewritten to `floor(t / window) * window`. Values and tag groupings are preserved; aggregation of points that collide on the snapped timestamp is the responsibility of downstream nodes.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "window": { "$ref": "#/definitions/compute.api.Duration" } }, "required": [ "input", "window" ] }, "NumericUnionOperation": { "description": "DEPRECATED: apply aggregations as a separate step over the unioned output.", "type": "string", "enum": [ "MIN", "MAX", "MEAN", "SUM", "COUNT", "STANDARD_DEVIATION", "ROOT_MEAN_SQUARE", "THROW" ], "x-enum-descriptions": { "MIN": "Combines multiple points by taking the minimum value", "MAX": "Combines multiple points by taking the maximum value", "MEAN": "Combines multiple points by taking the mean of the values", "SUM": "Combines multiple points by taking the sum of the values", "COUNT": "Combines multiple points by taking the count of the values", "STANDARD_DEVIATION": "Combines multiple points by taking the standard deviation of the values", "ROOT_MEAN_SQUARE": "Combines multiple points by taking the root mean square of the values", "THROW": "Throws a DuplicateTimestamp error if two series contain points with a duplicate timestamp." } }, "NumericUnionSeries": { "description": "Combines multiple numeric series together and outputs a single series. By default, points from the inputs are concatenated (SQL {@code UNION ALL}) and duplicate timestamps across inputs are preserved. To aggregate values that share a timestamp, do a separate aggregation step next.", "type": "object", "properties": { "input": { "type": "array", "items": { "$ref": "#/definitions/NumericSeries" }, "description": "Input series to union" }, "operation": { "allOf": [ { "$ref": "#/definitions/NumericUnionOperation" } ], "description": "The strategy to merge points with duplicate timestamps.", "x-deprecated": "Apply aggregations as a separate step over the unioned output." } } }, "Nyquist": { "description": "Returns a complex-valued frequency response, H(f), of the input series to the output series.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "output": { "$ref": "#/definitions/NumericSeries" }, "stftOptions": { "$ref": "#/definitions/StftOptions" } }, "required": [ "input", "output" ] }, "OffsetSeries": { "description": "For every timestamp specified in the input series, offset it by a constant factor.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "scalar": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The constant to add to each point" } }, "required": [ "input", "scalar" ] }, "OnChangeRanges": { "description": "Produces a list of ranges for each point that has a different value to the previous point. A range will have identical start and end times.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Series" } }, "required": [ "input" ] }, "OrSeries": { "description": "Combines two boolean series point-wise using logical OR, producing true where either input is true and false otherwise.", "type": "object", "properties": { "left": { "$ref": "#/definitions/BooleanSeries" }, "right": { "$ref": "#/definitions/BooleanSeries" } }, "required": [ "left", "right" ] }, "OutputFormat": { "type": "string", "enum": [ "ARROW_V4", "ARROW_V3", "LEGACY" ] }, "OutputFrequencyType": { "type": "string", "enum": [ "LINEAR", "ANGULAR", "NORMALIZED_LINEAR", "NORMALIZED_ANGULAR" ], "x-enum-descriptions": { "LINEAR": "Frequency in Hertz.", "ANGULAR": "Frequency in radians per second.", "NORMALIZED_LINEAR": "Normalized frequency, in the range [0, 0.5] for real-valued signals.", "NORMALIZED_ANGULAR": "Normalized angular frequency, in the range [0, π] for real-valued signals." } }, "OutputPhaseUnit": { "type": "string", "enum": [ "RADIANS", "DEGREES" ] }, "OutputRangeStart": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "firstPointMatchingCondition", "afterPersistenceWindow" ] }, "firstPointMatchingCondition": { "allOf": [ { "$ref": "#/definitions/FirstPointMatchingCondition" } ], "description": "The first point in the output range will be the first point where the condition evaluates to true." }, "afterPersistenceWindow": { "allOf": [ { "$ref": "#/definitions/AfterPersistenceWindow" } ], "description": "The output range will contain points where the condition has been true for at least the min duration and min points." } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "firstPointMatchingCondition", "firstPointMatchingCondition": {} } }, "PaddedRanges": { "description": "Expands ranges durations by adding temporal padding to the start, end, or both sides. Note that if the input ranges contain a RangeValue, it will be dropped.", "type": "object", "properties": { "input": { "$ref": "#/definitions/RangeSeries" }, "padding": { "$ref": "#/definitions/DurationConstant" }, "paddingConfiguration": { "allOf": [ { "$ref": "#/definitions/RangePaddingConfiguration" } ], "description": "Configuration for how to apply padding to the ranges. Defaults to PAD_START_AND_END if not specified." } }, "required": [ "input", "padding" ] }, "PaddedRangesV2": { "description": "Expands ranges using an authored Duration expression and a selected padding direction.", "type": "object", "properties": { "input": { "$ref": "#/definitions/RangeSeries" }, "duration": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "How far to extend each range on every padded side." }, "paddingConfiguration": { "$ref": "#/definitions/RangePaddingConfiguration" } }, "required": [ "input", "duration", "paddingConfiguration" ] }, "PageInfo": { "description": "Specification of a page for a series. Returns full resolution points beginning nearest to the given page token, advancing pageSize points in the time direction specified by the sign of the page size. Throws if the absolute pageSize is greater than 5,000. Paging cursors are not guaranteed to distinguish exact duplicate non-log points with the same timestamp, tags, and value. If those duplicates straddle a page boundary, later duplicates may be skipped.", "type": "object", "properties": { "pageToken": { "$ref": "#/definitions/PageToken" }, "pageSize": { "type": "integer", "format": "int32" } }, "required": [ "pageSize" ] }, "PageStrategy": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "pageInfo" ] }, "pageInfo": { "$ref": "#/definitions/PageInfo" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "pageInfo", "pageInfo": { "pageToken": { "type": "timestampAndId", "timestampAndId": { "timestamp": { "seconds": 1, "nanos": 1 }, "id": "string" } }, "pageSize": 1 } } }, "PageToken": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "timestampAndId" ] }, "timestampAndId": { "$ref": "#/definitions/TimestampAndId" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "timestampAndId", "timestampAndId": { "timestamp": { "seconds": 1, "nanos": 1 }, "id": "string" } } }, "PagedLogPlot": { "type": "object", "properties": { "timestamps": { "type": "array", "items": { "$ref": "#/definitions/Timestamp" } }, "values": { "type": "array", "items": { "$ref": "#/definitions/LogValue" } }, "nextPageToken": { "allOf": [ { "$ref": "#/definitions/PageToken" } ], "description": "Continuation token for this paged result. Can only be returned if paging was requested. To retrieve the next page, repeat the same request with this value as `pageToken` and keep the pageSize sign unchanged. Returned only when this response contains exactly `abs(pageSize)` points; the next response may still be empty if this page ended exactly at the result-set boundary. Empty means this response was short and there are no further points in the requested direction." } } }, "ParameterInput": { "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": { "$ref": "#/definitions/VariableValue" }, "x-map-key": "VariableName" }, "timeRange": { "allOf": [ { "$ref": "#/definitions/Range" } ], "description": "Overrides the start and end time of the compute request. If either the start or end are not present, we default back to the start/end specified in the request." } } }, "ParameterizedComputeNodeRequest": { "type": "object", "properties": { "node": { "$ref": "#/definitions/ComputableNode" }, "start": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "The start of the time range (inclusive)." }, "end": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "The end of the time range (inclusive)." }, "context": { "$ref": "#/definitions/Context" }, "sourceRid": { "type": "string", "format": "rid", "description": "Optional RID identifying the resource that initiated this query (e.g. workbook/notebook RID, checklist RID, dataset RID). Used for observability only — trusted as-is, no permission checks are performed on this value." }, "parameterizedContext": { "allOf": [ { "$ref": "#/definitions/ParameterizedContext" } ], "description": "Specifies how certain variables should be parameterized. If a variable name appears in both the context and the parameterized context, it will be treated as parameterized." } }, "required": [ "node", "start", "end", "context", "parameterizedContext" ], "example": { "node": { "type": "ranges", "ranges": { "input": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO" } } } }, "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "context": { "variables": { "": { "type": "double", "double": 1 } }, "functionVariables": { "": { "variables": { "": { "type": "double", "double": 1 } }, "subFunctionVariables": {} } }, "datasetReferences": { "": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } } }, "defaultFillStrategy": { "type": "forwardFill", "forwardFill": { "limit": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } } }, "defaultAlignmentStrategy": { "type": "driverSeries", "driverSeries": {} }, "applyDataScopeOffsets": true, "resolveAssetsThroughDatasets": true }, "parameterizedContext": { "parameterInputs": [ { "variables": { "": { "type": "double", "double": 1 } }, "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "value": { "type": "double", "double": 1 } } } ] } } }, "ParameterizedComputeNodeResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/ComputeNodeResult" } } } }, "ParameterizedContext": { "type": "object", "properties": { "parameterInputs": { "type": "array", "items": { "$ref": "#/definitions/ParameterInput" }, "description": "Each parameter input provides a satisfying set of values for the parameterized compute node." } } }, "PeakRanges": { "description": "Produces a list of ranges for each point that is greater than its neighbors. Peaks at edges are discarded, and continuous, multivalue, flat peaks will return all values.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "returnsPeaks": { "type": "boolean", "description": "True if returning peaks, else troughs.", "x-deprecated": "No longer used, use returnType instead" }, "returnType": { "allOf": [ { "$ref": "#/definitions/PeakType" } ], "description": "Optional for backcompatibility." }, "minimumProminence": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The minimum topographic prominence for an extrema to be returned. Prominence is the minimum vertical distance needed to travel from an extrema to one of greater magnitude." } }, "required": [ "input" ] }, "PeakType": { "type": "string", "enum": [ "PEAK", "TROUGH", "BOTH" ] }, "PercentageThreshold": { "description": "Threshold defined as the percentage of a given value.", "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Allowed spread, as a percentage of the window's mean value." } }, "required": [ "value" ] }, "Percentile": { "description": "The value at the specified percentile.", "type": "object", "properties": { "percentile": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Percentile to compute, in range [0, 1]. E.g. 0.5 for median, 0.95 for p95." } }, "required": [ "percentile" ] }, "Periodogram": { "description": "Returns the spectral density estimate (i.e. PSD) of the input series.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "method": { "$ref": "#/definitions/PeriodogramMethod" } }, "required": [ "input", "method" ] }, "PeriodogramMethod": { "type": "string", "enum": [ "WELCH_BLACKMAN", "WELCH_HANN", "WELCH_HAMMING", "WELCH_RECT" ] }, "PersistenceWindowConfiguration": { "description": "Configures how long a condition has to be true for to output a time range, and what to use as the start of the output range. For a point to be included in the output time range, both the minPoints and minDuration conditions must be satisfied.", "type": "object", "properties": { "minPoints": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The minimum number of points for which this condition be must satisfied to include the time range in the output. Must be non-negative. If not present, will default to 1." }, "minDuration": { "allOf": [ { "$ref": "#/definitions/DurationConstant" } ], "description": "The minimum number of points for which this condition must be satisfied to include the time range in the output. Must be non-negative. If not present, will default to 1 nanosecond." }, "outputRangeStart": { "allOf": [ { "$ref": "#/definitions/OutputRangeStart" } ], "description": "Which point to use as the start of the output range. Defaults to firstPointMatchingCondition if not specified." } }, "required": [ "outputRangeStart" ] }, "PhaseUnwrapSeries": { "description": "Removes discontinuities from a wrapping signal (e.g. phase or heading) by adding whole multiples of `period` whenever the step between consecutive samples exceeds half the period. Output length equals input length.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "period": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The wrapping period of the signal (e.g. 2*pi for radians, 360 for degrees). A jump between consecutive samples greater than `period/2` in magnitude is corrected by adding/subtracting a whole multiple of `period`." } }, "required": [ "input", "period" ] }, "PhysicalConstant": { "description": "Physical constants referenceable by name. The server resolves the symbol to its numeric value in SI units.", "type": "string", "enum": [ "SPEED_OF_LIGHT", "AVOGADRO", "BOLTZMANN", "PLANCK", "ELEMENTARY_CHARGE", "GAS_CONSTANT", "STANDARD_GRAVITY", "STANDARD_ATMOSPHERE", "ABSOLUTE_ZERO_CELSIUS", "GRAVITATIONAL_CONSTANT", "STEFAN_BOLTZMANN" ], "x-enum-descriptions": { "SPEED_OF_LIGHT": "Speed of light in vacuum, 299792458 m/s (exact).", "AVOGADRO": "Avogadro constant, 6.02214076e23 mol^-1 (exact).", "BOLTZMANN": "Boltzmann constant, 1.380649e-23 J/K (exact).", "PLANCK": "Planck constant, 6.62607015e-34 J*s (exact).", "ELEMENTARY_CHARGE": "Elementary charge, 1.602176634e-19 C (exact).", "GAS_CONSTANT": "Molar gas constant, 8.31446261815324 J/(mol*K) (exact, Avogadro times Boltzmann).", "STANDARD_GRAVITY": "Standard acceleration of gravity, 9.80665 m/s^2 (exact by convention).", "STANDARD_ATMOSPHERE": "Standard atmosphere, 101325 Pa (exact by convention).", "ABSOLUTE_ZERO_CELSIUS": "Absolute zero expressed in degrees Celsius, -273.15 (exact).", "GRAVITATIONAL_CONSTANT": "Newtonian constant of gravitation, 6.67430e-11 m^3/(kg*s^2) (CODATA 2022, measured).", "STEFAN_BOLTZMANN": "Stefan-Boltzmann constant, 5.670374419e-8 W/(m^2*K^4) (exact derived)." } }, "PinnedModuleVersionReference": { "type": "object", "properties": { "version": { "$ref": "#/definitions/StringConstant" } }, "required": [ "version" ] }, "Point3d": { "type": "object", "properties": { "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" }, "z": { "type": "number", "format": "double" }, "timestamp": { "$ref": "#/definitions/Timestamp" } }, "required": [ "x", "y", "z", "timestamp" ] }, "PolynomialCurve": { "type": "object", "properties": { "degree": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The highest allowable degree of the fit polynomial." }, "intercept": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The y-value at the point x (or t) = 0. If omitted, the y-intercept will also be fit to the data." } }, "required": [ "degree" ] }, "PolynomialCurveFit": { "description": "A polynomial fit of the enclosing target (`y`) against the chosen independent variable (`x`).", "type": "object", "properties": { "independentVariable": { "allOf": [ { "$ref": "#/definitions/CurveFitVariable" } ], "description": "The `x` axis the target is fit against — either relative sample time or another series." }, "degree": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The highest allowable degree of the fit polynomial." }, "intercept": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The y-value at the point x (or t) = 0. If omitted, the y-intercept will also be fit to the data." } }, "required": [ "independentVariable", "degree" ] }, "PolynomialResultDetails": { "description": "y = sum( a_i * x^i ) for i in 0...len(a)", "type": "object", "properties": { "a": { "type": "array", "items": { "type": "number", "format": "double" } } } }, "Power": { "description": "Raises base to the power of exponent pointwise.", "type": "object", "properties": { "base": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Base values." }, "exponent": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Exponent values." } }, "required": [ "base", "exponent" ] }, "PowerCurve": { "type": "object", "properties": {} }, "PowerResultDetails": { "description": "y = a * x^b", "type": "object", "properties": { "a": { "type": "number", "format": "double" }, "b": { "type": "number", "format": "double" } }, "required": [ "a", "b" ] }, "ProductSeries": { "description": "For every timestamp specified in the input series, outputs a value that is the product for that timestamp across all input series. Only outputs timestamps where all input series have an entry for that timestamp, subject to interpolation.", "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/NumericSeries" }, "description": "Input series across which to take the pointwise product" }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Defaults to forward fill interpolation with a 1s interpolation radius", "x-deprecated": "Setting interpolation on this node is deprecated." } } }, "Psd": { "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "stftOptions": { "$ref": "#/definitions/StftOptions" }, "magnitudeScaling": { "allOf": [ { "$ref": "#/definitions/MagnitudeScaling" } ], "description": "The scaling to apply to the output magnitude. Defaults to MAGNITUDE_DB_10 if not specified." }, "outputFrequencyType": { "allOf": [ { "$ref": "#/definitions/OutputFrequencyType" } ], "description": "The type of the output frequency. Defaults to LINEAR if not specified. Changing the output frequency unit may also rescale the magnitude of the output in order to ensure the density of the output is consistent." }, "summarizationStrategy": { "allOf": [ { "$ref": "#/definitions/FrequencySummarizationStrategy" } ], "description": "Strategy to downsample the output frequency spectrum." } }, "required": [ "input" ] }, "QuotaIntervalUsage": { "type": "object", "properties": { "durationSeconds": { "type": "integer", "format": "int64", "description": "Length of the quota window in seconds." }, "currentWindow": { "allOf": [ { "$ref": "#/definitions/QuotaWindow" } ], "description": "Bounds of the current quota window. Usage counters reset at the window's end." }, "resources": { "type": "array", "items": { "$ref": "#/definitions/QuotaResourceUsage" }, "description": "Usage per limited resource. Resources without a configured limit are not reported." } }, "required": [ "durationSeconds" ] }, "QuotaResourceType": { "description": "Resource types that can be limited by the per-user compute quota.", "type": "string", "enum": [ "READ_ROWS", "READ_BYTES", "QUERIES", "ERRORS", "EXECUTION_TIME" ] }, "QuotaResourceUsage": { "type": "object", "properties": { "resource": { "$ref": "#/definitions/QuotaResourceType" }, "used": { "type": "number", "format": "double", "description": "Amount consumed within the current window, in the resource's native unit (rows, bytes, query count, or seconds for EXECUTION_TIME)." }, "limit": { "type": "number", "format": "double", "description": "The cap for this resource in this window." } }, "required": [ "resource", "used", "limit" ] }, "QuotaWindow": { "type": "object", "properties": { "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" } }, "required": [ "startTime", "endTime" ] }, "Range": { "description": "The end represents the first timestamp that does not belong to the range. If absent, there is no known end to the range.", "type": "object", "properties": { "start": { "$ref": "#/definitions/Timestamp" }, "end": { "$ref": "#/definitions/Timestamp" }, "value": { "$ref": "#/definitions/RangeValue" } } }, "RangeAggregation": { "description": "An aggregation value representing combined aggregation metrics for data over a range.", "type": "object", "properties": { "average": { "type": "number", "format": "double" }, "min": { "type": "number", "format": "double" }, "max": { "type": "number", "format": "double" }, "standardDeviation": { "type": "number", "format": "double" }, "count": { "type": "number", "format": "double" }, "sum": { "type": "number", "format": "double" }, "rootMeanSquare": { "type": "number", "format": "double" } }, "required": [ "average", "min", "max", "standardDeviation", "count", "sum" ] }, "RangeAggregationOperation": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "sum", "rootMeanSquare", "average", "min", "max", "standardDeviation", "count", "all" ] }, "sum": { "$ref": "#/definitions/Summation" }, "rootMeanSquare": { "$ref": "#/definitions/RootMeanSquare" }, "average": { "$ref": "#/definitions/Average" }, "min": { "$ref": "#/definitions/Minimum" }, "max": { "$ref": "#/definitions/Maximum" }, "standardDeviation": { "$ref": "#/definitions/StandardDeviation" }, "count": { "$ref": "#/definitions/Count" }, "all": { "$ref": "#/definitions/Empty" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "sum", "sum": {} } }, "RangeDurationSeries": { "description": "Outputs a numeric series with one point per range: timestamp = range start, value = range duration.", "type": "object", "properties": { "input": { "$ref": "#/definitions/RangeSeries" }, "unboundedRangeBehavior": { "allOf": [ { "$ref": "#/definitions/UnboundedRangeBehavior" } ], "description": "How to handle ranges with a missing start or end." }, "timeUnit": { "allOf": [ { "$ref": "#/definitions/TimeUnit" } ], "description": "The time unit of the duration. Defaults to seconds if not specified." } }, "required": [ "input", "unboundedRangeBehavior" ] }, "RangeIntervalSource": { "description": "Intervals come from a range series. Must resolve to literal ranges.", "type": "object", "properties": { "ranges": { "$ref": "#/definitions/RangeSeries" }, "tagBy": { "type": "array", "items": { "$ref": "#/definitions/RangeTagSource" }, "description": "Non-empty ordered list of tag sources. Each contributes a tag key-value pair per range interval." } }, "required": [ "ranges" ] }, "RangeMap": { "type": "object", "properties": { "start": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Inclusive start value. If not specified, the start is the prior range's end value, or negative infinity." }, "end": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Exclusive end value. If not specified, the end value is the next range's start value, or positive infinity." }, "output": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "The value to map to if the input value is within the range." } }, "required": [ "output" ] }, "RangePaddingConfiguration": { "type": "string", "enum": [ "PAD_START", "PAD_END", "PAD_START_AND_END" ] }, "RangeSeries": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "approximateThreshold", "booleanRanges", "thresholdRangesV2", "durationFilter", "durationFilterV2", "enumFilter", "categoryFilterRangesV2", "categoricalOnChangeRangesV2", "categoricalStaleRangesV2", "categoricalEqualityRangesV2", "enumSeriesEqualityRangesNode", "eventsSearch", "intersectRange", "literalRanges", "minMaxThreshold", "not", "onChange", "peak", "extremaRangesV2", "rangeNumericAggregation", "raw", "derived", "seriesCrossoverRangesNode", "seriesEqualityRangesNode", "numericEqualityRangesV2", "stabilityDetection", "stabilityDetectionV2", "staleRange", "numericStaleRangesV2", "threshold", "unionRange", "paddedRanges", "paddedRangesV2" ] }, "approximateThreshold": { "$ref": "#/definitions/ApproximateThresholdRanges" }, "booleanRanges": { "$ref": "#/definitions/BooleanRanges" }, "thresholdRangesV2": { "$ref": "#/definitions/ThresholdRangesV2" }, "durationFilter": { "$ref": "#/definitions/DurationFilterRanges" }, "durationFilterV2": { "$ref": "#/definitions/DurationFilterRangesV2" }, "enumFilter": { "$ref": "#/definitions/EnumFilterRanges" }, "categoryFilterRangesV2": { "$ref": "#/definitions/CategoryFilterRangesV2" }, "categoricalOnChangeRangesV2": { "$ref": "#/definitions/CategoricalOnChangeRangesV2" }, "categoricalStaleRangesV2": { "$ref": "#/definitions/CategoricalStaleRangesV2" }, "categoricalEqualityRangesV2": { "$ref": "#/definitions/CategoricalEqualityRangesV2" }, "enumSeriesEqualityRangesNode": { "$ref": "#/definitions/EnumSeriesEqualityRanges" }, "eventsSearch": { "$ref": "#/definitions/EventsSearchRanges" }, "intersectRange": { "$ref": "#/definitions/IntersectRanges" }, "literalRanges": { "$ref": "#/definitions/LiteralRanges" }, "minMaxThreshold": { "allOf": [ { "$ref": "#/definitions/MinMaxThresholdRanges" } ], "description": "Computes ranges where the input time series matches a filter defined by lower and upper bounds, and an operator." }, "not": { "$ref": "#/definitions/NotRanges" }, "onChange": { "$ref": "#/definitions/OnChangeRanges" }, "peak": { "$ref": "#/definitions/PeakRanges" }, "extremaRangesV2": { "$ref": "#/definitions/ExtremaRangesV2" }, "rangeNumericAggregation": { "$ref": "#/definitions/RangesNumericAggregation" }, "raw": { "$ref": "#/definitions/Reference" }, "derived": { "$ref": "#/definitions/DerivedSeries" }, "seriesCrossoverRangesNode": { "$ref": "#/definitions/SeriesCrossoverRanges" }, "seriesEqualityRangesNode": { "$ref": "#/definitions/SeriesEqualityRanges" }, "numericEqualityRangesV2": { "$ref": "#/definitions/NumericEqualityRangesV2" }, "stabilityDetection": { "$ref": "#/definitions/StabilityDetectionRanges" }, "stabilityDetectionV2": { "$ref": "#/definitions/StabilityDetectionRangesV2" }, "staleRange": { "$ref": "#/definitions/StaleRanges" }, "numericStaleRangesV2": { "$ref": "#/definitions/NumericStaleRangesV2" }, "threshold": { "allOf": [ { "$ref": "#/definitions/ThresholdingRanges" } ], "description": "Computes ranges where the input time series matches a filter defined by a single threshold and an operator." }, "unionRange": { "$ref": "#/definitions/UnionRanges" }, "paddedRanges": { "$ref": "#/definitions/PaddedRanges" }, "paddedRangesV2": { "$ref": "#/definitions/PaddedRangesV2" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "approximateThreshold", "approximateThreshold": { "input": { "type": "abs", "abs": {} }, "threshold": { "type": "literal", "literal": 1 }, "tolerance": { "type": "literal", "literal": 1 }, "operator": "EQUAL_TO", "persistenceWindowConfiguration": { "minPoints": { "type": "literal", "literal": 1 }, "minDuration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } }, "outputRangeStart": { "type": "firstPointMatchingCondition", "firstPointMatchingCondition": {} } } } } }, "RangeSortOrder": { "description": "Sort order for selecting ranges. ASC selects from earliest to latest, DESC selects from latest to earliest.", "type": "string", "enum": [ "ASC", "DESC" ] }, "RangeStart": { "description": "Selects which point of a satisfied condition begins the output range.", "type": "string", "enum": [ "CONDITION_START", "PERSISTENCE_START" ] }, "RangeSummary": { "description": "Summary of a set of ranges", "type": "object", "properties": { "range": { "allOf": [ { "$ref": "#/definitions/Range" } ], "description": "The range representing the minimum start and maximum end times of the ranges." }, "subRangeCount": { "type": "integer", "format": "int32", "description": "The number of ranges found within this time range." } }, "required": [ "range", "subRangeCount" ] }, "RangeTagSource": { "description": "A dimension contributing a tag key-value pair per range interval.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "intervalIndex", "rangeStartTimestamp" ] }, "intervalIndex": { "$ref": "#/definitions/IntervalIndexTag" }, "rangeStartTimestamp": { "$ref": "#/definitions/IntervalStartTimestampTag" } }, "required": [ "type" ], "example": { "type": "intervalIndex", "intervalIndex": {} } }, "RangeValue": { "description": "A value attached to a range. If there are no relevant data points in the range, this will be noPointsInRange for the range; otherwise, an Aggregation will be returned if this is produced by getting multiple aggregation values over a range (i.e. aggregating for all metrics over a range), and will be a double otherwise for singular values (i.e. aggregating for just the sum of data values over a range).\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "double", "aggregation", "noPointsInRange" ] }, "double": { "type": "number", "format": "double" }, "aggregation": { "$ref": "#/definitions/RangeAggregation" }, "noPointsInRange": { "$ref": "#/definitions/Empty" } }, "required": [ "type" ], "example": { "type": "double", "double": 1 } }, "RangesAnchor": { "description": "Uses the start timestamp of the range at the configured zero-based index from `ranges` evaluated over each interval, considering only ranges whose start lies in the anchor window [start, end), or [start, +infinity) when the end is absent. The window is the run bounds for a run anchor. A range already in progress when the window opens anchors at the window start. Series in `ranges` that select no explicit dataset resolve against the aligned input dataset, and the computed range groups must carry the aligned runs' `runRid` grouping tags.", "type": "object", "properties": { "ranges": { "allOf": [ { "$ref": "#/definitions/RangeSeries" } ], "description": "The range series evaluated per interval to locate the anchor range." }, "index": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Zero-based range index after sorting. Defaults to zero and must be non-negative." }, "sortOrder": { "allOf": [ { "$ref": "#/definitions/RangeSortOrder" } ], "description": "Ordering by range start timestamp before selecting the index. Defaults to ASC." } }, "required": [ "ranges" ] }, "RangesNumericAggregation": { "description": "Aggregates the values of a numeric series at each range specified by the input ranges.", "type": "object", "properties": { "ranges": { "$ref": "#/definitions/RangeSeries" }, "input": { "$ref": "#/definitions/NumericSeries" }, "operation": { "$ref": "#/definitions/RangeAggregationOperation" } }, "required": [ "ranges", "input", "operation" ] }, "RangesSummary": { "description": "A summary of the ranges returned from a SummarizeRanges request. Returned when the number of ranges found is above a threshold.", "type": "object", "properties": { "rangesSummary": { "type": "array", "items": { "$ref": "#/definitions/RangeSummary" } } } }, "Reference": { "type": "object", "properties": { "name": { "type": "string", "x-alias": "VariableName", "description": "A reference to a value not defined in the current compute scope." } }, "required": [ "name" ] }, "RefpropProperty": { "description": "Supported properties for REFPROP calculations.", "type": "string", "enum": [ "TEMPERATURE", "PRESSURE", "MASS_DENSITY", "MASS_SPECIFIC_ENTHALPY", "MASS_SPECIFIC_INTERNAL_ENERGY", "MASS_SPECIFIC_ENTROPY", "VISCOSITY" ] }, "RefpropSeries": { "description": "Computes the output property given input properties for the substance using REFPROP. Initial implementation only expects two input properties.", "type": "object", "properties": { "inputs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/NumericSeries" }, "description": "A map that maps a REFPROP property to its numeric series." }, "outputProperty": { "allOf": [ { "$ref": "#/definitions/RefpropProperty" } ], "description": "The desired output property. This should not be one of the input properties." }, "substance": { "allOf": [ { "$ref": "#/definitions/RefpropSubstance" } ], "description": "The substance for REFPROP calculations." }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "x-deprecated": "Setting interpolation on this node is deprecated." } }, "required": [ "outputProperty", "substance" ] }, "RefpropSeriesV2": { "description": "Computes a REFPROP output property from the supplied substance and output property.", "type": "object", "properties": { "inputs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/NumericSeries" }, "description": "Map of REFPROP property to its numeric series." }, "substance": { "allOf": [ { "$ref": "#/definitions/RefpropSubstance" } ], "description": "The substance for REFPROP calculations." }, "outputProperty": { "allOf": [ { "$ref": "#/definitions/RefpropProperty" } ], "description": "The desired output property. This must not be one of the input properties." } }, "required": [ "substance", "outputProperty" ] }, "RefpropSubstance": { "description": "Supported substances for REFPROP calculations", "type": "string", "enum": [ "NITROGEN", "OXYGEN", "HELIUM", "HYDROGEN", "METHANE", "PROPANE", "BUTANE", "WATER", "XENON", "AIR", "CARBON_DIOXIDE", "ARGON", "CARBON_MONOXIDE", "JET_A_4658", "JET_A_3638" ] }, "RequestInProgress": { "description": "Summed across the request's active queries when it fans out into more than one.", "type": "object", "properties": { "readRows": { "type": "integer", "format": "int64" }, "totalRowsApprox": { "type": "integer", "format": "int64", "description": "May grow while a query runs as new sources to process become known." } }, "required": [ "readRows", "totalRowsApprox" ] }, "RequestInactive": { "description": "No query for this request was running at sample time; not necessarily finished.", "type": "object", "properties": {} }, "RequestProgress": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "inProgress", "inactive" ] }, "inProgress": { "$ref": "#/definitions/RequestInProgress" }, "inactive": { "$ref": "#/definitions/RequestInactive" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "inProgress", "inProgress": { "readRows": 1, "totalRowsApprox": 1 } } }, "ResourceSearchQuery": { "description": "Predicate tree for filtering.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "properties", "numericProperty", "numericPropertyRange", "labels", "workspace", "and", "or", "not" ] }, "properties": { "$ref": "#/definitions/PropertiesFilter" }, "numericProperty": { "$ref": "#/definitions/NumericPropertyPredicate" }, "numericPropertyRange": { "allOf": [ { "$ref": "#/definitions/NumericPropertyRangePredicate" } ], "description": "Matches resources using an inclusive numeric property range." }, "labels": { "$ref": "#/definitions/LabelsFilter" }, "workspace": { "$ref": "#/definitions/StringConstant" }, "and": { "type": "array", "items": { "$ref": "#/definitions/ResourceSearchQuery" } }, "or": { "type": "array", "items": { "$ref": "#/definitions/ResourceSearchQuery" } }, "not": { "$ref": "#/definitions/ResourceSearchQuery" } }, "required": [ "type" ], "example": { "type": "properties", "properties": { "name": "string", "values": [ "string" ] } } }, "RollingOperationSeries": { "description": "DEPRECATED. Use `numericAggregation` with `aggregation.RollingTimeAggregationBuilder` instead.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "window": { "$ref": "#/definitions/Window" }, "operator": { "$ref": "#/definitions/NumericAggregationOperator" } }, "required": [ "input", "window", "operator" ] }, "RollingPointsAggregationBuilder": { "description": "Rolling point-count aggregation: for each point in the input, aggregate the current point and the preceding N - 1 points within the same tag grouping.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Series" }, "points": { "$ref": "#/definitions/IntegerConstant" } }, "required": [ "input", "points" ] }, "RollingTimeAggregationBuilder": { "description": "Rolling time-window aggregation: for each point in the input, aggregate the values within the preceding time window.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Series" }, "window": { "$ref": "#/definitions/compute.api.Duration" } }, "required": [ "input", "window" ] }, "RootMeanSquare": { "description": "The root mean square of points inside the time window.", "type": "object", "properties": {} }, "Run": { "description": "Run reference for `Dataset.run`. The `rid` field accepts either a literal run RID or a `StringConstant` reference resolved from `Context`.", "type": "object", "properties": { "rid": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "Resource identifier of a run" } }, "required": [ "rid" ] }, "RunChannel": { "type": "object", "properties": { "runRid": { "$ref": "#/definitions/StringConstant" }, "assetRid": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "Used to disambiguate when multiple assets within this run contain data scopes with the same name. If not specified for a run with multiple assets, an error will be thrown." }, "dataScopeName": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "Used to disambiguate when multiple data scopes within this run contain channels with the same name." }, "channel": { "$ref": "#/definitions/StringConstant" }, "additionalTags": { "type": "object", "additionalProperties": { "$ref": "#/definitions/StringConstant" }, "x-deprecated": "Use additionalTagFilters" }, "additionalTagFilters": { "allOf": [ { "$ref": "#/definitions/TagFilters" } ], "description": "Tags to filter the channel by, in addition to tag filters defined for a given Run data scope. Throws on collisions with tag keys already defined for the given Run data scope. Only returns points that match both sets of tag filters. For log series, include arg filters here in addition to tag filters." }, "tagsToGroupBy": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "x-deprecated": "Use groupByTags instead. Throws if both tagsToGroupBy and groupByTags are specified." }, "groupByTags": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true, "description": "Tags that the channel should be grouped by. If this is non-empty a grouped result will be returned with an entry for each grouping. Only one of tagsToGroupBy and groupByTags should be specified." } }, "required": [ "runRid", "dataScopeName", "channel" ] }, "RunsSearchTarget": { "description": "Search runs. Each matched run expands to one grouping per data source attached to the run: asset-typed data sources contribute one grouping per data scope on the asset; dataset-typed data sources contribute one grouping per dataset. Every grouping is tagged by `runRid` and `dataScope` (the asset's data scope name for asset-typed sources, or the run-local data source ref name for dataset-typed sources); asset-typed groupings additionally carry `assetRid`.", "type": "object", "properties": { "query": { "allOf": [ { "$ref": "#/definitions/ResourceSearchQuery" } ], "description": "Predicate tree used to filter matching runs." } }, "required": [ "query" ] }, "RustUdfSource": { "description": "Rust source code defining the UDF entrypoint and any helper functions.", "type": "object", "properties": { "sourceCode": { "type": "string", "description": "Rust source code to transpile into WASM. The operation consuming this source defines the entrypoint signature: scalar UDFs receive one scalar per input series, while aggregation UDFs receive grouped value vectors. If several functions appear at the top level, annotate the entrypoint with `#[main]`." } }, "required": [ "sourceCode" ] }, "Sampling": { "description": "Options for returning a sampled subset of raw series points.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "everyNthPerSeries", "hashSubsample" ] }, "everyNthPerSeries": { "$ref": "#/definitions/EveryNthPerSeriesSampling" }, "hashSubsample": { "$ref": "#/definitions/HashSubsampleSampling" } }, "required": [ "type" ], "example": { "type": "everyNthPerSeries", "everyNthPerSeries": { "n": { "type": "literal", "literal": 1 } } } }, "SavedDataset": { "description": "A persisted source of data, named by its RID. Can be a catalog dataset, pipeline, connection, etc.", "type": "object", "properties": { "rid": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "A data source RID, given as a literal or as a variable resolved from `Context`. A pipeline's logic only accepts catalog datasets/pipelines, since it is persisted without context." } }, "required": [ "rid" ] }, "ScalarUdfSeries": { "description": "Executes user-provided scalar UDF code over aligned inputs. The function must return one output for each aligned input row, with the return type matching the series type that contains this node.", "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/Series" }, "description": "Input series passed to the UDF in argument order." }, "source": { "allOf": [ { "$ref": "#/definitions/UdfSource" } ], "description": "Language-specific source definition for the UDF." } }, "required": [ "source" ] }, "ScaleSeries": { "description": "For every timestamp specified in the input series, multiply it by a constant factor.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "scalar": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The constant to multiply each point by" }, "scalarUnit": { "type": "string", "x-alias": "UnitSymbol", "description": "The units of the scalar to multiply by. If empty, the scalar is considered unit-less." } }, "required": [ "input", "scalar" ] }, "Scatter": { "description": "A scatter plot comprised of the values from one input series on the x-axis and values from another input series on the y-axis, for all points within a requested time range.", "type": "object", "properties": { "x": { "$ref": "#/definitions/NumericSeries" }, "y": { "$ref": "#/definitions/NumericSeries" } }, "required": [ "x", "y" ] }, "Scatter3d": { "type": "object", "properties": { "x": { "$ref": "#/definitions/NumericSeries" }, "y": { "$ref": "#/definitions/NumericSeries" }, "z": { "$ref": "#/definitions/NumericSeries" }, "driverSeries": { "$ref": "#/definitions/DriverSeries3d" } }, "required": [ "x", "y", "z" ] }, "ScatterCurveFit": { "description": "Fits a curve to the scatter between two series.", "type": "object", "properties": { "scatter": { "allOf": [ { "$ref": "#/definitions/Scatter" } ], "description": "The x and y series to fit to." }, "options": { "$ref": "#/definitions/ScatterFitOptions" } }, "required": [ "scatter", "options" ] }, "ScatterFitOptions": { "type": "object", "properties": { "minX": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Inclusive lower bound on the x values to fit to. If omitted, does not set a bound (equivalent to setting this to the minimum x value among all points in the time range)." }, "maxX": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Inclusive upper bound on the x values to fit to. If omitted, does not set a bound (equivalent to setting this to the maximum x value among all points in the time range)." }, "minY": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Inclusive lower bound on the y values to fit to. If omitted, does not set a bound (equivalent to setting this to the minimum y value among all points in the time range)." }, "maxY": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Inclusive upper bound on the y values to fit to. If omitted, does not set a bound (equivalent to setting this to the maximum y value among all points in the time range)." } } }, "ScatterSummarizationStrategy": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "spatial", "temporal" ] }, "spatial": { "$ref": "#/definitions/SpatialDecimateStrategy" }, "temporal": { "$ref": "#/definitions/TemporalDecimateStrategy" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "spatial", "spatial": {} } }, "ScatterTemporalAggregation": { "type": "string", "enum": [ "MEAN", "MIN", "MAX", "FIRST", "LAST" ] }, "SearchDataset": { "description": "Resolves matching assets or runs from search, creating a combined dataset tagged by source rid and data scope.", "type": "object", "properties": { "target": { "allOf": [ { "$ref": "#/definitions/SearchTarget" } ], "description": "Whether to search assets or runs and with which query." }, "maxResults": { "type": "integer", "format": "int32", "description": "Maximum number of assets or runs returned from search. Defaults to 10000 when omitted." } }, "required": [ "target" ] }, "SearchTarget": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "assets", "runs" ] }, "assets": { "$ref": "#/definitions/AssetsSearchTarget" }, "runs": { "$ref": "#/definitions/RunsSearchTarget" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "assets", "assets": { "query": { "type": "properties", "properties": { "name": "string", "values": [ "string" ] } } } } }, "SelectIndexFrom1dEnumArraySeries": { "description": "For each timestamp, selects a single enum value from the 1D enum array at the specified index. If the index is out of bounds for an array at a given timestamp, it is omitted.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Enum1dArraySeries" }, "index": { "$ref": "#/definitions/IntegerConstant" } }, "required": [ "input", "index" ] }, "SelectIndexFrom1dNumericArraySeries": { "description": "For each timestamp, selects a single numeric value from the 1D numeric array at the specified index. If the index is out of bounds for an array at a given timestamp, it is omitted.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Numeric1dArraySeries" }, "index": { "$ref": "#/definitions/IntegerConstant" } }, "required": [ "input", "index" ] }, "SelectNewestPointsSeries": { "description": "Select the most recent N points from the input series by timestamp.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "The input series to select the newest points from." }, "numPoints": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The number of points to select." } }, "required": [ "input", "numPoints" ] }, "SelectOldestPointsSeries": { "description": "Select the earliest N points from the input series by timestamp.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "The input series to select the oldest points from." }, "numPoints": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The number of points to select." } }, "required": [ "input", "numPoints" ] }, "SelectProperty": { "description": "Selects a typed property value from every asset or run branch resolved from `dataset`. Inside a `WithSeriesDataset` definition, `dataset` may be omitted to use that node's wrapping input; it is required everywhere else. Asset branches read properties directly from their asset. Run branches read properties directly from their run, never from a backing asset or dataset. Direct saved-dataset branches are unsupported.", "type": "object", "properties": { "propertyName": { "type": "string", "x-alias": "PropertyName" }, "dataset": { "$ref": "#/definitions/Dataset" } }, "required": [ "propertyName" ] }, "SelectSeries": { "description": "Selects series from a dataset (might contain multiple tag groupings). When `name` is provided, selects that single channel. When `name` is omitted, selection starts from all channels in the dataset scope; callers narrow the selection with a `filterByTag` predicate on the reserved `NOMINAL_CHANNEL` tag key and preserve per-channel identity in the response with `selectTags`. Providing both `name` and a `NOMINAL_CHANNEL` filter is rejected as an invalid request. Raw and derived channels can both be selected through the reserved tag filter.", "type": "object", "properties": { "name": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "The identifying series name to query" }, "dataset": { "allOf": [ { "$ref": "#/definitions/Dataset" } ], "description": "The dataset providing the data to query. May be omitted inside a `WithSeriesDataset` series definition, in which case it defaults to that node's wrapping `input`; required everywhere else." }, "sampling": { "allOf": [ { "$ref": "#/definitions/Sampling" } ], "description": "Raw-series sampling options. Supported for numeric and enum raw series." } } }, "SelectValue": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "firstPoint", "firstValuePoint", "firstRange", "lastPoint", "lastValuePoint", "lastRange", "nthRange" ] }, "firstPoint": { "$ref": "#/definitions/Series" }, "firstValuePoint": { "$ref": "#/definitions/Series" }, "firstRange": { "$ref": "#/definitions/RangeSeries" }, "lastPoint": { "$ref": "#/definitions/Series" }, "lastValuePoint": { "$ref": "#/definitions/Series" }, "lastRange": { "$ref": "#/definitions/RangeSeries" }, "nthRange": { "$ref": "#/definitions/NthRange" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "firstPoint", "firstPoint": { "type": "raw", "raw": { "name": "string" } } } }, "Series": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "raw", "enum", "numeric", "log", "array", "struct", "video" ] }, "raw": { "allOf": [ { "$ref": "#/definitions/Reference" } ], "x-deprecated": "use typed value of series instead." }, "enum": { "$ref": "#/definitions/EnumSeries" }, "numeric": { "$ref": "#/definitions/NumericSeries" }, "log": { "$ref": "#/definitions/LogSeries" }, "array": { "$ref": "#/definitions/ArraySeries" }, "struct": { "$ref": "#/definitions/StructSeries" }, "video": { "$ref": "#/definitions/Reference" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "raw", "raw": { "name": "string" } } }, "SeriesCrossoverRanges": { "description": "Produces a list of zero-duration ranges at the first point where two series cross over one another", "type": "object", "properties": { "inputA": { "$ref": "#/definitions/NumericSeries" }, "inputB": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "The series `inputA` is compared against." } }, "required": [ "inputA", "inputB" ] }, "SeriesEqualityRanges": { "description": "Produces a list of ranges for which provided series are all equal (or are not all equal).", "type": "object", "properties": { "input": { "type": "array", "items": { "$ref": "#/definitions/NumericSeries" } }, "equalityOperator": { "$ref": "#/definitions/EqualityOperator" }, "tolerance": { "$ref": "#/definitions/DoubleConstant" }, "persistenceWindowConfiguration": { "$ref": "#/definitions/PersistenceWindowConfiguration" }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Defaults to forward fill interpolation with a 1s interpolation radius", "x-deprecated": "Setting interpolation on this node is deprecated." } }, "required": [ "equalityOperator" ] }, "SeriesVariable": { "description": "A series selected from a dataset, bound to a variable. The series type (numeric, enum, ...) is decided lazily by the node consuming the variable, matching the behaviour of channel variables.", "type": "object", "properties": { "select": { "$ref": "#/definitions/SelectSeries" }, "groupByTags": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true, "description": "Tags that the series should be grouped by. If this is non-empty a grouped result will be returned with an entry for each grouping; otherwise all matching series are merged." } }, "required": [ "select" ] }, "SetNegativeValuesToZero": { "type": "object", "properties": {} }, "SignalFilterConfiguration": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "lowPass", "highPass", "bandPass", "bandStop" ] }, "lowPass": { "$ref": "#/definitions/LowPassConfiguration" }, "highPass": { "$ref": "#/definitions/HighPassConfiguration" }, "bandPass": { "$ref": "#/definitions/BandPassConfiguration" }, "bandStop": { "$ref": "#/definitions/BandStopConfiguration" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "lowPass", "lowPass": { "cutoffFrequency": { "type": "literal", "literal": 1 } } } }, "SignalFilterSeries": { "description": "Applies IIR-based signal filtering to input series. Includes low-pass, high-pass, band-pass, and band-stop filters. Currently supports variable-order bidirectional Butterworth filters, with fixed-size padding based on SciPy output.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "signalFilterConfiguration": { "allOf": [ { "$ref": "#/definitions/SignalFilterConfiguration" } ], "description": "Filter type and cutoff frequencies." }, "order": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Order of filter. Must be a positive integer, and is effectively doubled for bidirectional filters." }, "samplingFrequency": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The sampling frequency of the input series. Used to calculate normalized frequency for cutoff frequencies." } }, "required": [ "input", "signalFilterConfiguration", "order" ] }, "Sin": { "description": "Computes the trigonometric sine of each value (input in radians).", "type": "object", "properties": { "x": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (radians)." } }, "required": [ "x" ] }, "SinglePoint": { "description": "Return type representing a single point value.", "type": "object", "properties": { "timestamp": { "$ref": "#/definitions/Timestamp" }, "value": { "$ref": "#/definitions/Value" }, "precisionLoss": { "type": "boolean", "description": "Returns true if the result required downcasting to a type with less precision, for example if the input series was Int64 and the result is a Float64." } }, "required": [ "timestamp", "value", "precisionLoss" ] }, "SpatialDecimateStrategy": { "description": "Decimate by spatial trees. Creates buckets by bisecting on each dimension, creating quadrants for 2d scatter and octants for 3d scatter. Continues subdividing by prioritizing larger undivided buckets until reaching the max amount of buckets.", "type": "object", "properties": {} }, "Spectrogram": { "description": "The PSD or amplitude of the input over time, from a short-time Fourier transform of overlapping windows.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "A numeric series from a single data source. Series grouped by tags are not supported." }, "stftOptions": { "allOf": [ { "$ref": "#/definitions/StftOptions" } ], "description": "Window and FFT parameters." }, "quantity": { "allOf": [ { "$ref": "#/definitions/SpectrogramQuantity" } ], "description": "What each cell measures. Defaults to PSD." }, "magnitudeScaling": { "allOf": [ { "$ref": "#/definitions/MagnitudeScaling" } ], "description": "How each cell's value is scaled. Defaults to decibels: 10·log10 of the PSD, or 20·log10 of the amplitude." }, "bucketing": { "allOf": [ { "$ref": "#/definitions/SpectrogramBucketing" } ], "description": "The output's time and frequency buckets, frequency band and reductions." } }, "required": [ "input" ] }, "SpectrogramBucketing": { "description": "The output's time and frequency buckets: at most `maxTimeBuckets` rows and `maxFrequencyBuckets` columns over the frequency band, with the values that share a row or column combined by `timeReduction` and `frequencyReduction`. Invalid values fail with `InvalidExpression`.", "type": "object", "properties": { "maxTimeBuckets": { "type": "integer", "format": "int32", "description": "Maximum number of rows, further lowered so that rows × columns is at most 262,144. Defaults to 256." }, "maxFrequencyBuckets": { "type": "integer", "format": "int32", "description": "Maximum number of columns. Defaults to 512." }, "minFrequency": { "type": "number", "format": "double", "description": "Inclusive lower bound of the band in Hz. Defaults to 0." }, "maxFrequency": { "type": "number", "format": "double", "description": "Exclusive upper bound of the band in Hz. Defaults to including the Nyquist frequency." }, "timeReduction": { "allOf": [ { "$ref": "#/definitions/SpectrogramReduction" } ], "description": "Combines the windows that share a row. Defaults to MEAN." }, "frequencyReduction": { "allOf": [ { "$ref": "#/definitions/SpectrogramReduction" } ], "description": "Combines the frequency bins that share a column. Defaults to MEAN." } } }, "SpectrogramPlot": { "description": "Values on a time-frequency grid. Columns are frequency buckets and rows are the time buckets that hold data, in ascending time.", "type": "object", "properties": { "frequencyCenters": { "type": "array", "items": { "type": "number", "format": "double" }, "description": "Center frequency in Hz of each column." }, "frequencyEdges": { "type": "array", "items": { "type": "number", "format": "double" }, "description": "Column boundaries in Hz, one more than `frequencyCenters`: column `c` spans `frequencyEdges[c]` to `frequencyEdges[c + 1]`. Columns may differ in width." }, "rows": { "type": "array", "items": { "$ref": "#/definitions/SpectrogramRow" } } } }, "SpectrogramQuantity": { "description": "What a spectrogram cell measures.", "type": "string", "enum": [ "PSD", "AMPLITUDE" ], "x-enum-descriptions": { "PSD": "Power spectral density, in the input unit squared per Hz.", "AMPLITUDE": "Peak amplitude, in the input unit." } }, "SpectrogramReduction": { "description": "How the values that share one output row or column are combined, before scaling.", "type": "string", "enum": [ "MEAN", "MAX", "GEOMETRIC_MEAN" ], "x-enum-descriptions": { "MEAN": "Arithmetic mean.", "MAX": "Maximum, which keeps short transients visible.", "GEOMETRIC_MEAN": "Geometric mean, which suits decibel displays with a wide dynamic range." } }, "SpectrogramRow": { "type": "object", "properties": { "start": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "Start of the time span this row covers." }, "end": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "End of the time span this row covers." }, "values": { "type": "array", "items": { "type": "number", "format": "double" }, "description": "One value per column" } }, "required": [ "start", "end" ] }, "Sqrt": { "description": "Computes the square root of each value.", "type": "object", "properties": { "x": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (non-negative values)." } }, "required": [ "x" ] }, "StabilityDetectionRanges": { "description": "Outputs a set of ranges where the input series is stable. For each point, the min and max are calculated over the specified lookback window, including the current point. A point is considered stable if its value does not deviate from the calculated min and the max by more than the threshold and the total number of points within the window is at least the specified amount. The threshold can be either fixed values or percentages of the value. The lookback window must be strictly positive. The minimum points threshold defaults to 2.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "windowConfiguration": { "$ref": "#/definitions/StabilityWindowConfiguration" }, "threshold": { "$ref": "#/definitions/Threshold" } }, "required": [ "input", "windowConfiguration", "threshold" ] }, "StabilityDetectionRangesV2": { "description": "Produces ranges where a numeric input is stable within a modern duration window.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "window": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Lookback window over which the input's spread is measured." }, "minPoints": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Minimum number of points in the window. Defaults to 2." }, "threshold": { "$ref": "#/definitions/Threshold" } }, "required": [ "input", "window", "threshold" ] }, "StabilityWindowConfiguration": { "type": "object", "properties": { "minPoints": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "The minimum number of points within the window to create a stable range. Must be non-negative. If not present, will default to 2." }, "duration": { "$ref": "#/definitions/DurationConstant" } }, "required": [ "duration" ] }, "StaleRanges": { "description": "Produces a list of ranges for which data does not exist for the specified duration or longer. Increases window size by the specified staleness threshold on both ends to capture edge cases of data not currently in view.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Series" }, "threshold": { "$ref": "#/definitions/DurationConstant" }, "startTimestamp": { "allOf": [ { "$ref": "#/definitions/TimestampConstant" } ], "description": "The start timestamp of the range. If not specified, staleness will automatically use view range start." }, "endTimestamp": { "allOf": [ { "$ref": "#/definitions/TimestampConstant" } ], "x-deprecated": "No longer used and will be removed" } }, "required": [ "input", "threshold" ] }, "StandardDeviation": { "description": "The standard deviation of points inside the time window.", "type": "object", "properties": {} }, "StftOptions": { "description": "Options for frequency analyses that are backed by short-time Fourier transforms.", "type": "object", "properties": { "window": { "allOf": [ { "$ref": "#/definitions/FftWindow" } ], "description": "Window function type to use" }, "windowSymmetry": { "allOf": [ { "$ref": "#/definitions/WindowSymmetry" } ], "description": "Either DFT_EVEN or SYMMETRIC" }, "samplingFrequency": { "type": "number", "format": "double", "description": "Sampling frequency of the series in Hz. If absent, will calculate using the input series." }, "nperseg": { "type": "integer", "format": "int32", "description": "Number of points per window segment." }, "noverlap": { "type": "integer", "format": "int32", "description": "Number of points of overlap between windows. Must be less than nperseg." }, "nfft": { "type": "integer", "format": "int32", "description": "Number of points to use in the FFT. Must be greater than or equal to nperseg." }, "detrend": { "allOf": [ { "$ref": "#/definitions/DetrendType" } ], "description": "Detrend the points in each window segment. If absent, will use the default detrend for that function." } } }, "StringConstant": { "description": "A string constant that can be a literal value or a named variable reference.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "literal", "variable" ] }, "literal": { "type": "string", "description": "Create from a literal string value." }, "variable": { "type": "string", "x-alias": "VariableName", "description": "Create from a named reference." } }, "required": [ "type" ], "example": { "type": "literal", "literal": "string" } }, "StringPropertyDimension": { "description": "Injects the value of a string property, under a tag key equal to the property name by default. Only supported on asset and run branches: asset branches read the asset's properties, and run branches, including run branches backed by an asset, read the run's properties, matching `SelectProperty`. Values are injected as is. A branch without the property, or whose property holds a numeric value, gets the reserved value `NOMINAL_ABSENT`.", "type": "object", "properties": { "propertyName": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "Name of the property whose value to inject. Also the default tag key." } }, "required": [ "propertyName" ] }, "StringSetConstant": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "literal", "variable" ] }, "literal": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "variable": { "type": "string", "x-alias": "VariableName" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "literal", "literal": [ "string" ] } }, "StringSetConstantV2": { "description": "A set of string constants that can be a literal set or a named variable reference.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "literal", "variable" ] }, "literal": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true, "description": "Create from a literal set of string constants." }, "variable": { "type": "string", "x-alias": "VariableName", "description": "Create from a named reference." } }, "required": [ "type" ], "example": { "type": "literal", "literal": [ { "type": "literal", "literal": "string" } ] } }, "StructSelectTagsSeries": { "description": "Subsets the tag dimensions of the input struct series to the given tag keys. Preserves the input series' cardinality: points that share the selected keys but differ on dropped keys remain distinct.", "type": "object", "properties": { "input": { "$ref": "#/definitions/StructSeries" }, "tagKeys": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true } }, "required": [ "input" ] }, "StructSeries": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "channel", "raw", "derived", "combine", "selectStruct", "extractFromStruct", "toStartOfInterval", "timeShift", "filterByTag", "selectTags" ] }, "channel": { "$ref": "#/definitions/ChannelSeries" }, "raw": { "$ref": "#/definitions/Reference" }, "derived": { "$ref": "#/definitions/DerivedSeries" }, "combine": { "$ref": "#/definitions/CombineStructSeries" }, "selectStruct": { "$ref": "#/definitions/SelectSeries" }, "extractFromStruct": { "$ref": "#/definitions/ExtractStructFromStructSeries" }, "toStartOfInterval": { "$ref": "#/definitions/StructToStartOfIntervalSeries" }, "timeShift": { "$ref": "#/definitions/StructTimeShiftSeries" }, "filterByTag": { "$ref": "#/definitions/StructTagFilterSeries" }, "selectTags": { "$ref": "#/definitions/StructSelectTagsSeries" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "channel", "channel": { "type": "dataSource", "dataSource": { "dataSourceRid": { "type": "literal", "literal": "string" }, "channel": { "type": "literal", "literal": "string" }, "tags": { "key": { "type": "literal", "literal": "string" } }, "tagFilters": { "type": "single", "single": { "key": { "type": "literal", "literal": "string" }, "values": [ { "type": "literal", "literal": "string" } ], "operator": "IN" } }, "tagsToGroupBy": [ "string" ], "groupByTags": [ { "type": "literal", "literal": "string" } ] } } } }, "StructTagFilterSeries": { "description": "Applies a tag predicate to the struct series produced by input.", "type": "object", "properties": { "input": { "$ref": "#/definitions/StructSeries" }, "predicate": { "$ref": "#/definitions/TagPredicate" } }, "required": [ "input", "predicate" ] }, "StructTimeShiftSeries": { "type": "object", "properties": { "input": { "$ref": "#/definitions/StructSeries" }, "duration": { "$ref": "#/definitions/DurationConstant" } }, "required": [ "input", "duration" ] }, "StructToStartOfIntervalSeries": { "description": "Snaps each point's timestamp to the start of its enclosing fixed-size time bucket. Buckets are epoch-aligned: a point at timestamp `t` (nanoseconds) is rewritten to `floor(t / window) * window`. Values and tag groupings are preserved; aggregation of points that collide on the snapped timestamp is the responsibility of downstream nodes.", "type": "object", "properties": { "input": { "$ref": "#/definitions/StructSeries" }, "window": { "$ref": "#/definitions/compute.api.Duration" } }, "required": [ "input", "window" ] }, "Subtract": { "description": "Subtracts right from left pointwise.", "type": "object", "properties": { "left": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Left-hand operand (minuend)." }, "right": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Right-hand operand (subtrahend)." } }, "required": [ "left", "right" ] }, "SumSeries": { "description": "For every timestamp specified in the input series, outputs a value that is the sum for that timestamp across all input series. Only outputs timestamps where all input series have an entry for that timestamp, subject to interpolation.", "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/NumericSeries" }, "description": "Input series across which to take the pointwise sum" }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Defaults to forward fill interpolation with a 1s interpolation radius", "x-deprecated": "Setting interpolation on this node is deprecated." } } }, "SummarizationStrategy": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "decimate", "largestTriangleThreeBuckets", "page", "truncate" ] }, "decimate": { "$ref": "#/definitions/DecimateStrategy" }, "largestTriangleThreeBuckets": { "allOf": [ { "$ref": "#/definitions/LttbStrategy" } ], "description": "Largest-Triangle-Three-Buckets downsampling returns selected numeric timestamp/value points that preserve the visual shape of each group. It is distinct from fixed-width bucket aggregation." }, "page": { "allOf": [ { "$ref": "#/definitions/PageStrategy" } ], "description": "Paging returns full resolution points for supported series types. Results include a continuation token when another request may be needed to continue in the requested direction." }, "truncate": { "allOf": [ { "$ref": "#/definitions/TruncateStrategy" } ], "description": "Truncation returns a bounded set of full-resolution points. For compute requests, it is supported for array and struct series. To retrieve full-resolution numeric series, use paging." } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "decimate", "decimate": { "type": "resolution", "resolution": { "resolution": 1 } } } }, "SummarizeCartesian": { "type": "object", "properties": { "input": { "$ref": "#/definitions/Cartesian" }, "bounds": { "$ref": "#/definitions/CartesianBounds" }, "summarizationStrategy": { "allOf": [ { "$ref": "#/definitions/ScatterSummarizationStrategy" } ], "description": "The summarization strategy to use when there are more than `maxPoints`. Defaults to spatial." }, "maxPoints": { "type": "integer", "format": "int32", "description": "The maximum number of points to return in the response. If more points are found, a BucketedCartesianPlot will be returned. Maximum is 10,000. Defaults to 2,000 if not specified." } }, "required": [ "input" ] }, "SummarizeCartesian3d": { "type": "object", "properties": { "input": { "$ref": "#/definitions/Cartesian3d" }, "bounds": { "$ref": "#/definitions/Cartesian3dBounds" }, "maxPoints": { "type": "integer", "format": "int32", "description": "The maximum number of points to return in the response. If more points are found, a BucketedCartesian3dPlot will be returned. Maximum is 10,000. Defaults to 2,000 if not specified." }, "summarizationStrategy": { "allOf": [ { "$ref": "#/definitions/ScatterSummarizationStrategy" } ], "description": "The strategy to use when summarizing the series. Only spatial decimation is supported." } }, "required": [ "input" ] }, "SummarizeMultivariate": { "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/MultivariateInput" }, "description": "List of input series to temporally align at the raw point level, then bucket the aligned tuples together. The series with the largest tag group acts as the \"driver\" that determines which raw timestamps are included in the alignment. All subsequent series are aligned to the driver's raw timestamps using the interpolation configuration. After alignment, the resulting (x, y, z, ...) tuples are bucketed into time windows and aggregated." }, "outputFormat": { "allOf": [ { "$ref": "#/definitions/OutputFormat" } ], "description": "The output format of the response. Defaults to LEGACY (JSON)." }, "bucketCount": { "type": "integer", "format": "int32", "description": "The number of buckets to return in the response. Maximum is 10,000. Defaults to 1,000 if not specified." }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Controls how the N input series are aligned at the raw point level when producing multivariate buckets.\n\nWhen present, the server may fill forward a series value from the most recent prior raw point (bounded by the interpolation radius). This alignment happens BEFORE bucketing, ensuring that aggregated values in each bucket are computed from temporally aligned raw tuples.\n\nWhen absent, the default interpolation configuration is used." } } }, "SummarizeRanges": { "type": "object", "properties": { "input": { "$ref": "#/definitions/RangeSeries" }, "maxRanges": { "type": "integer", "format": "int32", "description": "The maximum number of ranges to return in the response. If more ranges are found, a RangesSummary will be returned. Defaults to 2000 if not specified." } }, "required": [ "input" ] }, "SummarizeSeries": { "description": "Summarizes the output of a series node. The output can be a numeric, enum, log, or cartesian series. Summarization strategy should be specified.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Series" }, "outputFormat": { "allOf": [ { "$ref": "#/definitions/OutputFormat" } ], "description": "The output format of the response. Defaults to LEGACY." }, "numericOutputFields": { "type": "array", "items": { "$ref": "#/definitions/NumericOutputField" }, "uniqueItems": true, "description": "The fields to output from the summarization. Applies only to Arrow format numeric series.", "x-deprecated": "Use numericOutputFieldsV2 instead." }, "numericAggregations": { "type": "object", "additionalProperties": { "$ref": "#/definitions/NumericAggregationOperator" }, "description": "Additional numeric aggregations per decimation bucket (e.g. percentiles). Map key is the name of the column in the result." }, "numericOutputFieldsV2": { "type": "array", "items": { "$ref": "#/definitions/NumericOutputFieldV2" }, "description": "Numeric bucket output fields to return. Applies only to Arrow format numeric series. Defaults to MEAN when no numeric output selector is specified. Mutually exclusive with numericOutputFields and numericAggregations." }, "resolution": { "type": "integer", "format": "int64", "description": "Resolution of the output series specifying time interval between decimated points, in nanoseconds.", "x-deprecated": "Use summarizationStrategy instead." }, "buckets": { "type": "integer", "format": "int32", "description": "Number of points to generate in the output series.", "x-deprecated": "Use summarizationStrategy instead." }, "summarizationStrategy": { "allOf": [ { "$ref": "#/definitions/SummarizationStrategy" } ], "description": "The strategy to use when summarizing the series." } }, "required": [ "input" ] }, "Summation": { "description": "The sum of points inside the time window.", "type": "object", "properties": {} }, "TagAnd": { "description": "Conjunction of two tag predicates (both must hold).", "type": "object", "properties": { "left": { "$ref": "#/definitions/TagPredicate" }, "right": { "$ref": "#/definitions/TagPredicate" } }, "required": [ "left", "right" ] }, "TagByIntervalsSeries": { "description": "Injects tags derived from interval boundaries onto a numeric series. Points within an interval get tagged; points outside all intervals are dropped. Intervals come from either events or ranges. If intervals with different tag map overlap, a data point falling in multiple intervals is duplicated into each matching output group. Overlapping intervals with equal tag maps are not allowed. Optional time shift subtracts a per-interval anchor from timestamps after matching.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "intervals": { "$ref": "#/definitions/IntervalSource" }, "timeShift": { "allOf": [ { "$ref": "#/definitions/TagByIntervalsTimeShift" } ], "description": "When set, shift each matched point's timestamp by the chosen anchor for that interval." } }, "required": [ "input", "intervals" ] }, "TagByIntervalsTimeShift": { "description": "How to shift timestamps after tagging (subtract anchor from each point in the interval slice).\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "intervalStart", "intervalEnd", "eventTimeShift" ] }, "intervalStart": { "$ref": "#/definitions/IntervalStartTimeShift" }, "intervalEnd": { "$ref": "#/definitions/IntervalEndTimeShift" }, "eventTimeShift": { "$ref": "#/definitions/EventTimeShift" } }, "required": [ "type" ], "example": { "type": "intervalStart", "intervalStart": {} } }, "TagFilter": { "description": "A filter on a single tag key and set of values. For an IN operator, the tag key must match at least one of the values in the set. For a NOT_IN operator, it must not match any of the values in the set.", "type": "object", "properties": { "key": { "$ref": "#/definitions/StringConstant" }, "values": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true }, "operator": { "$ref": "#/definitions/TagFilterOperator" } }, "required": [ "key", "operator" ] }, "TagFilterOperator": { "type": "string", "enum": [ "IN", "NOT_IN" ] }, "TagFilters": { "description": "A set of tag filters to apply to a channel. Allows for combining filters on multiple tag keys, but throws if any one tag key is specified in more than one filter.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "single", "and" ] }, "single": { "$ref": "#/definitions/TagFilter" }, "and": { "type": "array", "items": { "$ref": "#/definitions/TagFilters" } } }, "required": [ "type" ], "example": { "type": "single", "single": { "key": { "type": "literal", "literal": "string" }, "values": [ { "type": "literal", "literal": "string" } ], "operator": "IN" } } }, "TagIn": { "description": "Constrains a tag key to be in the given set of values.", "type": "object", "properties": { "key": { "$ref": "#/definitions/StringConstant" }, "values": { "$ref": "#/definitions/StringSetConstantV2" } }, "required": [ "key", "values" ] }, "TagNotIn": { "description": "Constrains a tag key to not be in the given set of values.", "type": "object", "properties": { "key": { "$ref": "#/definitions/StringConstant" }, "values": { "$ref": "#/definitions/StringSetConstantV2" } }, "required": [ "key", "values" ] }, "TagPredicate": { "description": "Conjunctive tag predicate for dataset filtering. Compiles to resolved TagFilters for storage and resolution-time folding against known tag assignments (e.g. TaggedDataset, search branches).\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "in", "notIn", "and" ] }, "in": { "$ref": "#/definitions/TagIn" }, "notIn": { "$ref": "#/definitions/TagNotIn" }, "and": { "$ref": "#/definitions/TagAnd" } }, "required": [ "type" ], "example": { "type": "in", "in": { "key": { "type": "literal", "literal": "string" }, "values": { "type": "literal", "literal": [ { "type": "literal", "literal": "string" } ] } } } }, "TaggedDataset": { "description": "Injects one ephemeral tag (key and value) onto the underlying dataset.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/Dataset" } ], "description": "The underlying dataset to tag." }, "key": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "Tag key to inject onto each series in the dataset." }, "value": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "Tag value to assign to the injected key." } }, "required": [ "input", "key", "value" ] }, "Tan": { "description": "Computes the trigonometric tangent of each value (input in radians).", "type": "object", "properties": { "x": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "Input numeric series (radians)." } }, "required": [ "x" ] }, "TemporalDecimateStrategy": { "description": "Buckets the input by time range into equally sized buckets. The number of buckets is determined by the maxPoints parameter. Returns a CartesianPlot.", "type": "object", "properties": { "xAggregation": { "allOf": [ { "$ref": "#/definitions/ScatterTemporalAggregation" } ], "description": "The strategy to use for aggregating the x values in each bucket." }, "yAggregation": { "allOf": [ { "$ref": "#/definitions/ScatterTemporalAggregation" } ], "description": "The strategy to use for aggregating the y values in each bucket." } }, "required": [ "xAggregation", "yAggregation" ] }, "Threshold": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "absolute", "percentage" ] }, "absolute": { "$ref": "#/definitions/AbsoluteThreshold" }, "percentage": { "$ref": "#/definitions/PercentageThreshold" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "absolute", "absolute": { "value": { "type": "literal", "literal": 1 } } } }, "ThresholdOperator": { "type": "string", "enum": [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ] }, "ThresholdRangesComparison": { "description": "Selects the comparison applied to a numeric threshold.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "gt", "ge", "lt", "le", "eq", "ne" ] }, "gt": { "$ref": "#/definitions/ThresholdRangesOrderedComparison" }, "ge": { "$ref": "#/definitions/ThresholdRangesOrderedComparison" }, "lt": { "$ref": "#/definitions/ThresholdRangesOrderedComparison" }, "le": { "$ref": "#/definitions/ThresholdRangesOrderedComparison" }, "eq": { "$ref": "#/definitions/ThresholdRangesEqualityComparison" }, "ne": { "$ref": "#/definitions/ThresholdRangesEqualityComparison" } }, "required": [ "type" ], "example": { "type": "gt", "gt": { "threshold": { "type": "literal", "literal": 1 } } } }, "ThresholdRangesEqualityComparison": { "description": "An equality comparison against a numeric threshold, within an optional tolerance.", "type": "object", "properties": { "threshold": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The value each input point is compared against." }, "tolerance": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "Maximum absolute difference from the threshold still counted as equal. Defaults to zero, i.e. exact equality." } }, "required": [ "threshold" ] }, "ThresholdRangesOrderedComparison": { "description": "An ordering comparison against a single numeric threshold.", "type": "object", "properties": { "threshold": { "allOf": [ { "$ref": "#/definitions/DoubleConstant" } ], "description": "The value each input point is compared against." } }, "required": [ "threshold" ] }, "ThresholdRangesV2": { "description": "Produces ranges where a numeric input satisfies a threshold comparison.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "minPoints": { "allOf": [ { "$ref": "#/definitions/IntegerConstant" } ], "description": "Minimum number of matching points. Defaults to 1." }, "minDuration": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "Minimum matching duration. Defaults to one nanosecond." }, "rangeStart": { "allOf": [ { "$ref": "#/definitions/RangeStart" } ], "description": "Selects whether the output begins at the first match or after persistence is satisfied." }, "comparison": { "$ref": "#/definitions/ThresholdRangesComparison" } }, "required": [ "input", "comparison" ] }, "ThresholdingRanges": { "description": "Produces a list of ranges for which the threshold condition is satisfied.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "threshold": { "$ref": "#/definitions/DoubleConstant" }, "operator": { "$ref": "#/definitions/ThresholdOperator" }, "persistenceWindowConfiguration": { "$ref": "#/definitions/PersistenceWindowConfiguration" } }, "required": [ "input", "threshold", "operator" ] }, "TimeDifferenceSeries": { "description": "Outputs a new series where each value is the difference between the time of the current and previous points.", "type": "object", "properties": { "input": { "$ref": "#/definitions/Series" }, "timeUnit": { "allOf": [ { "$ref": "#/definitions/TimeUnit" } ], "description": "The time unit used to define the output values. Defaults to seconds if not specified." } }, "required": [ "input" ] }, "TimeSeriesCurveFit": { "description": "Fits a curve to a series vs its timestamps.", "type": "object", "properties": { "series": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "The series to fit. Timestamps will be used as x values and data as y values. The leftmost (earliest) timestamp will be used as the value of 0, and all other timestamps will be relative to that." }, "options": { "$ref": "#/definitions/TimeSeriesFitOptions" } }, "required": [ "series", "options" ] }, "TimeSeriesFitOptions": { "type": "object", "properties": { "timeUnit": { "allOf": [ { "$ref": "#/definitions/TimeUnit" } ], "description": "Time unit used for the timestamps to fit against. Defaults to seconds if not specified." } } }, "TimeShiftedDataset": { "description": "Transforms a dataset by adding a time offset to all its data.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/Dataset" } ], "description": "The underlying dataset to time-shift." }, "offset": { "allOf": [ { "$ref": "#/definitions/compute.api.Duration" } ], "description": "The time shift to apply. Positive values shift data forward in time, negative values shift backward." } }, "required": [ "input", "offset" ] }, "TimestampAndId": { "type": "object", "properties": { "timestamp": { "$ref": "#/definitions/Timestamp" }, "id": { "type": "string", "format": "uuid" } }, "required": [ "timestamp" ] }, "TimestampConstant": { "description": "A timestamp constant that can be a literal value or a named variable reference.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "literal", "variable" ] }, "literal": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "Create from a literal timestamp value." }, "variable": { "type": "string", "x-alias": "VariableName", "description": "Create from a named reference." } }, "required": [ "type" ], "example": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } }, "TruncateStrategy": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "maxPointsToReturn" ] }, "maxPointsToReturn": { "type": "integer", "format": "int32", "description": "Maximum number of points to return before truncating, ordered by timestamp. Throws if greater than 10,000" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "maxPointsToReturn", "maxPointsToReturn": 1 } }, "UdfSource": { "description": "Source provider for a user-defined function.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "rust" ] }, "rust": { "$ref": "#/definitions/RustUdfSource" } }, "required": [ "type" ], "example": { "type": "rust", "rust": { "sourceCode": "string" } } }, "UnaryArithmeticOperation": { "type": "string", "enum": [ "COS", "SIN", "TAN", "ABS", "ASIN", "ACOS", "LOG", "LN", "SQRT" ], "x-enum-descriptions": { "COS": "Calculates the trigonometric cosine (input in radians)", "SIN": "Calculates the trigonometric sine (input in radians)", "TAN": "Calculates the trigonometric tangent (input in radians)", "ABS": "Calculates the absolute value", "ASIN": "Calculates the arcsine, returning radians", "ACOS": "Calculates the arccosine, returning radians", "LOG": "Calculates the base 10 logarithm", "LN": "Calculates the natural logarithm (base e)", "SQRT": "Calculates the square root" } }, "UnaryArithmeticSeries": { "description": "Applies a point-wise transformation to a series. The transformation function is applied to every individual data point.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "operation": { "$ref": "#/definitions/UnaryArithmeticOperation" } }, "required": [ "input", "operation" ] }, "UnboundedBehavior": { "description": "Dictates how empty range bounds should be handled by the compute node. Defaults to INFINITY.", "type": "string", "enum": [ "INFINITY", "WINDOW_BOUND" ] }, "UnboundedRangeBehavior": { "description": "How to handle ranges with a missing start or end.\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "clampToWindow", "drop" ] }, "clampToWindow": { "allOf": [ { "$ref": "#/definitions/Empty" } ], "description": "Clamp a missing range start to the compute request window start and a missing range end to the compute request window end." }, "drop": { "allOf": [ { "$ref": "#/definitions/Empty" } ], "description": "Drop the range if it has a missing start or end." } }, "required": [ "type" ], "example": { "type": "clampToWindow", "clampToWindow": {} } }, "Union": { "description": "Uses the union of all input timestamps as the alignment grid.", "type": "object", "properties": {} }, "UnionRanges": { "type": "object", "properties": { "inputs": { "type": "array", "items": { "$ref": "#/definitions/RangeSeries" }, "description": "The ranges to union." } } }, "UnitComputationError": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "incompatibleUnitsOperation", "unitsMissing", "error" ] }, "incompatibleUnitsOperation": { "$ref": "#/definitions/IncompatibleUnitOperation" }, "unitsMissing": { "$ref": "#/definitions/UnitsMissing" }, "error": { "$ref": "#/definitions/SerializableError" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "incompatibleUnitsOperation", "incompatibleUnitsOperation": { "operation": "UNIT_AS_EXPONENT", "units": [ "string" ] } } }, "UnitConversionSeries": { "description": "Convert the given series to a different unit.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "outputUnit": { "type": "string", "x-alias": "UnitSymbol" } }, "required": [ "input", "outputUnit" ] }, "UnitOperation": { "type": "string", "enum": [ "UNIT_AS_EXPONENT", "NON_INTEGER_AS_EXPONENT", "FLOOR_DIVISION", "MODULO", "CROSSOVER_COMPARISON", "MAX", "MIN", "MEAN", "UNION", "ADDITION", "SUBTRACTION", "UNIT_CONVERSION", "COMPARISON", "TERNARY_OPERATOR" ] }, "UnitOverrideSeries": { "description": "Override the unit of the given series without changing its values. Unlike unit conversion, no compatibility with the input's current unit is required.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "unit": { "type": "string", "x-alias": "UnitSymbol", "description": "The unit to report for the input series. If absent, the input's unit is cleared." } }, "required": [ "input" ] }, "UnitResult": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "success", "noUnitAvailable" ] }, "success": { "type": "string", "x-alias": "UnitSymbol" }, "noUnitAvailable": { "type": "array", "items": { "$ref": "#/definitions/UnitComputationError" }, "uniqueItems": true, "description": "The resulting values have no units associated. If this is because of an error, it is listed here." } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "success", "success": "string" } }, "UnitsMissing": { "description": "At least one input is missing a unit.", "type": "object", "properties": { "seriesRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "LogicalSeriesRid" }, "uniqueItems": true, "x-deprecated": "Use channels instead." }, "channels": { "type": "array", "items": { "$ref": "#/definitions/DataSourceAndChannel" }, "uniqueItems": true } } }, "Value": { "description": "A single value. The type is dictated by the returned variant\n\nSet `type` to the name of one of the other fields, and set only that field.", "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "stringValue", "float64Value", "int64Value", "arrayValue", "structValue" ] }, "stringValue": { "type": "string" }, "float64Value": { "type": "number", "format": "double" }, "int64Value": { "type": "string" }, "arrayValue": { "type": "array", "items": { "$ref": "#/definitions/Value" } }, "structValue": { "description": "A JSON representation of the struct" } }, "required": [ "type" ], "example": { "type": "stringValue", "stringValue": "string" } }, "ValueDifferenceSeries": { "description": "Calculates the first discrete difference of the input series. For each point, computes the difference between the current value and the previous value (current - previous). The first point in the input series is omitted from the output since it has no previous point to compare against.\n\nThis is equivalent to pandas DataFrame.diff() with period=1. Useful for analyzing changes between consecutive data points in time series data, such as detecting value increases or decreases.\n\nExample: For input values [1.0, 1.0, 2.0, 2.5, 1.8], the output would be [0.0, 1.0, 0.5, -0.7] at the corresponding timestamps (the first timestamp is omitted).", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "negativeValuesConfiguration": { "allOf": [ { "$ref": "#/definitions/NegativeValueConfiguration" } ], "description": "Defines the strategy for handling negative output values. Defaults to allowNegativeValues if not specified." } }, "required": [ "input" ] }, "ValueMapSeries": { "description": "Maps a continuous numeric series to a discrete enum series using the specified value ranges.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/NumericSeries" } ], "description": "The input series to map to an enumerated series" }, "mapping": { "type": "array", "items": { "$ref": "#/definitions/RangeMap" }, "description": "The output of the first capturing range will be used. Ranges are start inclusive, end exclusive, must not overlap, and increasing from lowest to highest. Ranges can be open ended to the edge of the next or prior range. The first range can be open ended to negative infinity, and the last range can be open ended to positive infinity." }, "default": { "allOf": [ { "$ref": "#/definitions/StringConstant" } ], "description": "The default value if not captured by any range. If not specified, points will be filtered." } }, "required": [ "input" ] }, "VariableValue": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "double", "computeNode", "duration", "integer", "channel", "derived", "series", "string", "stringSet", "timestamp" ] }, "double": { "type": "number", "format": "double" }, "computeNode": { "$ref": "#/definitions/ComputeNodeWithContext" }, "duration": { "$ref": "#/definitions/run.api.Duration" }, "integer": { "type": "integer", "format": "int32" }, "channel": { "allOf": [ { "$ref": "#/definitions/ChannelSeries" } ], "x-deprecated": "use series instead." }, "derived": { "$ref": "#/definitions/DerivedSeries" }, "series": { "$ref": "#/definitions/SeriesVariable" }, "string": { "type": "string" }, "stringSet": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "timestamp": { "$ref": "#/definitions/Timestamp" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "double", "double": 1 } }, "Window": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "duration" ] }, "duration": { "$ref": "#/definitions/DurationConstant" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "duration", "duration": { "type": "literal", "literal": { "seconds": 1, "nanos": 1 } } } }, "WindowSymmetry": { "type": "string", "enum": [ "DFT_EVEN", "SYMMETRIC" ], "x-enum-descriptions": { "DFT_EVEN": "Generates dft-even/periodic window values.", "SYMMETRIC": "Generates symmetric window values." } }, "WithSeriesDataset": { "description": "Adds one or more derived series to the base dataset. Each entry's definition must reference only the wrapping `input`. Series names must be unique within the request; a derived name replaces a same-named series from `input`.", "type": "object", "properties": { "input": { "allOf": [ { "$ref": "#/definitions/Dataset" } ], "description": "The base dataset to which the new series will be added." }, "series": { "type": "array", "items": { "$ref": "#/definitions/NamedSeries" }, "description": "The named derived series to add." } }, "required": [ "input" ] }, "ZscoreSeries": { "description": "Computes the z-score for each series within a group-by family. For each group at each timestamp, the output is (value - mean) / stddev, where mean and stddev are computed across all groups in the family at that timestamp, using the interpolation configuration to align values across groups. When stddev is zero at a timestamp (e.g., all groups have the same value), that data point is excluded from the output. If groupByTags is empty, all groups in the input series will be considered as a single family. This node only produces meaningful results when the input has a group by.", "type": "object", "properties": { "input": { "$ref": "#/definitions/NumericSeries" }, "groupByTags": { "type": "array", "items": { "$ref": "#/definitions/StringConstant" }, "uniqueItems": true, "description": "Tags to group by for the normalization. If left empty, all groups in the input will be considered as a single family. Otherwise, inputs will be normalized separately across the groups specified by the tags." }, "interpolationConfiguration": { "allOf": [ { "$ref": "#/definitions/InterpolationConfiguration" } ], "description": "Configuration for aligning values across groups at each timestamp. Defaults to forward fill interpolation with a 1s interpolation radius.", "x-deprecated": "Setting interpolation on this node is deprecated." } }, "required": [ "input" ] }, "ComputeEventQuery": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "searchText", "after", "before", "advancedTimeFilter", "asset", "template", "workbook", "dataReview", "originType", "dataReviewCheck", "dispositionStatus", "priority", "assignee", "eventType", "createdBy", "label", "property", "and", "or", "not", "workspace", "procedure", "procedureExecution", "stepId" ] }, "searchText": { "$ref": "#/definitions/StringConstant" }, "after": { "allOf": [ { "$ref": "#/definitions/TimestampConstant" } ], "description": "Filters to events after this timestamp, exclusive. This includes events that start before, but end after this time." }, "before": { "allOf": [ { "$ref": "#/definitions/TimestampConstant" } ], "description": "Filters to events before this timestamp, exclusive. This includes events that start before, but end after this time." }, "advancedTimeFilter": { "$ref": "#/definitions/EventTimeFilter" }, "asset": { "$ref": "#/definitions/StringConstant" }, "template": { "$ref": "#/definitions/StringConstant" }, "workbook": { "$ref": "#/definitions/StringConstant" }, "dataReview": { "$ref": "#/definitions/StringConstant" }, "originType": { "$ref": "#/definitions/SearchEventOriginType" }, "dataReviewCheck": { "$ref": "#/definitions/StringConstant" }, "dispositionStatus": { "$ref": "#/definitions/EventDispositionStatus" }, "priority": { "$ref": "#/definitions/StringConstant" }, "assignee": { "$ref": "#/definitions/StringConstant" }, "eventType": { "$ref": "#/definitions/EventType" }, "createdBy": { "$ref": "#/definitions/StringConstant" }, "label": { "$ref": "#/definitions/StringConstant" }, "property": { "$ref": "#/definitions/Property" }, "and": { "type": "array", "items": { "$ref": "#/definitions/ComputeEventQuery" } }, "or": { "type": "array", "items": { "$ref": "#/definitions/ComputeEventQuery" } }, "not": { "$ref": "#/definitions/ComputeEventQuery" }, "workspace": { "$ref": "#/definitions/StringConstant" }, "procedure": { "$ref": "#/definitions/StringConstant" }, "procedureExecution": { "$ref": "#/definitions/StringConstant" }, "stepId": { "$ref": "#/definitions/StringConstant" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "searchText", "searchText": { "type": "literal", "literal": "string" } } }, "EventDispositionStatus": { "type": "string", "enum": [ "PENDING_REVIEW", "CLOSED_IGNORED", "CLOSED_REQUIRES_FURTHER_ACTION", "NO_DISPOSITION" ] }, "EventTimeFilter": { "type": "object", "properties": { "timestamp": { "$ref": "#/definitions/TimestampConstant" }, "timestampCondition": { "$ref": "#/definitions/EventTimeFilterCondition" } }, "required": [ "timestamp", "timestampCondition" ] }, "EventTimeFilterCondition": { "type": "string", "enum": [ "START_TIME_BEFORE_INCLUSIVE", "START_TIME_BEFORE_EXCLUSIVE", "START_TIME_AFTER_INCLUSIVE", "START_TIME_AFTER_EXCLUSIVE", "END_TIME_BEFORE_INCLUSIVE", "END_TIME_BEFORE_EXCLUSIVE", "END_TIME_AFTER_INCLUSIVE", "END_TIME_AFTER_EXCLUSIVE" ] }, "EventType": { "type": "string", "enum": [ "INFO", "FLAG", "ERROR", "SUCCESS" ] }, "LabelsFilter": { "type": "object", "properties": { "operator": { "$ref": "#/definitions/SetOperator" }, "labels": { "type": "array", "items": { "type": "string", "x-alias": "Label" } } }, "required": [ "operator" ] }, "PropertiesFilter": { "type": "object", "properties": { "name": { "type": "string", "x-alias": "PropertyName" }, "values": { "type": "array", "items": { "type": "string", "x-alias": "PropertyValue" } } }, "required": [ "name" ] }, "Property": { "type": "object", "properties": { "name": { "$ref": "#/definitions/StringConstant" }, "value": { "$ref": "#/definitions/StringConstant" } }, "required": [ "name", "value" ] }, "SearchEventOriginType": { "type": "string", "enum": [ "WORKBOOK", "TEMPLATE", "API", "DATA_REVIEW", "PROCEDURE" ] }, "run.api.Duration": { "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "nanos": { "type": "integer", "format": "int64" } }, "required": [ "seconds", "nanos" ] } }, "tags": [ { "name": "Compute Service", "x-displayName": "Compute service", "description": "The Compute Service provides the ability to compute the output of compute graphs.", "x-errors": [ { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:SpectrogramUnsupportedInput", "description": "The spectrogram input reads from more than one data source or uses an operation spectrograms do not support." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:SelectSeriesNameConflictsWithChannelFilter", "description": "A SelectSeries node provided both the `name` field and a NOMINAL_CHANNEL tag filter. Use the NOMINAL_CHANNEL filter alone to select channels." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:SelectSeriesResolvedNoChannels", "description": "A channel selection (channel name plus tag filters) resolved to zero dataset channels for the requested scope and time range, so the series has nothing to read. Verify the channel exists in the dataset and that the tag filters match at least one channel over the requested range." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:SelectPropertyMissingProperty", "description": "No resolved asset or run branch provides the selected property." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:SelectPropertyWrongType", "description": "A resolved branch has the selected property, but its typed variant differs from the numeric or string type required by the series node." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:DuplicateTimestamp" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:ResolutionIntervalTooSmallForRange" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:MissingVariable" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:MissingModuleVariable" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:MissingModuleFunction", "description": "The requested module function could not be found. This may be because the reference is incorrect or the function is unavailable in the current execution context." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:MissingFunctionParameter", "description": "The requested module function could not be executed because a required parameter was not provided." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:MissingModuleApplication", "description": "The requested module application could not be found. This may be because the reference is incorrect or the application is unavailable in the current execution context." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:VariableHasWrongType" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:UnknownBuiltinConstant" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:DerivedSeriesHasWrongType" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:ChannelHasWrongType" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidSeriesLocator" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidExpression" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidUdfSource", "description": "The Rust UDF source failed validation or compilation." }, { "status": 403, "errorCode": "PERMISSION_DENIED", "errorName": "Compute:NotAuthorized" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:SourceBlocked", "description": "Queries from this source are temporarily blocked." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:CannotAggregateEnumPlot" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:ComputationTooComplex", "description": "Computation too complex. Try reducing the number of channels, computations, or tags." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TooManyEvents", "description": "Number of events is greater than the max allowed (1000)." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TooManySearchResults", "description": "Asset or run search returned more matches than a single page allows. Refine the query or raise maxResults for the search frame so all matches fit in one page." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TooManyPoints", "description": "The number of points returned is greater than the max allowed. Try again with a smaller time range, or a larger resolution." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TooManyRanges", "description": "Ranges is greater than the max allowed (2000)." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TooManySubrequests", "description": "Number of parameterized subrequests is greater than the max allowed (300)." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TooManyCategories", "description": "An enum series has more categories than the max allowed." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TooManyBuckets", "description": "The number of buckets returned is greater than the max allowed (1000). Try again by specifying a larger bucket width or fewer bucket counts." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TooManyFrequencyBins", "description": "The number of one-sided frequency bins exceeds the maximum allowed. Reduce nfft in transform settings to produce fewer bins." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:NonPositiveDuration", "description": "Duration must be strictly positive." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:NonPositiveResampleInterval", "description": "The resample interval must be strictly positive." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TooManyResamplePoints", "description": "The resample interval is too short and would produce more than the max points (10,000,000). Try again by specifying a larger interval." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:ResampleDefaultValueTypeMismatchesSeriesType", "description": "The default value provided for resampling does not match the type of the series being resampled." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidPlotType" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:FrequencyDomainWindowTooLarge", "description": "The selected window for the frequency domain is too large. Try again with a smaller time range." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:FrequencyDomainWindowEmpty", "description": "The selected window for the frequency domain is empty. Try again with a larger time range." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:FrequencyDomainNotEnoughData", "description": "Not enough data points to estimate a sampling frequency for frequency-domain analysis. Try again with a larger time range." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:UnequalInputLength", "description": "The paired inputs for a calculation do not have the same length." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:SignalFilterInvalidOrder", "description": "Order must be positive even numbers for bidirectional filters. Bidirectional filters are applied once forwards and once backwards, effectively doubling order. Doubled again for bandpass/bandstop filters, requiring a multiple of 4 for filter order." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:SignalFilterNotEnoughData", "description": "Not enough data to apply the filter. Required data scales with filter order. Try again with a larger time range." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:SignalFilterInvalidCutoffBand", "description": "Lower band cutoff frequency must be less than or equal to upper band cutoff frequency." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:SignalFilterInvalidCutoffFrequency", "description": "Cutoff frequency must be less than half the sampling frequency." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:SignalFilterNonPositiveCutoffFrequency", "description": "Cutoff frequency must be strictly positive." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:GranularityMismatch", "description": "Some operations that require matching granularity did not have matching granularity." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "ExternalDatabase:ExternalDatabaseGatewayTimeout", "description": "A gateway timeout was encountered while trying to fetch data from the external database." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "ExternalDatabase:ExternalDatabaseRateLimitExceeded", "description": "The external database rate limit was exceeded." }, { "status": 500, "errorCode": "CUSTOM_SERVER", "errorName": "ExternalDatabase:ExternalDatabaseSocketTimeout", "description": "A socket timeout was encountered while trying to fetch data from the external database." }, { "status": 500, "errorCode": "CUSTOM_SERVER", "errorName": "ExternalDatabase:ExternalDatabaseBadGateway", "description": "A bad gateway result was encountered while trying to fetch data from the external database." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:QueryRangeTooLarge", "description": "The requested time range is too large. Try again with a smaller time range." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:ConverterInputUnitNotFound", "description": "A unit could not be found for the input series, or it did not exist in the unit system. The conversion could not be computed." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:ConverterOutputUnitNotFound", "description": "The output unit symbol could not be found in the unit system. The conversion could not be computed." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:UnitConversionInvalid", "description": "The unit conversion could not be computed because the input unit cannot be converted to the output unit." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidRangeNodeStartAfterViewRange", "description": "The compute node was given a starting timestamp after the end of the view range window." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:NotEnoughPointsForCurve", "description": "There were not enough points to fit the curve requested." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:CustomCurveMultipleTimeVariables", "description": "A custom curve fit may declare at most one time variable; there is only one sample-timestamp axis for the formula to refer to." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:CustomCurveFormulaMissingParameter", "description": "A custom curve fit declared a parameter (with an initial guess) that its formula never references. Every declared parameter must appear in the formula; otherwise it is an unconstrained degree of freedom for the solver. Remove the unused parameter or reference it in the formula." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:CustomCurveFormulaMissingVariable", "description": "A custom curve fit declared a variable that its formula never references. The unused variable's series would be fetched and aligned for nothing, so it almost certainly indicates a mistake in the formula. Remove the unused variable or reference it in the formula." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:CurveUnequalInputLength", "description": "The x and y inputs to fit a curve to do not have the same length." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:CurveInvalidNegativeInputs", "description": "Some points in the input had negative (or zero) x-values. Power and logarithmic curve fits do not allow negative (or zero) x-valued points." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:ExponentialCurveInputTooLarge", "description": "Due to limits in how numbers are represented by computers, exponential fits cannot be performed on data with x-values that are too large (> 650). This includes timestamp data based on the Time Unit parameter to the curve fit - e.g. 1 second at millisecond scale is too large, as it is 1000 milliseconds." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TooManyLiterals", "description": "Too many literals provided in a literal node." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidLiteralRange", "description": "The starting timestamp of a range cannot be greater than or equal to the end timestamp. At least one of start and end timestamps must be present. Only the first range when sorted may omit the start, and only the last may omit the end." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:OverlappingLiteralRanges", "description": "Ranges cannot overlap. Only the first range when sorted may omit the start, and only the last may omit the end." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:RowLimitExceeded", "description": "The query exceeded that limit for number of rows returned. For the query to complete, either zoom in or downsample." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:MaxQuerySizeExceeded", "description": "The maximum query size was exceeded." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:CannotCompileRegexp", "description": "The regular expression could not be compiled." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TimeoutExceeded", "description": "The query timed out. Try querying a smaller time range or fewer series." }, { "status": 500, "errorCode": "INTERNAL", "errorName": "Compute:UnexpectedTimeout", "description": "An unexpected timeout occurred when executing a query. This indicates an internal error where the query may have succeeded but the response did not reach the client." }, { "status": 500, "errorCode": "INTERNAL", "errorName": "Compute:ComputeBackendUnavailable", "description": "The compute backend was temporarily unavailable before the query could be submitted. Retry the request after a short delay." }, { "status": 500, "errorCode": "INTERNAL", "errorName": "Compute:ConcurrentQueriesExceeded", "description": "There are too many concurrent queries running." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:MemoryLimitExceeded", "description": "The query exceeded the memory limit. Try querying a smaller time range or fewer series." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:S3ObjectStorageRateLimited", "description": "S3 rejected the request with a TooManyRequests error. Try again with a smaller time range, fewer series, or after a short wait." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:ServerOverloaded", "description": "The query was rejected because the compute backend is temporarily overloaded. This is a transient, load-shedding response that protects overall availability; the query itself is valid. Callers do not receive this error directly: the read path wraps it in a QoS unavailable response (503), so standard classic REST clients back off and retry automatically. The error type is retained as the 503's cause for server-side logging and query_log correlation via queryId." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:RequestCancelled", "description": "The compute request was cancelled by the user." }, { "status": 500, "errorCode": "INTERNAL", "errorName": "Compute:UdfNotRegistered", "description": "A native user-defined function was not registered on the when the query executed. This indicates an internal failure rather than invalid user input." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:UdfExecutionLimitExceeded", "description": "A user-defined function exceeded its per-query execution limit while processing this query. Try querying a smaller time range, increasing the aggregation bucket size to reduce the number of UDF invocations, or simplifying the function's per-row logic." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:UdfMemoryLimitExceeded", "description": "A user-defined function exceeded its per-invocation memory limit." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:UdfRuntimeError", "description": "A user-defined function panicked or aborted at runtime." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidValueMap", "description": "Range end must be greater than range start. Range start may only be undefined if in the first range, or the prior end is defined and less. Range end may only be undefined if in the last range, or the next start is defined and greater. Ranges must be in increasing order." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TooManyValueMapRanges", "description": "A value map series contains too many range mappings." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:GroupBysNotSupportedForQuery", "description": "Group by queries are not supported for the compute node supplied" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidTimeUnit", "description": "The time unit associated with the series is incompatible with the current transform." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidTagFilterConfiguration", "description": "Invalid tag filter configuration was provided." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:GroupByMissingTag", "description": "Attempted to group by a tag that does not exist." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:GroupByTagsNotSubset", "description": "Group by tags must be equal, or one set must be a subset of the other." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:SelectTagsNotSubset", "description": "Select tags keys must be a subset of the tags available on the input series." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidNumericOutputFields", "description": "Numeric output fields can only be specified on Arrow format numeric series requests. At least one field must be specified." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidNumericAggregations", "description": "Numeric aggregations can only be specified on numeric series requests." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidBitOperation", "description": "The bit operation is invalid due to the index or operand being out of range. Valid range - [0, 63]." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:RequestedRowsLimitExceeded", "description": "The maximum number of points that can be returned is 10,000." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TruncationNotSupportedForSeriesType", "description": "The requested series type does not support truncation for this compute request." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:UnsupportedRefpropProperty", "description": "The specified REFPROP property is not supported or not available in the current configuration." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:UnsupportedRefpropSubstance", "description": "The specified REFPROP substance is not supported or not available in the current configuration." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidRefpropInputCount", "description": "REFPROP requires exactly two input series." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:RefpropOutputPropertyIsInput", "description": "The output property cannot be one of the input properties for REFPROP." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:RefpropInputTooLarge", "description": "The number of points in the REFPROP inputs is too large." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:InvalidFieldName", "description": "Struct field names cannot contain '.'" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:EmptyInput", "description": "At least one input must be provided." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:EmptyPath", "description": "Specified path cannot be empty." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:EmptySet", "description": "The provided set must contain at least one element." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:MisalignedScatterPoints", "description": "No scatter points could be aligned for plotting. This typically means the input series do not have overlapping timestamps within the configured interpolation window." }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "Compute:TooFewInputs", "description": "The operation requires more input series than were provided." } ] } ] }