{ "swagger": "2.0", "info": { "title": "Channel search 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": { "/channels/v1/delimiters": { "post": { "operationId": "ChannelSearchService_getLocatorDelimiters", "summary": "Get locator delimiters", "tags": [ "Channel Search Service" ], "description": "Returns the expanded locator topology for a dataset plus per-locator delimiter info.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/GetLocatorDelimitersRequest" }, "required": true, "x-example": { "scope": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } }, "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 }, "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetLocatorDelimitersResponse" }, "x-example": { "locators": [ { "locator": { "assetRid": "", "runRid": "", "dataScope": "", "dataSourceRid": "", "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } }, "injectedTags": { "": "" } }, "delimiter": "" } ] } } } } }, "/channels/v1/browse": { "post": { "operationId": "ChannelSearchService_listChannelChildren", "summary": "List channel children", "tags": [ "Channel Search Service" ], "description": "Lazy one-level hierarchical expansion under `parent`. Returns a mix of leaf channels and prefix nodes, each labelled with the set of locators where they exist.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/ListChannelChildrenRequest" }, "required": true, "x-example": { "scope": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } }, "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 }, "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ListChannelChildrenResponse" }, "x-example": { "allExpandedLocators": [ { "assetRid": "", "runRid": "", "dataScope": "", "dataSourceRid": "", "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } }, "injectedTags": { "": "" } } ], "entries": [ { "type": "channel", "channel": { "name": "", "kind": "CHANNEL", "locatorMetadata": [ { "locator": { "assetRid": "", "runRid": "", "dataScope": "", "dataSourceRid": "", "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } }, "injectedTags": { "": "" } }, "unit": "", "description": "", "dataType": "DOUBLE", "seriesId": { "type": "seriesArchetype", "seriesArchetype": "" }, "value": { "type": "stringValue", "stringValue": "" }, "channelKind": "STANDARD" } ] } } ] } } } } }, "/channels/v1/search": { "post": { "operationId": "ChannelSearchService_searchChannels", "summary": "Search channels", "tags": [ "Channel Search Service" ], "description": "Flat text search across the dataset. Returns matching channels (and properties when `includeProperties` is true), each labelled with the set of locators in which they exist.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/SearchChannelsRequest" }, "required": true, "x-example": { "scope": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } }, "query": { "type": "substring", "substring": "" }, "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 }, "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/SearchChannelsResponse" }, "x-example": { "allExpandedLocators": [ { "assetRid": "", "runRid": "", "dataScope": "", "dataSourceRid": "", "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } }, "injectedTags": { "": "" } } ], "results": [ { "name": "", "kind": "CHANNEL", "locatorMetadata": [ { "locator": { "assetRid": "", "runRid": "", "dataScope": "", "dataSourceRid": "", "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } }, "injectedTags": { "": "" } }, "unit": "", "description": "", "dataType": "DOUBLE", "seriesId": { "type": "seriesArchetype", "seriesArchetype": "" }, "value": { "type": "stringValue", "stringValue": "" }, "channelKind": "STANDARD" } ] } ] } } } } }, "/channels/v1/delimiters/batch": { "post": { "operationId": "ChannelSearchService_batchGetLocatorDelimiters", "summary": "Batch get locator delimiters", "tags": [ "Channel Search Service" ], "description": "Batched form of `getLocatorDelimiters`.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/BatchGetLocatorDelimitersRequest" }, "required": true, "x-example": { "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchGetLocatorDelimitersResponse" }, "x-example": { "locators": [ { "locator": { "locator": { "assetRid": "", "runRid": "", "dataScope": "", "dataSourceRid": "", "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } }, "injectedTags": { "": "" } }, "requestIds": [ "" ] }, "delimiter": "" } ] } } } } }, "/channels/v1/search/batch": { "post": { "operationId": "ChannelSearchService_batchSearchChannels", "summary": "Batch search channels", "tags": [ "Channel Search Service" ], "description": "Batched form of `searchChannels`. The channel search is performed across the union of all entry scopes and so is the limit and top-n selection by relevance.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/BatchSearchChannelsRequest" }, "required": true, "x-example": { "query": { "type": "substring", "substring": "" }, "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchSearchChannelsResponse" }, "x-example": { "allExpandedLocators": [ { "locator": { "assetRid": "", "runRid": "", "dataScope": "", "dataSourceRid": "", "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } }, "injectedTags": { "": "" } }, "requestIds": [ "" ] } ], "results": [ { "name": "", "kind": "CHANNEL", "locatorMetadata": [ { "locator": { "locator": { "assetRid": "", "runRid": "", "dataScope": "", "dataSourceRid": "", "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } }, "injectedTags": { "": "" } }, "requestIds": [ "" ] }, "unit": "", "description": "", "dataType": "DOUBLE", "seriesId": { "type": "seriesArchetype", "seriesArchetype": "" }, "value": { "type": "stringValue", "stringValue": "" }, "channelKind": "STANDARD" } ] } ] } } } } }, "/channels/v1/browse/batch": { "post": { "operationId": "ChannelSearchService_batchListChannelChildren", "summary": "Batch list channel children", "tags": [ "Channel Search Service" ], "description": "Batched form of `listChannelChildren`. The hierarchical expansion is performed across the union of all entry scopes for the shared `parent` path.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/BatchListChannelChildrenRequest" }, "required": true, "x-example": { "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchListChannelChildrenResponse" }, "x-example": { "allExpandedLocators": [ { "locator": { "assetRid": "", "runRid": "", "dataScope": "", "dataSourceRid": "", "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } }, "injectedTags": { "": "" } }, "requestIds": [ "" ] } ], "entries": [ { "type": "channel", "channel": { "name": "", "kind": "CHANNEL", "locatorMetadata": [ { "locator": { "locator": { "assetRid": "", "runRid": "", "dataScope": "", "dataSourceRid": "", "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } }, "injectedTags": { "": "" } }, "requestIds": [ "" ] }, "unit": "", "description": "", "dataType": "DOUBLE", "seriesId": { "type": "seriesArchetype", "seriesArchetype": "" }, "value": { "type": "stringValue", "stringValue": "" }, "channelKind": "STANDARD" } ] } } ] } } } } } }, "definitions": { "ChannelKind": { "description": "Classifies how a channel is used. COMMAND channels accept commands through the Command Service.", "type": "string", "enum": [ "STANDARD", "COMMAND" ] }, "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" ] }, "Range": { "description": "Deprecated for new APIs. Define an API-owned range with the endpoint semantics it needs instead.", "type": "object", "properties": { "start": { "$ref": "#/definitions/Timestamp" }, "end": { "$ref": "#/definitions/Timestamp" } }, "required": [ "start", "end" ] }, "SeriesDataType": { "description": "The data types that are available for querying.", "type": "string", "enum": [ "DOUBLE", "STRING", "LOG", "INT", "UINT", "DOUBLE_ARRAY", "STRING_ARRAY", "STRUCT", "VIDEO", "SPATIAL" ] }, "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" ] }, "TypedPropertyValue": { "description": "Typed metadata value. Additional variants may be added as property types expand.\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", "numericValue" ] }, "stringValue": { "type": "string", "x-alias": "PropertyValue" }, "numericValue": { "type": "number", "format": "double" } }, "required": [ "type" ], "example": { "type": "stringValue", "stringValue": "string" } }, "SeriesMetadataRidOrLogicalSeriesRid": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "seriesArchetype", "logicalSeries" ] }, "seriesArchetype": { "type": "string", "format": "rid", "x-alias": "SeriesMetadataRid" }, "logicalSeries": { "type": "string", "format": "rid", "x-alias": "LogicalSeriesRid" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "seriesArchetype", "seriesArchetype": "string" } }, "BatchGetLocatorDelimitersEntry": { "type": "object", "properties": { "scope": { "$ref": "#/definitions/Dataset" }, "context": { "$ref": "#/definitions/Context" } }, "required": [ "scope", "context" ] }, "BatchGetLocatorDelimitersRequest": { "description": "Batched form of `getLocatorDelimiters`. The map key of `requests` can be an arbitrary string identifier. It will be returned in the response as part of `BatchedLocatorWithDelimiter`.", "type": "object", "properties": { "requests": { "type": "object", "additionalProperties": { "$ref": "#/definitions/BatchGetLocatorDelimitersEntry" } }, "timeRange": { "$ref": "#/definitions/Range" } }, "required": [ "timeRange" ], "example": { "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } } } }, "BatchGetLocatorDelimitersResponse": { "type": "object", "properties": { "locators": { "type": "array", "items": { "$ref": "#/definitions/BatchedLocatorWithDelimiter" } } } }, "BatchListChannelChildrenEntry": { "type": "object", "properties": { "scope": { "$ref": "#/definitions/Dataset" }, "context": { "$ref": "#/definitions/Context" } }, "required": [ "scope", "context" ] }, "BatchListChannelChildrenRequest": { "description": "Batched form of `listChannelChildren`. The map key of `requests` can be an arbitrary string identifier. It will be returned in the response as part of `BatchedLocator`.", "type": "object", "properties": { "requests": { "type": "object", "additionalProperties": { "$ref": "#/definitions/BatchListChannelChildrenEntry" } }, "parent": { "type": "array", "items": { "type": "string" }, "description": "Ancestor parts. Empty means top-level. Applied identically to every entry's scope." }, "timeRange": { "allOf": [ { "$ref": "#/definitions/Range" } ], "description": "Time filter applied to the search. Only channels with data within this time range will be returned. A shorter time range will improve performance!" } }, "required": [ "timeRange" ], "example": { "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } } } }, "BatchListChannelChildrenResponse": { "type": "object", "properties": { "allExpandedLocators": { "type": "array", "items": { "$ref": "#/definitions/BatchedLocator" }, "uniqueItems": true, "description": "All locators expanded from the union of entry scopes in the batch, independent of which channels exist within them." }, "entries": { "type": "array", "items": { "$ref": "#/definitions/BatchedChannelChildEntry" }, "description": "Mix of channel leaves and prefix nodes, one entry per distinct (channel name | prefix part) collapsed across locators across all entries." } } }, "BatchSearchChannelsEntry": { "type": "object", "properties": { "scope": { "$ref": "#/definitions/Dataset" }, "context": { "$ref": "#/definitions/Context" } }, "required": [ "scope", "context" ] }, "BatchSearchChannelsRequest": { "description": "Batched form of `searchChannels`. The map key of `requests` can be an arbitrary string identifier. It will be returned in the response as part of `BatchedLocator`.", "type": "object", "properties": { "requests": { "type": "object", "additionalProperties": { "$ref": "#/definitions/BatchSearchChannelsEntry" } }, "query": { "$ref": "#/definitions/ChannelSearchQuery" }, "timeRange": { "allOf": [ { "$ref": "#/definitions/Range" } ], "description": "Time filter applied to the search. Only channels with data within this time range will be returned. A shorter time range will improve performance!" }, "maxResultChannels": { "type": "integer", "format": "int32", "description": "Global cap on the merged channel result list. Defaults to 1000. Capped at 1000." }, "allowedDataTypes": { "type": "array", "items": { "$ref": "#/definitions/SeriesDataType" }, "uniqueItems": true, "description": "Filter to only channels with these data types, applied before the result cap so a large scope of other-typed channels cannot crowd the requested types out of the response. An empty set means no filtering (all data types included). Matching follows API presentation: a DOUBLE filter also matches channels stored as INT or UINT, which are returned with dataType=DOUBLE." }, "includeProperties": { "type": "boolean", "description": "When true, asset and run properties from resolved branches are included in the ranked results as Kind.PROPERTY rows. Defaults to false so existing clients keep seeing only channels." } }, "required": [ "query", "timeRange" ], "example": { "query": { "type": "substring", "substring": "" }, "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } } } }, "BatchSearchChannelsResponse": { "type": "object", "properties": { "allExpandedLocators": { "type": "array", "items": { "$ref": "#/definitions/BatchedLocator" }, "uniqueItems": true, "description": "All locators expanded from the union of entry scopes in the batch, independent of which channels exist within them." }, "results": { "type": "array", "items": { "$ref": "#/definitions/BatchedChannelEntry" }, "description": "Channels matching the shared query, ordered by relevance from the underlying search: for fuzzy queries, exact matches first, then channels containing the query text, then other matches, with each tier ordered by descending similarity score; for substring queries, by earliest match position; for subsequence queries, exact matches first, then channels containing the query text ordered by earliest match position, then remaining subsequence matches. Ties are broken by natural (numeric-aware) channel name order. Each entry's `locatorMetadata` covers all locators across all entries where the channel exists; locators are tagged with the set of entry ids that expanded to them. When `includeProperties` is true, matching asset/run properties are included as Kind.PROPERTY rows. A channel and a property that share a name are returned as two rows distinguished by `kind`." } } }, "BatchedChannelChildEntry": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "channel", "prefix" ] }, "channel": { "$ref": "#/definitions/BatchedChannelEntry" }, "prefix": { "$ref": "#/definitions/BatchedPrefixEntry" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "channel", "channel": { "name": "string", "kind": "CHANNEL", "locatorMetadata": [ { "locator": { "locator": { "assetRid": "string", "runRid": "string", "dataScope": "string", "dataSourceRid": "string", "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } }, "injectedTags": { "key": "string" } }, "requestIds": [ "string" ] }, "unit": "string", "description": "string", "dataType": "DOUBLE", "seriesId": { "type": "seriesArchetype", "seriesArchetype": "string" }, "value": { "type": "stringValue", "stringValue": "string" }, "channelKind": "STANDARD" } ] } } }, "BatchedChannelEntry": { "description": "A channel or asset/run property (by name) found in one or more locators across the batch. `locatorMetadata` has one entry per locator the name exists in. For Kind.PROPERTY rows, `name` is the property name.", "type": "object", "properties": { "name": { "type": "string", "x-alias": "Channel" }, "kind": { "$ref": "#/definitions/Kind" }, "locatorMetadata": { "type": "array", "items": { "$ref": "#/definitions/BatchedLocatorChannelMetadata" }, "uniqueItems": true } }, "required": [ "name", "kind" ] }, "BatchedLocator": { "description": "A `Locator` annotated with the set of request ids whose batched-request scope expanded to it.", "type": "object", "properties": { "locator": { "$ref": "#/definitions/Locator" }, "requestIds": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } }, "required": [ "locator" ] }, "BatchedLocatorChannelMetadata": { "description": "Per-locator channel metadata for batched responses. Same shape as `LocatorChannelMetadata` but with the locator wrapped to carry request-id provenance.", "type": "object", "properties": { "locator": { "allOf": [ { "$ref": "#/definitions/BatchedLocator" } ], "description": "Absent for an ephemeral (compute-defined) channel that has no stored series to point at — an unsaved `withSeries` in the request scope. Present for stored and derived-dataset channels." }, "unit": { "type": "string", "x-alias": "Unit" }, "description": { "type": "string" }, "dataType": { "$ref": "#/definitions/SeriesDataType" }, "seriesId": { "allOf": [ { "$ref": "#/definitions/SeriesMetadataRidOrLogicalSeriesRid" } ], "description": "Absent for derived channels." }, "value": { "allOf": [ { "$ref": "#/definitions/TypedPropertyValue" } ], "description": "Typed property value at this locator. Present for Kind.PROPERTY rows; absent for channels. The same property name can have different values across locators." }, "channelKind": { "allOf": [ { "$ref": "#/definitions/ChannelKind" } ], "description": "Whether the channel accepts commands. Absent for derived channels and property rows, which have no stored series metadata to carry a kind." } } }, "BatchedLocatorWithDelimiter": { "type": "object", "properties": { "locator": { "$ref": "#/definitions/BatchedLocator" }, "delimiter": { "type": "string", "description": "Absent when the locator's data source has no indexed prefix tree (callers should fall back to flat search for those locators)." } }, "required": [ "locator" ] }, "BatchedPrefixEntry": { "description": "A prefix node collapsed across locators in the batch. `presentAtLocators` lists the locators where this prefix exists, each tagged with the set of entry ids whose scope expanded to that locator.", "type": "object", "properties": { "part": { "type": "string" }, "presentAtLocators": { "type": "array", "items": { "$ref": "#/definitions/BatchedLocator" }, "uniqueItems": true } }, "required": [ "part" ] }, "ChannelChildEntry": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "channel", "prefix" ] }, "channel": { "$ref": "#/definitions/ChannelEntry" }, "prefix": { "$ref": "#/definitions/PrefixEntry" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "channel", "channel": { "name": "string", "kind": "CHANNEL", "locatorMetadata": [ { "locator": { "assetRid": "string", "runRid": "string", "dataScope": "string", "dataSourceRid": "string", "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } }, "injectedTags": { "key": "string" } }, "unit": "string", "description": "string", "dataType": "DOUBLE", "seriesId": { "type": "seriesArchetype", "seriesArchetype": "string" }, "value": { "type": "stringValue", "stringValue": "string" }, "channelKind": "STANDARD" } ] } } }, "ChannelEntry": { "description": "A channel or asset/run property (by name) found in one or more locators of the dataset. `locatorMetadata` has one entry per locator the name exists in; locators not represented here are ones where it does not exist. For Kind.PROPERTY rows, `name` is the property name.", "type": "object", "properties": { "name": { "type": "string", "x-alias": "Channel" }, "kind": { "$ref": "#/definitions/Kind" }, "locatorMetadata": { "type": "array", "items": { "$ref": "#/definitions/LocatorChannelMetadata" }, "uniqueItems": true } }, "required": [ "name", "kind" ] }, "ChannelSearchQuery": { "description": "Text search strategy.\n - substring: all characters, including whitespace, must appear contiguously (case-insensitive).\n - subsequence: characters must appear in order, not necessarily adjacent; whitespace is ignored.\n - fuzzy: similarity-based match where whitespace contributes to the score.\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": [ "substring", "subsequence", "fuzzy" ] }, "substring": { "type": "string" }, "subsequence": { "type": "string" }, "fuzzy": { "type": "string" } }, "required": [ "type" ], "example": { "type": "substring", "substring": "string" } }, "GetLocatorDelimitersRequest": { "description": "Returns the expanded locators of a dataset plus per-locator delimiter (if that locator's data source has an indexed prefix tree).", "type": "object", "properties": { "scope": { "$ref": "#/definitions/Dataset" }, "context": { "$ref": "#/definitions/Context" }, "timeRange": { "$ref": "#/definitions/Range" } }, "required": [ "scope", "context", "timeRange" ], "example": { "scope": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } }, "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 }, "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } } } }, "GetLocatorDelimitersResponse": { "type": "object", "properties": { "locators": { "type": "array", "items": { "$ref": "#/definitions/LocatorWithDelimiter" } } } }, "Kind": { "description": "Distinguishes a stored or derived channel from an asset/run property surfaced in channel search.", "type": "string", "enum": [ "CHANNEL", "PROPERTY" ] }, "ListChannelChildrenRequest": { "description": "Lazy one-level expansion of the dataset's channel namespace under `parent`. For the root, pass an empty list.", "type": "object", "properties": { "scope": { "$ref": "#/definitions/Dataset" }, "parent": { "type": "array", "items": { "type": "string" }, "description": "Ancestor parts. Empty means top-level." }, "context": { "$ref": "#/definitions/Context" }, "timeRange": { "allOf": [ { "$ref": "#/definitions/Range" } ], "description": "Time filter applied to the search. Only channels with data within this time range will be returned. A shorter time range will improve performance!" } }, "required": [ "scope", "context", "timeRange" ], "example": { "scope": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } }, "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 }, "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } } } }, "ListChannelChildrenResponse": { "type": "object", "properties": { "allExpandedLocators": { "type": "array", "items": { "$ref": "#/definitions/Locator" }, "uniqueItems": true, "description": "All locators expanded from the request scope, independent of which channels exist within them. Useful for callers that need to know the complete locator topology (e.g. to render empty locators in a tree view) even when no matching channel was found in some of them." }, "entries": { "type": "array", "items": { "$ref": "#/definitions/ChannelChildEntry" }, "description": "Mix of channel leaves and prefix nodes, one entry per distinct (channel name | prefix part) collapsed across locators." } } }, "Locator": { "description": "One expanded leaf of the dataset. Semantic fields (assetRid, runRid, dataScope) carry the branch context from dataset expansion.", "type": "object", "properties": { "assetRid": { "type": "string", "format": "rid", "x-alias": "AssetRid" }, "runRid": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "dataScope": { "type": "string" }, "dataSourceRid": { "type": "string", "format": "rid", "x-alias": "DataSourceRid" }, "timeRange": { "allOf": [ { "$ref": "#/definitions/Range" } ], "description": "Effective source time range used for this expanded locator. This can differ from the request time range when the dataset includes transforms such as `Dataset.timeShift`." }, "injectedTags": { "type": "object", "additionalProperties": { "type": "string", "x-alias": "TagValue" }, "x-map-key": "TagName", "description": "Dataset-injected tags accumulated along this branch's resolution path. This includes reserved branch tags such as ASSET_RID, RUN_RID, and DATA_SCOPE, data-scope series tags, and explicit TaggedDataset pairs." } }, "required": [ "dataSourceRid" ] }, "LocatorChannelMetadata": { "description": "Metadata for a channel as it appears at one specific locator. Channels can have different metadata (seriesId, dataType, unit) across locators, so callers should treat each entry independently.", "type": "object", "properties": { "locator": { "allOf": [ { "$ref": "#/definitions/Locator" } ], "description": "Absent for an ephemeral (compute-defined) channel that has no stored series to point at — an unsaved `withSeries` in the request scope. Present for stored and derived-dataset channels." }, "unit": { "type": "string", "x-alias": "Unit" }, "description": { "type": "string" }, "dataType": { "$ref": "#/definitions/SeriesDataType" }, "seriesId": { "allOf": [ { "$ref": "#/definitions/SeriesMetadataRidOrLogicalSeriesRid" } ], "description": "Absent for derived channels." }, "value": { "allOf": [ { "$ref": "#/definitions/TypedPropertyValue" } ], "description": "Typed property value at this locator. Present for Kind.PROPERTY rows; absent for channels. The same property name can have different values across locators." }, "channelKind": { "allOf": [ { "$ref": "#/definitions/ChannelKind" } ], "description": "Whether the channel accepts commands. Absent for derived channels and property rows, which have no stored series metadata to carry a kind." } } }, "LocatorWithDelimiter": { "type": "object", "properties": { "locator": { "$ref": "#/definitions/Locator" }, "delimiter": { "type": "string", "description": "Absent when the locator's data source has no indexed prefix tree (callers should fall back to flat search for those locators)." } }, "required": [ "locator" ] }, "PrefixEntry": { "description": "A prefix node collapsed across locators. `presentAtLocators` lists the locators where this prefix exists.", "type": "object", "properties": { "part": { "type": "string" }, "presentAtLocators": { "type": "array", "items": { "$ref": "#/definitions/Locator" }, "uniqueItems": true } }, "required": [ "part" ] }, "SearchChannelsRequest": { "type": "object", "properties": { "scope": { "$ref": "#/definitions/Dataset" }, "query": { "$ref": "#/definitions/ChannelSearchQuery" }, "context": { "$ref": "#/definitions/Context" }, "timeRange": { "allOf": [ { "$ref": "#/definitions/Range" } ], "description": "Time filter applied to the search. Only channels with data within this time range will be returned. A shorter time range will improve performance!" }, "maxResultChannels": { "type": "integer", "format": "int32", "description": "Max number of distinct channels to return. Defaults to 200. Capped at 200." }, "allowedDataTypes": { "type": "array", "items": { "$ref": "#/definitions/SeriesDataType" }, "uniqueItems": true, "description": "Filter to only channels with these data types, applied before the result cap so a large scope of other-typed channels cannot crowd the requested types out of the response. An empty set means no filtering (all data types included). Matching follows API presentation: a DOUBLE filter also matches channels stored as INT or UINT, which are returned with dataType=DOUBLE." }, "includeProperties": { "type": "boolean", "description": "When true, asset and run properties from resolved branches are included in the ranked results as Kind.PROPERTY rows. Defaults to false so existing clients keep seeing only channels." } }, "required": [ "scope", "query", "context", "timeRange" ], "example": { "scope": { "type": "asset", "asset": { "rid": { "type": "literal", "literal": "" } } }, "query": { "type": "substring", "substring": "" }, "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 }, "timeRange": { "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 } } } }, "SearchChannelsResponse": { "type": "object", "properties": { "allExpandedLocators": { "type": "array", "items": { "$ref": "#/definitions/Locator" }, "uniqueItems": true, "description": "All locators expanded from the request scope, independent of which channels exist within them. Useful for callers that need to know the complete locator topology (e.g. to render empty locators in a tree view) even when no matching channel was found in some of them or if the channel only exists in a subset of locators." }, "results": { "type": "array", "items": { "$ref": "#/definitions/ChannelEntry" }, "description": "Channels matching the query (and properties when `includeProperties` is true), ordered by relevance from the underlying search: for fuzzy queries, exact matches first, then channels containing the query text, then other matches, with each tier ordered by descending similarity score; for substring queries, by earliest match position; for subsequence queries, exact matches first, then channels containing the query text ordered by earliest match position, then remaining subsequence matches. Ties are broken by natural (numeric-aware) channel name order. A channel and a property that share a name are returned as two rows distinguished by `kind`." } } }, "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": {} } }, "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" } ] } } } } }, "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" ] }, "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" ] }, "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": {} } } } }, "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" } }, "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." } } }, "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" } } } }, "ComputeNodeWithContext": { "type": "object", "properties": { "seriesNode": { "$ref": "#/definitions/ComputeNode" }, "context": { "$ref": "#/definitions/Context" } }, "required": [ "seriesNode", "context" ] }, "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": {} }, "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" ] }, "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 } } } } }, "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" ] }, "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" ] }, "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" } } } } }, "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": {} }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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": {} }, "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" ] }, "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": {} }, "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" } } }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "LogarithmicCurve": { "type": "object", "properties": {} }, "LowPassConfiguration": { "type": "object", "properties": { "cutoffFrequency": { "$ref": "#/definitions/DoubleConstant" } }, "required": [ "cutoffFrequency" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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." } } }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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": {} }, "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." } } }, "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" ] }, "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": {} } }, "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" ] }, "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" ] }, "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" ] }, "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)." } } }, "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." } } }, "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" ] }, "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": {} }, "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." } } }, "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" ] }, "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" ] }, "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 } } }, "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." } } }, "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" ] }, "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" ] }, "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 } } } }, "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": "Channel Search Service", "x-displayName": "Channel search service", "description": "Channel search over a `Dataset`, which can expand to multiple locators." } ] }