@salesforce/lds-adapters-analytics-wave 1.404.0-dev1 → 1.404.0-dev4

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.
package/src/raml/api.raml CHANGED
@@ -1432,6 +1432,135 @@ types:
1432
1432
  - Running
1433
1433
  - Success
1434
1434
  - Warning
1435
+ DataflowJobNodeStageCollectionRepresentation:
1436
+ description: A collection of Dataflow Job Node Stages.
1437
+ type: object
1438
+ properties:
1439
+ dataflowjobId:
1440
+ description: The ID of the associated DataflowJob.
1441
+ type: string
1442
+ foundCount:
1443
+ description: The number of stages that were found (only present in batch mode).
1444
+ type: integer | nil
1445
+ required: false # TODO Hand-rolled W-8253396
1446
+ nextPageUrl:
1447
+ description: URL for the next page of stages (null if no more pages).
1448
+ type: string | nil
1449
+ required: false # TODO Hand-rolled W-8253396
1450
+ nodeId:
1451
+ description: The ID of the associated DataflowJobNode.
1452
+ type: string
1453
+ notFoundStageIds:
1454
+ description: List of stage IDs that were not found (only present in batch
1455
+ mode, empty if all found).
1456
+ type: array # TODO Hand-rolled union types on arrays (#19 on https://salesforce.quip.com/NxVhAkxL6RTW)
1457
+ items:
1458
+ type: string
1459
+ required: false # TODO Hand-rolled W-8253396
1460
+ requestedStageIds:
1461
+ description: The list of requested stage IDs (only present in batch mode).
1462
+ type: array # TODO Hand-rolled union types on arrays (#19 on https://salesforce.quip.com/NxVhAkxL6RTW)
1463
+ items:
1464
+ type: string
1465
+ required: false # TODO Hand-rolled W-8253396
1466
+ stages:
1467
+ description: Collection of recipe stages.
1468
+ type: array
1469
+ items:
1470
+ type: DataflowJobNodeStageRepresentation
1471
+ totalStages:
1472
+ description: The total number of stages for this node.
1473
+ type: integer | nil
1474
+ url:
1475
+ description: URL to get the collection of recipe stages.
1476
+ type: string
1477
+ DataflowJobNodeStageParentsRepresentation:
1478
+ description: Parent stage information for a Recipe Stage.
1479
+ type: object
1480
+ properties:
1481
+ allParentStageIds:
1482
+ description: List of all ancestor stage IDs (transitive closure).
1483
+ type: array # TODO Hand-rolled union types on arrays (#19 on https://salesforce.quip.com/NxVhAkxL6RTW)
1484
+ items:
1485
+ type: string
1486
+ dataflowjobId:
1487
+ description: The ID of the associated DataflowJob.
1488
+ type: string
1489
+ nodeId:
1490
+ description: The ID of the associated DataflowJobNode.
1491
+ type: string
1492
+ parentStageIds:
1493
+ description: List of immediate parent stage IDs.
1494
+ type: array # TODO Hand-rolled union types on arrays (#19 on https://salesforce.quip.com/NxVhAkxL6RTW)
1495
+ items:
1496
+ type: string
1497
+ stageId:
1498
+ description: The Spark stage ID.
1499
+ type: string
1500
+ DataflowJobNodeStageRepresentation:
1501
+ description: Wave recipe stage representation.
1502
+ type: object
1503
+ properties:
1504
+ allParentStageIds:
1505
+ description: List of all ancestor stage IDs (transitive closure).
1506
+ type: array # TODO Hand-rolled union types on arrays (#19 on https://salesforce.quip.com/NxVhAkxL6RTW)
1507
+ items:
1508
+ type: string
1509
+ createdDate:
1510
+ description: The creation date of the stage record.
1511
+ type: string | nil
1512
+ required: false # TODO Hand-rolled W-8253396
1513
+ dataflowjobId:
1514
+ description: The ID of the associated DataflowJob.
1515
+ type: string
1516
+ durationMillis:
1517
+ description: The duration of the stage in milliseconds.
1518
+ type: integer | nil
1519
+ failureReason:
1520
+ description: The failure reason if the stage failed.
1521
+ type: string | nil
1522
+ required: false # TODO Hand-rolled W-8253396
1523
+ id:
1524
+ description: The unique ID of the stage record.
1525
+ type: string
1526
+ lastModifiedDate:
1527
+ description: The last modified date of the stage record.
1528
+ type: string | nil
1529
+ required: false # TODO Hand-rolled W-8253396
1530
+ nodeId:
1531
+ description: The ID of the associated DataflowJobNode.
1532
+ type: string
1533
+ parentStageIds:
1534
+ description: List of immediate parent stage IDs.
1535
+ type: array # TODO Hand-rolled union types on arrays (#19 on https://salesforce.quip.com/NxVhAkxL6RTW)
1536
+ items:
1537
+ type: string
1538
+ recipeNodeApiNames:
1539
+ description: The recipe node API name(s) associated with this stage.
1540
+ type: string | nil
1541
+ rowsIn:
1542
+ description: The number of input rows processed by the stage.
1543
+ type: integer | nil
1544
+ rowsOut:
1545
+ description: The number of output rows produced by the stage.
1546
+ type: integer | nil
1547
+ stageId:
1548
+ description: The Spark stage ID (e.g., '187', '95').
1549
+ type: string
1550
+ stageMetricsJson:
1551
+ description: The full stage metrics as JSON (only included in single-stage
1552
+ GET).
1553
+ type: string | nil
1554
+ required: false # TODO Hand-rolled W-8253396
1555
+ status:
1556
+ description: The status of the stage execution.
1557
+ type: string
1558
+ enum:
1559
+ - Failed
1560
+ - Succeeded
1561
+ url:
1562
+ description: URL to retrieve this stage resource.
1563
+ type: string | nil
1435
1564
  DataflowRepresentation:
1436
1565
  description: Wave dataflow asset representation.
1437
1566
  discriminatorValue: Dataflow
@@ -6670,6 +6799,92 @@ types:
6670
6799
  nodeId:
6671
6800
  type: string
6672
6801
  required: true
6802
+ /dataflowjobs/{dataflowjobId}/nodes/{nodeId}/stages:
6803
+ get:
6804
+ description: 'Get a collection of Dataflow Job Node Stages for a specific
6805
+ DataflowJobNode. Supports two modes: (1) List all stages with pagination
6806
+ and filtering, or (2) Batch get specific stages by providing stageIds parameter.'
6807
+ responses:
6808
+ '200':
6809
+ description: Success
6810
+ body:
6811
+ application/json:
6812
+ type: DataflowJobNodeStageCollectionRepresentation
6813
+ queryParameters:
6814
+ includeMetrics:
6815
+ description: 'If true, include stageMetricsJson in response. Default:
6816
+ false'
6817
+ type: boolean
6818
+ required: false
6819
+ pageSize:
6820
+ description: Number of stages per page (default 25). Only used on first
6821
+ page request.
6822
+ type: integer
6823
+ required: false
6824
+ pageToken:
6825
+ description: Encoded cursor for pagination. Returned in nextPageUrl from
6826
+ previous page. When provided, retrieves next page of results. Only used
6827
+ in list mode.
6828
+ type: string
6829
+ required: false
6830
+ stageIds:
6831
+ description: List of stage IDs to fetch (max 100). When provided, switches
6832
+ to batch mode and ignores pagination/filter params.
6833
+ type: array
6834
+ required: false
6835
+ items:
6836
+ type: string
6837
+ (oas-collectionFormat): csv
6838
+ status:
6839
+ description: Filter by status (e.g., 'succeeded', 'failed'). Case-insensitive.
6840
+ Only used in list mode.
6841
+ type: string
6842
+ required: false
6843
+ uriParameters:
6844
+ dataflowjobId:
6845
+ type: string
6846
+ required: true
6847
+ nodeId:
6848
+ type: string
6849
+ required: true
6850
+ /dataflowjobs/{dataflowjobId}/nodes/{nodeId}/stages/{stageId}:
6851
+ get:
6852
+ description: Get a single Dataflow Job Node Stage with full metrics.
6853
+ responses:
6854
+ '200':
6855
+ description: Success
6856
+ body:
6857
+ application/json:
6858
+ type: DataflowJobNodeStageRepresentation
6859
+ uriParameters:
6860
+ dataflowjobId:
6861
+ type: string
6862
+ required: true
6863
+ nodeId:
6864
+ type: string
6865
+ required: true
6866
+ stageId:
6867
+ type: string
6868
+ required: true
6869
+ /dataflowjobs/{dataflowjobId}/nodes/{nodeId}/stages/{stageId}/parents:
6870
+ get:
6871
+ description: Get parent stages for a Dataflow Job Node Stage.
6872
+ responses:
6873
+ '200':
6874
+ description: Success
6875
+ body:
6876
+ application/json:
6877
+ type: DataflowJobNodeStageParentsRepresentation
6878
+ uriParameters:
6879
+ dataflowjobId:
6880
+ type: string
6881
+ required: true
6882
+ nodeId:
6883
+ type: string
6884
+ required: true
6885
+ stageId:
6886
+ type: string
6887
+ required: true
6673
6888
  /datasets:
6674
6889
  get:
6675
6890
  description: Get a collection of dataset resource representations.
@@ -27,6 +27,14 @@ types:
27
27
  (luvio.ttl): 10080000
28
28
  DataflowJobNodeCollectionRepresentation:
29
29
  (luvio.ttl): 300
30
+ DataflowJobNodeStageRepresentation:
31
+ (luvio.ttl): 300
32
+ (luvio.key):
33
+ id: stageId
34
+ DataflowJobNodeStageParentsRepresentation:
35
+ (luvio.ttl): 300
36
+ (luvio.key):
37
+ id: stageId
30
38
  DependencyRepresentation:
31
39
  (luvio.ttl): 300
32
40
  DatasetCollectionRepresentation:
@@ -207,6 +215,22 @@ types:
207
215
  name: getDataflowJobNode
208
216
  (luvio.key):
209
217
  id: urlParams.nodeId
218
+ /dataflowjobs/{dataflowjobId}/nodes/{nodeId}/stages:
219
+ get:
220
+ (luvio.adapter):
221
+ name: getDataflowJobNodeStages
222
+ /dataflowjobs/{dataflowjobId}/nodes/{nodeId}/stages/{stageId}:
223
+ get:
224
+ (luvio.adapter):
225
+ name: getDataflowJobNodeStage
226
+ (luvio.key):
227
+ id: urlParams.stageId
228
+ /dataflowjobs/{dataflowjobId}/nodes/{nodeId}/stages/{stageId}/parents:
229
+ get:
230
+ (luvio.adapter):
231
+ name: getDataflowJobNodeStageParents
232
+ (luvio.key):
233
+ id: urlParams.stageId
210
234
  /datasets:
211
235
  get:
212
236
  (luvio.adapter):