nominal-api 0.624.0__py3-none-any.whl → 0.625.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.

Potentially problematic release.


This version of nominal-api might be problematic. Click here for more details.

nominal_api/__init__.py CHANGED
@@ -76,5 +76,5 @@ __all__ = [
76
76
 
77
77
  __conjure_generator_version__ = "4.9.0"
78
78
 
79
- __version__ = "0.624.0"
79
+ __version__ = "0.625.0"
80
80
 
nominal_api/_impl.py CHANGED
@@ -11815,24 +11815,18 @@ append result for [117s, 122s].
11815
11815
  @builtins.classmethod
11816
11816
  def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
11817
11817
  return {
11818
- 'subscription_id': ConjureFieldDefinition('subscriptionId', persistent_compute_api_SubscriptionId),
11819
11818
  'start': ConjureFieldDefinition('start', api_Timestamp),
11820
11819
  'end': ConjureFieldDefinition('end', api_Timestamp),
11821
11820
  'result': ConjureFieldDefinition('result', persistent_compute_api_ComputeNodeAppendResponse)
11822
11821
  }
11823
11822
 
11824
- __slots__: List[str] = ['_subscription_id', '_start', '_end', '_result']
11823
+ __slots__: List[str] = ['_start', '_end', '_result']
11825
11824
 
11826
- def __init__(self, end: "api_Timestamp", result: "persistent_compute_api_ComputeNodeAppendResponse", start: "api_Timestamp", subscription_id: str) -> None:
11827
- self._subscription_id = subscription_id
11825
+ def __init__(self, end: "api_Timestamp", result: "persistent_compute_api_ComputeNodeAppendResponse", start: "api_Timestamp") -> None:
11828
11826
  self._start = start
11829
11827
  self._end = end
11830
11828
  self._result = result
11831
11829
 
11832
- @builtins.property
11833
- def subscription_id(self) -> str:
11834
- return self._subscription_id
11835
-
11836
11830
  @builtins.property
11837
11831
  def start(self) -> "api_Timestamp":
11838
11832
  """
@@ -11923,9 +11917,9 @@ class persistent_compute_api_ClientMessage(ConjureUnionType):
11923
11917
  """
11924
11918
  Subscribes to all of the given `StreamingComputeNodeSubscription`s. For identifying the subscriptions and
11925
11919
  their results a `SubscriptionId` has to be passed, which should be a unique identifier.
11926
- If the subscription is invalid (e.g., window too big for in-memory compute or in-memory compute not
11927
- enabled for datasource) a `ServerMessage::subscriptionError` will be sent back. Otherwise, updated results
11928
- for the subscription will be sent periodically via `ServerMessage::subscriptionUpdate`.
11920
+ A `ServerMessage::subscriptionCreation` will be sent back for each subscription which shows whether the
11921
+ subscription was successfully created. If it was, updated results for the subscription will be sent
11922
+ periodically via `ServerMessage::subscriptionUpdate`.
11929
11923
  """
11930
11924
  return self._subscribe
11931
11925
 
@@ -11984,7 +11978,7 @@ persistent_compute_api_ClientMessageVisitor.__module__ = "nominal_api.persistent
11984
11978
 
11985
11979
 
11986
11980
  class persistent_compute_api_ComputeNodeAppendResponse(ConjureUnionType):
11987
- """These cover the subset of the union type in `ComputeWithUnitsResponse` for which we support append result.
11981
+ """These cover the subset of the union type in `ComputeNodeResponse` for which we support append results.
11988
11982
  Append results will have the same subtype as the previous full result for the same `SubscriptionId`.
11989
11983
  If the subtype were to change (e.g., we start doing bucketing because data frequency increased) we will send
11990
11984
  a new full result with that new type. The results will also have the same units as the previous `FullResult`.
@@ -12199,22 +12193,16 @@ class persistent_compute_api_FullResult(ConjureBeanType):
12199
12193
  @builtins.classmethod
12200
12194
  def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
12201
12195
  return {
12202
- 'subscription_id': ConjureFieldDefinition('subscriptionId', persistent_compute_api_SubscriptionId),
12203
- 'result': ConjureFieldDefinition('result', scout_compute_api_ComputeWithUnitsResponse)
12196
+ 'result': ConjureFieldDefinition('result', scout_compute_api_ComputeNodeResponse)
12204
12197
  }
12205
12198
 
12206
- __slots__: List[str] = ['_subscription_id', '_result']
12199
+ __slots__: List[str] = ['_result']
12207
12200
 
12208
- def __init__(self, result: "scout_compute_api_ComputeWithUnitsResponse", subscription_id: str) -> None:
12209
- self._subscription_id = subscription_id
12201
+ def __init__(self, result: "scout_compute_api_ComputeNodeResponse") -> None:
12210
12202
  self._result = result
12211
12203
 
12212
12204
  @builtins.property
12213
- def subscription_id(self) -> str:
12214
- return self._subscription_id
12215
-
12216
- @builtins.property
12217
- def result(self) -> "scout_compute_api_ComputeWithUnitsResponse":
12205
+ def result(self) -> "scout_compute_api_ComputeNodeResponse":
12218
12206
  return self._result
12219
12207
 
12220
12208
 
@@ -12223,6 +12211,83 @@ persistent_compute_api_FullResult.__qualname__ = "FullResult"
12223
12211
  persistent_compute_api_FullResult.__module__ = "nominal_api.persistent_compute_api"
12224
12212
 
12225
12213
 
12214
+ class persistent_compute_api_HealthMessage(ConjureUnionType):
12215
+ _ping: Optional["persistent_compute_api_Ping"] = None
12216
+ _pong: Optional["persistent_compute_api_Pong"] = None
12217
+
12218
+ @builtins.classmethod
12219
+ def _options(cls) -> Dict[str, ConjureFieldDefinition]:
12220
+ return {
12221
+ 'ping': ConjureFieldDefinition('ping', persistent_compute_api_Ping),
12222
+ 'pong': ConjureFieldDefinition('pong', persistent_compute_api_Pong)
12223
+ }
12224
+
12225
+ def __init__(
12226
+ self,
12227
+ ping: Optional["persistent_compute_api_Ping"] = None,
12228
+ pong: Optional["persistent_compute_api_Pong"] = None,
12229
+ type_of_union: Optional[str] = None
12230
+ ) -> None:
12231
+ if type_of_union is None:
12232
+ if (ping is not None) + (pong is not None) != 1:
12233
+ raise ValueError('a union must contain a single member')
12234
+
12235
+ if ping is not None:
12236
+ self._ping = ping
12237
+ self._type = 'ping'
12238
+ if pong is not None:
12239
+ self._pong = pong
12240
+ self._type = 'pong'
12241
+
12242
+ elif type_of_union == 'ping':
12243
+ if ping is None:
12244
+ raise ValueError('a union value must not be None')
12245
+ self._ping = ping
12246
+ self._type = 'ping'
12247
+ elif type_of_union == 'pong':
12248
+ if pong is None:
12249
+ raise ValueError('a union value must not be None')
12250
+ self._pong = pong
12251
+ self._type = 'pong'
12252
+
12253
+ @builtins.property
12254
+ def ping(self) -> Optional["persistent_compute_api_Ping"]:
12255
+ return self._ping
12256
+
12257
+ @builtins.property
12258
+ def pong(self) -> Optional["persistent_compute_api_Pong"]:
12259
+ return self._pong
12260
+
12261
+ def accept(self, visitor) -> Any:
12262
+ if not isinstance(visitor, persistent_compute_api_HealthMessageVisitor):
12263
+ raise ValueError('{} is not an instance of persistent_compute_api_HealthMessageVisitor'.format(visitor.__class__.__name__))
12264
+ if self._type == 'ping' and self.ping is not None:
12265
+ return visitor._ping(self.ping)
12266
+ if self._type == 'pong' and self.pong is not None:
12267
+ return visitor._pong(self.pong)
12268
+
12269
+
12270
+ persistent_compute_api_HealthMessage.__name__ = "HealthMessage"
12271
+ persistent_compute_api_HealthMessage.__qualname__ = "HealthMessage"
12272
+ persistent_compute_api_HealthMessage.__module__ = "nominal_api.persistent_compute_api"
12273
+
12274
+
12275
+ class persistent_compute_api_HealthMessageVisitor:
12276
+
12277
+ @abstractmethod
12278
+ def _ping(self, ping: "persistent_compute_api_Ping") -> Any:
12279
+ pass
12280
+
12281
+ @abstractmethod
12282
+ def _pong(self, pong: "persistent_compute_api_Pong") -> Any:
12283
+ pass
12284
+
12285
+
12286
+ persistent_compute_api_HealthMessageVisitor.__name__ = "HealthMessageVisitor"
12287
+ persistent_compute_api_HealthMessageVisitor.__qualname__ = "HealthMessageVisitor"
12288
+ persistent_compute_api_HealthMessageVisitor.__module__ = "nominal_api.persistent_compute_api"
12289
+
12290
+
12226
12291
  class persistent_compute_api_Ping(ConjureBeanType):
12227
12292
  """
12228
12293
  A ping can be sent by both client and server to keep the connection open and check that it is still working.
@@ -12282,93 +12347,76 @@ persistent_compute_api_Pong.__module__ = "nominal_api.persistent_compute_api"
12282
12347
 
12283
12348
 
12284
12349
  class persistent_compute_api_ServerMessage(ConjureUnionType):
12285
- _subscription_update: Optional["persistent_compute_api_SubscriptionUpdate"] = None
12286
- _subscription_error: Optional["persistent_compute_api_SubscriptionError"] = None
12287
- _ping: Optional["persistent_compute_api_Ping"] = None
12288
- _pong: Optional["persistent_compute_api_Pong"] = None
12350
+ _subscription_update: Optional["persistent_compute_api_SubscriptionUpdateMessage"] = None
12351
+ _subscription_creation: Optional["persistent_compute_api_SubscriptionCreationMessage"] = None
12352
+ _health: Optional["persistent_compute_api_HealthMessage"] = None
12289
12353
 
12290
12354
  @builtins.classmethod
12291
12355
  def _options(cls) -> Dict[str, ConjureFieldDefinition]:
12292
12356
  return {
12293
- 'subscription_update': ConjureFieldDefinition('subscriptionUpdate', persistent_compute_api_SubscriptionUpdate),
12294
- 'subscription_error': ConjureFieldDefinition('subscriptionError', persistent_compute_api_SubscriptionError),
12295
- 'ping': ConjureFieldDefinition('ping', persistent_compute_api_Ping),
12296
- 'pong': ConjureFieldDefinition('pong', persistent_compute_api_Pong)
12357
+ 'subscription_update': ConjureFieldDefinition('subscriptionUpdate', persistent_compute_api_SubscriptionUpdateMessage),
12358
+ 'subscription_creation': ConjureFieldDefinition('subscriptionCreation', persistent_compute_api_SubscriptionCreationMessage),
12359
+ 'health': ConjureFieldDefinition('health', persistent_compute_api_HealthMessage)
12297
12360
  }
12298
12361
 
12299
12362
  def __init__(
12300
12363
  self,
12301
- subscription_update: Optional["persistent_compute_api_SubscriptionUpdate"] = None,
12302
- subscription_error: Optional["persistent_compute_api_SubscriptionError"] = None,
12303
- ping: Optional["persistent_compute_api_Ping"] = None,
12304
- pong: Optional["persistent_compute_api_Pong"] = None,
12364
+ subscription_update: Optional["persistent_compute_api_SubscriptionUpdateMessage"] = None,
12365
+ subscription_creation: Optional["persistent_compute_api_SubscriptionCreationMessage"] = None,
12366
+ health: Optional["persistent_compute_api_HealthMessage"] = None,
12305
12367
  type_of_union: Optional[str] = None
12306
12368
  ) -> None:
12307
12369
  if type_of_union is None:
12308
- if (subscription_update is not None) + (subscription_error is not None) + (ping is not None) + (pong is not None) != 1:
12370
+ if (subscription_update is not None) + (subscription_creation is not None) + (health is not None) != 1:
12309
12371
  raise ValueError('a union must contain a single member')
12310
12372
 
12311
12373
  if subscription_update is not None:
12312
12374
  self._subscription_update = subscription_update
12313
12375
  self._type = 'subscriptionUpdate'
12314
- if subscription_error is not None:
12315
- self._subscription_error = subscription_error
12316
- self._type = 'subscriptionError'
12317
- if ping is not None:
12318
- self._ping = ping
12319
- self._type = 'ping'
12320
- if pong is not None:
12321
- self._pong = pong
12322
- self._type = 'pong'
12376
+ if subscription_creation is not None:
12377
+ self._subscription_creation = subscription_creation
12378
+ self._type = 'subscriptionCreation'
12379
+ if health is not None:
12380
+ self._health = health
12381
+ self._type = 'health'
12323
12382
 
12324
12383
  elif type_of_union == 'subscriptionUpdate':
12325
12384
  if subscription_update is None:
12326
12385
  raise ValueError('a union value must not be None')
12327
12386
  self._subscription_update = subscription_update
12328
12387
  self._type = 'subscriptionUpdate'
12329
- elif type_of_union == 'subscriptionError':
12330
- if subscription_error is None:
12388
+ elif type_of_union == 'subscriptionCreation':
12389
+ if subscription_creation is None:
12331
12390
  raise ValueError('a union value must not be None')
12332
- self._subscription_error = subscription_error
12333
- self._type = 'subscriptionError'
12334
- elif type_of_union == 'ping':
12335
- if ping is None:
12391
+ self._subscription_creation = subscription_creation
12392
+ self._type = 'subscriptionCreation'
12393
+ elif type_of_union == 'health':
12394
+ if health is None:
12336
12395
  raise ValueError('a union value must not be None')
12337
- self._ping = ping
12338
- self._type = 'ping'
12339
- elif type_of_union == 'pong':
12340
- if pong is None:
12341
- raise ValueError('a union value must not be None')
12342
- self._pong = pong
12343
- self._type = 'pong'
12396
+ self._health = health
12397
+ self._type = 'health'
12344
12398
 
12345
12399
  @builtins.property
12346
- def subscription_update(self) -> Optional["persistent_compute_api_SubscriptionUpdate"]:
12400
+ def subscription_update(self) -> Optional["persistent_compute_api_SubscriptionUpdateMessage"]:
12347
12401
  return self._subscription_update
12348
12402
 
12349
12403
  @builtins.property
12350
- def subscription_error(self) -> Optional["persistent_compute_api_SubscriptionError"]:
12351
- return self._subscription_error
12404
+ def subscription_creation(self) -> Optional["persistent_compute_api_SubscriptionCreationMessage"]:
12405
+ return self._subscription_creation
12352
12406
 
12353
12407
  @builtins.property
12354
- def ping(self) -> Optional["persistent_compute_api_Ping"]:
12355
- return self._ping
12356
-
12357
- @builtins.property
12358
- def pong(self) -> Optional["persistent_compute_api_Pong"]:
12359
- return self._pong
12408
+ def health(self) -> Optional["persistent_compute_api_HealthMessage"]:
12409
+ return self._health
12360
12410
 
12361
12411
  def accept(self, visitor) -> Any:
12362
12412
  if not isinstance(visitor, persistent_compute_api_ServerMessageVisitor):
12363
12413
  raise ValueError('{} is not an instance of persistent_compute_api_ServerMessageVisitor'.format(visitor.__class__.__name__))
12364
12414
  if self._type == 'subscriptionUpdate' and self.subscription_update is not None:
12365
12415
  return visitor._subscription_update(self.subscription_update)
12366
- if self._type == 'subscriptionError' and self.subscription_error is not None:
12367
- return visitor._subscription_error(self.subscription_error)
12368
- if self._type == 'ping' and self.ping is not None:
12369
- return visitor._ping(self.ping)
12370
- if self._type == 'pong' and self.pong is not None:
12371
- return visitor._pong(self.pong)
12416
+ if self._type == 'subscriptionCreation' and self.subscription_creation is not None:
12417
+ return visitor._subscription_creation(self.subscription_creation)
12418
+ if self._type == 'health' and self.health is not None:
12419
+ return visitor._health(self.health)
12372
12420
 
12373
12421
 
12374
12422
  persistent_compute_api_ServerMessage.__name__ = "ServerMessage"
@@ -12379,19 +12427,15 @@ persistent_compute_api_ServerMessage.__module__ = "nominal_api.persistent_comput
12379
12427
  class persistent_compute_api_ServerMessageVisitor:
12380
12428
 
12381
12429
  @abstractmethod
12382
- def _subscription_update(self, subscription_update: "persistent_compute_api_SubscriptionUpdate") -> Any:
12430
+ def _subscription_update(self, subscription_update: "persistent_compute_api_SubscriptionUpdateMessage") -> Any:
12383
12431
  pass
12384
12432
 
12385
12433
  @abstractmethod
12386
- def _subscription_error(self, subscription_error: "persistent_compute_api_SubscriptionError") -> Any:
12434
+ def _subscription_creation(self, subscription_creation: "persistent_compute_api_SubscriptionCreationMessage") -> Any:
12387
12435
  pass
12388
12436
 
12389
12437
  @abstractmethod
12390
- def _ping(self, ping: "persistent_compute_api_Ping") -> Any:
12391
- pass
12392
-
12393
- @abstractmethod
12394
- def _pong(self, pong: "persistent_compute_api_Pong") -> Any:
12438
+ def _health(self, health: "persistent_compute_api_HealthMessage") -> Any:
12395
12439
  pass
12396
12440
 
12397
12441
 
@@ -12468,30 +12512,100 @@ persistent_compute_api_StreamingComputeNodeSubscription.__qualname__ = "Streamin
12468
12512
  persistent_compute_api_StreamingComputeNodeSubscription.__module__ = "nominal_api.persistent_compute_api"
12469
12513
 
12470
12514
 
12471
- class persistent_compute_api_SubscriptionError(ConjureBeanType):
12515
+ class persistent_compute_api_SubscriptionCreation(ConjureUnionType):
12516
+ _success: Optional["persistent_compute_api_SubscriptionCreationSuccess"] = None
12517
+ _error: Optional["persistent_compute_api_SubscriptionCreationError"] = None
12518
+
12519
+ @builtins.classmethod
12520
+ def _options(cls) -> Dict[str, ConjureFieldDefinition]:
12521
+ return {
12522
+ 'success': ConjureFieldDefinition('success', persistent_compute_api_SubscriptionCreationSuccess),
12523
+ 'error': ConjureFieldDefinition('error', persistent_compute_api_SubscriptionCreationError)
12524
+ }
12525
+
12526
+ def __init__(
12527
+ self,
12528
+ success: Optional["persistent_compute_api_SubscriptionCreationSuccess"] = None,
12529
+ error: Optional["persistent_compute_api_SubscriptionCreationError"] = None,
12530
+ type_of_union: Optional[str] = None
12531
+ ) -> None:
12532
+ if type_of_union is None:
12533
+ if (success is not None) + (error is not None) != 1:
12534
+ raise ValueError('a union must contain a single member')
12535
+
12536
+ if success is not None:
12537
+ self._success = success
12538
+ self._type = 'success'
12539
+ if error is not None:
12540
+ self._error = error
12541
+ self._type = 'error'
12542
+
12543
+ elif type_of_union == 'success':
12544
+ if success is None:
12545
+ raise ValueError('a union value must not be None')
12546
+ self._success = success
12547
+ self._type = 'success'
12548
+ elif type_of_union == 'error':
12549
+ if error is None:
12550
+ raise ValueError('a union value must not be None')
12551
+ self._error = error
12552
+ self._type = 'error'
12553
+
12554
+ @builtins.property
12555
+ def success(self) -> Optional["persistent_compute_api_SubscriptionCreationSuccess"]:
12556
+ return self._success
12557
+
12558
+ @builtins.property
12559
+ def error(self) -> Optional["persistent_compute_api_SubscriptionCreationError"]:
12560
+ return self._error
12561
+
12562
+ def accept(self, visitor) -> Any:
12563
+ if not isinstance(visitor, persistent_compute_api_SubscriptionCreationVisitor):
12564
+ raise ValueError('{} is not an instance of persistent_compute_api_SubscriptionCreationVisitor'.format(visitor.__class__.__name__))
12565
+ if self._type == 'success' and self.success is not None:
12566
+ return visitor._success(self.success)
12567
+ if self._type == 'error' and self.error is not None:
12568
+ return visitor._error(self.error)
12569
+
12570
+
12571
+ persistent_compute_api_SubscriptionCreation.__name__ = "SubscriptionCreation"
12572
+ persistent_compute_api_SubscriptionCreation.__qualname__ = "SubscriptionCreation"
12573
+ persistent_compute_api_SubscriptionCreation.__module__ = "nominal_api.persistent_compute_api"
12574
+
12575
+
12576
+ class persistent_compute_api_SubscriptionCreationVisitor:
12577
+
12578
+ @abstractmethod
12579
+ def _success(self, success: "persistent_compute_api_SubscriptionCreationSuccess") -> Any:
12580
+ pass
12581
+
12582
+ @abstractmethod
12583
+ def _error(self, error: "persistent_compute_api_SubscriptionCreationError") -> Any:
12584
+ pass
12585
+
12586
+
12587
+ persistent_compute_api_SubscriptionCreationVisitor.__name__ = "SubscriptionCreationVisitor"
12588
+ persistent_compute_api_SubscriptionCreationVisitor.__qualname__ = "SubscriptionCreationVisitor"
12589
+ persistent_compute_api_SubscriptionCreationVisitor.__module__ = "nominal_api.persistent_compute_api"
12590
+
12591
+
12592
+ class persistent_compute_api_SubscriptionCreationError(ConjureBeanType):
12472
12593
  """
12473
- This will be sent if there is an error while creating or updating a subscription. Note: This won't
12474
- automatically cancel the subscription. The client will have to call `ClientMessage::unsubscribe` to do that
12475
- if warranted.
12594
+ This will be sent if there is an error while creating a subscription. This means that the subscription was
12595
+ never created and the client will have to re-try creating it if warranted.
12476
12596
  """
12477
12597
 
12478
12598
  @builtins.classmethod
12479
12599
  def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
12480
12600
  return {
12481
- 'subscription_id': ConjureFieldDefinition('subscriptionId', persistent_compute_api_SubscriptionId),
12482
12601
  'serializable_error': ConjureFieldDefinition('serializableError', api_SerializableError)
12483
12602
  }
12484
12603
 
12485
- __slots__: List[str] = ['_subscription_id', '_serializable_error']
12604
+ __slots__: List[str] = ['_serializable_error']
12486
12605
 
12487
- def __init__(self, serializable_error: "api_SerializableError", subscription_id: str) -> None:
12488
- self._subscription_id = subscription_id
12606
+ def __init__(self, serializable_error: "api_SerializableError") -> None:
12489
12607
  self._serializable_error = serializable_error
12490
12608
 
12491
- @builtins.property
12492
- def subscription_id(self) -> str:
12493
- return self._subscription_id
12494
-
12495
12609
  @builtins.property
12496
12610
  def serializable_error(self) -> "api_SerializableError":
12497
12611
  """
@@ -12500,9 +12614,64 @@ if warranted.
12500
12614
  return self._serializable_error
12501
12615
 
12502
12616
 
12503
- persistent_compute_api_SubscriptionError.__name__ = "SubscriptionError"
12504
- persistent_compute_api_SubscriptionError.__qualname__ = "SubscriptionError"
12505
- persistent_compute_api_SubscriptionError.__module__ = "nominal_api.persistent_compute_api"
12617
+ persistent_compute_api_SubscriptionCreationError.__name__ = "SubscriptionCreationError"
12618
+ persistent_compute_api_SubscriptionCreationError.__qualname__ = "SubscriptionCreationError"
12619
+ persistent_compute_api_SubscriptionCreationError.__module__ = "nominal_api.persistent_compute_api"
12620
+
12621
+
12622
+ class persistent_compute_api_SubscriptionCreationMessage(ConjureBeanType):
12623
+
12624
+ @builtins.classmethod
12625
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
12626
+ return {
12627
+ 'subscription_id': ConjureFieldDefinition('subscriptionId', persistent_compute_api_SubscriptionId),
12628
+ 'creation': ConjureFieldDefinition('creation', persistent_compute_api_SubscriptionCreation)
12629
+ }
12630
+
12631
+ __slots__: List[str] = ['_subscription_id', '_creation']
12632
+
12633
+ def __init__(self, creation: "persistent_compute_api_SubscriptionCreation", subscription_id: str) -> None:
12634
+ self._subscription_id = subscription_id
12635
+ self._creation = creation
12636
+
12637
+ @builtins.property
12638
+ def subscription_id(self) -> str:
12639
+ return self._subscription_id
12640
+
12641
+ @builtins.property
12642
+ def creation(self) -> "persistent_compute_api_SubscriptionCreation":
12643
+ return self._creation
12644
+
12645
+
12646
+ persistent_compute_api_SubscriptionCreationMessage.__name__ = "SubscriptionCreationMessage"
12647
+ persistent_compute_api_SubscriptionCreationMessage.__qualname__ = "SubscriptionCreationMessage"
12648
+ persistent_compute_api_SubscriptionCreationMessage.__module__ = "nominal_api.persistent_compute_api"
12649
+
12650
+
12651
+ class persistent_compute_api_SubscriptionCreationSuccess(ConjureBeanType):
12652
+ """
12653
+ Will be returned once a subscriptions has been successfully created.
12654
+ """
12655
+
12656
+ @builtins.classmethod
12657
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
12658
+ return {
12659
+ 'unit_result': ConjureFieldDefinition('unitResult', scout_compute_api_ComputeUnitResult)
12660
+ }
12661
+
12662
+ __slots__: List[str] = ['_unit_result']
12663
+
12664
+ def __init__(self, unit_result: "scout_compute_api_ComputeUnitResult") -> None:
12665
+ self._unit_result = unit_result
12666
+
12667
+ @builtins.property
12668
+ def unit_result(self) -> "scout_compute_api_ComputeUnitResult":
12669
+ return self._unit_result
12670
+
12671
+
12672
+ persistent_compute_api_SubscriptionCreationSuccess.__name__ = "SubscriptionCreationSuccess"
12673
+ persistent_compute_api_SubscriptionCreationSuccess.__qualname__ = "SubscriptionCreationSuccess"
12674
+ persistent_compute_api_SubscriptionCreationSuccess.__module__ = "nominal_api.persistent_compute_api"
12506
12675
 
12507
12676
 
12508
12677
  class persistent_compute_api_SubscriptionOptions(ConjureBeanType):
@@ -12549,22 +12718,25 @@ persistent_compute_api_SubscriptionOptions.__module__ = "nominal_api.persistent_
12549
12718
  class persistent_compute_api_SubscriptionUpdate(ConjureUnionType):
12550
12719
  _full: Optional["persistent_compute_api_FullResult"] = None
12551
12720
  _append: Optional["persistent_compute_api_AppendResult"] = None
12721
+ _error: Optional["persistent_compute_api_SubscriptionUpdateError"] = None
12552
12722
 
12553
12723
  @builtins.classmethod
12554
12724
  def _options(cls) -> Dict[str, ConjureFieldDefinition]:
12555
12725
  return {
12556
12726
  'full': ConjureFieldDefinition('full', persistent_compute_api_FullResult),
12557
- 'append': ConjureFieldDefinition('append', persistent_compute_api_AppendResult)
12727
+ 'append': ConjureFieldDefinition('append', persistent_compute_api_AppendResult),
12728
+ 'error': ConjureFieldDefinition('error', persistent_compute_api_SubscriptionUpdateError)
12558
12729
  }
12559
12730
 
12560
12731
  def __init__(
12561
12732
  self,
12562
12733
  full: Optional["persistent_compute_api_FullResult"] = None,
12563
12734
  append: Optional["persistent_compute_api_AppendResult"] = None,
12735
+ error: Optional["persistent_compute_api_SubscriptionUpdateError"] = None,
12564
12736
  type_of_union: Optional[str] = None
12565
12737
  ) -> None:
12566
12738
  if type_of_union is None:
12567
- if (full is not None) + (append is not None) != 1:
12739
+ if (full is not None) + (append is not None) + (error is not None) != 1:
12568
12740
  raise ValueError('a union must contain a single member')
12569
12741
 
12570
12742
  if full is not None:
@@ -12573,6 +12745,9 @@ class persistent_compute_api_SubscriptionUpdate(ConjureUnionType):
12573
12745
  if append is not None:
12574
12746
  self._append = append
12575
12747
  self._type = 'append'
12748
+ if error is not None:
12749
+ self._error = error
12750
+ self._type = 'error'
12576
12751
 
12577
12752
  elif type_of_union == 'full':
12578
12753
  if full is None:
@@ -12584,6 +12759,11 @@ class persistent_compute_api_SubscriptionUpdate(ConjureUnionType):
12584
12759
  raise ValueError('a union value must not be None')
12585
12760
  self._append = append
12586
12761
  self._type = 'append'
12762
+ elif type_of_union == 'error':
12763
+ if error is None:
12764
+ raise ValueError('a union value must not be None')
12765
+ self._error = error
12766
+ self._type = 'error'
12587
12767
 
12588
12768
  @builtins.property
12589
12769
  def full(self) -> Optional["persistent_compute_api_FullResult"]:
@@ -12593,6 +12773,10 @@ class persistent_compute_api_SubscriptionUpdate(ConjureUnionType):
12593
12773
  def append(self) -> Optional["persistent_compute_api_AppendResult"]:
12594
12774
  return self._append
12595
12775
 
12776
+ @builtins.property
12777
+ def error(self) -> Optional["persistent_compute_api_SubscriptionUpdateError"]:
12778
+ return self._error
12779
+
12596
12780
  def accept(self, visitor) -> Any:
12597
12781
  if not isinstance(visitor, persistent_compute_api_SubscriptionUpdateVisitor):
12598
12782
  raise ValueError('{} is not an instance of persistent_compute_api_SubscriptionUpdateVisitor'.format(visitor.__class__.__name__))
@@ -12600,6 +12784,8 @@ class persistent_compute_api_SubscriptionUpdate(ConjureUnionType):
12600
12784
  return visitor._full(self.full)
12601
12785
  if self._type == 'append' and self.append is not None:
12602
12786
  return visitor._append(self.append)
12787
+ if self._type == 'error' and self.error is not None:
12788
+ return visitor._error(self.error)
12603
12789
 
12604
12790
 
12605
12791
  persistent_compute_api_SubscriptionUpdate.__name__ = "SubscriptionUpdate"
@@ -12617,12 +12803,75 @@ class persistent_compute_api_SubscriptionUpdateVisitor:
12617
12803
  def _append(self, append: "persistent_compute_api_AppendResult") -> Any:
12618
12804
  pass
12619
12805
 
12806
+ @abstractmethod
12807
+ def _error(self, error: "persistent_compute_api_SubscriptionUpdateError") -> Any:
12808
+ pass
12809
+
12620
12810
 
12621
12811
  persistent_compute_api_SubscriptionUpdateVisitor.__name__ = "SubscriptionUpdateVisitor"
12622
12812
  persistent_compute_api_SubscriptionUpdateVisitor.__qualname__ = "SubscriptionUpdateVisitor"
12623
12813
  persistent_compute_api_SubscriptionUpdateVisitor.__module__ = "nominal_api.persistent_compute_api"
12624
12814
 
12625
12815
 
12816
+ class persistent_compute_api_SubscriptionUpdateError(ConjureBeanType):
12817
+ """
12818
+ This will be sent if there is an error while updating a subscription. Note: This won't automatically cancel
12819
+ the subscription. The client will have to call `ClientMessage::unsubscribe` to do that if warranted.
12820
+ """
12821
+
12822
+ @builtins.classmethod
12823
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
12824
+ return {
12825
+ 'serializable_error': ConjureFieldDefinition('serializableError', api_SerializableError)
12826
+ }
12827
+
12828
+ __slots__: List[str] = ['_serializable_error']
12829
+
12830
+ def __init__(self, serializable_error: "api_SerializableError") -> None:
12831
+ self._serializable_error = serializable_error
12832
+
12833
+ @builtins.property
12834
+ def serializable_error(self) -> "api_SerializableError":
12835
+ """
12836
+ A serialized version of the error. Should match the errors defined below.
12837
+ """
12838
+ return self._serializable_error
12839
+
12840
+
12841
+ persistent_compute_api_SubscriptionUpdateError.__name__ = "SubscriptionUpdateError"
12842
+ persistent_compute_api_SubscriptionUpdateError.__qualname__ = "SubscriptionUpdateError"
12843
+ persistent_compute_api_SubscriptionUpdateError.__module__ = "nominal_api.persistent_compute_api"
12844
+
12845
+
12846
+ class persistent_compute_api_SubscriptionUpdateMessage(ConjureBeanType):
12847
+
12848
+ @builtins.classmethod
12849
+ def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
12850
+ return {
12851
+ 'subscription_id': ConjureFieldDefinition('subscriptionId', persistent_compute_api_SubscriptionId),
12852
+ 'update': ConjureFieldDefinition('update', persistent_compute_api_SubscriptionUpdate)
12853
+ }
12854
+
12855
+ __slots__: List[str] = ['_subscription_id', '_update']
12856
+
12857
+ def __init__(self, subscription_id: str, update: "persistent_compute_api_SubscriptionUpdate") -> None:
12858
+ self._subscription_id = subscription_id
12859
+ self._update = update
12860
+
12861
+ @builtins.property
12862
+ def subscription_id(self) -> str:
12863
+ return self._subscription_id
12864
+
12865
+ @builtins.property
12866
+ def update(self) -> "persistent_compute_api_SubscriptionUpdate":
12867
+ return self._update
12868
+
12869
+
12870
+ persistent_compute_api_SubscriptionUpdateMessage.__name__ = "SubscriptionUpdateMessage"
12871
+ persistent_compute_api_SubscriptionUpdateMessage.__qualname__ = "SubscriptionUpdateMessage"
12872
+ persistent_compute_api_SubscriptionUpdateMessage.__module__ = "nominal_api.persistent_compute_api"
12873
+
12874
+
12626
12875
  class scout_InternalVersioningService(Service):
12627
12876
  """
12628
12877
  These endpoints are not intended to be used directly by clients, since
@@ -59312,101 +59561,12 @@ quick access within search pages throughout the application for themselves.
59312
59561
  _decoder = ConjureDecoder()
59313
59562
  return _decoder.decode(_response.json(), scout_favorites_api_FavoritesListResponse, self._return_none_for_unknown_union_types)
59314
59563
 
59315
- def update_favorites(self, auth_header: str, request: "scout_favorites_api_SetFavoritesListRequest") -> "scout_favorites_api_FavoritesListResponse":
59316
- """
59317
- Update the user's favorited resources.
59318
- This will use the org's default workspace if the user has access to it.
59319
- """
59320
-
59321
- _headers: Dict[str, Any] = {
59322
- 'Accept': 'application/json',
59323
- 'Content-Type': 'application/json',
59324
- 'Authorization': auth_header,
59325
- }
59326
-
59327
- _params: Dict[str, Any] = {
59328
- }
59329
-
59330
- _path_params: Dict[str, Any] = {
59331
- }
59332
-
59333
- _json: Any = ConjureEncoder().default(request)
59334
-
59335
- _path = '/scout/v2/favorites'
59336
- _path = _path.format(**_path_params)
59337
-
59338
- _response: Response = self._request(
59339
- 'PUT',
59340
- self._uri + _path,
59341
- params=_params,
59342
- headers=_headers,
59343
- json=_json)
59344
-
59345
- _decoder = ConjureDecoder()
59346
- return _decoder.decode(_response.json(), scout_favorites_api_FavoritesListResponse, self._return_none_for_unknown_union_types)
59347
-
59348
- def list_favorites(self, auth_header: str, request: "scout_favorites_api_DeprecatedListFavoritesRequest") -> "scout_favorites_api_FavoritesListResponse":
59349
- """
59350
- Retrieves all the user's favorites with filtering options on the resource types to include.
59351
- This will use the org's default workspace if the user has access to it.
59352
- """
59353
-
59354
- _headers: Dict[str, Any] = {
59355
- 'Accept': 'application/json',
59356
- 'Content-Type': 'application/json',
59357
- 'Authorization': auth_header,
59358
- }
59359
-
59360
- _params: Dict[str, Any] = {
59361
- }
59362
-
59363
- _path_params: Dict[str, Any] = {
59364
- }
59365
-
59366
- _json: Any = ConjureEncoder().default(request)
59367
-
59368
- _path = '/scout/v2/favorites/list'
59369
- _path = _path.format(**_path_params)
59370
-
59371
- _response: Response = self._request(
59372
- 'POST',
59373
- self._uri + _path,
59374
- params=_params,
59375
- headers=_headers,
59376
- json=_json)
59377
-
59378
- _decoder = ConjureDecoder()
59379
- return _decoder.decode(_response.json(), scout_favorites_api_FavoritesListResponse, self._return_none_for_unknown_union_types)
59380
-
59381
59564
 
59382
59565
  scout_favorites_FavoritesService.__name__ = "FavoritesService"
59383
59566
  scout_favorites_FavoritesService.__qualname__ = "FavoritesService"
59384
59567
  scout_favorites_FavoritesService.__module__ = "nominal_api.scout_favorites"
59385
59568
 
59386
59569
 
59387
- class scout_favorites_api_DeprecatedListFavoritesRequest(ConjureBeanType):
59388
-
59389
- @builtins.classmethod
59390
- def _fields(cls) -> Dict[str, ConjureFieldDefinition]:
59391
- return {
59392
- 'resource_types': ConjureFieldDefinition('resourceTypes', OptionalTypeWrapper[List[scout_favorites_api_ResourceType]])
59393
- }
59394
-
59395
- __slots__: List[str] = ['_resource_types']
59396
-
59397
- def __init__(self, resource_types: Optional[List["scout_favorites_api_ResourceType"]] = None) -> None:
59398
- self._resource_types = resource_types
59399
-
59400
- @builtins.property
59401
- def resource_types(self) -> Optional[List["scout_favorites_api_ResourceType"]]:
59402
- return self._resource_types
59403
-
59404
-
59405
- scout_favorites_api_DeprecatedListFavoritesRequest.__name__ = "DeprecatedListFavoritesRequest"
59406
- scout_favorites_api_DeprecatedListFavoritesRequest.__qualname__ = "DeprecatedListFavoritesRequest"
59407
- scout_favorites_api_DeprecatedListFavoritesRequest.__module__ = "nominal_api.scout_favorites_api"
59408
-
59409
-
59410
59570
  class scout_favorites_api_FavoriteResource(ConjureUnionType):
59411
59571
  _asset: Optional[str] = None
59412
59572
  _run: Optional[str] = None
@@ -6,6 +6,8 @@ from .._impl import (
6
6
  persistent_compute_api_ComputeNodeAppendResponse as ComputeNodeAppendResponse,
7
7
  persistent_compute_api_ComputeNodeAppendResponseVisitor as ComputeNodeAppendResponseVisitor,
8
8
  persistent_compute_api_FullResult as FullResult,
9
+ persistent_compute_api_HealthMessage as HealthMessage,
10
+ persistent_compute_api_HealthMessageVisitor as HealthMessageVisitor,
9
11
  persistent_compute_api_Milliseconds as Milliseconds,
10
12
  persistent_compute_api_Ping as Ping,
11
13
  persistent_compute_api_Pong as Pong,
@@ -13,10 +15,16 @@ from .._impl import (
13
15
  persistent_compute_api_ServerMessageVisitor as ServerMessageVisitor,
14
16
  persistent_compute_api_StreamingComputeNodeRequest as StreamingComputeNodeRequest,
15
17
  persistent_compute_api_StreamingComputeNodeSubscription as StreamingComputeNodeSubscription,
16
- persistent_compute_api_SubscriptionError as SubscriptionError,
18
+ persistent_compute_api_SubscriptionCreation as SubscriptionCreation,
19
+ persistent_compute_api_SubscriptionCreationError as SubscriptionCreationError,
20
+ persistent_compute_api_SubscriptionCreationMessage as SubscriptionCreationMessage,
21
+ persistent_compute_api_SubscriptionCreationSuccess as SubscriptionCreationSuccess,
22
+ persistent_compute_api_SubscriptionCreationVisitor as SubscriptionCreationVisitor,
17
23
  persistent_compute_api_SubscriptionId as SubscriptionId,
18
24
  persistent_compute_api_SubscriptionOptions as SubscriptionOptions,
19
25
  persistent_compute_api_SubscriptionUpdate as SubscriptionUpdate,
26
+ persistent_compute_api_SubscriptionUpdateError as SubscriptionUpdateError,
27
+ persistent_compute_api_SubscriptionUpdateMessage as SubscriptionUpdateMessage,
20
28
  persistent_compute_api_SubscriptionUpdateVisitor as SubscriptionUpdateVisitor,
21
29
  )
22
30
 
@@ -1,6 +1,5 @@
1
1
  # coding=utf-8
2
2
  from .._impl import (
3
- scout_favorites_api_DeprecatedListFavoritesRequest as DeprecatedListFavoritesRequest,
4
3
  scout_favorites_api_FavoriteResource as FavoriteResource,
5
4
  scout_favorites_api_FavoriteResourceVisitor as FavoriteResourceVisitor,
6
5
  scout_favorites_api_FavoritesListResponse as FavoritesListResponse,
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: nominal-api
3
- Version: 0.624.0
3
+ Version: 0.625.0
4
4
  Requires-Python: >=3.8
5
5
  Requires-Dist: requests
6
6
  Requires-Dist: conjure-python-client<3,>=2.8.0
@@ -1,5 +1,5 @@
1
- nominal_api/__init__.py,sha256=z9TAYSaOADm5ISQy4xx5yD0VbDejQ8spOwhxfaYYrNo,1995
2
- nominal_api/_impl.py,sha256=hNLXhm7Of7lwzrCBGMMRCwSvSvN05AhbLK9NeTrtmKQ,2996592
1
+ nominal_api/__init__.py,sha256=1jB8LoHK2esww0ZdWjOh83WJuQgcQ7hFuoisU9N8-64,1995
2
+ nominal_api/_impl.py,sha256=Jq-jFqwQaz9E4LSegTSByQn1WFPF_IB3LSJQL3QKazE,3003501
3
3
  nominal_api/py.typed,sha256=eoZ6GfifbqhMLNzjlqRDVil-yyBkOmVN9ujSgJWNBlY,15
4
4
  nominal_api/api/__init__.py,sha256=1oJPOuAMfV2uClPUW8Ie1nj2Y6j81TDpedcc3yUFTe0,1294
5
5
  nominal_api/api_ids/__init__.py,sha256=CAtt44XgNZEEUDv-BbEbYtuxQ8y1wqSZU-STjBYdZv8,80
@@ -17,7 +17,7 @@ nominal_api/datasource_pagination_api/__init__.py,sha256=3GO8TAUavOe6dUEitOhje74
17
17
  nominal_api/event/__init__.py,sha256=YUhvDFXtyAn08WNd7Xwnybz3PtflvtTcIOaunRS5-1I,836
18
18
  nominal_api/ingest_api/__init__.py,sha256=jpxmJO0dzcCEIv5iM7xvziQEs1x92XLTm-LmbHxtii4,6953
19
19
  nominal_api/ingest_workflow_api/__init__.py,sha256=1oJO78YCmXFkfN5LY7x0gOJwtijrOcXD8Sl0GJCOyrk,1352
20
- nominal_api/persistent_compute_api/__init__.py,sha256=ovp4TsiVPGgCFjHVo4L9s0xSr0t7lV6GRSn6-8m3wBE,1268
20
+ nominal_api/persistent_compute_api/__init__.py,sha256=9X56Ar01aw8PUC7rVVZ2A9Vny0QIXaJPWJtjjCY4IWg,1912
21
21
  nominal_api/scout/__init__.py,sha256=ip3XK_9jJKAoFiCifUVMTpDMiUE4mWIdGzMDu7LASus,324
22
22
  nominal_api/scout_api/__init__.py,sha256=biO4DEygbGcLwM6Dg2VuvMra3A5EW6NBjukbIemXoG8,178
23
23
  nominal_api/scout_asset_api/__init__.py,sha256=Ph-KlW-ki0JRejYQZDvbZ2jRzNAttVBux27lcEj7--Q,1910
@@ -41,7 +41,7 @@ nominal_api/scout_datasource_connection/__init__.py,sha256=he1CCSqMBwRWnzovWCeYP
41
41
  nominal_api/scout_datasource_connection_api/__init__.py,sha256=uZDDTsvvsr_7LfkHwEIfPnV9MsHoxmoTL95e37bZ_nE,4984
42
42
  nominal_api/scout_datasource_connection_api_influx/__init__.py,sha256=PeUZYnCR7Iq92bRuygtWly-HaZ-G1MfqShxJmamiTWA,99
43
43
  nominal_api/scout_favorites/__init__.py,sha256=qiOvaWVVl3O7tXZIq_NrCWFcMx-Q-H5sA_NpIc4TFVU,98
44
- nominal_api/scout_favorites_api/__init__.py,sha256=gwJVcakw17C6U_dFSbHDVw1AMvz6AyiXXD374rHdt0Q,470
44
+ nominal_api/scout_favorites_api/__init__.py,sha256=VOsTMNCQTHYxdYRzRlvEyli5b7Lo2BEnSNcWT2HA9uY,380
45
45
  nominal_api/scout_integrations_api/__init__.py,sha256=8iXeDLEbgMYEZz0dEZsvUj7v9JkuaaTdxkzS-ld8E0U,1432
46
46
  nominal_api/scout_internal_search_api/__init__.py,sha256=CF2YYZXkl95YkEgCbhqXSdAQ4ayPDDOJiCcyoFKOaA8,520
47
47
  nominal_api/scout_jobs_api/__init__.py,sha256=_2ETRUShk1pestGAKzHwc69S-ililQRD4Y9JLD5qqZ4,146
@@ -73,7 +73,7 @@ nominal_api/timeseries_logicalseries_api/__init__.py,sha256=Q9iZHurmyDsJIFbUg-Eb
73
73
  nominal_api/timeseries_seriescache/__init__.py,sha256=tFCkNuyrVMgtj-HIl1pOYPJHaL2VikI4C_x97bX_Lcs,109
74
74
  nominal_api/timeseries_seriescache_api/__init__.py,sha256=U9EhlqdF9qzD1O9al0vcvcdgS_C5lq-lN3Kmr0K3g84,1191
75
75
  nominal_api/upload_api/__init__.py,sha256=ZMudWMSqCrNozohbHaJKuxJnT9Edepe7nxxXMz_pT9k,87
76
- nominal_api-0.624.0.dist-info/METADATA,sha256=2YmbdPMkf1JoqFQQZn4F6YioJ0WUW17KIX2Rxfa18sA,199
77
- nominal_api-0.624.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
78
- nominal_api-0.624.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
79
- nominal_api-0.624.0.dist-info/RECORD,,
76
+ nominal_api-0.625.0.dist-info/METADATA,sha256=ZXo6H9Ssw4miirmImDttwuvrFjGUGOYOqpUe359MGcQ,199
77
+ nominal_api-0.625.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
78
+ nominal_api-0.625.0.dist-info/top_level.txt,sha256=gI1ZdNJbuHcJZeKtCzzBXsEtpU1GX6XJKs6ksi_gCRA,12
79
+ nominal_api-0.625.0.dist-info/RECORD,,