nominal-api 0.1025.0__py3-none-any.whl → 0.1060.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -548,57 +548,6 @@
548
548
  }
549
549
  } ],
550
550
  "unsafeArgs" : [ ]
551
- }, {
552
- "errorName" : {
553
- "name" : "FailedToCreateLogSet",
554
- "package" : "io.nominal.datasource.logset.api"
555
- },
556
- "namespace" : "LogSet",
557
- "code" : "INTERNAL",
558
- "safeArgs" : [ {
559
- "fieldName" : "message",
560
- "type" : {
561
- "type" : "primitive",
562
- "primitive" : "STRING"
563
- }
564
- } ],
565
- "unsafeArgs" : [ ]
566
- }, {
567
- "errorName" : {
568
- "name" : "LogSetAlreadyFinalized",
569
- "package" : "io.nominal.datasource.logset.api"
570
- },
571
- "namespace" : "LogSet",
572
- "code" : "INVALID_ARGUMENT",
573
- "safeArgs" : [ {
574
- "fieldName" : "rid",
575
- "type" : {
576
- "type" : "reference",
577
- "reference" : {
578
- "name" : "LogSetRid",
579
- "package" : "io.nominal.datasource.logset.api"
580
- }
581
- }
582
- } ],
583
- "unsafeArgs" : [ ]
584
- }, {
585
- "errorName" : {
586
- "name" : "LogSetNotFound",
587
- "package" : "io.nominal.datasource.logset.api"
588
- },
589
- "namespace" : "LogSet",
590
- "code" : "NOT_FOUND",
591
- "safeArgs" : [ {
592
- "fieldName" : "rid",
593
- "type" : {
594
- "type" : "reference",
595
- "reference" : {
596
- "name" : "LogSetRid",
597
- "package" : "io.nominal.datasource.logset.api"
598
- }
599
- }
600
- } ],
601
- "unsafeArgs" : [ ]
602
551
  }, {
603
552
  "errorName" : {
604
553
  "name" : "EventNotFound",
@@ -841,6 +790,15 @@
841
790
  "code" : "INTERNAL",
842
791
  "safeArgs" : [ ],
843
792
  "unsafeArgs" : [ ]
793
+ }, {
794
+ "errorName" : {
795
+ "name" : "FailedToDownloadFileUserError",
796
+ "package" : "io.nominal.ingest.api"
797
+ },
798
+ "namespace" : "IngestService",
799
+ "code" : "INVALID_ARGUMENT",
800
+ "safeArgs" : [ ],
801
+ "unsafeArgs" : [ ]
844
802
  }, {
845
803
  "errorName" : {
846
804
  "name" : "FrameCountTimestampsMismatch",
@@ -1079,6 +1037,15 @@
1079
1037
  }
1080
1038
  } ],
1081
1039
  "unsafeArgs" : [ ]
1040
+ }, {
1041
+ "errorName" : {
1042
+ "name" : "NullKey",
1043
+ "package" : "io.nominal.ingest.api"
1044
+ },
1045
+ "namespace" : "UploadService",
1046
+ "code" : "INVALID_ARGUMENT",
1047
+ "safeArgs" : [ ],
1048
+ "unsafeArgs" : [ ]
1082
1049
  }, {
1083
1050
  "errorName" : {
1084
1051
  "name" : "ParallelReingestIntoDatasetV1",
@@ -1550,6 +1517,25 @@
1550
1517
  }
1551
1518
  } ],
1552
1519
  "unsafeArgs" : [ ]
1520
+ }, {
1521
+ "errorName" : {
1522
+ "name" : "UnavailableResultConfiguration",
1523
+ "package" : "io.nominal.persistent.compute.api"
1524
+ },
1525
+ "docs" : "ResultConfiguration is incompatible with the requested compute.",
1526
+ "namespace" : "PersistentCompute",
1527
+ "code" : "INVALID_ARGUMENT",
1528
+ "safeArgs" : [ {
1529
+ "fieldName" : "reason",
1530
+ "type" : {
1531
+ "type" : "reference",
1532
+ "reference" : {
1533
+ "name" : "UnavailableResultConfigurationReason",
1534
+ "package" : "io.nominal.persistent.compute.api"
1535
+ }
1536
+ }
1537
+ } ],
1538
+ "unsafeArgs" : [ ]
1553
1539
  }, {
1554
1540
  "errorName" : {
1555
1541
  "name" : "UnsupportedGranularity",
@@ -1997,6 +1983,30 @@
1997
1983
  }
1998
1984
  } ],
1999
1985
  "unsafeArgs" : [ ]
1986
+ }, {
1987
+ "errorName" : {
1988
+ "name" : "VideoFileNotFound",
1989
+ "package" : "io.nominal.scout.catalog"
1990
+ },
1991
+ "namespace" : "Catalog",
1992
+ "code" : "NOT_FOUND",
1993
+ "safeArgs" : [ {
1994
+ "fieldName" : "videoFileRid",
1995
+ "type" : {
1996
+ "type" : "primitive",
1997
+ "primitive" : "RID"
1998
+ }
1999
+ }, {
2000
+ "fieldName" : "fileId",
2001
+ "type" : {
2002
+ "type" : "reference",
2003
+ "reference" : {
2004
+ "name" : "VideoFileId",
2005
+ "package" : "io.nominal.datasource"
2006
+ }
2007
+ }
2008
+ } ],
2009
+ "unsafeArgs" : [ ]
2000
2010
  }, {
2001
2011
  "errorName" : {
2002
2012
  "name" : "CheckNotAvailableInStreamingContext",
@@ -2461,6 +2471,16 @@
2461
2471
  "code" : "INVALID_ARGUMENT",
2462
2472
  "safeArgs" : [ ],
2463
2473
  "unsafeArgs" : [ ]
2474
+ }, {
2475
+ "errorName" : {
2476
+ "name" : "EmptySet",
2477
+ "package" : "io.nominal.scout.compute.api"
2478
+ },
2479
+ "docs" : "The provided set must contain at least one element.\n",
2480
+ "namespace" : "Compute",
2481
+ "code" : "INVALID_ARGUMENT",
2482
+ "safeArgs" : [ ],
2483
+ "unsafeArgs" : [ ]
2464
2484
  }, {
2465
2485
  "errorName" : {
2466
2486
  "name" : "ExponentialCurveInputTooLarge",
@@ -2549,6 +2569,16 @@
2549
2569
  "code" : "INVALID_ARGUMENT",
2550
2570
  "safeArgs" : [ ],
2551
2571
  "unsafeArgs" : [ ]
2572
+ }, {
2573
+ "errorName" : {
2574
+ "name" : "GroupByMissingTag",
2575
+ "package" : "io.nominal.scout.compute.api"
2576
+ },
2577
+ "docs" : "Attempted to group by a tag that does not exist.\n",
2578
+ "namespace" : "Compute",
2579
+ "code" : "INVALID_ARGUMENT",
2580
+ "safeArgs" : [ ],
2581
+ "unsafeArgs" : [ ]
2552
2582
  }, {
2553
2583
  "errorName" : {
2554
2584
  "name" : "GroupByTagsNotSubset",
@@ -3352,6 +3382,28 @@
3352
3382
  }
3353
3383
  } ],
3354
3384
  "unsafeArgs" : [ ]
3385
+ }, {
3386
+ "errorName" : {
3387
+ "name" : "TooFewInputs",
3388
+ "package" : "io.nominal.scout.compute.api"
3389
+ },
3390
+ "docs" : "The operation requires more input series than were provided.\n",
3391
+ "namespace" : "Compute",
3392
+ "code" : "INVALID_ARGUMENT",
3393
+ "safeArgs" : [ {
3394
+ "fieldName" : "requiredInputCount",
3395
+ "type" : {
3396
+ "type" : "primitive",
3397
+ "primitive" : "INTEGER"
3398
+ }
3399
+ }, {
3400
+ "fieldName" : "providedInputCount",
3401
+ "type" : {
3402
+ "type" : "primitive",
3403
+ "primitive" : "INTEGER"
3404
+ }
3405
+ } ],
3406
+ "unsafeArgs" : [ ]
3355
3407
  }, {
3356
3408
  "errorName" : {
3357
3409
  "name" : "TooManyBuckets",
@@ -3367,7 +3419,7 @@
3367
3419
  "name" : "TooManyCategories",
3368
3420
  "package" : "io.nominal.scout.compute.api"
3369
3421
  },
3370
- "docs" : "An enum series has more categories than the max allowed (200).",
3422
+ "docs" : "An enum series has more categories than the max allowed.",
3371
3423
  "namespace" : "Compute",
3372
3424
  "code" : "INVALID_ARGUMENT",
3373
3425
  "safeArgs" : [ {
@@ -3376,6 +3428,12 @@
3376
3428
  "type" : "primitive",
3377
3429
  "primitive" : "INTEGER"
3378
3430
  }
3431
+ }, {
3432
+ "fieldName" : "maxAllowed",
3433
+ "type" : {
3434
+ "type" : "primitive",
3435
+ "primitive" : "INTEGER"
3436
+ }
3379
3437
  } ],
3380
3438
  "unsafeArgs" : [ ]
3381
3439
  }, {
@@ -3444,6 +3502,22 @@
3444
3502
  "code" : "INVALID_ARGUMENT",
3445
3503
  "safeArgs" : [ ],
3446
3504
  "unsafeArgs" : [ ]
3505
+ }, {
3506
+ "errorName" : {
3507
+ "name" : "UnexpectedTimeout",
3508
+ "package" : "io.nominal.scout.compute.api"
3509
+ },
3510
+ "docs" : "An unexpected timeout occurred when executing a query. This indicates an internal error\nwhere the query may have succeeded but the response did not reach the client.\n",
3511
+ "namespace" : "Compute",
3512
+ "code" : "INVALID_ARGUMENT",
3513
+ "safeArgs" : [ {
3514
+ "fieldName" : "queryId",
3515
+ "type" : {
3516
+ "type" : "primitive",
3517
+ "primitive" : "UUID"
3518
+ }
3519
+ } ],
3520
+ "unsafeArgs" : [ ]
3447
3521
  }, {
3448
3522
  "errorName" : {
3449
3523
  "name" : "UnitConversionInvalid",
@@ -4294,6 +4368,15 @@
4294
4368
  "code" : "INVALID_ARGUMENT",
4295
4369
  "safeArgs" : [ ],
4296
4370
  "unsafeArgs" : [ ]
4371
+ }, {
4372
+ "errorName" : {
4373
+ "name" : "UnsupportedOperationForIntegration",
4374
+ "package" : "io.nominal.scout.integrations.api"
4375
+ },
4376
+ "namespace" : "Scout",
4377
+ "code" : "INVALID_ARGUMENT",
4378
+ "safeArgs" : [ ],
4379
+ "unsafeArgs" : [ ]
4297
4380
  }, {
4298
4381
  "errorName" : {
4299
4382
  "name" : "ArchiveNotebookFailed",
@@ -5354,6 +5437,22 @@
5354
5437
  }
5355
5438
  } ],
5356
5439
  "unsafeArgs" : [ ]
5440
+ }, {
5441
+ "errorName" : {
5442
+ "name" : "InvalidChannelSpecification",
5443
+ "package" : "io.nominal.scout.video.api"
5444
+ },
5445
+ "docs" : "Invalid channel specification (e.g., mutually exclusive parameters provided)",
5446
+ "namespace" : "Video",
5447
+ "code" : "INVALID_ARGUMENT",
5448
+ "safeArgs" : [ {
5449
+ "fieldName" : "message",
5450
+ "type" : {
5451
+ "type" : "primitive",
5452
+ "primitive" : "STRING"
5453
+ }
5454
+ } ],
5455
+ "unsafeArgs" : [ ]
5357
5456
  }, {
5358
5457
  "errorName" : {
5359
5458
  "name" : "InvalidFileShiftScaleRequest",
@@ -5408,6 +5507,112 @@
5408
5507
  }
5409
5508
  } ],
5410
5509
  "unsafeArgs" : [ ]
5510
+ }, {
5511
+ "errorName" : {
5512
+ "name" : "InvalidTags",
5513
+ "package" : "io.nominal.scout.video.api"
5514
+ },
5515
+ "docs" : "The provided tags parameter is not valid JSON",
5516
+ "namespace" : "Video",
5517
+ "code" : "INVALID_ARGUMENT",
5518
+ "safeArgs" : [ ],
5519
+ "unsafeArgs" : [ {
5520
+ "fieldName" : "tags",
5521
+ "type" : {
5522
+ "type" : "primitive",
5523
+ "primitive" : "STRING"
5524
+ }
5525
+ } ]
5526
+ }, {
5527
+ "errorName" : {
5528
+ "name" : "InvalidTimestamp",
5529
+ "package" : "io.nominal.scout.video.api"
5530
+ },
5531
+ "docs" : "The provided timestamp string is not in valid ISO-8601 format",
5532
+ "namespace" : "Video",
5533
+ "code" : "INVALID_ARGUMENT",
5534
+ "safeArgs" : [ {
5535
+ "fieldName" : "timestamp",
5536
+ "type" : {
5537
+ "type" : "primitive",
5538
+ "primitive" : "STRING"
5539
+ }
5540
+ } ],
5541
+ "unsafeArgs" : [ ]
5542
+ }, {
5543
+ "errorName" : {
5544
+ "name" : "MissingTimestampBoundPair",
5545
+ "package" : "io.nominal.scout.video.api"
5546
+ },
5547
+ "docs" : "Both start and end timestamp bounds must be provided together, or neither. Either provide both bounds or neither.",
5548
+ "namespace" : "Video",
5549
+ "code" : "INVALID_ARGUMENT",
5550
+ "safeArgs" : [ {
5551
+ "fieldName" : "hasStart",
5552
+ "type" : {
5553
+ "type" : "primitive",
5554
+ "primitive" : "BOOLEAN"
5555
+ }
5556
+ }, {
5557
+ "fieldName" : "hasEnd",
5558
+ "type" : {
5559
+ "type" : "primitive",
5560
+ "primitive" : "BOOLEAN"
5561
+ }
5562
+ } ],
5563
+ "unsafeArgs" : [ ]
5564
+ }, {
5565
+ "errorName" : {
5566
+ "name" : "NoSegmentsInBounds",
5567
+ "package" : "io.nominal.scout.video.api"
5568
+ },
5569
+ "docs" : "The requested time bounds do not overlap with any video segments.",
5570
+ "namespace" : "Video",
5571
+ "code" : "NOT_FOUND",
5572
+ "safeArgs" : [ {
5573
+ "fieldName" : "videoRid",
5574
+ "type" : {
5575
+ "type" : "reference",
5576
+ "reference" : {
5577
+ "name" : "VideoRid",
5578
+ "package" : "io.nominal.api.rids"
5579
+ }
5580
+ }
5581
+ }, {
5582
+ "fieldName" : "requestedBounds",
5583
+ "type" : {
5584
+ "type" : "reference",
5585
+ "reference" : {
5586
+ "name" : "Bounds",
5587
+ "package" : "io.nominal.scout.video.api"
5588
+ }
5589
+ }
5590
+ } ],
5591
+ "unsafeArgs" : [ ]
5592
+ }, {
5593
+ "errorName" : {
5594
+ "name" : "NotAuthorized",
5595
+ "package" : "io.nominal.scout.video.api"
5596
+ },
5597
+ "docs" : "User is not authorized to read data from the requested datasources.",
5598
+ "namespace" : "Video",
5599
+ "code" : "PERMISSION_DENIED",
5600
+ "safeArgs" : [ {
5601
+ "fieldName" : "dataSourceRids",
5602
+ "type" : {
5603
+ "type" : "set",
5604
+ "set" : {
5605
+ "itemType" : {
5606
+ "type" : "reference",
5607
+ "reference" : {
5608
+ "name" : "DataSourceRid",
5609
+ "package" : "io.nominal.api.rids"
5610
+ }
5611
+ }
5612
+ }
5613
+ }
5614
+ } ],
5615
+ "unsafeArgs" : [ ]
5411
5616
  }, {
5412
5617
  "errorName" : {
5413
5618
  "name" : "SegmentConflict",
@@ -5507,8 +5712,9 @@
5507
5712
  "name" : "VideoIngestNotComplete",
5508
5713
  "package" : "io.nominal.scout.video.api"
5509
5714
  },
5715
+ "docs" : "Video has no segments available. The video may still be processing or ingest has not started.",
5510
5716
  "namespace" : "Video",
5511
- "code" : "INVALID_ARGUMENT",
5717
+ "code" : "FAILED_PRECONDITION",
5512
5718
  "safeArgs" : [ {
5513
5719
  "fieldName" : "videoRid",
5514
5720
  "type" : {
@@ -6213,6 +6419,24 @@
6213
6419
  "value" : "VIDEO"
6214
6420
  } ]
6215
6421
  }
6422
+ }, {
6423
+ "type" : "object",
6424
+ "object" : {
6425
+ "typeName" : {
6426
+ "name" : "Deleted",
6427
+ "package" : "io.nominal.api"
6428
+ },
6429
+ "fields" : [ ]
6430
+ }
6431
+ }, {
6432
+ "type" : "object",
6433
+ "object" : {
6434
+ "typeName" : {
6435
+ "name" : "DeletionInProgress",
6436
+ "package" : "io.nominal.api"
6437
+ },
6438
+ "fields" : [ ]
6439
+ }
6216
6440
  }, {
6217
6441
  "type" : "object",
6218
6442
  "object" : {
@@ -6348,6 +6572,24 @@
6348
6572
  "package" : "io.nominal.api"
6349
6573
  }
6350
6574
  }
6575
+ }, {
6576
+ "fieldName" : "deletionInProgress",
6577
+ "type" : {
6578
+ "type" : "reference",
6579
+ "reference" : {
6580
+ "name" : "DeletionInProgress",
6581
+ "package" : "io.nominal.api"
6582
+ }
6583
+ }
6584
+ }, {
6585
+ "fieldName" : "deleted",
6586
+ "type" : {
6587
+ "type" : "reference",
6588
+ "reference" : {
6589
+ "name" : "Deleted",
6590
+ "package" : "io.nominal.api"
6591
+ }
6592
+ }
6351
6593
  } ]
6352
6594
  }
6353
6595
  }, {
@@ -7455,6 +7697,66 @@
7455
7697
  "value" : "DARK"
7456
7698
  } ]
7457
7699
  }
7700
+ }, {
7701
+ "type" : "enum",
7702
+ "enum" : {
7703
+ "typeName" : {
7704
+ "name" : "ChartTooltipModeSetting",
7705
+ "package" : "io.nominal.authentication.api"
7706
+ },
7707
+ "values" : [ {
7708
+ "value" : "VERBOSE"
7709
+ }, {
7710
+ "value" : "CONCISE"
7711
+ }, {
7712
+ "value" : "SINGLE"
7713
+ }, {
7714
+ "value" : "NONE"
7715
+ } ]
7716
+ }
7717
+ }, {
7718
+ "type" : "object",
7719
+ "object" : {
7720
+ "typeName" : {
7721
+ "name" : "CoachmarkDismissal",
7722
+ "package" : "io.nominal.authentication.api"
7723
+ },
7724
+ "fields" : [ {
7725
+ "fieldName" : "coachmarkId",
7726
+ "type" : {
7727
+ "type" : "primitive",
7728
+ "primitive" : "STRING"
7729
+ },
7730
+ "docs" : "The coachmark identifier (typically the feature flag name)"
7731
+ }, {
7732
+ "fieldName" : "dismissedAt",
7733
+ "type" : {
7734
+ "type" : "primitive",
7735
+ "primitive" : "DATETIME"
7736
+ },
7737
+ "docs" : "ISO 8601 timestamp of when the coachmark was dismissed"
7738
+ }, {
7739
+ "fieldName" : "appVersion",
7740
+ "type" : {
7741
+ "type" : "primitive",
7742
+ "primitive" : "STRING"
7743
+ },
7744
+ "docs" : "The apps-scout version (semver) when the coachmark was dismissed"
7745
+ }, {
7746
+ "fieldName" : "stepIndex",
7747
+ "type" : {
7748
+ "type" : "optional",
7749
+ "optional" : {
7750
+ "itemType" : {
7751
+ "type" : "primitive",
7752
+ "primitive" : "INTEGER"
7753
+ }
7754
+ }
7755
+ },
7756
+ "docs" : "The step index when dismissed (for multi-step coachmarks).\nIf not present, the coachmark was dismissed via the X button.\n"
7757
+ } ],
7758
+ "docs" : "A record of a coachmark dismissal, including when it was dismissed\nand on which app version.\n"
7759
+ }
7458
7760
  }, {
7459
7761
  "type" : "enum",
7460
7762
  "enum" : {
@@ -7470,6 +7772,42 @@
7470
7772
  "value" : "RELATIVE"
7471
7773
  } ]
7472
7774
  }
7775
+ }, {
7776
+ "type" : "object",
7777
+ "object" : {
7778
+ "typeName" : {
7779
+ "name" : "DismissCoachmarkRequest",
7780
+ "package" : "io.nominal.authentication.api"
7781
+ },
7782
+ "fields" : [ {
7783
+ "fieldName" : "coachmarkId",
7784
+ "type" : {
7785
+ "type" : "primitive",
7786
+ "primitive" : "STRING"
7787
+ },
7788
+ "docs" : "The coachmark identifier to dismiss"
7789
+ }, {
7790
+ "fieldName" : "appVersion",
7791
+ "type" : {
7792
+ "type" : "primitive",
7793
+ "primitive" : "STRING"
7794
+ },
7795
+ "docs" : "The apps-scout version (semver) when dismissing"
7796
+ }, {
7797
+ "fieldName" : "stepIndex",
7798
+ "type" : {
7799
+ "type" : "optional",
7800
+ "optional" : {
7801
+ "itemType" : {
7802
+ "type" : "primitive",
7803
+ "primitive" : "INTEGER"
7804
+ }
7805
+ }
7806
+ },
7807
+ "docs" : "The step index when dismissed (for multi-step coachmarks)"
7808
+ } ],
7809
+ "docs" : "Request to dismiss a coachmark"
7810
+ }
7473
7811
  }, {
7474
7812
  "type" : "object",
7475
7813
  "object" : {
@@ -7512,6 +7850,62 @@
7512
7850
  } ],
7513
7851
  "docs" : "Response containing the generated MediaMTX token"
7514
7852
  }
7853
+ }, {
7854
+ "type" : "object",
7855
+ "object" : {
7856
+ "typeName" : {
7857
+ "name" : "GetCoachmarkDismissalsRequest",
7858
+ "package" : "io.nominal.authentication.api"
7859
+ },
7860
+ "fields" : [ {
7861
+ "fieldName" : "coachmarkIds",
7862
+ "type" : {
7863
+ "type" : "optional",
7864
+ "optional" : {
7865
+ "itemType" : {
7866
+ "type" : "list",
7867
+ "list" : {
7868
+ "itemType" : {
7869
+ "type" : "primitive",
7870
+ "primitive" : "STRING"
7871
+ }
7872
+ }
7873
+ }
7874
+ }
7875
+ },
7876
+ "docs" : "Optional list of coachmark IDs to filter by.\nIf empty, returns all dismissals for the user.\n"
7877
+ } ],
7878
+ "docs" : "Request to get coachmark dismissals"
7879
+ }
7880
+ }, {
7881
+ "type" : "object",
7882
+ "object" : {
7883
+ "typeName" : {
7884
+ "name" : "GetCoachmarkDismissalsResponse",
7885
+ "package" : "io.nominal.authentication.api"
7886
+ },
7887
+ "fields" : [ {
7888
+ "fieldName" : "dismissals",
7889
+ "type" : {
7890
+ "type" : "map",
7891
+ "map" : {
7892
+ "keyType" : {
7893
+ "type" : "primitive",
7894
+ "primitive" : "STRING"
7895
+ },
7896
+ "valueType" : {
7897
+ "type" : "reference",
7898
+ "reference" : {
7899
+ "name" : "CoachmarkDismissal",
7900
+ "package" : "io.nominal.authentication.api"
7901
+ }
7902
+ }
7903
+ }
7904
+ },
7905
+ "docs" : "Map of coachmark ID to dismissal record"
7906
+ } ],
7907
+ "docs" : "Response containing coachmark dismissals"
7908
+ }
7515
7909
  }, {
7516
7910
  "type" : "object",
7517
7911
  "object" : {
@@ -7929,6 +8323,21 @@
7929
8323
  "primitive" : "BOOLEAN"
7930
8324
  }
7931
8325
  }
8326
+ },
8327
+ "deprecated" : "Use `chartHoverTooltipMode` instead. If `chartHoverTooltipMode` is not set, this field will be\nused: `true` as `SINGLE` and `false` as `VERBOSE`.\n"
8328
+ }, {
8329
+ "fieldName" : "chartHoverTooltipMode",
8330
+ "type" : {
8331
+ "type" : "optional",
8332
+ "optional" : {
8333
+ "itemType" : {
8334
+ "type" : "reference",
8335
+ "reference" : {
8336
+ "name" : "ChartTooltipModeSetting",
8337
+ "package" : "io.nominal.authentication.api"
8338
+ }
8339
+ }
8340
+ }
7932
8341
  }
7933
8342
  } ]
7934
8343
  }
@@ -8466,6 +8875,55 @@
8466
8875
  }
8467
8876
  } ]
8468
8877
  }
8878
+ }, {
8879
+ "type" : "object",
8880
+ "object" : {
8881
+ "typeName" : {
8882
+ "name" : "RefreshAccessTokenRequest",
8883
+ "package" : "io.nominal.authorization"
8884
+ },
8885
+ "fields" : [ {
8886
+ "fieldName" : "accessToken",
8887
+ "type" : {
8888
+ "type" : "primitive",
8889
+ "primitive" : "STRING"
8890
+ }
8891
+ } ],
8892
+ "docs" : "We accept an OIDC access token issued by a trusted identity provider to refresh a Nominal access token.\nThe access token is validated and exchanged for a Nominal access token. To be used in this endpoint,\nthe OIDC access token must contain an email claim.\n"
8893
+ }
8894
+ }, {
8895
+ "type" : "object",
8896
+ "object" : {
8897
+ "typeName" : {
8898
+ "name" : "RefreshAccessTokenResponse",
8899
+ "package" : "io.nominal.authorization"
8900
+ },
8901
+ "fields" : [ {
8902
+ "fieldName" : "accessToken",
8903
+ "type" : {
8904
+ "type" : "primitive",
8905
+ "primitive" : "STRING"
8906
+ }
8907
+ }, {
8908
+ "fieldName" : "expiresAtSeconds",
8909
+ "type" : {
8910
+ "type" : "primitive",
8911
+ "primitive" : "SAFELONG"
8912
+ }
8913
+ }, {
8914
+ "fieldName" : "userUuid",
8915
+ "type" : {
8916
+ "type" : "primitive",
8917
+ "primitive" : "UUID"
8918
+ }
8919
+ }, {
8920
+ "fieldName" : "orgUuid",
8921
+ "type" : {
8922
+ "type" : "primitive",
8923
+ "primitive" : "UUID"
8924
+ }
8925
+ } ]
8926
+ }
8469
8927
  }, {
8470
8928
  "type" : "object",
8471
8929
  "object" : {
@@ -8983,6 +9441,98 @@
8983
9441
  "value" : "ABSOLUTE"
8984
9442
  } ]
8985
9443
  }
9444
+ }, {
9445
+ "type" : "alias",
9446
+ "alias" : {
9447
+ "typeName" : {
9448
+ "name" : "VideoFileId",
9449
+ "package" : "io.nominal.datasource"
9450
+ },
9451
+ "alias" : {
9452
+ "type" : "primitive",
9453
+ "primitive" : "UUID"
9454
+ }
9455
+ }
9456
+ }, {
9457
+ "type" : "object",
9458
+ "object" : {
9459
+ "typeName" : {
9460
+ "name" : "VideoFileMetadata",
9461
+ "package" : "io.nominal.datasource"
9462
+ },
9463
+ "fields" : [ {
9464
+ "fieldName" : "timestampManifest",
9465
+ "type" : {
9466
+ "type" : "reference",
9467
+ "reference" : {
9468
+ "name" : "VideoFileTimestampManifest",
9469
+ "package" : "io.nominal.scout.video.api"
9470
+ }
9471
+ },
9472
+ "docs" : "Specifies how to determine absolute timestamps for each frame in the video.\nCan be an embedded MCAP manifest, an external sidecar file, or calculated\nfrom a starting offset applied to presentation timestamps.\n"
9473
+ }, {
9474
+ "fieldName" : "segmentMetadata",
9475
+ "type" : {
9476
+ "type" : "optional",
9477
+ "optional" : {
9478
+ "itemType" : {
9479
+ "type" : "reference",
9480
+ "reference" : {
9481
+ "name" : "VideoSegmentsMetadata",
9482
+ "package" : "io.nominal.datasource"
9483
+ }
9484
+ }
9485
+ }
9486
+ },
9487
+ "docs" : "Cached aggregate metadata about the segments comprising this video file\nafter segmentation has completed. Includes frame counts, duration, and\nframe rate. Empty until segmentation is complete.\nNote: Min/max timestamps are stored in DatasetFile.bounds field.\nRaw file size is stored in DatasetFile.fileSizeBytes.\n"
9488
+ } ],
9489
+ "docs" : "Metadata specific to video files.\n"
9490
+ }
9491
+ }, {
9492
+ "type" : "object",
9493
+ "object" : {
9494
+ "typeName" : {
9495
+ "name" : "VideoSegmentsMetadata",
9496
+ "package" : "io.nominal.datasource"
9497
+ },
9498
+ "fields" : [ {
9499
+ "fieldName" : "numFrames",
9500
+ "type" : {
9501
+ "type" : "primitive",
9502
+ "primitive" : "INTEGER"
9503
+ },
9504
+ "docs" : "Total number of frames across all segments."
9505
+ }, {
9506
+ "fieldName" : "numSegments",
9507
+ "type" : {
9508
+ "type" : "primitive",
9509
+ "primitive" : "INTEGER"
9510
+ },
9511
+ "docs" : "Number of segments the video was split into."
9512
+ }, {
9513
+ "fieldName" : "scaleFactor",
9514
+ "type" : {
9515
+ "type" : "primitive",
9516
+ "primitive" : "DOUBLE"
9517
+ },
9518
+ "docs" : "Scale factor applied to timestamps during segmentation."
9519
+ }, {
9520
+ "fieldName" : "mediaDurationSeconds",
9521
+ "type" : {
9522
+ "type" : "primitive",
9523
+ "primitive" : "DOUBLE"
9524
+ },
9525
+ "docs" : "Total duration of the video in seconds."
9526
+ }, {
9527
+ "fieldName" : "mediaFrameRate",
9528
+ "type" : {
9529
+ "type" : "primitive",
9530
+ "primitive" : "DOUBLE"
9531
+ },
9532
+ "docs" : "Average frame rate (FPS) calculated as total frames / duration."
9533
+ } ],
9534
+ "docs" : "Segment metadata for video files.\nLightweight version that excludes bounds and RID since those are stored elsewhere.\n"
9535
+ }
8986
9536
  }, {
8987
9537
  "type" : "object",
8988
9538
  "object" : {
@@ -10332,477 +10882,6 @@
10332
10882
  } ],
10333
10883
  "docs" : "Filters to use when searching for available tag names and values in paged endpoints.\nAll filters are optional.\n"
10334
10884
  }
10335
- }, {
10336
- "type" : "object",
10337
- "object" : {
10338
- "typeName" : {
10339
- "name" : "AttachLogsAndFinalizeRequest",
10340
- "package" : "io.nominal.datasource.logset.api"
10341
- },
10342
- "fields" : [ {
10343
- "fieldName" : "logs",
10344
- "type" : {
10345
- "type" : "list",
10346
- "list" : {
10347
- "itemType" : {
10348
- "type" : "reference",
10349
- "reference" : {
10350
- "name" : "Log",
10351
- "package" : "io.nominal.datasource.logset.api"
10352
- }
10353
- }
10354
- }
10355
- }
10356
- } ]
10357
- }
10358
- }, {
10359
- "type" : "object",
10360
- "object" : {
10361
- "typeName" : {
10362
- "name" : "BasicLogBody",
10363
- "package" : "io.nominal.datasource.logset.api"
10364
- },
10365
- "fields" : [ {
10366
- "fieldName" : "properties",
10367
- "type" : {
10368
- "type" : "map",
10369
- "map" : {
10370
- "keyType" : {
10371
- "type" : "primitive",
10372
- "primitive" : "STRING"
10373
- },
10374
- "valueType" : {
10375
- "type" : "primitive",
10376
- "primitive" : "STRING"
10377
- }
10378
- }
10379
- }
10380
- }, {
10381
- "fieldName" : "message",
10382
- "type" : {
10383
- "type" : "primitive",
10384
- "primitive" : "STRING"
10385
- }
10386
- } ],
10387
- "docs" : "A largely unopinionated but very flexible format.\n"
10388
- }
10389
- }, {
10390
- "type" : "object",
10391
- "object" : {
10392
- "typeName" : {
10393
- "name" : "CreateLogSetRequest",
10394
- "package" : "io.nominal.datasource.logset.api"
10395
- },
10396
- "fields" : [ {
10397
- "fieldName" : "name",
10398
- "type" : {
10399
- "type" : "primitive",
10400
- "primitive" : "STRING"
10401
- }
10402
- }, {
10403
- "fieldName" : "description",
10404
- "type" : {
10405
- "type" : "optional",
10406
- "optional" : {
10407
- "itemType" : {
10408
- "type" : "primitive",
10409
- "primitive" : "STRING"
10410
- }
10411
- }
10412
- }
10413
- }, {
10414
- "fieldName" : "originMetadata",
10415
- "type" : {
10416
- "type" : "map",
10417
- "map" : {
10418
- "keyType" : {
10419
- "type" : "primitive",
10420
- "primitive" : "STRING"
10421
- },
10422
- "valueType" : {
10423
- "type" : "primitive",
10424
- "primitive" : "STRING"
10425
- }
10426
- }
10427
- }
10428
- }, {
10429
- "fieldName" : "timestampType",
10430
- "type" : {
10431
- "type" : "reference",
10432
- "reference" : {
10433
- "name" : "TimestampType",
10434
- "package" : "io.nominal.datasource"
10435
- }
10436
- }
10437
- }, {
10438
- "fieldName" : "workspace",
10439
- "type" : {
10440
- "type" : "optional",
10441
- "optional" : {
10442
- "itemType" : {
10443
- "type" : "reference",
10444
- "reference" : {
10445
- "name" : "WorkspaceRid",
10446
- "package" : "io.nominal.api.rids"
10447
- }
10448
- }
10449
- }
10450
- },
10451
- "docs" : "The workspace in which to create the logset. If not provided, the logset will be created in the default workspace for\nthe user's organization, if the default workspace for the organization is configured.\n"
10452
- } ]
10453
- }
10454
- }, {
10455
- "type" : "object",
10456
- "object" : {
10457
- "typeName" : {
10458
- "name" : "Log",
10459
- "package" : "io.nominal.datasource.logset.api"
10460
- },
10461
- "fields" : [ {
10462
- "fieldName" : "time",
10463
- "type" : {
10464
- "type" : "reference",
10465
- "reference" : {
10466
- "name" : "Timestamp",
10467
- "package" : "io.nominal.api"
10468
- }
10469
- }
10470
- }, {
10471
- "fieldName" : "body",
10472
- "type" : {
10473
- "type" : "reference",
10474
- "reference" : {
10475
- "name" : "LogBody",
10476
- "package" : "io.nominal.datasource.logset.api"
10477
- }
10478
- }
10479
- } ]
10480
- }
10481
- }, {
10482
- "type" : "union",
10483
- "union" : {
10484
- "typeName" : {
10485
- "name" : "LogBody",
10486
- "package" : "io.nominal.datasource.logset.api"
10487
- },
10488
- "union" : [ {
10489
- "fieldName" : "basic",
10490
- "type" : {
10491
- "type" : "reference",
10492
- "reference" : {
10493
- "name" : "BasicLogBody",
10494
- "package" : "io.nominal.datasource.logset.api"
10495
- }
10496
- }
10497
- } ]
10498
- }
10499
- }, {
10500
- "type" : "enum",
10501
- "enum" : {
10502
- "typeName" : {
10503
- "name" : "LogFormat",
10504
- "package" : "io.nominal.datasource.logset.api"
10505
- },
10506
- "values" : [ {
10507
- "value" : "V1"
10508
- } ]
10509
- }
10510
- }, {
10511
- "type" : "union",
10512
- "union" : {
10513
- "typeName" : {
10514
- "name" : "LogHandle",
10515
- "package" : "io.nominal.datasource.logset.api"
10516
- },
10517
- "union" : [ {
10518
- "fieldName" : "s3",
10519
- "type" : {
10520
- "type" : "reference",
10521
- "reference" : {
10522
- "name" : "S3LogHandle",
10523
- "package" : "io.nominal.datasource.logset.api"
10524
- }
10525
- }
10526
- } ]
10527
- }
10528
- }, {
10529
- "type" : "object",
10530
- "object" : {
10531
- "typeName" : {
10532
- "name" : "LogSetMetadata",
10533
- "package" : "io.nominal.datasource.logset.api"
10534
- },
10535
- "fields" : [ {
10536
- "fieldName" : "rid",
10537
- "type" : {
10538
- "type" : "reference",
10539
- "reference" : {
10540
- "name" : "LogSetRid",
10541
- "package" : "io.nominal.datasource.logset.api"
10542
- }
10543
- }
10544
- }, {
10545
- "fieldName" : "createdBy",
10546
- "type" : {
10547
- "type" : "primitive",
10548
- "primitive" : "RID"
10549
- }
10550
- }, {
10551
- "fieldName" : "name",
10552
- "type" : {
10553
- "type" : "primitive",
10554
- "primitive" : "STRING"
10555
- }
10556
- }, {
10557
- "fieldName" : "description",
10558
- "type" : {
10559
- "type" : "optional",
10560
- "optional" : {
10561
- "itemType" : {
10562
- "type" : "primitive",
10563
- "primitive" : "STRING"
10564
- }
10565
- }
10566
- }
10567
- }, {
10568
- "fieldName" : "originMetadata",
10569
- "type" : {
10570
- "type" : "map",
10571
- "map" : {
10572
- "keyType" : {
10573
- "type" : "primitive",
10574
- "primitive" : "STRING"
10575
- },
10576
- "valueType" : {
10577
- "type" : "primitive",
10578
- "primitive" : "STRING"
10579
- }
10580
- }
10581
- }
10582
- }, {
10583
- "fieldName" : "createdAt",
10584
- "type" : {
10585
- "type" : "primitive",
10586
- "primitive" : "DATETIME"
10587
- }
10588
- }, {
10589
- "fieldName" : "updatedAt",
10590
- "type" : {
10591
- "type" : "primitive",
10592
- "primitive" : "DATETIME"
10593
- }
10594
- }, {
10595
- "fieldName" : "logCount",
10596
- "type" : {
10597
- "type" : "primitive",
10598
- "primitive" : "SAFELONG"
10599
- }
10600
- }, {
10601
- "fieldName" : "timestampType",
10602
- "type" : {
10603
- "type" : "reference",
10604
- "reference" : {
10605
- "name" : "TimestampType",
10606
- "package" : "io.nominal.datasource"
10607
- }
10608
- }
10609
- } ]
10610
- }
10611
- }, {
10612
- "type" : "alias",
10613
- "alias" : {
10614
- "typeName" : {
10615
- "name" : "LogSetRid",
10616
- "package" : "io.nominal.datasource.logset.api"
10617
- },
10618
- "alias" : {
10619
- "type" : "primitive",
10620
- "primitive" : "RID"
10621
- }
10622
- }
10623
- }, {
10624
- "type" : "object",
10625
- "object" : {
10626
- "typeName" : {
10627
- "name" : "S3LogHandle",
10628
- "package" : "io.nominal.datasource.logset.api"
10629
- },
10630
- "fields" : [ {
10631
- "fieldName" : "path",
10632
- "type" : {
10633
- "type" : "primitive",
10634
- "primitive" : "STRING"
10635
- }
10636
- }, {
10637
- "fieldName" : "format",
10638
- "type" : {
10639
- "type" : "reference",
10640
- "reference" : {
10641
- "name" : "LogFormat",
10642
- "package" : "io.nominal.datasource.logset.api"
10643
- }
10644
- }
10645
- } ]
10646
- }
10647
- }, {
10648
- "type" : "object",
10649
- "object" : {
10650
- "typeName" : {
10651
- "name" : "SearchLogSetsRequest",
10652
- "package" : "io.nominal.datasource.logset.api"
10653
- },
10654
- "fields" : [ {
10655
- "fieldName" : "token",
10656
- "type" : {
10657
- "type" : "optional",
10658
- "optional" : {
10659
- "itemType" : {
10660
- "type" : "reference",
10661
- "reference" : {
10662
- "name" : "Token",
10663
- "package" : "io.nominal.api"
10664
- }
10665
- }
10666
- }
10667
- }
10668
- }, {
10669
- "fieldName" : "pageSize",
10670
- "type" : {
10671
- "type" : "optional",
10672
- "optional" : {
10673
- "itemType" : {
10674
- "type" : "primitive",
10675
- "primitive" : "INTEGER"
10676
- }
10677
- }
10678
- },
10679
- "docs" : "The maximum allowed page size is 1000. Defaults to the maximum if not supplied."
10680
- }, {
10681
- "fieldName" : "workspaces",
10682
- "type" : {
10683
- "type" : "set",
10684
- "set" : {
10685
- "itemType" : {
10686
- "type" : "reference",
10687
- "reference" : {
10688
- "name" : "WorkspaceRid",
10689
- "package" : "io.nominal.api.rids"
10690
- }
10691
- }
10692
- }
10693
- },
10694
- "docs" : "If supplied, will return only the log sets within the supplied workspaces. If empty\nwill return all connections for workspaces that the user is permitted to see.\n"
10695
- } ]
10696
- }
10697
- }, {
10698
- "type" : "object",
10699
- "object" : {
10700
- "typeName" : {
10701
- "name" : "SearchLogSetsResponse",
10702
- "package" : "io.nominal.datasource.logset.api"
10703
- },
10704
- "fields" : [ {
10705
- "fieldName" : "values",
10706
- "type" : {
10707
- "type" : "list",
10708
- "list" : {
10709
- "itemType" : {
10710
- "type" : "reference",
10711
- "reference" : {
10712
- "name" : "LogSetMetadata",
10713
- "package" : "io.nominal.datasource.logset.api"
10714
- }
10715
- }
10716
- }
10717
- }
10718
- }, {
10719
- "fieldName" : "nextPageToken",
10720
- "type" : {
10721
- "type" : "optional",
10722
- "optional" : {
10723
- "itemType" : {
10724
- "type" : "reference",
10725
- "reference" : {
10726
- "name" : "Token",
10727
- "package" : "io.nominal.api"
10728
- }
10729
- }
10730
- }
10731
- }
10732
- } ]
10733
- }
10734
- }, {
10735
- "type" : "object",
10736
- "object" : {
10737
- "typeName" : {
10738
- "name" : "SearchLogsRequest",
10739
- "package" : "io.nominal.datasource.logset.api"
10740
- },
10741
- "fields" : [ {
10742
- "fieldName" : "token",
10743
- "type" : {
10744
- "type" : "optional",
10745
- "optional" : {
10746
- "itemType" : {
10747
- "type" : "reference",
10748
- "reference" : {
10749
- "name" : "Token",
10750
- "package" : "io.nominal.api"
10751
- }
10752
- }
10753
- }
10754
- }
10755
- }, {
10756
- "fieldName" : "pageSize",
10757
- "type" : {
10758
- "type" : "optional",
10759
- "optional" : {
10760
- "itemType" : {
10761
- "type" : "primitive",
10762
- "primitive" : "INTEGER"
10763
- }
10764
- }
10765
- },
10766
- "docs" : "The maximum allowed page size is 10000. Defaults to the maximum if not supplied."
10767
- } ]
10768
- }
10769
- }, {
10770
- "type" : "object",
10771
- "object" : {
10772
- "typeName" : {
10773
- "name" : "SearchLogsResponse",
10774
- "package" : "io.nominal.datasource.logset.api"
10775
- },
10776
- "fields" : [ {
10777
- "fieldName" : "logs",
10778
- "type" : {
10779
- "type" : "list",
10780
- "list" : {
10781
- "itemType" : {
10782
- "type" : "reference",
10783
- "reference" : {
10784
- "name" : "Log",
10785
- "package" : "io.nominal.datasource.logset.api"
10786
- }
10787
- }
10788
- }
10789
- }
10790
- }, {
10791
- "fieldName" : "nextPageToken",
10792
- "type" : {
10793
- "type" : "optional",
10794
- "optional" : {
10795
- "itemType" : {
10796
- "type" : "reference",
10797
- "reference" : {
10798
- "name" : "Token",
10799
- "package" : "io.nominal.api"
10800
- }
10801
- }
10802
- }
10803
- }
10804
- } ]
10805
- }
10806
10885
  }, {
10807
10886
  "type" : "object",
10808
10887
  "object" : {
@@ -13637,13 +13716,18 @@
13637
13716
  }, {
13638
13717
  "fieldName" : "timestampMetadata",
13639
13718
  "type" : {
13640
- "type" : "reference",
13641
- "reference" : {
13642
- "name" : "TimestampMetadata",
13643
- "package" : "io.nominal.ingest.api"
13719
+ "type" : "optional",
13720
+ "optional" : {
13721
+ "itemType" : {
13722
+ "type" : "reference",
13723
+ "reference" : {
13724
+ "name" : "TimestampMetadata",
13725
+ "package" : "io.nominal.ingest.api"
13726
+ }
13727
+ }
13644
13728
  }
13645
13729
  },
13646
- "docs" : "Metadata about the intermediate parquet this extractor will produce\n"
13730
+ "docs" : "Metadata about the intermediate parquet this extractor will produce.\nIf not set, timestamp metadata must be provided at ingest time.\n"
13647
13731
  }, {
13648
13732
  "fieldName" : "outputFileFormat",
13649
13733
  "type" : {
@@ -13724,6 +13808,20 @@
13724
13808
  "package" : "io.nominal.ingest.api"
13725
13809
  }
13726
13810
  }
13811
+ }, {
13812
+ "fieldName" : "timestampMetadata",
13813
+ "type" : {
13814
+ "type" : "optional",
13815
+ "optional" : {
13816
+ "itemType" : {
13817
+ "type" : "reference",
13818
+ "reference" : {
13819
+ "name" : "TimestampMetadata",
13820
+ "package" : "io.nominal.ingest.api"
13821
+ }
13822
+ }
13823
+ }
13824
+ }
13727
13825
  }, {
13728
13826
  "fieldName" : "tag",
13729
13827
  "type" : {
@@ -15094,6 +15192,15 @@
15094
15192
  "package" : "io.nominal.ingest.api"
15095
15193
  }
15096
15194
  }
15195
+ }, {
15196
+ "fieldName" : "videoV2",
15197
+ "type" : {
15198
+ "type" : "reference",
15199
+ "reference" : {
15200
+ "name" : "VideoOptsV2",
15201
+ "package" : "io.nominal.ingest.api"
15202
+ }
15203
+ }
15097
15204
  }, {
15098
15205
  "fieldName" : "containerized",
15099
15206
  "type" : {
@@ -16857,13 +16964,18 @@
16857
16964
  }, {
16858
16965
  "fieldName" : "timestampMetadata",
16859
16966
  "type" : {
16860
- "type" : "reference",
16861
- "reference" : {
16862
- "name" : "TimestampMetadata",
16863
- "package" : "io.nominal.ingest.api"
16967
+ "type" : "optional",
16968
+ "optional" : {
16969
+ "itemType" : {
16970
+ "type" : "reference",
16971
+ "reference" : {
16972
+ "name" : "TimestampMetadata",
16973
+ "package" : "io.nominal.ingest.api"
16974
+ }
16975
+ }
16864
16976
  }
16865
16977
  },
16866
- "docs" : "Metadata about the intermediate parquet this extractor will produce\n"
16978
+ "docs" : "Metadata about the intermediate parquet this extractor will produce.\nIf not set, timestamp metadata must be provided at ingest time.\n"
16867
16979
  }, {
16868
16980
  "fieldName" : "outputFileFormat",
16869
16981
  "type" : {
@@ -19774,6 +19886,23 @@
19774
19886
  },
19775
19887
  "docs" : "Unique resource identifier for a Module.\n"
19776
19888
  }
19889
+ }, {
19890
+ "type" : "object",
19891
+ "object" : {
19892
+ "typeName" : {
19893
+ "name" : "AppendOnlyConfig",
19894
+ "package" : "io.nominal.persistent.compute.api"
19895
+ },
19896
+ "fields" : [ {
19897
+ "fieldName" : "decimateResults",
19898
+ "type" : {
19899
+ "type" : "primitive",
19900
+ "primitive" : "BOOLEAN"
19901
+ },
19902
+ "docs" : "Specifies whether the returned results should be decimated.\nIf this is false, the client may receive a `SubscriptionCreationError` if the data rate is too high\nand responses must be decimated.\n"
19903
+ } ],
19904
+ "docs" : "Defines the append results from the websocket.\n"
19905
+ }
19777
19906
  }, {
19778
19907
  "type" : "object",
19779
19908
  "object" : {
@@ -20292,6 +20421,24 @@
20292
20421
  }
20293
20422
  } ]
20294
20423
  }
20424
+ }, {
20425
+ "type" : "union",
20426
+ "union" : {
20427
+ "typeName" : {
20428
+ "name" : "ResultConfiguration",
20429
+ "package" : "io.nominal.persistent.compute.api"
20430
+ },
20431
+ "union" : [ {
20432
+ "fieldName" : "appendOnly",
20433
+ "type" : {
20434
+ "type" : "reference",
20435
+ "reference" : {
20436
+ "name" : "AppendOnlyConfig",
20437
+ "package" : "io.nominal.persistent.compute.api"
20438
+ }
20439
+ }
20440
+ } ]
20441
+ }
20295
20442
  }, {
20296
20443
  "type" : "union",
20297
20444
  "union" : {
@@ -20535,7 +20682,23 @@
20535
20682
  }
20536
20683
  }
20537
20684
  },
20538
- "docs" : "Can be set to `false` by the client to indicate that it doesn't support appends for this subscription\nand always wants to receive full results. Defaults to `false` if not set.\nThe expectation is that clients should implement support for appends for any of the results covered in\n`ComputeNodeAppendResponse` and set this to `true` as quickly as possible. However, in order to support \nadding new sub-types to `ComputeNodeAppendResponse` without breaking clients that haven't upgraded yet \nand haven't yet added support for them, we default this to `false` and make clients opt-in as soon as they\nimplement support.\n"
20685
+ "docs" : "Can be set to `false` by the client to indicate that it doesn't support appends for this subscription\nand always wants to receive full results. Defaults to `false` if not set.\nThe expectation is that clients should implement support for appends for any of the results covered in\n`ComputeNodeAppendResponse` and set this to `true` as quickly as possible. However, in order to support \nadding new sub-types to `ComputeNodeAppendResponse` without breaking clients that haven't upgraded yet \nand haven't yet added support for them, we default this to `false` and make clients opt-in as soon as they\nimplement support.\n",
20686
+ "deprecated" : "Use `resultConfiguration` instead.\n"
20687
+ }, {
20688
+ "fieldName" : "resultConfiguration",
20689
+ "type" : {
20690
+ "type" : "optional",
20691
+ "optional" : {
20692
+ "itemType" : {
20693
+ "type" : "reference",
20694
+ "reference" : {
20695
+ "name" : "ResultConfiguration",
20696
+ "package" : "io.nominal.persistent.compute.api"
20697
+ }
20698
+ }
20699
+ }
20700
+ },
20701
+ "docs" : "Defines the results that are sent for this subscription. If not set, falls back to the behavior \ndefined by `allowAppends`.\n"
20539
20702
  } ]
20540
20703
  }
20541
20704
  }, {
@@ -20621,6 +20784,19 @@
20621
20784
  }
20622
20785
  } ]
20623
20786
  }
20787
+ }, {
20788
+ "type" : "enum",
20789
+ "enum" : {
20790
+ "typeName" : {
20791
+ "name" : "UnavailableResultConfigurationReason",
20792
+ "package" : "io.nominal.persistent.compute.api"
20793
+ },
20794
+ "values" : [ {
20795
+ "value" : "APPENDS_NOT_SUPPORTED_FOR_COMPUTE"
20796
+ }, {
20797
+ "value" : "TOO_MANY_POINTS_FOR_UNDECIMATED_APPENDS"
20798
+ } ]
20799
+ }
20624
20800
  }, {
20625
20801
  "type" : "object",
20626
20802
  "object" : {
@@ -22827,6 +23003,21 @@
22827
23003
  }
22828
23004
  }
22829
23005
  }
23006
+ }, {
23007
+ "fieldName" : "metadata",
23008
+ "type" : {
23009
+ "type" : "optional",
23010
+ "optional" : {
23011
+ "itemType" : {
23012
+ "type" : "reference",
23013
+ "reference" : {
23014
+ "name" : "DatasetFileMetadata",
23015
+ "package" : "io.nominal.scout.catalog"
23016
+ }
23017
+ }
23018
+ }
23019
+ },
23020
+ "docs" : "File-type-specific metadata. For video files, contains timestamp manifest.\n"
22830
23021
  } ]
22831
23022
  }
22832
23023
  }, {
@@ -23499,8 +23690,42 @@
23499
23690
  }
23500
23691
  },
23501
23692
  "docs" : "Timestamp that the file is deleted at, only present if the file has been deleted.\n"
23693
+ }, {
23694
+ "fieldName" : "metadata",
23695
+ "type" : {
23696
+ "type" : "optional",
23697
+ "optional" : {
23698
+ "itemType" : {
23699
+ "type" : "reference",
23700
+ "reference" : {
23701
+ "name" : "DatasetFileMetadata",
23702
+ "package" : "io.nominal.scout.catalog"
23703
+ }
23704
+ }
23705
+ }
23706
+ },
23707
+ "docs" : "File-type-specific metadata. For video files, contains timestamp manifest and segment metadata.\n"
23502
23708
  } ]
23503
23709
  }
23710
+ }, {
23711
+ "type" : "union",
23712
+ "union" : {
23713
+ "typeName" : {
23714
+ "name" : "DatasetFileMetadata",
23715
+ "package" : "io.nominal.scout.catalog"
23716
+ },
23717
+ "union" : [ {
23718
+ "fieldName" : "video",
23719
+ "type" : {
23720
+ "type" : "reference",
23721
+ "reference" : {
23722
+ "name" : "VideoFileMetadata",
23723
+ "package" : "io.nominal.datasource"
23724
+ }
23725
+ }
23726
+ } ],
23727
+ "docs" : "Metadata specific to different file types stored in datasets.\n"
23728
+ }
23504
23729
  }, {
23505
23730
  "type" : "enum",
23506
23731
  "enum" : {
@@ -24081,6 +24306,10 @@
24081
24306
  "value" : "COMPLETED"
24082
24307
  }, {
24083
24308
  "value" : "FAILED"
24309
+ }, {
24310
+ "value" : "DELETION_IN_PROGRESS"
24311
+ }, {
24312
+ "value" : "DELETED"
24084
24313
  } ]
24085
24314
  }
24086
24315
  }, {
@@ -24983,6 +25212,22 @@
24983
25212
  }
24984
25213
  } ]
24985
25214
  }
25215
+ }, {
25216
+ "type" : "object",
25217
+ "object" : {
25218
+ "typeName" : {
25219
+ "name" : "VideoFileUri",
25220
+ "package" : "io.nominal.scout.catalog"
25221
+ },
25222
+ "fields" : [ {
25223
+ "fieldName" : "uri",
25224
+ "type" : {
25225
+ "type" : "primitive",
25226
+ "primitive" : "STRING"
25227
+ }
25228
+ } ],
25229
+ "docs" : "Pre-signed URI that can be used to download the original video file directly. Expires if the download has\nnot been initiated within 1 minute.\n"
25230
+ }
24986
25231
  }, {
24987
25232
  "type" : "enum",
24988
25233
  "enum" : {
@@ -28720,6 +28965,35 @@
28720
28965
  }
28721
28966
  } ]
28722
28967
  }
28968
+ }, {
28969
+ "type" : "union",
28970
+ "union" : {
28971
+ "typeName" : {
28972
+ "name" : "PlotColoringConfiguration",
28973
+ "package" : "io.nominal.scout.chartdefinition.api"
28974
+ },
28975
+ "union" : [ {
28976
+ "fieldName" : "rowIndependent",
28977
+ "type" : {
28978
+ "type" : "reference",
28979
+ "reference" : {
28980
+ "name" : "RowIndependentPlotColoringConfiguration",
28981
+ "package" : "io.nominal.scout.chartdefinition.api"
28982
+ }
28983
+ },
28984
+ "docs" : "Series plotted on each row is colored independently of series in other rows.\n"
28985
+ }, {
28986
+ "fieldName" : "rowShared",
28987
+ "type" : {
28988
+ "type" : "reference",
28989
+ "reference" : {
28990
+ "name" : "RowSharedPlotColoringConfiguration",
28991
+ "package" : "io.nominal.scout.chartdefinition.api"
28992
+ }
28993
+ },
28994
+ "docs" : "Series plotted on each row will be colored using the same order of colors as the plots in the other rows \nin the panel.\n"
28995
+ } ]
28996
+ }
28723
28997
  }, {
28724
28998
  "type" : "union",
28725
28999
  "union" : {
@@ -29093,6 +29367,24 @@
29093
29367
  }
29094
29368
  } ]
29095
29369
  }
29370
+ }, {
29371
+ "type" : "object",
29372
+ "object" : {
29373
+ "typeName" : {
29374
+ "name" : "RowIndependentPlotColoringConfiguration",
29375
+ "package" : "io.nominal.scout.chartdefinition.api"
29376
+ },
29377
+ "fields" : [ ]
29378
+ }
29379
+ }, {
29380
+ "type" : "object",
29381
+ "object" : {
29382
+ "typeName" : {
29383
+ "name" : "RowSharedPlotColoringConfiguration",
29384
+ "package" : "io.nominal.scout.chartdefinition.api"
29385
+ },
29386
+ "fields" : [ ]
29387
+ }
29096
29388
  }, {
29097
29389
  "type" : "enum",
29098
29390
  "enum" : {
@@ -29538,6 +29830,21 @@
29538
29830
  }
29539
29831
  },
29540
29832
  "docs" : "Determines when to draw lines between points. By default, the staleness threshold is 1s and stale points are connected."
29833
+ }, {
29834
+ "fieldName" : "plotColoringConfiguration",
29835
+ "type" : {
29836
+ "type" : "optional",
29837
+ "optional" : {
29838
+ "itemType" : {
29839
+ "type" : "reference",
29840
+ "reference" : {
29841
+ "name" : "PlotColoringConfiguration",
29842
+ "package" : "io.nominal.scout.chartdefinition.api"
29843
+ }
29844
+ }
29845
+ }
29846
+ },
29847
+ "docs" : "Configuration for coloring time series plots in this chart. By default, plots are colored\nindependently between rows with a unique color if possible when created.\n"
29541
29848
  } ]
29542
29849
  }
29543
29850
  }, {
@@ -31020,6 +31327,12 @@
31020
31327
  "package" : "io.nominal.scout.run.api"
31021
31328
  }
31022
31329
  }
31330
+ }, {
31331
+ "fieldName" : "autoCreateEvents",
31332
+ "type" : {
31333
+ "type" : "primitive",
31334
+ "primitive" : "BOOLEAN"
31335
+ }
31023
31336
  } ]
31024
31337
  }
31025
31338
  }, {
@@ -31243,7 +31556,7 @@
31243
31556
  }
31244
31557
  }
31245
31558
  },
31246
- "docs" : "Checks can define a single range computation which can evaluate over multiple implementations of a context.\nThe check implementation index will correspond to the implementation index of the check condition.\n"
31559
+ "docs" : "Checks can define a single range computation which can evaluate over multiple implementations of a context.\nassetRid: common.AssetRid\nThe check implementation index will correspond to the implementation index of the check condition.\n"
31247
31560
  } ]
31248
31561
  }
31249
31562
  }, {
@@ -31472,6 +31785,18 @@
31472
31785
  }
31473
31786
  },
31474
31787
  "docs" : "Specifies the minimum amount of time that must pass before a check can recover from a failure.\nMinimum value is 15 seconds.\n"
31788
+ }, {
31789
+ "fieldName" : "autoCreateEvents",
31790
+ "type" : {
31791
+ "type" : "optional",
31792
+ "optional" : {
31793
+ "itemType" : {
31794
+ "type" : "primitive",
31795
+ "primitive" : "BOOLEAN"
31796
+ }
31797
+ }
31798
+ },
31799
+ "docs" : "The option to automatically create events for check status changes.\nIf true, events will be created when checks fail and recover.\nDefaults to false if not specified.\n"
31475
31800
  } ]
31476
31801
  }
31477
31802
  }, {
@@ -37579,24 +37904,6 @@
37579
37904
  }
37580
37905
  } ]
37581
37906
  }
37582
- }, {
37583
- "type" : "union",
37584
- "union" : {
37585
- "typeName" : {
37586
- "name" : "BucketedGeoPlot",
37587
- "package" : "io.nominal.scout.compute.api"
37588
- },
37589
- "union" : [ {
37590
- "fieldName" : "timeBased",
37591
- "type" : {
37592
- "type" : "reference",
37593
- "reference" : {
37594
- "name" : "TimeBucketedGeoPlot",
37595
- "package" : "io.nominal.scout.compute.api"
37596
- }
37597
- }
37598
- } ]
37599
- }
37600
37907
  }, {
37601
37908
  "type" : "object",
37602
37909
  "object" : {
@@ -38296,15 +38603,6 @@
38296
38603
  "package" : "io.nominal.scout.compute.api"
38297
38604
  }
38298
38605
  }
38299
- }, {
38300
- "fieldName" : "geo",
38301
- "type" : {
38302
- "type" : "reference",
38303
- "reference" : {
38304
- "name" : "SummarizeGeo",
38305
- "package" : "io.nominal.scout.compute.api"
38306
- }
38307
- }
38308
38606
  }, {
38309
38607
  "fieldName" : "curve",
38310
38608
  "type" : {
@@ -38693,15 +38991,6 @@
38693
38991
  "package" : "io.nominal.scout.compute.api"
38694
38992
  }
38695
38993
  }
38696
- }, {
38697
- "fieldName" : "bucketedGeo",
38698
- "type" : {
38699
- "type" : "reference",
38700
- "reference" : {
38701
- "name" : "BucketedGeoPlot",
38702
- "package" : "io.nominal.scout.compute.api"
38703
- }
38704
- }
38705
38994
  }, {
38706
38995
  "fieldName" : "frequencyDomain",
38707
38996
  "type" : {
@@ -41440,155 +41729,6 @@
41440
41729
  }
41441
41730
  } ]
41442
41731
  }
41443
- }, {
41444
- "type" : "union",
41445
- "union" : {
41446
- "typeName" : {
41447
- "name" : "GeoPoint",
41448
- "package" : "io.nominal.scout.compute.api"
41449
- },
41450
- "union" : [ {
41451
- "fieldName" : "latLong",
41452
- "type" : {
41453
- "type" : "reference",
41454
- "reference" : {
41455
- "name" : "LatLongPoint",
41456
- "package" : "io.nominal.scout.compute.api"
41457
- }
41458
- }
41459
- } ],
41460
- "docs" : "Represents a geographic point. Flexible to handle multiple types of geographic coordinate systems.\n"
41461
- }
41462
- }, {
41463
- "type" : "object",
41464
- "object" : {
41465
- "typeName" : {
41466
- "name" : "GeoPointWithTimestamp",
41467
- "package" : "io.nominal.scout.compute.api"
41468
- },
41469
- "fields" : [ {
41470
- "fieldName" : "timestamp",
41471
- "type" : {
41472
- "type" : "reference",
41473
- "reference" : {
41474
- "name" : "Timestamp",
41475
- "package" : "io.nominal.api"
41476
- }
41477
- }
41478
- }, {
41479
- "fieldName" : "value",
41480
- "type" : {
41481
- "type" : "reference",
41482
- "reference" : {
41483
- "name" : "GeoPoint",
41484
- "package" : "io.nominal.scout.compute.api"
41485
- }
41486
- }
41487
- } ]
41488
- }
41489
- }, {
41490
- "type" : "union",
41491
- "union" : {
41492
- "typeName" : {
41493
- "name" : "GeoSeries",
41494
- "package" : "io.nominal.scout.compute.api"
41495
- },
41496
- "union" : [ {
41497
- "fieldName" : "latLongGeoNode",
41498
- "type" : {
41499
- "type" : "reference",
41500
- "reference" : {
41501
- "name" : "LatLongGeo",
41502
- "package" : "io.nominal.scout.compute.api"
41503
- }
41504
- }
41505
- } ]
41506
- }
41507
- }, {
41508
- "type" : "union",
41509
- "union" : {
41510
- "typeName" : {
41511
- "name" : "GeoSummaryStrategy",
41512
- "package" : "io.nominal.scout.compute.api"
41513
- },
41514
- "union" : [ {
41515
- "fieldName" : "temporal",
41516
- "type" : {
41517
- "type" : "reference",
41518
- "reference" : {
41519
- "name" : "GeoTemporalSummary",
41520
- "package" : "io.nominal.scout.compute.api"
41521
- }
41522
- }
41523
- } ]
41524
- }
41525
- }, {
41526
- "type" : "object",
41527
- "object" : {
41528
- "typeName" : {
41529
- "name" : "GeoTemporalSummary",
41530
- "package" : "io.nominal.scout.compute.api"
41531
- },
41532
- "fields" : [ {
41533
- "fieldName" : "resolution",
41534
- "type" : {
41535
- "type" : "primitive",
41536
- "primitive" : "SAFELONG"
41537
- }
41538
- } ]
41539
- }
41540
- }, {
41541
- "type" : "object",
41542
- "object" : {
41543
- "typeName" : {
41544
- "name" : "GeoTimeBucket",
41545
- "package" : "io.nominal.scout.compute.api"
41546
- },
41547
- "fields" : [ {
41548
- "fieldName" : "mean",
41549
- "type" : {
41550
- "type" : "reference",
41551
- "reference" : {
41552
- "name" : "GeoPoint",
41553
- "package" : "io.nominal.scout.compute.api"
41554
- }
41555
- },
41556
- "docs" : "The mean value of the GeoPoints in the bucket."
41557
- }, {
41558
- "fieldName" : "count",
41559
- "type" : {
41560
- "type" : "primitive",
41561
- "primitive" : "SAFELONG"
41562
- },
41563
- "docs" : "The number of GeoPoints in the bucket."
41564
- }, {
41565
- "fieldName" : "firstPoint",
41566
- "type" : {
41567
- "type" : "reference",
41568
- "reference" : {
41569
- "name" : "GeoPointWithTimestamp",
41570
- "package" : "io.nominal.scout.compute.api"
41571
- }
41572
- },
41573
- "docs" : "The first GeoPoint in the bucket."
41574
- }, {
41575
- "fieldName" : "lastPoint",
41576
- "type" : {
41577
- "type" : "optional",
41578
- "optional" : {
41579
- "itemType" : {
41580
- "type" : "reference",
41581
- "reference" : {
41582
- "name" : "GeoPointWithTimestamp",
41583
- "package" : "io.nominal.scout.compute.api"
41584
- }
41585
- }
41586
- }
41587
- },
41588
- "docs" : "The last GeoPoint in the bucket. Will be empty if the bucket only has a single point."
41589
- } ],
41590
- "docs" : "Summary of a time-based bucket of geo points."
41591
- }
41592
41732
  }, {
41593
41733
  "type" : "object",
41594
41734
  "object" : {
@@ -41868,76 +42008,6 @@
41868
42008
  } ],
41869
42009
  "docs" : "The FE should try to pass in inputs in the order in which they should be\nevaluated for optimization's sake. Alternatively, we can let the user select\npreconditions which they know to be cheaper to compute, which we will evaluate\nfirst.\n"
41870
42010
  }
41871
- }, {
41872
- "type" : "object",
41873
- "object" : {
41874
- "typeName" : {
41875
- "name" : "LatLongBounds",
41876
- "package" : "io.nominal.scout.compute.api"
41877
- },
41878
- "fields" : [ {
41879
- "fieldName" : "southWest",
41880
- "type" : {
41881
- "type" : "reference",
41882
- "reference" : {
41883
- "name" : "LatLongPoint",
41884
- "package" : "io.nominal.scout.compute.api"
41885
- }
41886
- }
41887
- }, {
41888
- "fieldName" : "northEast",
41889
- "type" : {
41890
- "type" : "reference",
41891
- "reference" : {
41892
- "name" : "LatLongPoint",
41893
- "package" : "io.nominal.scout.compute.api"
41894
- }
41895
- }
41896
- } ],
41897
- "docs" : "The bounds of a lat long geographic area. Represented by the southwest and northeast corners \nof a rectangle, inclusive.\n"
41898
- }
41899
- }, {
41900
- "type" : "object",
41901
- "object" : {
41902
- "typeName" : {
41903
- "name" : "LatLongGeo",
41904
- "package" : "io.nominal.scout.compute.api"
41905
- },
41906
- "fields" : [ {
41907
- "fieldName" : "latitude",
41908
- "type" : {
41909
- "type" : "reference",
41910
- "reference" : {
41911
- "name" : "NumericSeries",
41912
- "package" : "io.nominal.scout.compute.api"
41913
- }
41914
- }
41915
- }, {
41916
- "fieldName" : "longitude",
41917
- "type" : {
41918
- "type" : "reference",
41919
- "reference" : {
41920
- "name" : "NumericSeries",
41921
- "package" : "io.nominal.scout.compute.api"
41922
- }
41923
- }
41924
- }, {
41925
- "fieldName" : "bounds",
41926
- "type" : {
41927
- "type" : "optional",
41928
- "optional" : {
41929
- "itemType" : {
41930
- "type" : "reference",
41931
- "reference" : {
41932
- "name" : "LatLongBounds",
41933
- "package" : "io.nominal.scout.compute.api"
41934
- }
41935
- }
41936
- }
41937
- }
41938
- } ],
41939
- "docs" : "A geo node derived from a lat and long series."
41940
- }
41941
42011
  }, {
41942
42012
  "type" : "object",
41943
42013
  "object" : {
@@ -46290,7 +46360,8 @@
46290
46360
  }
46291
46361
  }
46292
46362
  }
46293
- } ]
46363
+ } ],
46364
+ "docs" : "Deprecated and should not be created by clients. Use ChannelSeries instead.\n"
46294
46365
  }
46295
46366
  }, {
46296
46367
  "type" : "object",
@@ -46988,33 +47059,6 @@
46988
47059
  "docs" : "The strategy to use when summarizing the series. Only spatial decimation is supported.\n"
46989
47060
  } ]
46990
47061
  }
46991
- }, {
46992
- "type" : "object",
46993
- "object" : {
46994
- "typeName" : {
46995
- "name" : "SummarizeGeo",
46996
- "package" : "io.nominal.scout.compute.api"
46997
- },
46998
- "fields" : [ {
46999
- "fieldName" : "input",
47000
- "type" : {
47001
- "type" : "reference",
47002
- "reference" : {
47003
- "name" : "GeoSeries",
47004
- "package" : "io.nominal.scout.compute.api"
47005
- }
47006
- }
47007
- }, {
47008
- "fieldName" : "summaryStrategy",
47009
- "type" : {
47010
- "type" : "reference",
47011
- "reference" : {
47012
- "name" : "GeoSummaryStrategy",
47013
- "package" : "io.nominal.scout.compute.api"
47014
- }
47015
- }
47016
- } ]
47017
- }
47018
47062
  }, {
47019
47063
  "type" : "object",
47020
47064
  "object" : {
@@ -47386,44 +47430,6 @@
47386
47430
  } ],
47387
47431
  "docs" : "Produces a list of ranges for which the threshold condition is satisfied.\n"
47388
47432
  }
47389
- }, {
47390
- "type" : "object",
47391
- "object" : {
47392
- "typeName" : {
47393
- "name" : "TimeBucketedGeoPlot",
47394
- "package" : "io.nominal.scout.compute.api"
47395
- },
47396
- "fields" : [ {
47397
- "fieldName" : "timestamps",
47398
- "type" : {
47399
- "type" : "list",
47400
- "list" : {
47401
- "itemType" : {
47402
- "type" : "reference",
47403
- "reference" : {
47404
- "name" : "Timestamp",
47405
- "package" : "io.nominal.api"
47406
- }
47407
- }
47408
- }
47409
- },
47410
- "docs" : "The end of the bucket, exclusive."
47411
- }, {
47412
- "fieldName" : "buckets",
47413
- "type" : {
47414
- "type" : "list",
47415
- "list" : {
47416
- "itemType" : {
47417
- "type" : "reference",
47418
- "reference" : {
47419
- "name" : "GeoTimeBucket",
47420
- "package" : "io.nominal.scout.compute.api"
47421
- }
47422
- }
47423
- }
47424
- }
47425
- } ]
47426
- }
47427
47433
  }, {
47428
47434
  "type" : "object",
47429
47435
  "object" : {
@@ -48083,7 +48089,8 @@
48083
48089
  "name" : "SeriesSpec",
48084
48090
  "package" : "io.nominal.scout.compute.api"
48085
48091
  }
48086
- }
48092
+ },
48093
+ "deprecated" : "use channel instead"
48087
48094
  }, {
48088
48095
  "fieldName" : "string",
48089
48096
  "type" : {
@@ -51362,57 +51369,6 @@
51362
51369
  }
51363
51370
  } ]
51364
51371
  }
51365
- }, {
51366
- "type" : "union",
51367
- "union" : {
51368
- "typeName" : {
51369
- "name" : "GeoNode",
51370
- "package" : "io.nominal.scout.compute.resolved.api"
51371
- },
51372
- "union" : [ {
51373
- "fieldName" : "latLongGeoNode",
51374
- "type" : {
51375
- "type" : "reference",
51376
- "reference" : {
51377
- "name" : "LatLongGeoNode",
51378
- "package" : "io.nominal.scout.compute.resolved.api"
51379
- }
51380
- }
51381
- } ]
51382
- }
51383
- }, {
51384
- "type" : "union",
51385
- "union" : {
51386
- "typeName" : {
51387
- "name" : "GeoNodeSummaryStrategy",
51388
- "package" : "io.nominal.scout.compute.resolved.api"
51389
- },
51390
- "union" : [ {
51391
- "fieldName" : "temporal",
51392
- "type" : {
51393
- "type" : "reference",
51394
- "reference" : {
51395
- "name" : "GeoNodeTemporalSummary",
51396
- "package" : "io.nominal.scout.compute.resolved.api"
51397
- }
51398
- }
51399
- } ]
51400
- }
51401
- }, {
51402
- "type" : "object",
51403
- "object" : {
51404
- "typeName" : {
51405
- "name" : "GeoNodeTemporalSummary",
51406
- "package" : "io.nominal.scout.compute.resolved.api"
51407
- },
51408
- "fields" : [ {
51409
- "fieldName" : "resolution",
51410
- "type" : {
51411
- "type" : "primitive",
51412
- "primitive" : "SAFELONG"
51413
- }
51414
- } ]
51415
- }
51416
51372
  }, {
51417
51373
  "type" : "object",
51418
51374
  "object" : {
@@ -51537,74 +51493,6 @@
51537
51493
  }
51538
51494
  } ]
51539
51495
  }
51540
- }, {
51541
- "type" : "object",
51542
- "object" : {
51543
- "typeName" : {
51544
- "name" : "LatLongBounds",
51545
- "package" : "io.nominal.scout.compute.resolved.api"
51546
- },
51547
- "fields" : [ {
51548
- "fieldName" : "southWest",
51549
- "type" : {
51550
- "type" : "reference",
51551
- "reference" : {
51552
- "name" : "LatLongPoint",
51553
- "package" : "io.nominal.scout.compute.api"
51554
- }
51555
- }
51556
- }, {
51557
- "fieldName" : "northEast",
51558
- "type" : {
51559
- "type" : "reference",
51560
- "reference" : {
51561
- "name" : "LatLongPoint",
51562
- "package" : "io.nominal.scout.compute.api"
51563
- }
51564
- }
51565
- } ]
51566
- }
51567
- }, {
51568
- "type" : "object",
51569
- "object" : {
51570
- "typeName" : {
51571
- "name" : "LatLongGeoNode",
51572
- "package" : "io.nominal.scout.compute.resolved.api"
51573
- },
51574
- "fields" : [ {
51575
- "fieldName" : "latitude",
51576
- "type" : {
51577
- "type" : "reference",
51578
- "reference" : {
51579
- "name" : "NumericSeriesNode",
51580
- "package" : "io.nominal.scout.compute.resolved.api"
51581
- }
51582
- }
51583
- }, {
51584
- "fieldName" : "longitude",
51585
- "type" : {
51586
- "type" : "reference",
51587
- "reference" : {
51588
- "name" : "NumericSeriesNode",
51589
- "package" : "io.nominal.scout.compute.resolved.api"
51590
- }
51591
- }
51592
- }, {
51593
- "fieldName" : "bounds",
51594
- "type" : {
51595
- "type" : "optional",
51596
- "optional" : {
51597
- "itemType" : {
51598
- "type" : "reference",
51599
- "reference" : {
51600
- "name" : "LatLongBounds",
51601
- "package" : "io.nominal.scout.compute.resolved.api"
51602
- }
51603
- }
51604
- }
51605
- }
51606
- } ]
51607
- }
51608
51496
  }, {
51609
51497
  "type" : "object",
51610
51498
  "object" : {
@@ -53533,15 +53421,6 @@
53533
53421
  "package" : "io.nominal.scout.compute.resolved.api"
53534
53422
  }
53535
53423
  }
53536
- }, {
53537
- "fieldName" : "geo",
53538
- "type" : {
53539
- "type" : "reference",
53540
- "reference" : {
53541
- "name" : "SummarizeGeoNode",
53542
- "package" : "io.nominal.scout.compute.resolved.api"
53543
- }
53544
- }
53545
53424
  }, {
53546
53425
  "fieldName" : "curve",
53547
53426
  "type" : {
@@ -54420,33 +54299,6 @@
54420
54299
  }
54421
54300
  } ]
54422
54301
  }
54423
- }, {
54424
- "type" : "object",
54425
- "object" : {
54426
- "typeName" : {
54427
- "name" : "SummarizeGeoNode",
54428
- "package" : "io.nominal.scout.compute.resolved.api"
54429
- },
54430
- "fields" : [ {
54431
- "fieldName" : "input",
54432
- "type" : {
54433
- "type" : "reference",
54434
- "reference" : {
54435
- "name" : "GeoNode",
54436
- "package" : "io.nominal.scout.compute.resolved.api"
54437
- }
54438
- }
54439
- }, {
54440
- "fieldName" : "summaryStrategy",
54441
- "type" : {
54442
- "type" : "reference",
54443
- "reference" : {
54444
- "name" : "GeoNodeSummaryStrategy",
54445
- "package" : "io.nominal.scout.compute.resolved.api"
54446
- }
54447
- }
54448
- } ]
54449
- }
54450
54302
  }, {
54451
54303
  "type" : "object",
54452
54304
  "object" : {
@@ -55178,6 +55030,24 @@
55178
55030
  }
55179
55031
  } ]
55180
55032
  }
55033
+ }, {
55034
+ "type" : "object",
55035
+ "object" : {
55036
+ "typeName" : {
55037
+ "name" : "GeneratePresignedLinkResponse",
55038
+ "package" : "io.nominal.scout.dataexport.api"
55039
+ },
55040
+ "fields" : [ {
55041
+ "fieldName" : "presignedUrl",
55042
+ "type" : {
55043
+ "type" : "reference",
55044
+ "reference" : {
55045
+ "name" : "PresignedUrl",
55046
+ "package" : "io.nominal.scout.dataexport.api"
55047
+ }
55048
+ }
55049
+ } ]
55050
+ }
55181
55051
  }, {
55182
55052
  "type" : "object",
55183
55053
  "object" : {
@@ -55235,6 +55105,21 @@
55235
55105
  "fields" : [ ],
55236
55106
  "docs" : "Do nothing. The value of a channel will be empty at\ntimestamps not present in its original time series.\n"
55237
55107
  }
55108
+ }, {
55109
+ "type" : "object",
55110
+ "object" : {
55111
+ "typeName" : {
55112
+ "name" : "PresignedUrl",
55113
+ "package" : "io.nominal.scout.dataexport.api"
55114
+ },
55115
+ "fields" : [ {
55116
+ "fieldName" : "url",
55117
+ "type" : {
55118
+ "type" : "primitive",
55119
+ "primitive" : "STRING"
55120
+ }
55121
+ } ]
55122
+ }
55238
55123
  }, {
55239
55124
  "type" : "object",
55240
55125
  "object" : {
@@ -59915,6 +59800,43 @@
59915
59800
  }
59916
59801
  } ]
59917
59802
  }
59803
+ }, {
59804
+ "type" : "object",
59805
+ "object" : {
59806
+ "typeName" : {
59807
+ "name" : "ListConnectionsResponse",
59808
+ "package" : "io.nominal.scout.datasource.connection.api"
59809
+ },
59810
+ "fields" : [ {
59811
+ "fieldName" : "connections",
59812
+ "type" : {
59813
+ "type" : "list",
59814
+ "list" : {
59815
+ "itemType" : {
59816
+ "type" : "reference",
59817
+ "reference" : {
59818
+ "name" : "Connection",
59819
+ "package" : "io.nominal.scout.datasource.connection.api"
59820
+ }
59821
+ }
59822
+ }
59823
+ }
59824
+ }, {
59825
+ "fieldName" : "nextPageToken",
59826
+ "type" : {
59827
+ "type" : "optional",
59828
+ "optional" : {
59829
+ "itemType" : {
59830
+ "type" : "reference",
59831
+ "reference" : {
59832
+ "name" : "Token",
59833
+ "package" : "io.nominal.api"
59834
+ }
59835
+ }
59836
+ }
59837
+ }
59838
+ } ]
59839
+ }
59918
59840
  }, {
59919
59841
  "type" : "alias",
59920
59842
  "alias" : {
@@ -61020,6 +60942,137 @@
61020
60942
  "docs" : "The resources to set as the user's favorites. Note that the provided list will overwrite \nall the user's previous favorites.\n"
61021
60943
  } ]
61022
60944
  }
60945
+ }, {
60946
+ "type" : "object",
60947
+ "object" : {
60948
+ "typeName" : {
60949
+ "name" : "AlertMessageFields",
60950
+ "package" : "io.nominal.scout.integrations.api"
60951
+ },
60952
+ "fields" : [ {
60953
+ "fieldName" : "assetTitle",
60954
+ "type" : {
60955
+ "type" : "primitive",
60956
+ "primitive" : "STRING"
60957
+ }
60958
+ }, {
60959
+ "fieldName" : "checkTitle",
60960
+ "type" : {
60961
+ "type" : "primitive",
60962
+ "primitive" : "STRING"
60963
+ }
60964
+ }, {
60965
+ "fieldName" : "checkDescription",
60966
+ "type" : {
60967
+ "type" : "primitive",
60968
+ "primitive" : "STRING"
60969
+ }
60970
+ }, {
60971
+ "fieldName" : "checklistTitle",
60972
+ "type" : {
60973
+ "type" : "primitive",
60974
+ "primitive" : "STRING"
60975
+ }
60976
+ }, {
60977
+ "fieldName" : "assetRid",
60978
+ "type" : {
60979
+ "type" : "reference",
60980
+ "reference" : {
60981
+ "name" : "AssetRid",
60982
+ "package" : "io.nominal.scout.rids.api"
60983
+ }
60984
+ }
60985
+ }, {
60986
+ "fieldName" : "checkLineageRid",
60987
+ "type" : {
60988
+ "type" : "reference",
60989
+ "reference" : {
60990
+ "name" : "CheckLineageRid",
60991
+ "package" : "io.nominal.scout.rids.api"
60992
+ }
60993
+ }
60994
+ }, {
60995
+ "fieldName" : "workbookUrl",
60996
+ "type" : {
60997
+ "type" : "optional",
60998
+ "optional" : {
60999
+ "itemType" : {
61000
+ "type" : "primitive",
61001
+ "primitive" : "STRING"
61002
+ }
61003
+ }
61004
+ },
61005
+ "docs" : "Appended to the end of the message as a button (if supported) or as a text hyperlink."
61006
+ }, {
61007
+ "fieldName" : "alertUrl",
61008
+ "type" : {
61009
+ "type" : "optional",
61010
+ "optional" : {
61011
+ "itemType" : {
61012
+ "type" : "primitive",
61013
+ "primitive" : "STRING"
61014
+ }
61015
+ }
61016
+ },
61017
+ "docs" : "Appended to the end of the message as a button (if supported) or as a text hyperlink."
61018
+ }, {
61019
+ "fieldName" : "eventType",
61020
+ "type" : {
61021
+ "type" : "reference",
61022
+ "reference" : {
61023
+ "name" : "EventType",
61024
+ "package" : "io.nominal.event"
61025
+ }
61026
+ },
61027
+ "docs" : "Will be prefixed in title and indicated by an icon."
61028
+ }, {
61029
+ "fieldName" : "priority",
61030
+ "type" : {
61031
+ "type" : "reference",
61032
+ "reference" : {
61033
+ "name" : "Priority",
61034
+ "package" : "io.nominal.scout.api"
61035
+ }
61036
+ }
61037
+ }, {
61038
+ "fieldName" : "labels",
61039
+ "type" : {
61040
+ "type" : "list",
61041
+ "list" : {
61042
+ "itemType" : {
61043
+ "type" : "primitive",
61044
+ "primitive" : "STRING"
61045
+ }
61046
+ }
61047
+ },
61048
+ "docs" : "Currently exposed as 'tags' on the frontend to match Opsgenie naming. Used by some integrations to filter/route messages."
61049
+ }, {
61050
+ "fieldName" : "alertType",
61051
+ "type" : {
61052
+ "type" : "reference",
61053
+ "reference" : {
61054
+ "name" : "AlertType",
61055
+ "package" : "io.nominal.scout.integrations.api"
61056
+ }
61057
+ },
61058
+ "docs" : "Determines execution status of the alert, between success, failure, and execution error."
61059
+ } ]
61060
+ }
61061
+ }, {
61062
+ "type" : "enum",
61063
+ "enum" : {
61064
+ "typeName" : {
61065
+ "name" : "AlertType",
61066
+ "package" : "io.nominal.scout.integrations.api"
61067
+ },
61068
+ "values" : [ {
61069
+ "value" : "INVALID"
61070
+ }, {
61071
+ "value" : "FAILURE"
61072
+ }, {
61073
+ "value" : "RECOVERY"
61074
+ } ]
61075
+ }
61023
61076
  }, {
61024
61077
  "type" : "union",
61025
61078
  "union" : {
@@ -61045,6 +61098,24 @@
61045
61098
  "package" : "io.nominal.scout.integrations.api"
61046
61099
  }
61047
61100
  }
61101
+ }, {
61102
+ "fieldName" : "createTeamsWebhookIntegrationDetails",
61103
+ "type" : {
61104
+ "type" : "reference",
61105
+ "reference" : {
61106
+ "name" : "CreateTeamsWebhookIntegrationDetails",
61107
+ "package" : "io.nominal.scout.integrations.api"
61108
+ }
61109
+ }
61110
+ }, {
61111
+ "fieldName" : "createPagerDutyIntegrationDetails",
61112
+ "type" : {
61113
+ "type" : "reference",
61114
+ "reference" : {
61115
+ "name" : "CreatePagerDutyIntegrationDetails",
61116
+ "package" : "io.nominal.scout.integrations.api"
61117
+ }
61118
+ }
61048
61119
  } ]
61049
61120
  }
61050
61121
  }, {
@@ -61121,6 +61192,21 @@
61121
61192
  }
61122
61193
  } ]
61123
61194
  }
61195
+ }, {
61196
+ "type" : "object",
61197
+ "object" : {
61198
+ "typeName" : {
61199
+ "name" : "CreatePagerDutyIntegrationDetails",
61200
+ "package" : "io.nominal.scout.integrations.api"
61201
+ },
61202
+ "fields" : [ {
61203
+ "fieldName" : "routingKey",
61204
+ "type" : {
61205
+ "type" : "primitive",
61206
+ "primitive" : "STRING"
61207
+ }
61208
+ } ]
61209
+ }
61124
61210
  }, {
61125
61211
  "type" : "object",
61126
61212
  "object" : {
@@ -61136,6 +61222,21 @@
61136
61222
  }
61137
61223
  } ]
61138
61224
  }
61225
+ }, {
61226
+ "type" : "object",
61227
+ "object" : {
61228
+ "typeName" : {
61229
+ "name" : "CreateTeamsWebhookIntegrationDetails",
61230
+ "package" : "io.nominal.scout.integrations.api"
61231
+ },
61232
+ "fields" : [ {
61233
+ "fieldName" : "webhook",
61234
+ "type" : {
61235
+ "type" : "primitive",
61236
+ "primitive" : "STRING"
61237
+ }
61238
+ } ]
61239
+ }
61139
61240
  }, {
61140
61241
  "type" : "object",
61141
61242
  "object" : {
@@ -61248,6 +61349,24 @@
61248
61349
  "package" : "io.nominal.scout.integrations.api"
61249
61350
  }
61250
61351
  }
61352
+ }, {
61353
+ "fieldName" : "teamsWebhookIntegration",
61354
+ "type" : {
61355
+ "type" : "reference",
61356
+ "reference" : {
61357
+ "name" : "TeamsWebhookIntegration",
61358
+ "package" : "io.nominal.scout.integrations.api"
61359
+ }
61360
+ }
61361
+ }, {
61362
+ "fieldName" : "pagerDutyIntegration",
61363
+ "type" : {
61364
+ "type" : "reference",
61365
+ "reference" : {
61366
+ "name" : "PagerDutyIntegration",
61367
+ "package" : "io.nominal.scout.integrations.api"
61368
+ }
61369
+ }
61251
61370
  } ]
61252
61371
  }
61253
61372
  }, {
@@ -61262,6 +61381,60 @@
61262
61381
  "primitive" : "RID"
61263
61382
  }
61264
61383
  }
61384
+ }, {
61385
+ "type" : "object",
61386
+ "object" : {
61387
+ "typeName" : {
61388
+ "name" : "InternalSendMessageRequest",
61389
+ "package" : "io.nominal.scout.integrations.api"
61390
+ },
61391
+ "fields" : [ {
61392
+ "fieldName" : "integrationRid",
61393
+ "type" : {
61394
+ "type" : "reference",
61395
+ "reference" : {
61396
+ "name" : "IntegrationRid",
61397
+ "package" : "io.nominal.scout.integrations.api"
61398
+ }
61399
+ }
61400
+ }, {
61401
+ "fieldName" : "message",
61402
+ "type" : {
61403
+ "type" : "reference",
61404
+ "reference" : {
61405
+ "name" : "MessageFields",
61406
+ "package" : "io.nominal.scout.integrations.api"
61407
+ }
61408
+ }
61409
+ } ]
61410
+ }
61411
+ }, {
61412
+ "type" : "union",
61413
+ "union" : {
61414
+ "typeName" : {
61415
+ "name" : "MessageFields",
61416
+ "package" : "io.nominal.scout.integrations.api"
61417
+ },
61418
+ "union" : [ {
61419
+ "fieldName" : "alert",
61420
+ "type" : {
61421
+ "type" : "reference",
61422
+ "reference" : {
61423
+ "name" : "AlertMessageFields",
61424
+ "package" : "io.nominal.scout.integrations.api"
61425
+ }
61426
+ }
61427
+ }, {
61428
+ "fieldName" : "resolutionError",
61429
+ "type" : {
61430
+ "type" : "reference",
61431
+ "reference" : {
61432
+ "name" : "ResolutionFailureMessageFields",
61433
+ "package" : "io.nominal.scout.integrations.api"
61434
+ }
61435
+ }
61436
+ } ]
61437
+ }
61265
61438
  }, {
61266
61439
  "type" : "object",
61267
61440
  "object" : {
@@ -61372,6 +61545,78 @@
61372
61545
  } ],
61373
61546
  "docs" : "Opsgenie region for the account linked to the provided API key.\n"
61374
61547
  }
61548
+ }, {
61549
+ "type" : "object",
61550
+ "object" : {
61551
+ "typeName" : {
61552
+ "name" : "PagerDutyIntegration",
61553
+ "package" : "io.nominal.scout.integrations.api"
61554
+ },
61555
+ "fields" : [ ]
61556
+ }
61557
+ }, {
61558
+ "type" : "object",
61559
+ "object" : {
61560
+ "typeName" : {
61561
+ "name" : "ResolutionFailureMessageFields",
61562
+ "package" : "io.nominal.scout.integrations.api"
61563
+ },
61564
+ "fields" : [ {
61565
+ "fieldName" : "checklistTitle",
61566
+ "type" : {
61567
+ "type" : "primitive",
61568
+ "primitive" : "STRING"
61569
+ }
61570
+ }, {
61571
+ "fieldName" : "assetTitle",
61572
+ "type" : {
61573
+ "type" : "primitive",
61574
+ "primitive" : "STRING"
61575
+ }
61576
+ }, {
61577
+ "fieldName" : "checklistRid",
61578
+ "type" : {
61579
+ "type" : "reference",
61580
+ "reference" : {
61581
+ "name" : "ChecklistRid",
61582
+ "package" : "io.nominal.scout.rids.api"
61583
+ }
61584
+ }
61585
+ }, {
61586
+ "fieldName" : "assetRid",
61587
+ "type" : {
61588
+ "type" : "reference",
61589
+ "reference" : {
61590
+ "name" : "AssetRid",
61591
+ "package" : "io.nominal.scout.rids.api"
61592
+ }
61593
+ }
61594
+ }, {
61595
+ "fieldName" : "unresolvedChecks",
61596
+ "type" : {
61597
+ "type" : "primitive",
61598
+ "primitive" : "INTEGER"
61599
+ }
61600
+ }, {
61601
+ "fieldName" : "totalChecks",
61602
+ "type" : {
61603
+ "type" : "primitive",
61604
+ "primitive" : "INTEGER"
61605
+ }
61606
+ }, {
61607
+ "fieldName" : "labels",
61608
+ "type" : {
61609
+ "type" : "list",
61610
+ "list" : {
61611
+ "itemType" : {
61612
+ "type" : "primitive",
61613
+ "primitive" : "STRING"
61614
+ }
61615
+ }
61616
+ },
61617
+ "docs" : "Currently exposed as 'tags' on the frontend to match Opsgenie naming. Used by some integrations to filter/route messages."
61618
+ } ]
61619
+ }
61375
61620
  }, {
61376
61621
  "type" : "object",
61377
61622
  "object" : {
@@ -61509,6 +61754,15 @@
61509
61754
  }
61510
61755
  } ]
61511
61756
  }
61757
+ }, {
61758
+ "type" : "object",
61759
+ "object" : {
61760
+ "typeName" : {
61761
+ "name" : "TeamsWebhookIntegration",
61762
+ "package" : "io.nominal.scout.integrations.api"
61763
+ },
61764
+ "fields" : [ ]
61765
+ }
61512
61766
  }, {
61513
61767
  "type" : "union",
61514
61768
  "union" : {
@@ -61534,6 +61788,24 @@
61534
61788
  "package" : "io.nominal.scout.integrations.api"
61535
61789
  }
61536
61790
  }
61791
+ }, {
61792
+ "fieldName" : "teamsWebhook",
61793
+ "type" : {
61794
+ "type" : "reference",
61795
+ "reference" : {
61796
+ "name" : "UpdateTeamsWebhookIntegrationDetails",
61797
+ "package" : "io.nominal.scout.integrations.api"
61798
+ }
61799
+ }
61800
+ }, {
61801
+ "fieldName" : "pagerDuty",
61802
+ "type" : {
61803
+ "type" : "reference",
61804
+ "reference" : {
61805
+ "name" : "UpdatePagerDutyIntegrationDetails",
61806
+ "package" : "io.nominal.scout.integrations.api"
61807
+ }
61808
+ }
61537
61809
  } ]
61538
61810
  }
61539
61811
  }, {
@@ -61610,6 +61882,21 @@
61610
61882
  }
61611
61883
  } ]
61612
61884
  }
61885
+ }, {
61886
+ "type" : "object",
61887
+ "object" : {
61888
+ "typeName" : {
61889
+ "name" : "UpdatePagerDutyIntegrationDetails",
61890
+ "package" : "io.nominal.scout.integrations.api"
61891
+ },
61892
+ "fields" : [ {
61893
+ "fieldName" : "routingKey",
61894
+ "type" : {
61895
+ "type" : "primitive",
61896
+ "primitive" : "STRING"
61897
+ }
61898
+ } ]
61899
+ }
61613
61900
  }, {
61614
61901
  "type" : "object",
61615
61902
  "object" : {
@@ -61625,6 +61912,21 @@
61625
61912
  }
61626
61913
  } ]
61627
61914
  }
61915
+ }, {
61916
+ "type" : "object",
61917
+ "object" : {
61918
+ "typeName" : {
61919
+ "name" : "UpdateTeamsWebhookIntegrationDetails",
61920
+ "package" : "io.nominal.scout.integrations.api"
61921
+ },
61922
+ "fields" : [ {
61923
+ "fieldName" : "webhook",
61924
+ "type" : {
61925
+ "type" : "primitive",
61926
+ "primitive" : "STRING"
61927
+ }
61928
+ } ]
61929
+ }
61628
61930
  }, {
61629
61931
  "type" : "object",
61630
61932
  "object" : {
@@ -63262,6 +63564,18 @@
63262
63564
  "type" : "primitive",
63263
63565
  "primitive" : "DATETIME"
63264
63566
  }
63567
+ }, {
63568
+ "fieldName" : "updatedAt",
63569
+ "type" : {
63570
+ "type" : "optional",
63571
+ "optional" : {
63572
+ "itemType" : {
63573
+ "type" : "primitive",
63574
+ "primitive" : "DATETIME"
63575
+ }
63576
+ }
63577
+ },
63578
+ "docs" : "The timestamp when the workbook was last updated"
63265
63579
  }, {
63266
63580
  "fieldName" : "properties",
63267
63581
  "type" : {
@@ -67559,8 +67873,17 @@
67559
67873
  "type" : {
67560
67874
  "type" : "reference",
67561
67875
  "reference" : {
67562
- "name" : "CustomTimeRange",
67563
- "package" : "io.nominal.scout.savedviews.api"
67876
+ "name" : "CustomTimeframeFilter",
67877
+ "package" : "io.nominal.scout.run.api"
67878
+ }
67879
+ }
67880
+ }, {
67881
+ "fieldName" : "preset",
67882
+ "type" : {
67883
+ "type" : "reference",
67884
+ "reference" : {
67885
+ "name" : "PresetTimeframeFilter",
67886
+ "package" : "io.nominal.scout.run.api"
67564
67887
  }
67565
67888
  }
67566
67889
  } ]
@@ -67843,43 +68166,6 @@
67843
68166
  }
67844
68167
  } ]
67845
68168
  }
67846
- }, {
67847
- "type" : "object",
67848
- "object" : {
67849
- "typeName" : {
67850
- "name" : "CustomTimeRange",
67851
- "package" : "io.nominal.scout.savedviews.api"
67852
- },
67853
- "fields" : [ {
67854
- "fieldName" : "startTime",
67855
- "type" : {
67856
- "type" : "optional",
67857
- "optional" : {
67858
- "itemType" : {
67859
- "type" : "reference",
67860
- "reference" : {
67861
- "name" : "UtcTimestamp",
67862
- "package" : "io.nominal.scout.run.api"
67863
- }
67864
- }
67865
- }
67866
- }
67867
- }, {
67868
- "fieldName" : "endTime",
67869
- "type" : {
67870
- "type" : "optional",
67871
- "optional" : {
67872
- "itemType" : {
67873
- "type" : "reference",
67874
- "reference" : {
67875
- "name" : "UtcTimestamp",
67876
- "package" : "io.nominal.scout.run.api"
67877
- }
67878
- }
67879
- }
67880
- }
67881
- } ]
67882
- }
67883
68169
  }, {
67884
68170
  "type" : "union",
67885
68171
  "union" : {
@@ -70694,6 +70980,60 @@
70694
70980
  }
70695
70981
  } ]
70696
70982
  }
70983
+ }, {
70984
+ "type" : "object",
70985
+ "object" : {
70986
+ "typeName" : {
70987
+ "name" : "CreateDatasetFileSegmentsRequest",
70988
+ "package" : "io.nominal.scout.video.api"
70989
+ },
70990
+ "fields" : [ {
70991
+ "fieldName" : "videoRid",
70992
+ "type" : {
70993
+ "type" : "reference",
70994
+ "reference" : {
70995
+ "name" : "VideoRid",
70996
+ "package" : "io.nominal.api.rids"
70997
+ }
70998
+ }
70999
+ }, {
71000
+ "fieldName" : "datasetRid",
71001
+ "type" : {
71002
+ "type" : "reference",
71003
+ "reference" : {
71004
+ "name" : "DatasetRid",
71005
+ "package" : "io.nominal.api.rids"
71006
+ }
71007
+ }
71008
+ }, {
71009
+ "fieldName" : "datasetFileId",
71010
+ "type" : {
71011
+ "type" : "primitive",
71012
+ "primitive" : "UUID"
71013
+ }
71014
+ }, {
71015
+ "fieldName" : "requests",
71016
+ "type" : {
71017
+ "type" : "list",
71018
+ "list" : {
71019
+ "itemType" : {
71020
+ "type" : "reference",
71021
+ "reference" : {
71022
+ "name" : "CreateSegment",
71023
+ "package" : "io.nominal.scout.video.api"
71024
+ }
71025
+ }
71026
+ }
71027
+ }
71028
+ }, {
71029
+ "fieldName" : "seriesUuid",
71030
+ "type" : {
71031
+ "type" : "primitive",
71032
+ "primitive" : "UUID"
71033
+ }
71034
+ } ],
71035
+ "docs" : "Request to create segments for a dataset file video. Used for channel-based video ingestion.\n"
71036
+ }
70697
71037
  }, {
70698
71038
  "type" : "object",
70699
71039
  "object" : {
@@ -71275,6 +71615,34 @@
71275
71615
  }
71276
71616
  } ]
71277
71617
  }
71618
+ }, {
71619
+ "type" : "object",
71620
+ "object" : {
71621
+ "typeName" : {
71622
+ "name" : "GetPlaylistInBoundsForChannelRequest",
71623
+ "package" : "io.nominal.scout.video.api"
71624
+ },
71625
+ "fields" : [ {
71626
+ "fieldName" : "channelSeries",
71627
+ "type" : {
71628
+ "type" : "reference",
71629
+ "reference" : {
71630
+ "name" : "VideoChannelSeries",
71631
+ "package" : "io.nominal.scout.video.api"
71632
+ }
71633
+ }
71634
+ }, {
71635
+ "fieldName" : "bounds",
71636
+ "type" : {
71637
+ "type" : "reference",
71638
+ "reference" : {
71639
+ "name" : "Bounds",
71640
+ "package" : "io.nominal.scout.video.api"
71641
+ }
71642
+ }
71643
+ } ],
71644
+ "docs" : "Request to get playlist for a video channel series.\nUses channel + tags to resolve to video series metadata within the specified video.\n"
71645
+ }
71278
71646
  }, {
71279
71647
  "type" : "object",
71280
71648
  "object" : {
@@ -71331,6 +71699,34 @@
71331
71699
  "docs" : "The start of the view range used to dynamically calculate media timestamps. The first segment with an \noverlap with the time bounds will have its minimum media timestamp set to 0, with every subsequent\nsegment building media time cumulatively from that offset. This will determine the starting media\ntimestamp of the returned segment. The view range should be the same as the one requested to get the\nplaylist and segment summaries.\n"
71332
71700
  } ]
71333
71701
  }
71702
+ }, {
71703
+ "type" : "object",
71704
+ "object" : {
71705
+ "typeName" : {
71706
+ "name" : "GetSegmentSummariesInBoundsForChannelRequest",
71707
+ "package" : "io.nominal.scout.video.api"
71708
+ },
71709
+ "fields" : [ {
71710
+ "fieldName" : "channelSeries",
71711
+ "type" : {
71712
+ "type" : "reference",
71713
+ "reference" : {
71714
+ "name" : "VideoChannelSeries",
71715
+ "package" : "io.nominal.scout.video.api"
71716
+ }
71717
+ }
71718
+ }, {
71719
+ "fieldName" : "bounds",
71720
+ "type" : {
71721
+ "type" : "reference",
71722
+ "reference" : {
71723
+ "name" : "Bounds",
71724
+ "package" : "io.nominal.scout.video.api"
71725
+ }
71726
+ }
71727
+ } ],
71728
+ "docs" : "Request to get segment summaries for a video channel series.\nUses channel + tags to resolve to video series metadata within the specified bounds.\n"
71729
+ }
71334
71730
  }, {
71335
71731
  "type" : "object",
71336
71732
  "object" : {
@@ -72487,6 +72883,126 @@
72487
72883
  "docs" : "deprecated. Will be removed after April 15th."
72488
72884
  } ]
72489
72885
  }
72886
+ }, {
72887
+ "type" : "object",
72888
+ "object" : {
72889
+ "typeName" : {
72890
+ "name" : "VideoAssetChannel",
72891
+ "package" : "io.nominal.scout.video.api"
72892
+ },
72893
+ "fields" : [ {
72894
+ "fieldName" : "assetRid",
72895
+ "type" : {
72896
+ "type" : "primitive",
72897
+ "primitive" : "STRING"
72898
+ }
72899
+ }, {
72900
+ "fieldName" : "dataScopeName",
72901
+ "type" : {
72902
+ "type" : "primitive",
72903
+ "primitive" : "STRING"
72904
+ }
72905
+ }, {
72906
+ "fieldName" : "channel",
72907
+ "type" : {
72908
+ "type" : "primitive",
72909
+ "primitive" : "STRING"
72910
+ }
72911
+ }, {
72912
+ "fieldName" : "tags",
72913
+ "type" : {
72914
+ "type" : "map",
72915
+ "map" : {
72916
+ "keyType" : {
72917
+ "type" : "reference",
72918
+ "reference" : {
72919
+ "name" : "TagName",
72920
+ "package" : "io.nominal.api"
72921
+ }
72922
+ },
72923
+ "valueType" : {
72924
+ "type" : "reference",
72925
+ "reference" : {
72926
+ "name" : "TagValue",
72927
+ "package" : "io.nominal.api"
72928
+ }
72929
+ }
72930
+ }
72931
+ }
72932
+ } ],
72933
+ "docs" : "Reference a video channel via an Asset's data scope"
72934
+ }
72935
+ }, {
72936
+ "type" : "union",
72937
+ "union" : {
72938
+ "typeName" : {
72939
+ "name" : "VideoChannelSeries",
72940
+ "package" : "io.nominal.scout.video.api"
72941
+ },
72942
+ "union" : [ {
72943
+ "fieldName" : "dataSource",
72944
+ "type" : {
72945
+ "type" : "reference",
72946
+ "reference" : {
72947
+ "name" : "VideoDataSourceChannel",
72948
+ "package" : "io.nominal.scout.video.api"
72949
+ }
72950
+ }
72951
+ }, {
72952
+ "fieldName" : "asset",
72953
+ "type" : {
72954
+ "type" : "reference",
72955
+ "reference" : {
72956
+ "name" : "VideoAssetChannel",
72957
+ "package" : "io.nominal.scout.video.api"
72958
+ }
72959
+ }
72960
+ } ],
72961
+ "docs" : "Union type for referencing a video channel. Allows querying video data via \ndatasource/channel, asset data scopes, or run data scopes.\n"
72962
+ }
72963
+ }, {
72964
+ "type" : "object",
72965
+ "object" : {
72966
+ "typeName" : {
72967
+ "name" : "VideoDataSourceChannel",
72968
+ "package" : "io.nominal.scout.video.api"
72969
+ },
72970
+ "fields" : [ {
72971
+ "fieldName" : "dataSourceRid",
72972
+ "type" : {
72973
+ "type" : "primitive",
72974
+ "primitive" : "STRING"
72975
+ }
72976
+ }, {
72977
+ "fieldName" : "channel",
72978
+ "type" : {
72979
+ "type" : "primitive",
72980
+ "primitive" : "STRING"
72981
+ }
72982
+ }, {
72983
+ "fieldName" : "tags",
72984
+ "type" : {
72985
+ "type" : "map",
72986
+ "map" : {
72987
+ "keyType" : {
72988
+ "type" : "reference",
72989
+ "reference" : {
72990
+ "name" : "TagName",
72991
+ "package" : "io.nominal.api"
72992
+ }
72993
+ },
72994
+ "valueType" : {
72995
+ "type" : "reference",
72996
+ "reference" : {
72997
+ "name" : "TagValue",
72998
+ "package" : "io.nominal.api"
72999
+ }
73000
+ }
73001
+ }
73002
+ }
73003
+ } ],
73004
+ "docs" : "Reference a video channel directly from a datasource/dataset"
73005
+ }
72490
73006
  }, {
72491
73007
  "type" : "object",
72492
73008
  "object" : {
@@ -75346,6 +75862,20 @@
75346
75862
  }
75347
75863
  }
75348
75864
  }
75865
+ }, {
75866
+ "fieldName" : "uint64",
75867
+ "type" : {
75868
+ "type" : "list",
75869
+ "list" : {
75870
+ "itemType" : {
75871
+ "type" : "reference",
75872
+ "reference" : {
75873
+ "name" : "Uint64Point",
75874
+ "package" : "io.nominal.storage.writer.api"
75875
+ }
75876
+ }
75877
+ }
75878
+ }
75349
75879
  }, {
75350
75880
  "fieldName" : "array",
75351
75881
  "type" : {
@@ -75684,6 +76214,30 @@
75684
76214
  }
75685
76215
  } ]
75686
76216
  }
76217
+ }, {
76218
+ "type" : "object",
76219
+ "object" : {
76220
+ "typeName" : {
76221
+ "name" : "Uint64Point",
76222
+ "package" : "io.nominal.storage.writer.api"
76223
+ },
76224
+ "fields" : [ {
76225
+ "fieldName" : "timestamp",
76226
+ "type" : {
76227
+ "type" : "reference",
76228
+ "reference" : {
76229
+ "name" : "Timestamp",
76230
+ "package" : "io.nominal.api"
76231
+ }
76232
+ }
76233
+ }, {
76234
+ "fieldName" : "value",
76235
+ "type" : {
76236
+ "type" : "primitive",
76237
+ "primitive" : "SAFELONG"
76238
+ }
76239
+ } ]
76240
+ }
75687
76241
  }, {
75688
76242
  "type" : "object",
75689
76243
  "object" : {
@@ -77403,15 +77957,6 @@
77403
77957
  "package" : "io.nominal.timeseries.logicalseries.api"
77404
77958
  }
77405
77959
  }
77406
- }, {
77407
- "fieldName" : "videoLocator",
77408
- "type" : {
77409
- "type" : "reference",
77410
- "reference" : {
77411
- "name" : "VideoLocator",
77412
- "package" : "io.nominal.timeseries.logicalseries.api"
77413
- }
77414
- }
77415
77960
  } ]
77416
77961
  }
77417
77962
  }, {
@@ -78003,54 +78548,6 @@
78003
78548
  }
78004
78549
  } ]
78005
78550
  }
78006
- }, {
78007
- "type" : "object",
78008
- "object" : {
78009
- "typeName" : {
78010
- "name" : "VideoLocator",
78011
- "package" : "io.nominal.timeseries.logicalseries.api"
78012
- },
78013
- "fields" : [ {
78014
- "fieldName" : "channel",
78015
- "type" : {
78016
- "type" : "reference",
78017
- "reference" : {
78018
- "name" : "Channel",
78019
- "package" : "io.nominal.api"
78020
- }
78021
- }
78022
- }, {
78023
- "fieldName" : "videoRid",
78024
- "type" : {
78025
- "type" : "reference",
78026
- "reference" : {
78027
- "name" : "VideoRid",
78028
- "package" : "io.nominal.api.rids"
78029
- }
78030
- }
78031
- }, {
78032
- "fieldName" : "tags",
78033
- "type" : {
78034
- "type" : "map",
78035
- "map" : {
78036
- "keyType" : {
78037
- "type" : "reference",
78038
- "reference" : {
78039
- "name" : "TagName",
78040
- "package" : "io.nominal.api"
78041
- }
78042
- },
78043
- "valueType" : {
78044
- "type" : "reference",
78045
- "reference" : {
78046
- "name" : "TagValue",
78047
- "package" : "io.nominal.api"
78048
- }
78049
- }
78050
- }
78051
- }
78052
- } ]
78053
- }
78054
78551
  }, {
78055
78552
  "type" : "enum",
78056
78553
  "enum" : {
@@ -80063,6 +80560,126 @@
80063
80560
  "docs" : "Generates a JWT token for MediaMTX authentication with a 2-hour expiration.\nThe token is signed with the MediaMTX private key and contains the specified permissions.\nRequires authentication with Nominal. This endpoint is intended for internal use only.\n",
80064
80561
  "markers" : [ ],
80065
80562
  "tags" : [ ]
80563
+ }, {
80564
+ "endpointName" : "getMyCoachmarkDismissals",
80565
+ "httpMethod" : "POST",
80566
+ "httpPath" : "/authentication/v2/my/coachmarks/dismissals",
80567
+ "auth" : {
80568
+ "type" : "header",
80569
+ "header" : { }
80570
+ },
80571
+ "args" : [ {
80572
+ "argName" : "request",
80573
+ "type" : {
80574
+ "type" : "reference",
80575
+ "reference" : {
80576
+ "name" : "GetCoachmarkDismissalsRequest",
80577
+ "package" : "io.nominal.authentication.api"
80578
+ }
80579
+ },
80580
+ "paramType" : {
80581
+ "type" : "body",
80582
+ "body" : { }
80583
+ },
80584
+ "markers" : [ ],
80585
+ "tags" : [ ]
80586
+ } ],
80587
+ "returns" : {
80588
+ "type" : "reference",
80589
+ "reference" : {
80590
+ "name" : "GetCoachmarkDismissalsResponse",
80591
+ "package" : "io.nominal.authentication.api"
80592
+ }
80593
+ },
80594
+ "docs" : "Gets coachmark dismissals for the authenticated user.\nOptionally filter by specific coachmark IDs.\n",
80595
+ "markers" : [ ],
80596
+ "tags" : [ ]
80597
+ }, {
80598
+ "endpointName" : "dismissMyCoachmark",
80599
+ "httpMethod" : "POST",
80600
+ "httpPath" : "/authentication/v2/my/coachmarks/dismiss",
80601
+ "auth" : {
80602
+ "type" : "header",
80603
+ "header" : { }
80604
+ },
80605
+ "args" : [ {
80606
+ "argName" : "request",
80607
+ "type" : {
80608
+ "type" : "reference",
80609
+ "reference" : {
80610
+ "name" : "DismissCoachmarkRequest",
80611
+ "package" : "io.nominal.authentication.api"
80612
+ }
80613
+ },
80614
+ "paramType" : {
80615
+ "type" : "body",
80616
+ "body" : { }
80617
+ },
80618
+ "markers" : [ ],
80619
+ "tags" : [ ]
80620
+ } ],
80621
+ "returns" : {
80622
+ "type" : "reference",
80623
+ "reference" : {
80624
+ "name" : "CoachmarkDismissal",
80625
+ "package" : "io.nominal.authentication.api"
80626
+ }
80627
+ },
80628
+ "docs" : "Dismisses a coachmark for the authenticated user.\nRecords the dismissal timestamp and app version.\n",
80629
+ "markers" : [ ],
80630
+ "tags" : [ ]
80631
+ }, {
80632
+ "endpointName" : "isMyCoachmarkDismissed",
80633
+ "httpMethod" : "GET",
80634
+ "httpPath" : "/authentication/v2/my/coachmarks/dismissed/{coachmarkId}",
80635
+ "auth" : {
80636
+ "type" : "header",
80637
+ "header" : { }
80638
+ },
80639
+ "args" : [ {
80640
+ "argName" : "coachmarkId",
80641
+ "type" : {
80642
+ "type" : "primitive",
80643
+ "primitive" : "STRING"
80644
+ },
80645
+ "paramType" : {
80646
+ "type" : "path",
80647
+ "path" : { }
80648
+ },
80649
+ "markers" : [ ],
80650
+ "tags" : [ ]
80651
+ } ],
80652
+ "returns" : {
80653
+ "type" : "primitive",
80654
+ "primitive" : "BOOLEAN"
80655
+ },
80656
+ "docs" : "Checks if a specific coachmark has been dismissed by the authenticated user.\n",
80657
+ "markers" : [ ],
80658
+ "tags" : [ ]
80659
+ }, {
80660
+ "endpointName" : "resetMyCoachmarkDismissal",
80661
+ "httpMethod" : "DELETE",
80662
+ "httpPath" : "/authentication/v2/my/coachmarks/dismissals/{coachmarkId}",
80663
+ "auth" : {
80664
+ "type" : "header",
80665
+ "header" : { }
80666
+ },
80667
+ "args" : [ {
80668
+ "argName" : "coachmarkId",
80669
+ "type" : {
80670
+ "type" : "primitive",
80671
+ "primitive" : "STRING"
80672
+ },
80673
+ "paramType" : {
80674
+ "type" : "path",
80675
+ "path" : { }
80676
+ },
80677
+ "markers" : [ ],
80678
+ "tags" : [ ]
80679
+ } ],
80680
+ "docs" : "Resets a coachmark dismissal for the authenticated user.\nThis allows the coachmark to be shown again.\nPrimarily intended for testing and debugging.\n",
80681
+ "markers" : [ ],
80682
+ "tags" : [ ]
80066
80683
  } ],
80067
80684
  "docs" : "This service provides operations for managing user and org profiles/settings.\nIts name is a bit of a misnomer.\n"
80068
80685
  }, {
@@ -80280,6 +80897,36 @@
80280
80897
  "docs" : "Provide an OIDC ID token to get a Nominal access token suitable for making API requests.\nIts expiry will match that of the input ID token, capped at 24h. TODO(MGMT-933): reduce this duration.\nThrows NotAuthorized if the ID token is invalid or if the OIDC provider is not known.\n",
80281
80898
  "markers" : [ ],
80282
80899
  "tags" : [ ]
80900
+ }, {
80901
+ "endpointName" : "refreshAccessToken",
80902
+ "httpMethod" : "POST",
80903
+ "httpPath" : "/authorization/v1/refresh-access-token",
80904
+ "args" : [ {
80905
+ "argName" : "request",
80906
+ "type" : {
80907
+ "type" : "reference",
80908
+ "reference" : {
80909
+ "name" : "RefreshAccessTokenRequest",
80910
+ "package" : "io.nominal.authorization"
80911
+ }
80912
+ },
80913
+ "paramType" : {
80914
+ "type" : "body",
80915
+ "body" : { }
80916
+ },
80917
+ "markers" : [ ],
80918
+ "tags" : [ ]
80919
+ } ],
80920
+ "returns" : {
80921
+ "type" : "reference",
80922
+ "reference" : {
80923
+ "name" : "RefreshAccessTokenResponse",
80924
+ "package" : "io.nominal.authorization"
80925
+ }
80926
+ },
80927
+ "docs" : "Given an authenticated session, provide an OIDC access token to get a Nominal access token suitable \nfor making API requests. Its expiry will match that of the input access token, capped at 24h. TODO(MGMT-933): \nreduce this duration. Throws NotAuthorized if the access token is invalid or if the OIDC provider is not \nknown.\n",
80928
+ "markers" : [ ],
80929
+ "tags" : [ ]
80283
80930
  }, {
80284
80931
  "endpointName" : "createApiKey",
80285
80932
  "httpMethod" : "POST",
@@ -80842,309 +81489,58 @@
80842
81489
  "markers" : [ ],
80843
81490
  "tags" : [ ]
80844
81491
  }, {
80845
- "endpointName" : "removeReaction",
80846
- "httpMethod" : "DELETE",
80847
- "httpPath" : "/comments/v1/comments/{commentRid}/reactions/{type}",
80848
- "auth" : {
80849
- "type" : "header",
80850
- "header" : { }
80851
- },
80852
- "args" : [ {
80853
- "argName" : "commentRid",
80854
- "type" : {
80855
- "type" : "reference",
80856
- "reference" : {
80857
- "name" : "CommentRid",
80858
- "package" : "io.nominal.comments.api"
80859
- }
80860
- },
80861
- "paramType" : {
80862
- "type" : "path",
80863
- "path" : { }
80864
- },
80865
- "docs" : "The RID of comment to delete\n",
80866
- "markers" : [ ],
80867
- "tags" : [ ]
80868
- }, {
80869
- "argName" : "type",
80870
- "type" : {
80871
- "type" : "reference",
80872
- "reference" : {
80873
- "name" : "ReactionType",
80874
- "package" : "io.nominal.comments.api"
80875
- }
80876
- },
80877
- "paramType" : {
80878
- "type" : "path",
80879
- "path" : { }
80880
- },
80881
- "docs" : "The type of reaction\n",
80882
- "markers" : [ ],
80883
- "tags" : [ ]
80884
- } ],
80885
- "returns" : {
80886
- "type" : "reference",
80887
- "reference" : {
80888
- "name" : "Comment",
80889
- "package" : "io.nominal.comments.api"
80890
- }
80891
- },
80892
- "docs" : "Create a reaction on a comment\n",
80893
- "markers" : [ ],
80894
- "tags" : [ ]
80895
- } ],
80896
- "docs" : "Comments service manages conversations about resources."
80897
- }, {
80898
- "serviceName" : {
80899
- "name" : "LogSetService",
80900
- "package" : "io.nominal.datasource.logset"
80901
- },
80902
- "endpoints" : [ {
80903
- "endpointName" : "create",
80904
- "httpMethod" : "POST",
80905
- "httpPath" : "/data-source/log-set/v1/log-sets",
80906
- "auth" : {
80907
- "type" : "header",
80908
- "header" : { }
80909
- },
80910
- "args" : [ {
80911
- "argName" : "request",
80912
- "type" : {
80913
- "type" : "reference",
80914
- "reference" : {
80915
- "name" : "CreateLogSetRequest",
80916
- "package" : "io.nominal.datasource.logset.api"
80917
- }
80918
- },
80919
- "paramType" : {
80920
- "type" : "body",
80921
- "body" : { }
80922
- },
80923
- "markers" : [ ],
80924
- "tags" : [ ]
80925
- } ],
80926
- "returns" : {
80927
- "type" : "reference",
80928
- "reference" : {
80929
- "name" : "LogSetMetadata",
80930
- "package" : "io.nominal.datasource.logset.api"
80931
- }
80932
- },
80933
- "deprecated" : "Deprecated. Logs should be streamed to a dataset via NominalChannelWriterService#writeLogs.\n",
80934
- "markers" : [ ],
80935
- "tags" : [ ]
80936
- }, {
80937
- "endpointName" : "attachLogsAndFinalize",
80938
- "httpMethod" : "POST",
80939
- "httpPath" : "/data-source/log-set/v1/log-set/{logSetRid}/attach-and-finalize",
81492
+ "endpointName" : "removeReaction",
81493
+ "httpMethod" : "DELETE",
81494
+ "httpPath" : "/comments/v1/comments/{commentRid}/reactions/{type}",
80940
81495
  "auth" : {
80941
81496
  "type" : "header",
80942
81497
  "header" : { }
80943
81498
  },
80944
81499
  "args" : [ {
80945
- "argName" : "logSetRid",
81500
+ "argName" : "commentRid",
80946
81501
  "type" : {
80947
81502
  "type" : "reference",
80948
81503
  "reference" : {
80949
- "name" : "LogSetRid",
80950
- "package" : "io.nominal.datasource.logset.api"
81504
+ "name" : "CommentRid",
81505
+ "package" : "io.nominal.comments.api"
80951
81506
  }
80952
81507
  },
80953
81508
  "paramType" : {
80954
81509
  "type" : "path",
80955
81510
  "path" : { }
80956
81511
  },
81512
+ "docs" : "The RID of comment to delete\n",
80957
81513
  "markers" : [ ],
80958
81514
  "tags" : [ ]
80959
81515
  }, {
80960
- "argName" : "request",
80961
- "type" : {
80962
- "type" : "reference",
80963
- "reference" : {
80964
- "name" : "AttachLogsAndFinalizeRequest",
80965
- "package" : "io.nominal.datasource.logset.api"
80966
- }
80967
- },
80968
- "paramType" : {
80969
- "type" : "body",
80970
- "body" : { }
80971
- },
80972
- "markers" : [ ],
80973
- "tags" : [ ]
80974
- } ],
80975
- "returns" : {
80976
- "type" : "reference",
80977
- "reference" : {
80978
- "name" : "LogSetMetadata",
80979
- "package" : "io.nominal.datasource.logset.api"
80980
- }
80981
- },
80982
- "deprecated" : "Deprecated. Logs should be streamed to a dataset via NominalChannelWriterService#writeLogs.\n",
80983
- "markers" : [ ],
80984
- "tags" : [ ]
80985
- }, {
80986
- "endpointName" : "getLogSetMetadata",
80987
- "httpMethod" : "GET",
80988
- "httpPath" : "/data-source/log-set/v1/log-set/{logSetRid}",
80989
- "auth" : {
80990
- "type" : "header",
80991
- "header" : { }
80992
- },
80993
- "args" : [ {
80994
- "argName" : "logSetRid",
80995
- "type" : {
80996
- "type" : "reference",
80997
- "reference" : {
80998
- "name" : "LogSetRid",
80999
- "package" : "io.nominal.datasource.logset.api"
81000
- }
81001
- },
81002
- "paramType" : {
81003
- "type" : "path",
81004
- "path" : { }
81005
- },
81006
- "markers" : [ ],
81007
- "tags" : [ ]
81008
- } ],
81009
- "returns" : {
81010
- "type" : "reference",
81011
- "reference" : {
81012
- "name" : "LogSetMetadata",
81013
- "package" : "io.nominal.datasource.logset.api"
81014
- }
81015
- },
81016
- "deprecated" : "Logsets have been deprecated and replaced by datasets.\n",
81017
- "markers" : [ ],
81018
- "tags" : [ ]
81019
- }, {
81020
- "endpointName" : "batchGetLogSetMetadata",
81021
- "httpMethod" : "POST",
81022
- "httpPath" : "/data-source/log-set/v1/log-set/multiple",
81023
- "auth" : {
81024
- "type" : "header",
81025
- "header" : { }
81026
- },
81027
- "args" : [ {
81028
- "argName" : "request",
81029
- "type" : {
81030
- "type" : "set",
81031
- "set" : {
81032
- "itemType" : {
81033
- "type" : "reference",
81034
- "reference" : {
81035
- "name" : "LogSetRid",
81036
- "package" : "io.nominal.datasource.logset.api"
81037
- }
81038
- }
81039
- }
81040
- },
81041
- "paramType" : {
81042
- "type" : "body",
81043
- "body" : { }
81044
- },
81045
- "markers" : [ ],
81046
- "tags" : [ ]
81047
- } ],
81048
- "returns" : {
81049
- "type" : "set",
81050
- "set" : {
81051
- "itemType" : {
81052
- "type" : "reference",
81053
- "reference" : {
81054
- "name" : "LogSetMetadata",
81055
- "package" : "io.nominal.datasource.logset.api"
81056
- }
81057
- }
81058
- }
81059
- },
81060
- "deprecated" : "Logsets have been deprecated and replaced by datasets.\n",
81061
- "markers" : [ ],
81062
- "tags" : [ ]
81063
- }, {
81064
- "endpointName" : "searchLogSets",
81065
- "httpMethod" : "POST",
81066
- "httpPath" : "/data-source/log-set/v1/log-sets/get",
81067
- "auth" : {
81068
- "type" : "header",
81069
- "header" : { }
81070
- },
81071
- "args" : [ {
81072
- "argName" : "request",
81073
- "type" : {
81074
- "type" : "reference",
81075
- "reference" : {
81076
- "name" : "SearchLogSetsRequest",
81077
- "package" : "io.nominal.datasource.logset.api"
81078
- }
81079
- },
81080
- "paramType" : {
81081
- "type" : "body",
81082
- "body" : { }
81083
- },
81084
- "markers" : [ ],
81085
- "tags" : [ ]
81086
- } ],
81087
- "returns" : {
81088
- "type" : "reference",
81089
- "reference" : {
81090
- "name" : "SearchLogSetsResponse",
81091
- "package" : "io.nominal.datasource.logset.api"
81092
- }
81093
- },
81094
- "deprecated" : "Logsets have been deprecated and replaced by datasets.\n",
81095
- "markers" : [ ],
81096
- "tags" : [ ]
81097
- }, {
81098
- "endpointName" : "searchLogs",
81099
- "httpMethod" : "POST",
81100
- "httpPath" : "/data-source/log-set/v1/log-set/{logSetRid}/logs",
81101
- "auth" : {
81102
- "type" : "header",
81103
- "header" : { }
81104
- },
81105
- "args" : [ {
81106
- "argName" : "logSetRid",
81516
+ "argName" : "type",
81107
81517
  "type" : {
81108
81518
  "type" : "reference",
81109
81519
  "reference" : {
81110
- "name" : "LogSetRid",
81111
- "package" : "io.nominal.datasource.logset.api"
81520
+ "name" : "ReactionType",
81521
+ "package" : "io.nominal.comments.api"
81112
81522
  }
81113
81523
  },
81114
81524
  "paramType" : {
81115
81525
  "type" : "path",
81116
81526
  "path" : { }
81117
81527
  },
81118
- "markers" : [ ],
81119
- "tags" : [ ]
81120
- }, {
81121
- "argName" : "request",
81122
- "type" : {
81123
- "type" : "reference",
81124
- "reference" : {
81125
- "name" : "SearchLogsRequest",
81126
- "package" : "io.nominal.datasource.logset.api"
81127
- }
81128
- },
81129
- "paramType" : {
81130
- "type" : "body",
81131
- "body" : { }
81132
- },
81528
+ "docs" : "The type of reaction\n",
81133
81529
  "markers" : [ ],
81134
81530
  "tags" : [ ]
81135
81531
  } ],
81136
81532
  "returns" : {
81137
81533
  "type" : "reference",
81138
81534
  "reference" : {
81139
- "name" : "SearchLogsResponse",
81140
- "package" : "io.nominal.datasource.logset.api"
81535
+ "name" : "Comment",
81536
+ "package" : "io.nominal.comments.api"
81141
81537
  }
81142
81538
  },
81143
- "deprecated" : "Logsets have been deprecated and replaced by datasets.\n",
81539
+ "docs" : "Create a reaction on a comment\n",
81144
81540
  "markers" : [ ],
81145
81541
  "tags" : [ ]
81146
81542
  } ],
81147
- "docs" : "Log sets are a type of datasource which can be used to store log data.\n"
81543
+ "docs" : "Comments service manages conversations about resources."
81148
81544
  }, {
81149
81545
  "serviceName" : {
81150
81546
  "name" : "EventService",
@@ -87128,18 +87524,104 @@
87128
87524
  "tags" : [ ]
87129
87525
  } ],
87130
87526
  "returns" : {
87131
- "type" : "reference",
87132
- "reference" : {
87133
- "name" : "DatasetFileUri",
87134
- "package" : "io.nominal.scout.catalog"
87527
+ "type" : "reference",
87528
+ "reference" : {
87529
+ "name" : "DatasetFileUri",
87530
+ "package" : "io.nominal.scout.catalog"
87531
+ }
87532
+ },
87533
+ "markers" : [ ],
87534
+ "tags" : [ ]
87535
+ }, {
87536
+ "endpointName" : "getVideoFileUri",
87537
+ "httpMethod" : "GET",
87538
+ "httpPath" : "/catalog/v1/videos/{videoFileRid}/uri",
87539
+ "auth" : {
87540
+ "type" : "header",
87541
+ "header" : { }
87542
+ },
87543
+ "args" : [ {
87544
+ "argName" : "videoFileRid",
87545
+ "type" : {
87546
+ "type" : "reference",
87547
+ "reference" : {
87548
+ "name" : "VideoFileRid",
87549
+ "package" : "io.nominal.api.rids"
87550
+ }
87551
+ },
87552
+ "paramType" : {
87553
+ "type" : "path",
87554
+ "path" : { }
87555
+ },
87556
+ "markers" : [ ],
87557
+ "tags" : [ ]
87558
+ } ],
87559
+ "returns" : {
87560
+ "type" : "reference",
87561
+ "reference" : {
87562
+ "name" : "VideoFileUri",
87563
+ "package" : "io.nominal.scout.catalog"
87564
+ }
87565
+ },
87566
+ "markers" : [ ],
87567
+ "tags" : [ ]
87568
+ }, {
87569
+ "endpointName" : "getOriginFileUris",
87570
+ "httpMethod" : "GET",
87571
+ "httpPath" : "/catalog/v1/datasets/{datasetRid}/{fileId}/origin-uris",
87572
+ "auth" : {
87573
+ "type" : "header",
87574
+ "header" : { }
87575
+ },
87576
+ "args" : [ {
87577
+ "argName" : "datasetRid",
87578
+ "type" : {
87579
+ "type" : "reference",
87580
+ "reference" : {
87581
+ "name" : "DatasetRid",
87582
+ "package" : "io.nominal.api.rids"
87583
+ }
87584
+ },
87585
+ "paramType" : {
87586
+ "type" : "path",
87587
+ "path" : { }
87588
+ },
87589
+ "markers" : [ ],
87590
+ "tags" : [ ]
87591
+ }, {
87592
+ "argName" : "fileId",
87593
+ "type" : {
87594
+ "type" : "reference",
87595
+ "reference" : {
87596
+ "name" : "DatasetFileId",
87597
+ "package" : "io.nominal.datasource"
87598
+ }
87599
+ },
87600
+ "paramType" : {
87601
+ "type" : "path",
87602
+ "path" : { }
87603
+ },
87604
+ "markers" : [ ],
87605
+ "tags" : [ ]
87606
+ } ],
87607
+ "returns" : {
87608
+ "type" : "list",
87609
+ "list" : {
87610
+ "itemType" : {
87611
+ "type" : "reference",
87612
+ "reference" : {
87613
+ "name" : "OriginFileUri",
87614
+ "package" : "io.nominal.scout.catalog"
87615
+ }
87616
+ }
87135
87617
  }
87136
87618
  },
87137
87619
  "markers" : [ ],
87138
87620
  "tags" : [ ]
87139
87621
  }, {
87140
- "endpointName" : "getOriginFileUris",
87141
- "httpMethod" : "GET",
87142
- "httpPath" : "/catalog/v1/datasets/{datasetRid}/{fileId}/origin-uris",
87622
+ "endpointName" : "markFileIngestSuccessful",
87623
+ "httpMethod" : "PUT",
87624
+ "httpPath" : "/catalog/v1/datasets/{datasetRid}/file/{fileId}/success",
87143
87625
  "auth" : {
87144
87626
  "type" : "header",
87145
87627
  "header" : { }
@@ -87147,11 +87629,8 @@
87147
87629
  "args" : [ {
87148
87630
  "argName" : "datasetRid",
87149
87631
  "type" : {
87150
- "type" : "reference",
87151
- "reference" : {
87152
- "name" : "DatasetRid",
87153
- "package" : "io.nominal.api.rids"
87154
- }
87632
+ "type" : "primitive",
87633
+ "primitive" : "RID"
87155
87634
  },
87156
87635
  "paramType" : {
87157
87636
  "type" : "path",
@@ -87174,25 +87653,35 @@
87174
87653
  },
87175
87654
  "markers" : [ ],
87176
87655
  "tags" : [ ]
87656
+ }, {
87657
+ "argName" : "request",
87658
+ "type" : {
87659
+ "type" : "reference",
87660
+ "reference" : {
87661
+ "name" : "MarkFileIngestSuccessful",
87662
+ "package" : "io.nominal.scout.catalog"
87663
+ }
87664
+ },
87665
+ "paramType" : {
87666
+ "type" : "body",
87667
+ "body" : { }
87668
+ },
87669
+ "markers" : [ ],
87670
+ "tags" : [ ]
87177
87671
  } ],
87178
87672
  "returns" : {
87179
- "type" : "list",
87180
- "list" : {
87181
- "itemType" : {
87182
- "type" : "reference",
87183
- "reference" : {
87184
- "name" : "OriginFileUri",
87185
- "package" : "io.nominal.scout.catalog"
87186
- }
87187
- }
87673
+ "type" : "reference",
87674
+ "reference" : {
87675
+ "name" : "DatasetFile",
87676
+ "package" : "io.nominal.scout.catalog"
87188
87677
  }
87189
87678
  },
87190
87679
  "markers" : [ ],
87191
87680
  "tags" : [ ]
87192
87681
  }, {
87193
- "endpointName" : "markFileIngestSuccessful",
87682
+ "endpointName" : "markFileIngestError",
87194
87683
  "httpMethod" : "PUT",
87195
- "httpPath" : "/catalog/v1/datasets/{datasetRid}/file/{fileId}/success",
87684
+ "httpPath" : "/catalog/v1/datasets/{datasetRid}/file/{fileId}/error",
87196
87685
  "auth" : {
87197
87686
  "type" : "header",
87198
87687
  "header" : { }
@@ -87229,7 +87718,7 @@
87229
87718
  "type" : {
87230
87719
  "type" : "reference",
87231
87720
  "reference" : {
87232
- "name" : "MarkFileIngestSuccessful",
87721
+ "name" : "MarkFileIngestError",
87233
87722
  "package" : "io.nominal.scout.catalog"
87234
87723
  }
87235
87724
  },
@@ -87250,9 +87739,9 @@
87250
87739
  "markers" : [ ],
87251
87740
  "tags" : [ ]
87252
87741
  }, {
87253
- "endpointName" : "markFileIngestError",
87742
+ "endpointName" : "updateDatasetFileMetadata",
87254
87743
  "httpMethod" : "PUT",
87255
- "httpPath" : "/catalog/v1/datasets/{datasetRid}/file/{fileId}/error",
87744
+ "httpPath" : "/catalog/v1/datasets/{datasetRid}/file/{fileId}/metadata",
87256
87745
  "auth" : {
87257
87746
  "type" : "header",
87258
87747
  "header" : { }
@@ -87260,8 +87749,11 @@
87260
87749
  "args" : [ {
87261
87750
  "argName" : "datasetRid",
87262
87751
  "type" : {
87263
- "type" : "primitive",
87264
- "primitive" : "RID"
87752
+ "type" : "reference",
87753
+ "reference" : {
87754
+ "name" : "DatasetRid",
87755
+ "package" : "io.nominal.api.rids"
87756
+ }
87265
87757
  },
87266
87758
  "paramType" : {
87267
87759
  "type" : "path",
@@ -87285,11 +87777,11 @@
87285
87777
  "markers" : [ ],
87286
87778
  "tags" : [ ]
87287
87779
  }, {
87288
- "argName" : "request",
87780
+ "argName" : "metadata",
87289
87781
  "type" : {
87290
87782
  "type" : "reference",
87291
87783
  "reference" : {
87292
- "name" : "MarkFileIngestError",
87784
+ "name" : "DatasetFileMetadata",
87293
87785
  "package" : "io.nominal.scout.catalog"
87294
87786
  }
87295
87787
  },
@@ -87307,6 +87799,7 @@
87307
87799
  "package" : "io.nominal.scout.catalog"
87308
87800
  }
87309
87801
  },
87802
+ "docs" : "Updates file-type-specific metadata for a dataset file. Currently used to update video segment metadata\nafter video segmentation is complete.\n",
87310
87803
  "markers" : [ ],
87311
87804
  "tags" : [ ]
87312
87805
  }, {
@@ -88872,6 +89365,40 @@
88872
89365
  "docs" : "Required permissions matches those required to compute the channels via the compute API.\n",
88873
89366
  "markers" : [ ],
88874
89367
  "tags" : [ ]
89368
+ }, {
89369
+ "endpointName" : "generateExportChannelDataPresignedLink",
89370
+ "httpMethod" : "POST",
89371
+ "httpPath" : "/export/v1/generateExportPresignedLink",
89372
+ "auth" : {
89373
+ "type" : "header",
89374
+ "header" : { }
89375
+ },
89376
+ "args" : [ {
89377
+ "argName" : "request",
89378
+ "type" : {
89379
+ "type" : "reference",
89380
+ "reference" : {
89381
+ "name" : "ExportDataRequest",
89382
+ "package" : "io.nominal.scout.dataexport.api"
89383
+ }
89384
+ },
89385
+ "paramType" : {
89386
+ "type" : "body",
89387
+ "body" : { }
89388
+ },
89389
+ "markers" : [ ],
89390
+ "tags" : [ ]
89391
+ } ],
89392
+ "returns" : {
89393
+ "type" : "reference",
89394
+ "reference" : {
89395
+ "name" : "GeneratePresignedLinkResponse",
89396
+ "package" : "io.nominal.scout.dataexport.api"
89397
+ }
89398
+ },
89399
+ "docs" : "Required permissions matches those required to compute the channels via the compute API.\n",
89400
+ "markers" : [ ],
89401
+ "tags" : [ ]
88875
89402
  } ],
88876
89403
  "docs" : "Provides functionality for exporting data from Scout.\n"
88877
89404
  }, {
@@ -90433,6 +90960,112 @@
90433
90960
  }
90434
90961
  },
90435
90962
  "docs" : "Lists all connections.\n",
90963
+ "deprecated" : "Use listConnectionsV2 for paginated results.",
90964
+ "markers" : [ ],
90965
+ "tags" : [ ]
90966
+ }, {
90967
+ "endpointName" : "listConnectionsV2",
90968
+ "httpMethod" : "GET",
90969
+ "httpPath" : "/data-source/connection/v2/connections",
90970
+ "auth" : {
90971
+ "type" : "header",
90972
+ "header" : { }
90973
+ },
90974
+ "args" : [ {
90975
+ "argName" : "includeArchived",
90976
+ "type" : {
90977
+ "type" : "optional",
90978
+ "optional" : {
90979
+ "itemType" : {
90980
+ "type" : "primitive",
90981
+ "primitive" : "BOOLEAN"
90982
+ }
90983
+ }
90984
+ },
90985
+ "paramType" : {
90986
+ "type" : "query",
90987
+ "query" : {
90988
+ "paramId" : "includeArchived"
90989
+ }
90990
+ },
90991
+ "docs" : "Whether to include archived connections in the response.\nBy default, this is false.\n",
90992
+ "markers" : [ ],
90993
+ "tags" : [ ]
90994
+ }, {
90995
+ "argName" : "workspaces",
90996
+ "type" : {
90997
+ "type" : "set",
90998
+ "set" : {
90999
+ "itemType" : {
91000
+ "type" : "reference",
91001
+ "reference" : {
91002
+ "name" : "WorkspaceRid",
91003
+ "package" : "io.nominal.api.rids"
91004
+ }
91005
+ }
91006
+ }
91007
+ },
91008
+ "paramType" : {
91009
+ "type" : "query",
91010
+ "query" : {
91011
+ "paramId" : "workspaces"
91012
+ }
91013
+ },
91014
+ "docs" : "If supplied, will return only the connections within the supplied workspaces. If empty\nwill return all connections for workspaces that the user is permitted to see.\n",
91015
+ "markers" : [ ],
91016
+ "tags" : [ ]
91017
+ }, {
91018
+ "argName" : "pageSize",
91019
+ "type" : {
91020
+ "type" : "optional",
91021
+ "optional" : {
91022
+ "itemType" : {
91023
+ "type" : "primitive",
91024
+ "primitive" : "INTEGER"
91025
+ }
91026
+ }
91027
+ },
91028
+ "paramType" : {
91029
+ "type" : "query",
91030
+ "query" : {
91031
+ "paramId" : "pageSize"
91032
+ }
91033
+ },
91034
+ "docs" : "Number of connections to return per page. Defaults to 100. Will return at most 1000 records per page.\n",
91035
+ "markers" : [ ],
91036
+ "tags" : [ ]
91037
+ }, {
91038
+ "argName" : "nextPageToken",
91039
+ "type" : {
91040
+ "type" : "optional",
91041
+ "optional" : {
91042
+ "itemType" : {
91043
+ "type" : "reference",
91044
+ "reference" : {
91045
+ "name" : "Token",
91046
+ "package" : "io.nominal.api"
91047
+ }
91048
+ }
91049
+ }
91050
+ },
91051
+ "paramType" : {
91052
+ "type" : "query",
91053
+ "query" : {
91054
+ "paramId" : "nextPageToken"
91055
+ }
91056
+ },
91057
+ "docs" : "Token to retrieve the next page of results.\n",
91058
+ "markers" : [ ],
91059
+ "tags" : [ ]
91060
+ } ],
91061
+ "returns" : {
91062
+ "type" : "reference",
91063
+ "reference" : {
91064
+ "name" : "ListConnectionsResponse",
91065
+ "package" : "io.nominal.scout.datasource.connection.api"
91066
+ }
91067
+ },
91068
+ "docs" : "Lists connections with pagination. Returns connections ordered by creation time descending.\n",
90436
91069
  "markers" : [ ],
90437
91070
  "tags" : [ ]
90438
91071
  }, {
@@ -91952,13 +92585,76 @@
91952
92585
  "markers" : [ ],
91953
92586
  "tags" : [ ]
91954
92587
  } ],
91955
- "deprecated" : "Replaced by createVideoFileSegments. Will be removed after April 15th.",
92588
+ "deprecated" : "Replaced by createVideoFileSegments. Will be removed after April 15th.",
92589
+ "markers" : [ ],
92590
+ "tags" : [ ]
92591
+ }, {
92592
+ "endpointName" : "createVideoFileSegments",
92593
+ "httpMethod" : "POST",
92594
+ "httpPath" : "/video/v1/videos/{videoRid}/{videoFileRid}/create-segments",
92595
+ "auth" : {
92596
+ "type" : "header",
92597
+ "header" : { }
92598
+ },
92599
+ "args" : [ {
92600
+ "argName" : "videoRid",
92601
+ "type" : {
92602
+ "type" : "reference",
92603
+ "reference" : {
92604
+ "name" : "VideoRid",
92605
+ "package" : "io.nominal.api.rids"
92606
+ }
92607
+ },
92608
+ "paramType" : {
92609
+ "type" : "path",
92610
+ "path" : { }
92611
+ },
92612
+ "markers" : [ ],
92613
+ "tags" : [ ]
92614
+ }, {
92615
+ "argName" : "videoFileRid",
92616
+ "type" : {
92617
+ "type" : "reference",
92618
+ "reference" : {
92619
+ "name" : "VideoFileRid",
92620
+ "package" : "io.nominal.api.rids"
92621
+ }
92622
+ },
92623
+ "paramType" : {
92624
+ "type" : "path",
92625
+ "path" : { }
92626
+ },
92627
+ "markers" : [ ],
92628
+ "tags" : [ ]
92629
+ }, {
92630
+ "argName" : "request",
92631
+ "type" : {
92632
+ "type" : "reference",
92633
+ "reference" : {
92634
+ "name" : "CreateSegmentsRequest",
92635
+ "package" : "io.nominal.scout.video.api"
92636
+ }
92637
+ },
92638
+ "paramType" : {
92639
+ "type" : "body",
92640
+ "body" : { }
92641
+ },
92642
+ "markers" : [ ],
92643
+ "tags" : [ ]
92644
+ } ],
92645
+ "returns" : {
92646
+ "type" : "reference",
92647
+ "reference" : {
92648
+ "name" : "CreateSegmentsResponse",
92649
+ "package" : "io.nominal.scout.video.api"
92650
+ }
92651
+ },
91956
92652
  "markers" : [ ],
91957
92653
  "tags" : [ ]
91958
92654
  }, {
91959
- "endpointName" : "createVideoFileSegments",
92655
+ "endpointName" : "createVideoStreamSegments",
91960
92656
  "httpMethod" : "POST",
91961
- "httpPath" : "/video/v1/videos/{videoRid}/{videoFileRid}/create-segments",
92657
+ "httpPath" : "/video/v1/videos/{videoRid}/streams/{streamUuid}/create-segments",
91962
92658
  "auth" : {
91963
92659
  "type" : "header",
91964
92660
  "header" : { }
@@ -91979,13 +92675,10 @@
91979
92675
  "markers" : [ ],
91980
92676
  "tags" : [ ]
91981
92677
  }, {
91982
- "argName" : "videoFileRid",
92678
+ "argName" : "streamUuid",
91983
92679
  "type" : {
91984
- "type" : "reference",
91985
- "reference" : {
91986
- "name" : "VideoFileRid",
91987
- "package" : "io.nominal.api.rids"
91988
- }
92680
+ "type" : "primitive",
92681
+ "primitive" : "UUID"
91989
92682
  },
91990
92683
  "paramType" : {
91991
92684
  "type" : "path",
@@ -92016,49 +92709,23 @@
92016
92709
  "package" : "io.nominal.scout.video.api"
92017
92710
  }
92018
92711
  },
92712
+ "docs" : "Creates segments for a video stream. Similar to createVideoFileSegments but for streaming video.\n",
92019
92713
  "markers" : [ ],
92020
92714
  "tags" : [ ]
92021
92715
  }, {
92022
- "endpointName" : "createVideoStreamSegments",
92716
+ "endpointName" : "createDatasetFileSegments",
92023
92717
  "httpMethod" : "POST",
92024
- "httpPath" : "/video/v1/videos/{videoRid}/streams/{streamUuid}/create-segments",
92718
+ "httpPath" : "/video/v1/videos/dataset-files/create-segments",
92025
92719
  "auth" : {
92026
92720
  "type" : "header",
92027
92721
  "header" : { }
92028
92722
  },
92029
92723
  "args" : [ {
92030
- "argName" : "videoRid",
92031
- "type" : {
92032
- "type" : "reference",
92033
- "reference" : {
92034
- "name" : "VideoRid",
92035
- "package" : "io.nominal.api.rids"
92036
- }
92037
- },
92038
- "paramType" : {
92039
- "type" : "path",
92040
- "path" : { }
92041
- },
92042
- "markers" : [ ],
92043
- "tags" : [ ]
92044
- }, {
92045
- "argName" : "streamUuid",
92046
- "type" : {
92047
- "type" : "primitive",
92048
- "primitive" : "UUID"
92049
- },
92050
- "paramType" : {
92051
- "type" : "path",
92052
- "path" : { }
92053
- },
92054
- "markers" : [ ],
92055
- "tags" : [ ]
92056
- }, {
92057
92724
  "argName" : "request",
92058
92725
  "type" : {
92059
92726
  "type" : "reference",
92060
92727
  "reference" : {
92061
- "name" : "CreateSegmentsRequest",
92728
+ "name" : "CreateDatasetFileSegmentsRequest",
92062
92729
  "package" : "io.nominal.scout.video.api"
92063
92730
  }
92064
92731
  },
@@ -92076,7 +92743,7 @@
92076
92743
  "package" : "io.nominal.scout.video.api"
92077
92744
  }
92078
92745
  },
92079
- "docs" : "Creates segments for a video stream. Similar to createVideoFileSegments but for streaming video.\n",
92746
+ "docs" : "Creates segments for a dataset file video. Used for channel-based video ingestion.\n",
92080
92747
  "markers" : [ ],
92081
92748
  "tags" : [ ]
92082
92749
  }, {
@@ -92565,13 +93232,52 @@
92565
93232
  },
92566
93233
  "markers" : [ ],
92567
93234
  "tags" : [ ]
93235
+ }, {
93236
+ "argName" : "start",
93237
+ "type" : {
93238
+ "type" : "optional",
93239
+ "optional" : {
93240
+ "itemType" : {
93241
+ "type" : "primitive",
93242
+ "primitive" : "STRING"
93243
+ }
93244
+ }
93245
+ },
93246
+ "paramType" : {
93247
+ "type" : "query",
93248
+ "query" : {
93249
+ "paramId" : "start"
93250
+ }
93251
+ },
93252
+ "docs" : "Start bound as ISO-8601 timestamp (e.g., \"2024-01-01T00:00:00Z\"). Must be provided together with end, or neither.",
93253
+ "markers" : [ ],
93254
+ "tags" : [ ]
93255
+ }, {
93256
+ "argName" : "end",
93257
+ "type" : {
93258
+ "type" : "optional",
93259
+ "optional" : {
93260
+ "itemType" : {
93261
+ "type" : "primitive",
93262
+ "primitive" : "STRING"
93263
+ }
93264
+ }
93265
+ },
93266
+ "paramType" : {
93267
+ "type" : "query",
93268
+ "query" : {
93269
+ "paramId" : "end"
93270
+ }
93271
+ },
93272
+ "docs" : "End bound as ISO-8601 timestamp (e.g., \"2024-01-01T01:00:00Z\"). Must be provided together with start, or neither.",
93273
+ "markers" : [ ],
93274
+ "tags" : [ ]
92568
93275
  } ],
92569
93276
  "returns" : {
92570
93277
  "type" : "primitive",
92571
93278
  "primitive" : "BINARY"
92572
93279
  },
92573
- "docs" : "Generates an HLS playlist for a video with the given video rid to enable playback. The HLS playlist will contain\nlinks to all of the segments in the video in sequential order.\n",
92574
- "deprecated" : "Replaced by getPlaylistInBounds. Will be removed after April 15th.",
93280
+ "docs" : "Generates an HLS playlist for a video within optional time bounds.\nUses GET with query parameters for HLS.js compatibility.\nThe HLS playlist will contain links to all of the segments in the video that overlap with the given bounds,\nor all segments if no bounds are provided.\n\nNote: The start and end parameters must either both be provided or both be omitted.\nProviding only one will result in a MissingTimestampBoundPair error.\n",
92575
93281
  "markers" : [ ],
92576
93282
  "tags" : [ ]
92577
93283
  }, {
@@ -92658,6 +93364,186 @@
92658
93364
  "primitive" : "BINARY"
92659
93365
  },
92660
93366
  "docs" : "Generates an HLS playlist for a video with the given video rid to enable playback within an optional set of\nbounds. The HLS playlist will contain links to all of the segments in the video that overlap with the given \nbounds.\nplaylist will be limited to the given bounds.\n",
93367
+ "deprecated" : "Use getPlaylist (GET) for HLS.js compatibility.",
93368
+ "markers" : [ ],
93369
+ "tags" : [ ]
93370
+ }, {
93371
+ "endpointName" : "getPlaylistInBoundsForChannel",
93372
+ "httpMethod" : "POST",
93373
+ "httpPath" : "/video/v1/videos/channel/playlist-in-bounds",
93374
+ "auth" : {
93375
+ "type" : "header",
93376
+ "header" : { }
93377
+ },
93378
+ "args" : [ {
93379
+ "argName" : "request",
93380
+ "type" : {
93381
+ "type" : "reference",
93382
+ "reference" : {
93383
+ "name" : "GetPlaylistInBoundsForChannelRequest",
93384
+ "package" : "io.nominal.scout.video.api"
93385
+ }
93386
+ },
93387
+ "paramType" : {
93388
+ "type" : "body",
93389
+ "body" : { }
93390
+ },
93391
+ "markers" : [ ],
93392
+ "tags" : [ ]
93393
+ } ],
93394
+ "returns" : {
93395
+ "type" : "primitive",
93396
+ "primitive" : "BINARY"
93397
+ },
93398
+ "docs" : "Generates an HLS playlist for a video channel series (identified by channel + tags) within an optional set of\nbounds then generates a playlist for all matching video segments.\n",
93399
+ "deprecated" : "Use getPlaylistForChannel (GET) for HLS.js compatibility.",
93400
+ "markers" : [ ],
93401
+ "tags" : [ ]
93402
+ }, {
93403
+ "endpointName" : "getPlaylistForChannel",
93404
+ "httpMethod" : "GET",
93405
+ "httpPath" : "/video/v1/videos/channel/playlist",
93406
+ "auth" : {
93407
+ "type" : "header",
93408
+ "header" : { }
93409
+ },
93410
+ "args" : [ {
93411
+ "argName" : "dataSourceRid",
93412
+ "type" : {
93413
+ "type" : "optional",
93414
+ "optional" : {
93415
+ "itemType" : {
93416
+ "type" : "reference",
93417
+ "reference" : {
93418
+ "name" : "DataSourceRid",
93419
+ "package" : "io.nominal.api.rids"
93420
+ }
93421
+ }
93422
+ }
93423
+ },
93424
+ "paramType" : {
93425
+ "type" : "query",
93426
+ "query" : {
93427
+ "paramId" : "dataSourceRid"
93428
+ }
93429
+ },
93430
+ "docs" : "Data source RID (mutually exclusive with assetRid)",
93431
+ "markers" : [ ],
93432
+ "tags" : [ ]
93433
+ }, {
93434
+ "argName" : "assetRid",
93435
+ "type" : {
93436
+ "type" : "optional",
93437
+ "optional" : {
93438
+ "itemType" : {
93439
+ "type" : "reference",
93440
+ "reference" : {
93441
+ "name" : "AssetRid",
93442
+ "package" : "io.nominal.scout.rids.api"
93443
+ }
93444
+ }
93445
+ }
93446
+ },
93447
+ "paramType" : {
93448
+ "type" : "query",
93449
+ "query" : {
93450
+ "paramId" : "assetRid"
93451
+ }
93452
+ },
93453
+ "docs" : "Asset RID (mutually exclusive with dataSourceRid, requires dataScopeName)",
93454
+ "markers" : [ ],
93455
+ "tags" : [ ]
93456
+ }, {
93457
+ "argName" : "dataScopeName",
93458
+ "type" : {
93459
+ "type" : "optional",
93460
+ "optional" : {
93461
+ "itemType" : {
93462
+ "type" : "primitive",
93463
+ "primitive" : "STRING"
93464
+ }
93465
+ }
93466
+ },
93467
+ "paramType" : {
93468
+ "type" : "query",
93469
+ "query" : {
93470
+ "paramId" : "dataScopeName"
93471
+ }
93472
+ },
93473
+ "docs" : "Data scope name (required when using assetRid)",
93474
+ "markers" : [ ],
93475
+ "tags" : [ ]
93476
+ }, {
93477
+ "argName" : "channel",
93478
+ "type" : {
93479
+ "type" : "primitive",
93480
+ "primitive" : "STRING"
93481
+ },
93482
+ "paramType" : {
93483
+ "type" : "query",
93484
+ "query" : {
93485
+ "paramId" : "channel"
93486
+ }
93487
+ },
93488
+ "docs" : "Channel name",
93489
+ "markers" : [ ],
93490
+ "tags" : [ ]
93491
+ }, {
93492
+ "argName" : "tags",
93493
+ "type" : {
93494
+ "type" : "optional",
93495
+ "optional" : {
93496
+ "itemType" : {
93497
+ "type" : "primitive",
93498
+ "primitive" : "STRING"
93499
+ }
93500
+ }
93501
+ },
93502
+ "paramType" : {
93503
+ "type" : "query",
93504
+ "query" : {
93505
+ "paramId" : "tags"
93506
+ }
93507
+ },
93508
+ "docs" : "Tags as JSON-encoded map (e.g., {\"vehicle\":\"car1\"})",
93509
+ "markers" : [ ],
93510
+ "tags" : [ ]
93511
+ }, {
93512
+ "argName" : "start",
93513
+ "type" : {
93514
+ "type" : "primitive",
93515
+ "primitive" : "STRING"
93516
+ },
93517
+ "paramType" : {
93518
+ "type" : "query",
93519
+ "query" : {
93520
+ "paramId" : "start"
93521
+ }
93522
+ },
93523
+ "docs" : "Required start bound as ISO-8601 timestamp (e.g., \"2024-01-01T00:00:00Z\"). Must be provided with end.",
93524
+ "markers" : [ ],
93525
+ "tags" : [ ]
93526
+ }, {
93527
+ "argName" : "end",
93528
+ "type" : {
93529
+ "type" : "primitive",
93530
+ "primitive" : "STRING"
93531
+ },
93532
+ "paramType" : {
93533
+ "type" : "query",
93534
+ "query" : {
93535
+ "paramId" : "end"
93536
+ }
93537
+ },
93538
+ "docs" : "Required end bound as ISO-8601 timestamp (e.g., \"2024-01-01T01:00:00Z\"). Must be provided with start.",
93539
+ "markers" : [ ],
93540
+ "tags" : [ ]
93541
+ } ],
93542
+ "returns" : {
93543
+ "type" : "primitive",
93544
+ "primitive" : "BINARY"
93545
+ },
93546
+ "docs" : "Generates an HLS playlist for a video channel series within time bounds.\nSpecify either dataSourceRid OR (assetRid + dataScopeName) to identify the channel source.\n\nNote: Both start and end parameters are required and must be provided together.\n",
92661
93547
  "markers" : [ ],
92662
93548
  "tags" : [ ]
92663
93549
  }, {
@@ -92714,6 +93600,45 @@
92714
93600
  "docs" : "Returns the min and max absolute and media timestamps for each segment in a video that overlap with an \noptional set of bounds.\n",
92715
93601
  "markers" : [ ],
92716
93602
  "tags" : [ ]
93603
+ }, {
93604
+ "endpointName" : "getSegmentSummariesInBoundsForChannel",
93605
+ "httpMethod" : "POST",
93606
+ "httpPath" : "/video/v1/videos/channel/segment-summaries-in-bounds",
93607
+ "auth" : {
93608
+ "type" : "header",
93609
+ "header" : { }
93610
+ },
93611
+ "args" : [ {
93612
+ "argName" : "request",
93613
+ "type" : {
93614
+ "type" : "reference",
93615
+ "reference" : {
93616
+ "name" : "GetSegmentSummariesInBoundsForChannelRequest",
93617
+ "package" : "io.nominal.scout.video.api"
93618
+ }
93619
+ },
93620
+ "paramType" : {
93621
+ "type" : "body",
93622
+ "body" : { }
93623
+ },
93624
+ "markers" : [ ],
93625
+ "tags" : [ ]
93626
+ } ],
93627
+ "returns" : {
93628
+ "type" : "list",
93629
+ "list" : {
93630
+ "itemType" : {
93631
+ "type" : "reference",
93632
+ "reference" : {
93633
+ "name" : "SegmentSummary",
93634
+ "package" : "io.nominal.scout.video.api"
93635
+ }
93636
+ }
93637
+ }
93638
+ },
93639
+ "docs" : "Returns the min and max absolute and media timestamps for each segment matching a video channel series \n(identified by channel + tags) within the specified bounds.\n",
93640
+ "markers" : [ ],
93641
+ "tags" : [ ]
92717
93642
  }, {
92718
93643
  "endpointName" : "getFileSummaries",
92719
93644
  "httpMethod" : "POST",
@@ -93821,7 +94746,7 @@
93821
94746
  "markers" : [ ],
93822
94747
  "tags" : [ ]
93823
94748
  } ],
93824
- "docs" : "Synchronously writes a Nominal Write Request to a Nominal data source using the NominalWrite Protobuf schema.\nThe request must be Protobuf-encoded and accompanied by the appropriate content encoding headers if compressed.\n\nThe request should follow this Protobuf schema:\n```proto\nmessage WriteRequestNominal {\n repeated Series series = 1;\n}\n\nmessage Series {\n Channel channel = 1; \n map<string, string> tags = 2; // Key-value pairs for series tags\n Points points = 3; // Contains double, string, integer, array, or struct points\n}\n\nmessage Channel {\n string name = 1;\n} \n\nmessage Points {\n oneof points_type {\n DoublePoints double_points = 1;\n StringPoints string_points = 2;\n IntegerPoints integer_points = 3;\n ArrayPoints array_points = 4;\n StructPoints struct_points = 5;\n }\n}\n\nmessage DoublePoints {\n repeated DoublePoint points = 1;\n}\n\nmessage StringPoints {\n repeated StringPoint points = 1;\n}\n\nmessage IntegerPoints {\n repeated IntegerPoint points = 1;\n}\n\nmessage ArrayPoints {\n oneof array_type {\n DoubleArrayPoints double_array_points = 1;\n StringArrayPoints string_array_points = 2;\n }\n}\n\nmessage DoubleArrayPoints {\n repeated DoubleArrayPoint points = 1;\n}\n\nmessage StringArrayPoints {\n repeated StringArrayPoint points = 1;\n}\n\nmessage StructPoints {\n repeated StructPoint points = 1;\n}\n\nmessage DoublePoint {\n google.protobuf.Timestamp timestamp = 1;\n double value = 2;\n}\n\nmessage StringPoint {\n google.protobuf.Timestamp timestamp = 1;\n string value = 2;\n}\n\nmessage IntegerPoint {\n google.protobuf.Timestamp timestamp = 1;\n int64 value = 2;\n}\n\nmessage DoubleArrayPoint {\n google.protobuf.Timestamp timestamp = 1;\n repeated double value = 2;\n}\n\nmessage StringArrayPoint {\n google.protobuf.Timestamp timestamp = 1;\n repeated string value = 2;\n}\n\nmessage StructPoint {\n google.protobuf.Timestamp timestamp = 1;\n string jsonString = 2;\n}\n```\n\nEach request can contain multiple series, where each series consists of:\n- A channel name\n- A map of tags (key-value pairs)\n- A collection of points, which can be double, string, integer, array (double/string), or struct (json) values\n- Each point includes a timestamp (using google.protobuf.Timestamp) and its value\n- Array points contain repeated values (array<double> or array<string>)\n- Struct points are represented using strings that contain the JSON formatted blobs, with all keys being strings\n\nThe endpoint requires the Content-Type header to be set to \"application/x-protobuf\".\nIf the payload is compressed, the appropriate Content-Encoding header must be included.\n",
94749
+ "docs" : "Synchronously writes a Nominal Write Request to a Nominal data source using the NominalWrite Protobuf schema.\nThe request must be Protobuf-encoded and accompanied by the appropriate content encoding headers if compressed.\n\nThe request should follow this Protobuf schema:\n```proto\nmessage WriteRequestNominal {\n repeated Series series = 1;\n}\n\nmessage Series {\n Channel channel = 1; \n map<string, string> tags = 2; // Key-value pairs for series tags\n Points points = 3; // Contains double, string, integer, array, or struct points\n}\n\nmessage Channel {\n string name = 1;\n} \n\nmessage Points {\n oneof points_type {\n DoublePoints double_points = 1;\n StringPoints string_points = 2;\n IntegerPoints integer_points = 3;\n ArrayPoints array_points = 4;\n StructPoints struct_points = 5;\n Uint64Points uint64_points = 6;\n }\n}\n\nmessage DoublePoints {\n repeated DoublePoint points = 1;\n}\n\nmessage StringPoints {\n repeated StringPoint points = 1;\n}\n\nmessage IntegerPoints {\n repeated IntegerPoint points = 1;\n}\n\nmessage Uint64Points {\n repeated Uint64Point points = 1;\n}\n\nmessage ArrayPoints {\n oneof array_type {\n DoubleArrayPoints double_array_points = 1;\n StringArrayPoints string_array_points = 2;\n }\n}\n\nmessage DoubleArrayPoints {\n repeated DoubleArrayPoint points = 1;\n}\n\nmessage StringArrayPoints {\n repeated StringArrayPoint points = 1;\n}\n\nmessage StructPoints {\n repeated StructPoint points = 1;\n}\n\nmessage DoublePoint {\n google.protobuf.Timestamp timestamp = 1;\n double value = 2;\n}\n\nmessage StringPoint {\n google.protobuf.Timestamp timestamp = 1;\n string value = 2;\n}\n\nmessage IntegerPoint {\n google.protobuf.Timestamp timestamp = 1;\n int64 value = 2;\n}\n\nmessage Uint64Point {\n google.protobuf.Timestamp timestamp = 1;\n uint64 value = 2;\n}\n\nmessage DoubleArrayPoint {\n google.protobuf.Timestamp timestamp = 1;\n repeated double value = 2;\n}\n\nmessage StringArrayPoint {\n google.protobuf.Timestamp timestamp = 1;\n repeated string value = 2;\n}\n\nmessage StructPoint {\n google.protobuf.Timestamp timestamp = 1;\n string jsonString = 2;\n}\n```\n\nEach request can contain multiple series, where each series consists of:\n- A channel name\n- A map of tags (key-value pairs)\n- A collection of points, which can be double, string, integer, array (double/string), or struct (json) values\n- Each point includes a timestamp (using google.protobuf.Timestamp) and its value\n- Array points contain repeated values (array<double> or array<string>)\n- Struct points are represented using strings that contain the JSON formatted blobs, with all keys being strings\n\nThe endpoint requires the Content-Type header to be set to \"application/x-protobuf\".\nIf the payload is compressed, the appropriate Content-Encoding header must be included.\n",
93825
94750
  "markers" : [ ],
93826
94751
  "tags" : [ ]
93827
94752
  }, {