@temporalio/core-bridge 1.12.0 → 1.12.2

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.
Files changed (116) hide show
  1. package/Cargo.lock +64 -119
  2. package/Cargo.toml +1 -1
  3. package/index.js +3 -2
  4. package/package.json +3 -3
  5. package/releases/aarch64-apple-darwin/index.node +0 -0
  6. package/releases/aarch64-unknown-linux-gnu/index.node +0 -0
  7. package/releases/x86_64-apple-darwin/index.node +0 -0
  8. package/releases/x86_64-pc-windows-msvc/index.node +0 -0
  9. package/releases/x86_64-unknown-linux-gnu/index.node +0 -0
  10. package/sdk-core/.cargo/config.toml +1 -2
  11. package/sdk-core/.github/workflows/per-pr.yml +2 -0
  12. package/sdk-core/AGENTS.md +7 -0
  13. package/sdk-core/Cargo.toml +9 -5
  14. package/sdk-core/README.md +6 -5
  15. package/sdk-core/client/Cargo.toml +3 -2
  16. package/sdk-core/client/src/lib.rs +17 -8
  17. package/sdk-core/client/src/metrics.rs +57 -23
  18. package/sdk-core/client/src/raw.rs +33 -15
  19. package/sdk-core/core/Cargo.toml +11 -9
  20. package/sdk-core/core/benches/workflow_replay.rs +114 -15
  21. package/sdk-core/core/src/core_tests/activity_tasks.rs +18 -18
  22. package/sdk-core/core/src/core_tests/child_workflows.rs +4 -4
  23. package/sdk-core/core/src/core_tests/determinism.rs +6 -6
  24. package/sdk-core/core/src/core_tests/local_activities.rs +20 -20
  25. package/sdk-core/core/src/core_tests/mod.rs +40 -5
  26. package/sdk-core/core/src/core_tests/queries.rs +25 -16
  27. package/sdk-core/core/src/core_tests/replay_flag.rs +3 -3
  28. package/sdk-core/core/src/core_tests/updates.rs +3 -3
  29. package/sdk-core/core/src/core_tests/workers.rs +9 -7
  30. package/sdk-core/core/src/core_tests/workflow_tasks.rs +40 -42
  31. package/sdk-core/core/src/ephemeral_server/mod.rs +1 -19
  32. package/sdk-core/core/src/lib.rs +10 -1
  33. package/sdk-core/core/src/pollers/poll_buffer.rs +2 -2
  34. package/sdk-core/core/src/replay/mod.rs +3 -3
  35. package/sdk-core/core/src/telemetry/metrics.rs +306 -152
  36. package/sdk-core/core/src/telemetry/mod.rs +11 -4
  37. package/sdk-core/core/src/telemetry/otel.rs +134 -131
  38. package/sdk-core/core/src/telemetry/prometheus_meter.rs +885 -0
  39. package/sdk-core/core/src/telemetry/prometheus_server.rs +48 -28
  40. package/sdk-core/core/src/test_help/mod.rs +27 -12
  41. package/sdk-core/core/src/worker/activities/activity_heartbeat_manager.rs +7 -7
  42. package/sdk-core/core/src/worker/activities.rs +4 -4
  43. package/sdk-core/core/src/worker/client/mocks.rs +10 -3
  44. package/sdk-core/core/src/worker/client.rs +68 -5
  45. package/sdk-core/core/src/worker/heartbeat.rs +229 -0
  46. package/sdk-core/core/src/worker/mod.rs +35 -14
  47. package/sdk-core/core/src/worker/tuner/resource_based.rs +4 -4
  48. package/sdk-core/core/src/worker/workflow/history_update.rs +71 -19
  49. package/sdk-core/core/src/worker/workflow/machines/cancel_external_state_machine.rs +1 -2
  50. package/sdk-core/core/src/worker/workflow/machines/child_workflow_state_machine.rs +1 -1
  51. package/sdk-core/core/src/worker/workflow/machines/nexus_operation_state_machine.rs +31 -48
  52. package/sdk-core/core/src/worker/workflow/machines/signal_external_state_machine.rs +1 -2
  53. package/sdk-core/core/src/worker/workflow/machines/upsert_search_attributes_state_machine.rs +3 -3
  54. package/sdk-core/core/src/worker/workflow/machines/workflow_machines.rs +4 -1
  55. package/sdk-core/core/src/worker/workflow/managed_run.rs +1 -1
  56. package/sdk-core/core/src/worker/workflow/mod.rs +15 -15
  57. package/sdk-core/core-api/Cargo.toml +2 -2
  58. package/sdk-core/core-api/src/envconfig.rs +204 -99
  59. package/sdk-core/core-api/src/lib.rs +9 -0
  60. package/sdk-core/core-api/src/telemetry/metrics.rs +548 -100
  61. package/sdk-core/core-api/src/worker.rs +11 -5
  62. package/sdk-core/core-c-bridge/Cargo.toml +49 -0
  63. package/sdk-core/core-c-bridge/build.rs +26 -0
  64. package/sdk-core/core-c-bridge/include/temporal-sdk-core-c-bridge.h +817 -0
  65. package/sdk-core/core-c-bridge/src/client.rs +679 -0
  66. package/sdk-core/core-c-bridge/src/lib.rs +245 -0
  67. package/sdk-core/core-c-bridge/src/metric.rs +682 -0
  68. package/sdk-core/core-c-bridge/src/random.rs +61 -0
  69. package/sdk-core/core-c-bridge/src/runtime.rs +445 -0
  70. package/sdk-core/core-c-bridge/src/testing.rs +282 -0
  71. package/sdk-core/core-c-bridge/src/tests/context.rs +644 -0
  72. package/sdk-core/core-c-bridge/src/tests/mod.rs +178 -0
  73. package/sdk-core/core-c-bridge/src/tests/utils.rs +108 -0
  74. package/sdk-core/core-c-bridge/src/worker.rs +1069 -0
  75. package/sdk-core/etc/deps.svg +64 -64
  76. package/sdk-core/sdk/src/activity_context.rs +6 -4
  77. package/sdk-core/sdk/src/lib.rs +49 -27
  78. package/sdk-core/sdk/src/workflow_future.rs +18 -25
  79. package/sdk-core/sdk-core-protos/protos/api_upstream/README.md +4 -0
  80. package/sdk-core/sdk-core-protos/protos/api_upstream/buf.yaml +0 -2
  81. package/sdk-core/sdk-core-protos/protos/api_upstream/openapi/openapiv2.json +630 -83
  82. package/sdk-core/sdk-core-protos/protos/api_upstream/openapi/openapiv3.yaml +632 -78
  83. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/batch/v1/message.proto +4 -4
  84. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/command/v1/message.proto +6 -4
  85. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/common/v1/message.proto +2 -2
  86. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/deployment/v1/message.proto +32 -2
  87. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/common.proto +10 -1
  88. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/deployment.proto +26 -0
  89. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/failed_cause.proto +2 -0
  90. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/reset.proto +4 -4
  91. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/failure/v1/message.proto +2 -2
  92. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/history/v1/message.proto +47 -31
  93. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/nexus/v1/message.proto +4 -4
  94. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/schedule/v1/message.proto +7 -1
  95. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/worker/v1/message.proto +134 -0
  96. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflow/v1/message.proto +14 -11
  97. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflowservice/v1/request_response.proto +148 -37
  98. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflowservice/v1/service.proto +21 -0
  99. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/workflow_activation/workflow_activation.proto +4 -4
  100. package/sdk-core/sdk-core-protos/src/history_builder.rs +9 -5
  101. package/sdk-core/sdk-core-protos/src/lib.rs +96 -6
  102. package/sdk-core/test-utils/src/lib.rs +11 -3
  103. package/sdk-core/tests/cloud_tests.rs +3 -3
  104. package/sdk-core/tests/heavy_tests.rs +11 -3
  105. package/sdk-core/tests/integ_tests/client_tests.rs +12 -13
  106. package/sdk-core/tests/integ_tests/ephemeral_server_tests.rs +1 -1
  107. package/sdk-core/tests/integ_tests/metrics_tests.rs +188 -83
  108. package/sdk-core/tests/integ_tests/polling_tests.rs +1 -1
  109. package/sdk-core/tests/integ_tests/queries_tests.rs +56 -40
  110. package/sdk-core/tests/integ_tests/update_tests.rs +2 -7
  111. package/sdk-core/tests/integ_tests/worker_tests.rs +3 -4
  112. package/sdk-core/tests/integ_tests/worker_versioning_tests.rs +3 -7
  113. package/sdk-core/tests/integ_tests/workflow_tests/local_activities.rs +3 -5
  114. package/sdk-core/tests/integ_tests/workflow_tests/nexus.rs +24 -17
  115. package/src/client.rs +6 -0
  116. package/src/metrics.rs +6 -6
@@ -1418,8 +1418,8 @@ paths:
1418
1418
  - name: taskQueueType
1419
1419
  in: query
1420
1420
  description: |-
1421
- Deprecated. Use `ENHANCED` mode with `task_queue_types`. Ignored in `ENHANCED` mode.
1422
- If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.
1421
+ If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.
1422
+ Only supported in default mode (use `task_queue_types` in ENHANCED mode instead).
1423
1423
  schema:
1424
1424
  enum:
1425
1425
  - TASK_QUEUE_TYPE_UNSPECIFIED
@@ -1428,14 +1428,24 @@ paths:
1428
1428
  - TASK_QUEUE_TYPE_NEXUS
1429
1429
  type: string
1430
1430
  format: enum
1431
+ - name: reportStats
1432
+ in: query
1433
+ description: Report stats for the requested task queue type(s).
1434
+ schema:
1435
+ type: boolean
1431
1436
  - name: includeTaskQueueStatus
1432
1437
  in: query
1433
- description: Deprecated. Ignored in `ENHANCED` mode.
1438
+ description: |-
1439
+ Deprecated, use `report_stats` instead.
1440
+ If true, the task queue status will be included in the response.
1434
1441
  schema:
1435
1442
  type: boolean
1436
1443
  - name: apiMode
1437
1444
  in: query
1438
- description: All options except `task_queue_type` and `include_task_queue_status` are only available in the `ENHANCED` mode.
1445
+ description: |-
1446
+ Deprecated. ENHANCED mode is also being deprecated.
1447
+ Select the API mode to use for this request: DEFAULT mode (if unset) or ENHANCED mode.
1448
+ Consult the documentation for each field to understand which mode it is supported in.
1439
1449
  schema:
1440
1450
  enum:
1441
1451
  - DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED
@@ -1463,7 +1473,9 @@ paths:
1463
1473
  type: boolean
1464
1474
  - name: taskQueueTypes
1465
1475
  in: query
1466
- description: Task queue types to report info about. If not specified, all types are considered.
1476
+ description: |-
1477
+ Deprecated (as part of the ENHANCED mode deprecation).
1478
+ Task queue types to report info about. If not specified, all types are considered.
1467
1479
  schema:
1468
1480
  type: array
1469
1481
  items:
@@ -1474,20 +1486,18 @@ paths:
1474
1486
  - TASK_QUEUE_TYPE_NEXUS
1475
1487
  type: string
1476
1488
  format: enum
1477
- - name: reportStats
1478
- in: query
1479
- description: Report stats for the requested task queue types and versions
1480
- schema:
1481
- type: boolean
1482
1489
  - name: reportPollers
1483
1490
  in: query
1484
- description: Report list of pollers for requested task queue types and versions
1491
+ description: |-
1492
+ Deprecated (as part of the ENHANCED mode deprecation).
1493
+ Report list of pollers for requested task queue types and versions.
1485
1494
  schema:
1486
1495
  type: boolean
1487
1496
  - name: reportTaskReachability
1488
1497
  in: query
1489
1498
  description: |-
1490
- Report task reachability for the requested versions and all task types (task reachability is not reported
1499
+ Deprecated (as part of the ENHANCED mode deprecation).
1500
+ Report task reachability for the requested versions and all task types (task reachability is not reported
1491
1501
  per task type).
1492
1502
  schema:
1493
1503
  type: boolean
@@ -1580,6 +1590,11 @@ paths:
1580
1590
  description: Identifies the Worker Deployment this Version is part of.
1581
1591
  schema:
1582
1592
  type: string
1593
+ - name: reportTaskQueueStats
1594
+ in: query
1595
+ description: Report stats for task queues which have been polled by this version.
1596
+ schema:
1597
+ type: boolean
1583
1598
  responses:
1584
1599
  "200":
1585
1600
  description: OK
@@ -1972,6 +1987,92 @@ paths:
1972
1987
  application/json:
1973
1988
  schema:
1974
1989
  $ref: '#/components/schemas/Status'
1990
+ /api/v1/namespaces/{namespace}/workers:
1991
+ get:
1992
+ tags:
1993
+ - WorkflowService
1994
+ description: ListWorkers is a visibility API to list worker status information in a specific namespace.
1995
+ operationId: ListWorkers
1996
+ parameters:
1997
+ - name: namespace
1998
+ in: path
1999
+ required: true
2000
+ schema:
2001
+ type: string
2002
+ - name: pageSize
2003
+ in: query
2004
+ schema:
2005
+ type: integer
2006
+ format: int32
2007
+ - name: nextPageToken
2008
+ in: query
2009
+ schema:
2010
+ type: string
2011
+ format: bytes
2012
+ - name: query
2013
+ in: query
2014
+ description: |-
2015
+ `query` in ListWorkers is used to filter workers based on worker status info.
2016
+ The following worker status attributes are expected are supported as part of the query:
2017
+ * WorkerInstanceKey
2018
+ * WorkerIdentity
2019
+ * HostName
2020
+ * TaskQueue
2021
+ * DeploymentName
2022
+ * BuildId
2023
+ * SdkName
2024
+ * SdkVersion
2025
+ * StartTime
2026
+ * LastHeartbeatTime
2027
+ * Status
2028
+ Currently metrics are not supported as a part of ListWorkers query.
2029
+ schema:
2030
+ type: string
2031
+ responses:
2032
+ "200":
2033
+ description: OK
2034
+ content:
2035
+ application/json:
2036
+ schema:
2037
+ $ref: '#/components/schemas/ListWorkersResponse'
2038
+ default:
2039
+ description: Default error response
2040
+ content:
2041
+ application/json:
2042
+ schema:
2043
+ $ref: '#/components/schemas/Status'
2044
+ /api/v1/namespaces/{namespace}/workers/heartbeat:
2045
+ post:
2046
+ tags:
2047
+ - WorkflowService
2048
+ description: WorkerHeartbeat receive heartbeat request from the worker.
2049
+ operationId: RecordWorkerHeartbeat
2050
+ parameters:
2051
+ - name: namespace
2052
+ in: path
2053
+ description: Namespace this worker belongs to.
2054
+ required: true
2055
+ schema:
2056
+ type: string
2057
+ requestBody:
2058
+ content:
2059
+ application/json:
2060
+ schema:
2061
+ $ref: '#/components/schemas/RecordWorkerHeartbeatRequest'
2062
+ required: true
2063
+ responses:
2064
+ "200":
2065
+ description: OK
2066
+ content:
2067
+ application/json:
2068
+ schema:
2069
+ $ref: '#/components/schemas/RecordWorkerHeartbeatResponse'
2070
+ default:
2071
+ description: Default error response
2072
+ content:
2073
+ application/json:
2074
+ schema:
2075
+ $ref: '#/components/schemas/Status'
1975
2076
  /api/v1/namespaces/{namespace}/workflow-count:
1976
2077
  get:
1977
2078
  tags:
@@ -4588,8 +4689,8 @@ paths:
4588
4689
  - name: taskQueueType
4589
4690
  in: query
4590
4691
  description: |-
4591
- Deprecated. Use `ENHANCED` mode with `task_queue_types`. Ignored in `ENHANCED` mode.
4592
- If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.
4692
+ If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.
4693
+ Only supported in default mode (use `task_queue_types` in ENHANCED mode instead).
4593
4694
  schema:
4594
4695
  enum:
4595
4696
  - TASK_QUEUE_TYPE_UNSPECIFIED
@@ -4598,14 +4699,24 @@ paths:
4598
4699
  - TASK_QUEUE_TYPE_NEXUS
4599
4700
  type: string
4600
4701
  format: enum
4702
+ - name: reportStats
4703
+ in: query
4704
+ description: Report stats for the requested task queue type(s).
4705
+ schema:
4706
+ type: boolean
4601
4707
  - name: includeTaskQueueStatus
4602
4708
  in: query
4603
- description: Deprecated. Ignored in `ENHANCED` mode.
4709
+ description: |-
4710
+ Deprecated, use `report_stats` instead.
4711
+ If true, the task queue status will be included in the response.
4604
4712
  schema:
4605
4713
  type: boolean
4606
4714
  - name: apiMode
4607
4715
  in: query
4608
- description: All options except `task_queue_type` and `include_task_queue_status` are only available in the `ENHANCED` mode.
4716
+ description: |-
4717
+ Deprecated. ENHANCED mode is also being deprecated.
4718
+ Select the API mode to use for this request: DEFAULT mode (if unset) or ENHANCED mode.
4719
+ Consult the documentation for each field to understand which mode it is supported in.
4609
4720
  schema:
4610
4721
  enum:
4611
4722
  - DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED
@@ -4633,7 +4744,9 @@ paths:
4633
4744
  type: boolean
4634
4745
  - name: taskQueueTypes
4635
4746
  in: query
4636
- description: Task queue types to report info about. If not specified, all types are considered.
4747
+ description: |-
4748
+ Deprecated (as part of the ENHANCED mode deprecation).
4749
+ Task queue types to report info about. If not specified, all types are considered.
4637
4750
  schema:
4638
4751
  type: array
4639
4752
  items:
@@ -4644,20 +4757,18 @@ paths:
4644
4757
  - TASK_QUEUE_TYPE_NEXUS
4645
4758
  type: string
4646
4759
  format: enum
4647
- - name: reportStats
4648
- in: query
4649
- description: Report stats for the requested task queue types and versions
4650
- schema:
4651
- type: boolean
4652
4760
  - name: reportPollers
4653
4761
  in: query
4654
- description: Report list of pollers for requested task queue types and versions
4762
+ description: |-
4763
+ Deprecated (as part of the ENHANCED mode deprecation).
4764
+ Report list of pollers for requested task queue types and versions.
4655
4765
  schema:
4656
4766
  type: boolean
4657
4767
  - name: reportTaskReachability
4658
4768
  in: query
4659
4769
  description: |-
4660
- Report task reachability for the requested versions and all task types (task reachability is not reported
4770
+ Deprecated (as part of the ENHANCED mode deprecation).
4771
+ Report task reachability for the requested versions and all task types (task reachability is not reported
4661
4772
  per task type).
4662
4773
  schema:
4663
4774
  type: boolean
@@ -4717,6 +4828,11 @@ paths:
4717
4828
  description: Identifies the Worker Deployment this Version is part of.
4718
4829
  schema:
4719
4830
  type: string
4831
+ - name: reportTaskQueueStats
4832
+ in: query
4833
+ description: Report stats for task queues which have been polled by this version.
4834
+ schema:
4835
+ type: boolean
4720
4836
  responses:
4721
4837
  "200":
4722
4838
  description: OK
@@ -5109,6 +5225,92 @@ paths:
5109
5225
  application/json:
5110
5226
  schema:
5111
5227
  $ref: '#/components/schemas/Status'
5228
+ /namespaces/{namespace}/workers:
5229
+ get:
5230
+ tags:
5231
+ - WorkflowService
5232
+ description: ListWorkers is a visibility API to list worker status information in a specific namespace.
5233
+ operationId: ListWorkers
5234
+ parameters:
5235
+ - name: namespace
5236
+ in: path
5237
+ required: true
5238
+ schema:
5239
+ type: string
5240
+ - name: pageSize
5241
+ in: query
5242
+ schema:
5243
+ type: integer
5244
+ format: int32
5245
+ - name: nextPageToken
5246
+ in: query
5247
+ schema:
5248
+ type: string
5249
+ format: bytes
5250
+ - name: query
5251
+ in: query
5252
+ description: |-
5253
+ `query` in ListWorkers is used to filter workers based on worker status info.
5254
+ The following worker status attributes are expected are supported as part of the query:
5255
+ * WorkerInstanceKey
5256
+ * WorkerIdentity
5257
+ * HostName
5258
+ * TaskQueue
5259
+ * DeploymentName
5260
+ * BuildId
5261
+ * SdkName
5262
+ * SdkVersion
5263
+ * StartTime
5264
+ * LastHeartbeatTime
5265
+ * Status
5266
+ Currently metrics are not supported as a part of ListWorkers query.
5267
+ schema:
5268
+ type: string
5269
+ responses:
5270
+ "200":
5271
+ description: OK
5272
+ content:
5273
+ application/json:
5274
+ schema:
5275
+ $ref: '#/components/schemas/ListWorkersResponse'
5276
+ default:
5277
+ description: Default error response
5278
+ content:
5279
+ application/json:
5280
+ schema:
5281
+ $ref: '#/components/schemas/Status'
5282
+ /namespaces/{namespace}/workers/heartbeat:
5283
+ post:
5284
+ tags:
5285
+ - WorkflowService
5286
+ description: WorkerHeartbeat receive heartbeat request from the worker.
5287
+ operationId: RecordWorkerHeartbeat
5288
+ parameters:
5289
+ - name: namespace
5290
+ in: path
5291
+ description: Namespace this worker belongs to.
5292
+ required: true
5293
+ schema:
5294
+ type: string
5295
+ requestBody:
5296
+ content:
5297
+ application/json:
5298
+ schema:
5299
+ $ref: '#/components/schemas/RecordWorkerHeartbeatRequest'
5300
+ required: true
5301
+ responses:
5302
+ "200":
5303
+ description: OK
5304
+ content:
5305
+ application/json:
5306
+ schema:
5307
+ $ref: '#/components/schemas/RecordWorkerHeartbeatResponse'
5308
+ default:
5309
+ description: Default error response
5310
+ content:
5311
+ application/json:
5312
+ schema:
5313
+ $ref: '#/components/schemas/Status'
5112
5314
  /namespaces/{namespace}/workflow-count:
5113
5315
  get:
5114
5316
  tags:
@@ -6399,7 +6601,7 @@ components:
6399
6601
  - RESET_TYPE_FIRST_WORKFLOW_TASK
6400
6602
  - RESET_TYPE_LAST_WORKFLOW_TASK
6401
6603
  type: string
6402
- description: Reset type (deprecated, use `options`).
6604
+ description: Deprecated. Use `options`.
6403
6605
  format: enum
6404
6606
  resetReapplyType:
6405
6607
  enum:
@@ -6408,7 +6610,7 @@ components:
6408
6610
  - RESET_REAPPLY_TYPE_NONE
6409
6611
  - RESET_REAPPLY_TYPE_ALL_ELIGIBLE
6410
6612
  type: string
6411
- description: History event reapply options (deprecated, use `options`).
6613
+ description: Deprecated. Use `options`.
6412
6614
  format: enum
6413
6615
  postResetOperations:
6414
6616
  type: array
@@ -7296,20 +7498,10 @@ components:
7296
7498
  type: array
7297
7499
  items:
7298
7500
  $ref: '#/components/schemas/PollerInfo'
7299
- description: |-
7300
- Deprecated. Use `versions_info.types_info.pollers` with `ENHANCED` mode instead.
7301
- Not set in `ENHANCED` mode.
7302
- taskQueueStatus:
7501
+ stats:
7303
7502
  allOf:
7304
- - $ref: '#/components/schemas/TaskQueueStatus'
7305
- description: Deprecated. Not set in `ENHANCED` mode.
7306
- versionsInfo:
7307
- type: object
7308
- additionalProperties:
7309
- $ref: '#/components/schemas/TaskQueueVersionInfo'
7310
- description: |-
7311
- This map contains Task Queue information for each Build ID. Empty string as key value means unversioned.
7312
- Only set in `ENHANCED` mode.
7503
+ - $ref: '#/components/schemas/TaskQueueStats'
7504
+ description: Statistics for the task queue. Only populated when `report_stats` is set to true in the request.
7313
7505
  versioningInfo:
7314
7506
  allOf:
7315
7507
  - $ref: '#/components/schemas/TaskQueueVersioningInfo'
@@ -7323,6 +7515,20 @@ components:
7323
7515
  they are always routed to their Pinned Deployment Version. However, new workflow executions
7324
7516
  are typically not Pinned until they complete their first task (unless they are started with
7325
7517
  a Pinned VersioningOverride or are Child Workflows of a Pinned parent).
7518
+ taskQueueStatus:
7519
+ allOf:
7520
+ - $ref: '#/components/schemas/TaskQueueStatus'
7521
+ description: |-
7522
+ Deprecated.
7523
+ Status of the task queue. Only populated when `include_task_queue_status` is set to true in the request.
7524
+ versionsInfo:
7525
+ type: object
7526
+ additionalProperties:
7527
+ $ref: '#/components/schemas/TaskQueueVersionInfo'
7528
+ description: |-
7529
+ Deprecated.
7530
+ Only returned in ENHANCED mode.
7531
+ This map contains Task Queue information for each Build ID. Empty string as key value means unversioned.
7326
7532
  DescribeWorkerDeploymentResponse:
7327
7533
  type: object
7328
7534
  properties:
@@ -7340,6 +7546,28 @@ components:
7340
7546
  properties:
7341
7547
  workerDeploymentVersionInfo:
7342
7548
  $ref: '#/components/schemas/WorkerDeploymentVersionInfo'
7549
+ versionTaskQueues:
7550
+ type: array
7551
+ items:
7552
+ $ref: '#/components/schemas/DescribeWorkerDeploymentVersionResponse_VersionTaskQueue'
7553
+ description: All the Task Queues that have ever polled from this Deployment version.
7554
+ DescribeWorkerDeploymentVersionResponse_VersionTaskQueue:
7555
+ type: object
7556
+ properties:
7557
+ name:
7558
+ type: string
7559
+ type:
7560
+ enum:
7561
+ - TASK_QUEUE_TYPE_UNSPECIFIED
7562
+ - TASK_QUEUE_TYPE_WORKFLOW
7563
+ - TASK_QUEUE_TYPE_ACTIVITY
7564
+ - TASK_QUEUE_TYPE_NEXUS
7565
+ type: string
7566
+ format: enum
7567
+ stats:
7568
+ allOf:
7569
+ - $ref: '#/components/schemas/TaskQueueStats'
7570
+ description: Only set if `report_task_queue_stats` is set on the request.
7343
7571
  DescribeWorkflowExecutionResponse:
7344
7572
  type: object
7345
7573
  properties:
@@ -7548,7 +7776,7 @@ components:
7548
7776
  $ref: '#/components/schemas/WorkflowExecution'
7549
7777
  control:
7550
7778
  type: string
7551
- description: Deprecated
7779
+ description: Deprecated.
7552
7780
  FailoverStatus:
7553
7781
  type: object
7554
7782
  properties:
@@ -8251,7 +8479,30 @@ components:
8251
8479
  format: date-time
8252
8480
  routingConfig:
8253
8481
  $ref: '#/components/schemas/RoutingConfig'
8482
+ latestVersionSummary:
8483
+ allOf:
8484
+ - $ref: '#/components/schemas/WorkerDeploymentInfo_WorkerDeploymentVersionSummary'
8485
+ description: Summary of the version that was added most recently in the Worker Deployment.
8486
+ currentVersionSummary:
8487
+ allOf:
8488
+ - $ref: '#/components/schemas/WorkerDeploymentInfo_WorkerDeploymentVersionSummary'
8489
+ description: Summary of the current version of the Worker Deployment.
8490
+ rampingVersionSummary:
8491
+ allOf:
8492
+ - $ref: '#/components/schemas/WorkerDeploymentInfo_WorkerDeploymentVersionSummary'
8493
+ description: Summary of the ramping version of the Worker Deployment.
8254
8494
  description: A subset of WorkerDeploymentInfo
8495
+ ListWorkersResponse:
8496
+ type: object
8497
+ properties:
8498
+ workersInfo:
8499
+ type: array
8500
+ items:
8501
+ $ref: '#/components/schemas/WorkerInfo'
8502
+ nextPageToken:
8503
+ type: string
8504
+ description: Next page token
8505
+ format: bytes
8255
8506
  ListWorkflowExecutionsResponse:
8256
8507
  type: object
8257
8508
  properties:
@@ -8674,7 +8925,7 @@ components:
8674
8925
  description: |-
8675
8926
  Operation ID - may be empty if the operation completed synchronously.
8676
8927
 
8677
- Deprecated: Renamed to operation_token.
8928
+ Deprecated. Renamed to operation_token.
8678
8929
  operationToken:
8679
8930
  type: string
8680
8931
  description: Operation token - may be empty if the operation completed synchronously.
@@ -8917,7 +9168,7 @@ components:
8917
9168
  lastIndependentlyAssignedBuildId:
8918
9169
  type: string
8919
9170
  description: |-
8920
- This means the activity is independently versioned and not bound to the build ID of its workflow.
9171
+ Deprecated. This means the activity is independently versioned and not bound to the build ID of its workflow.
8921
9172
  The activity will use the build id in this field instead.
8922
9173
  If the task fails and is scheduled again, the assigned build ID may change according to the latest versioning
8923
9174
  rules.
@@ -8925,8 +9176,8 @@ components:
8925
9176
  allOf:
8926
9177
  - $ref: '#/components/schemas/WorkerVersionStamp'
8927
9178
  description: |-
8928
- The version stamp of the worker to whom this activity was most recently dispatched
8929
- Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
9179
+ Deprecated. The version stamp of the worker to whom this activity was most recently dispatched
9180
+ This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
8930
9181
  currentRetryInterval:
8931
9182
  pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
8932
9183
  type: string
@@ -9030,7 +9281,7 @@ components:
9030
9281
  description: |-
9031
9282
  Operation ID. Only set for asynchronous operations after a successful StartOperation call.
9032
9283
 
9033
- Deprecated: Renamed to operation_token.
9284
+ Deprecated. Renamed to operation_token.
9034
9285
  scheduleToCloseTimeout:
9035
9286
  pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
9036
9287
  type: string
@@ -9462,6 +9713,22 @@ components:
9462
9713
  description: |-
9463
9714
  Will be set to true if the activity was reset.
9464
9715
  Applies only to the current run.
9716
+ RecordWorkerHeartbeatRequest:
9717
+ type: object
9718
+ properties:
9719
+ namespace:
9720
+ type: string
9721
+ description: Namespace this worker belongs to.
9722
+ identity:
9723
+ type: string
9724
+ description: The identity of the client who initiated this request.
9725
+ workerHeartbeat:
9726
+ type: array
9727
+ items:
9728
+ $ref: '#/components/schemas/WorkerHeartbeat'
9729
+ RecordWorkerHeartbeatResponse:
9730
+ type: object
9731
+ properties: {}
9465
9732
  RegisterNamespaceRequest:
9466
9733
  type: object
9467
9734
  properties:
@@ -9560,7 +9827,7 @@ components:
9560
9827
  corresponds to
9561
9828
  control:
9562
9829
  type: string
9563
- description: Deprecated
9830
+ description: Deprecated.
9564
9831
  RequestCancelExternalWorkflowExecutionInitiatedEventAttributes:
9565
9832
  type: object
9566
9833
  properties:
@@ -9578,7 +9845,7 @@ components:
9578
9845
  $ref: '#/components/schemas/WorkflowExecution'
9579
9846
  control:
9580
9847
  type: string
9581
- description: Deprecated
9848
+ description: Deprecated.
9582
9849
  childWorkflowOnly:
9583
9850
  type: boolean
9584
9851
  description: |-
@@ -9728,6 +9995,12 @@ components:
9728
9995
  description: |-
9729
9996
  If set, and activity is in backoff, the activity will start at a random time within the specified jitter duration.
9730
9997
  (unless it is paused and keep_paused is set)
9998
+ restoreOriginalOptions:
9999
+ type: boolean
10000
+ description: |-
10001
+ If set, the activity options will be restored to the defaults.
10002
+ Default options are then options activity was created with.
10003
+ They are part of the first SCHEDULE event.
9731
10004
  ResetActivityResponse:
9732
10005
  type: object
9733
10006
  properties: {}
@@ -9756,7 +10029,7 @@ components:
9756
10029
  - RESET_REAPPLY_TYPE_ALL_ELIGIBLE
9757
10030
  type: string
9758
10031
  description: |-
9759
- Event types to be reapplied (deprecated)
10032
+ Deprecated. Use `options`.
9760
10033
  Default: RESET_REAPPLY_TYPE_SIGNAL
9761
10034
  format: enum
9762
10035
  currentRunOnly:
@@ -9787,7 +10060,7 @@ components:
9787
10060
  description: Worker build id.
9788
10061
  binaryChecksum:
9789
10062
  type: string
9790
- description: A worker binary version identifier (deprecated).
10063
+ description: Deprecated. A worker binary version identifier.
9791
10064
  runId:
9792
10065
  type: string
9793
10066
  description: The first run ID in the execution chain that was touched by this worker build.
@@ -9848,7 +10121,7 @@ components:
9848
10121
  - RESET_REAPPLY_TYPE_ALL_ELIGIBLE
9849
10122
  type: string
9850
10123
  description: |-
9851
- Event types to be reapplied (deprecated)
10124
+ Deprecated. Use `options`.
9852
10125
  Default: RESET_REAPPLY_TYPE_SIGNAL
9853
10126
  format: enum
9854
10127
  resetReapplyExcludeTypes:
@@ -9871,6 +10144,9 @@ components:
9871
10144
  Operations to perform after the workflow has been reset. These operations will be applied
9872
10145
  to the *new* run of the workflow execution in the order they are provided.
9873
10146
  All operations are applied to the workflow before the first new workflow task is generated
10147
+ identity:
10148
+ type: string
10149
+ description: The identity of the worker/client
9874
10150
  ResetWorkflowExecutionResponse:
9875
10151
  type: object
9876
10152
  properties:
@@ -10278,6 +10554,7 @@ components:
10278
10554
  format: date-time
10279
10555
  invalidScheduleError:
10280
10556
  type: string
10557
+ description: Deprecated.
10281
10558
  ScheduleListEntry:
10282
10559
  type: object
10283
10560
  properties:
@@ -10432,7 +10709,9 @@ components:
10432
10709
  type: array
10433
10710
  items:
10434
10711
  $ref: '#/components/schemas/CalendarSpec'
10435
- description: Any timestamps matching any of exclude_* will be skipped.
10712
+ description: |-
10713
+ Any timestamps matching any of exclude_* will be skipped.
10714
+ Deprecated. Use exclude_structured_calendar.
10436
10715
  excludeStructuredCalendar:
10437
10716
  type: array
10438
10717
  items:
@@ -10727,7 +11006,7 @@ components:
10727
11006
  type: string
10728
11007
  control:
10729
11008
  type: string
10730
- description: Deprecated
11009
+ description: Deprecated.
10731
11010
  SignalExternalWorkflowExecutionInitiatedEventAttributes:
10732
11011
  type: object
10733
11012
  properties:
@@ -10752,7 +11031,7 @@ components:
10752
11031
  description: Serialized arguments to provide to the signal handler
10753
11032
  control:
10754
11033
  type: string
10755
- description: Deprecated
11034
+ description: Deprecated.
10756
11035
  childWorkflowOnly:
10757
11036
  type: boolean
10758
11037
  description: |-
@@ -10832,7 +11111,7 @@ components:
10832
11111
  description: Serialized value(s) to provide with the signal
10833
11112
  control:
10834
11113
  type: string
10835
- description: Deprecated
11114
+ description: Deprecated.
10836
11115
  retryPolicy:
10837
11116
  allOf:
10838
11117
  - $ref: '#/components/schemas/RetryPolicy'
@@ -10908,7 +11187,7 @@ components:
10908
11187
  description: Used to de-dupe sent signals
10909
11188
  control:
10910
11189
  type: string
10911
- description: Deprecated
11190
+ description: Deprecated.
10912
11191
  header:
10913
11192
  allOf:
10914
11193
  - $ref: '#/components/schemas/Header'
@@ -11001,7 +11280,7 @@ components:
11001
11280
  format: enum
11002
11281
  control:
11003
11282
  type: string
11004
- description: Deprecated
11283
+ description: Deprecated.
11005
11284
  initiatedEventId:
11006
11285
  type: string
11007
11286
  description: Id of the `START_CHILD_WORKFLOW_EXECUTION_INITIATED` event which this event corresponds to
@@ -11049,7 +11328,7 @@ components:
11049
11328
  format: enum
11050
11329
  control:
11051
11330
  type: string
11052
- description: Deprecated
11331
+ description: Deprecated.
11053
11332
  workflowTaskCompletedEventId:
11054
11333
  type: string
11055
11334
  description: The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
@@ -11079,6 +11358,7 @@ components:
11079
11358
  description: |-
11080
11359
  If this is set, the child workflow inherits the Build ID of the parent. Otherwise, the assignment
11081
11360
  rules of the child's Task Queue will be used to independently assign a Build ID to it.
11361
+ Deprecated. Only considered for versioning v0.2.
11082
11362
  priority:
11083
11363
  allOf:
11084
11364
  - $ref: '#/components/schemas/Priority'
@@ -11661,6 +11941,12 @@ components:
11661
11941
  type: string
11662
11942
  description: If set, override overlap policy for this one request.
11663
11943
  format: enum
11944
+ scheduledTime:
11945
+ type: string
11946
+ description: |-
11947
+ Timestamp used for the identity of the target workflow.
11948
+ If not set the default value is the current time.
11949
+ format: date-time
11664
11950
  TriggerWorkflowRuleRequest:
11665
11951
  type: object
11666
11952
  properties:
@@ -11747,6 +12033,14 @@ components:
11747
12033
  type:
11748
12034
  type: string
11749
12035
  description: Update all running activities of this type.
12036
+ restoreOriginal:
12037
+ type: boolean
12038
+ description: |-
12039
+ If set, the activity options will be restored to the default.
12040
+ Default options are then options activity was created with.
12041
+ They are part of the first SCHEDULE event.
12042
+ This flag cannot be combined with any other option; if you supply
12043
+ restore_original together with other options, the request will be rejected.
11750
12044
  UpdateActivityOptionsResponse:
11751
12045
  type: object
11752
12046
  properties:
@@ -11914,6 +12208,9 @@ components:
11914
12208
  items:
11915
12209
  type: string
11916
12210
  description: List of keys to remove from the metadata.
12211
+ identity:
12212
+ type: string
12213
+ description: Optional. The identity of the client who initiated this request.
11917
12214
  description: Used to update the user-defined metadata of a Worker Deployment Version.
11918
12215
  UpdateWorkerDeploymentVersionMetadataResponse:
11919
12216
  type: object
@@ -12145,6 +12442,8 @@ components:
12145
12442
  `WorkflowExecutionInfo.VersioningInfo` for more information. To remove the override, call
12146
12443
  `UpdateWorkflowExecutionOptions` with a null `VersioningOverride`, and use the `update_mask`
12147
12444
  to indicate that it should be mutated.
12445
+ Pinned overrides are automatically inherited by child workflows, continue-as-new workflows,
12446
+ workflow retries, and cron workflows.
12148
12447
  VersioningOverride_PinnedOverride:
12149
12448
  type: object
12150
12449
  properties:
@@ -12208,6 +12507,17 @@ components:
12208
12507
  version:
12209
12508
  type: string
12210
12509
  description: Deprecated. Use `deployment_version`.
12510
+ status:
12511
+ enum:
12512
+ - WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED
12513
+ - WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE
12514
+ - WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT
12515
+ - WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING
12516
+ - WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING
12517
+ - WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED
12518
+ type: string
12519
+ description: The status of the Worker Deployment Version.
12520
+ format: enum
12211
12521
  deploymentVersion:
12212
12522
  allOf:
12213
12523
  - $ref: '#/components/schemas/WorkerDeploymentVersion'
@@ -12221,7 +12531,40 @@ components:
12221
12531
  - VERSION_DRAINAGE_STATUS_DRAINING
12222
12532
  - VERSION_DRAINAGE_STATUS_DRAINED
12223
12533
  type: string
12534
+ description: Deprecated. Use `drainage_info` instead.
12224
12535
  format: enum
12536
+ drainageInfo:
12537
+ allOf:
12538
+ - $ref: '#/components/schemas/VersionDrainageInfo'
12539
+ description: |-
12540
+ Information about workflow drainage to help the user determine when it is safe
12541
+ to decommission a Version. Not present while version is current or ramping
12542
+ currentSinceTime:
12543
+ type: string
12544
+ description: |-
12545
+ Unset if not current.
12546
+ (-- api-linter: core::0140::prepositions=disabled
12547
+ aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
12548
+ format: date-time
12549
+ rampingSinceTime:
12550
+ type: string
12551
+ description: |-
12552
+ Unset if not ramping. Updated when the version first starts ramping, not on each ramp change.
12553
+ (-- api-linter: core::0140::prepositions=disabled
12554
+ aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
12555
+ format: date-time
12556
+ routingUpdateTime:
12557
+ type: string
12558
+ description: Last time `current_since_time`, `ramping_since_time, or `ramp_percentage` of this version changed.
12559
+ format: date-time
12560
+ firstActivationTime:
12561
+ type: string
12562
+ description: Timestamp when this version first became current or ramping.
12563
+ format: date-time
12564
+ lastDeactivationTime:
12565
+ type: string
12566
+ description: Timestamp when this version last stopped being current or ramping.
12567
+ format: date-time
12225
12568
  WorkerDeploymentOptions:
12226
12569
  type: object
12227
12570
  properties:
@@ -12272,6 +12615,17 @@ components:
12272
12615
  version:
12273
12616
  type: string
12274
12617
  description: Deprecated. Use `deployment_version`.
12618
+ status:
12619
+ enum:
12620
+ - WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED
12621
+ - WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE
12622
+ - WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT
12623
+ - WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING
12624
+ - WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING
12625
+ - WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED
12626
+ type: string
12627
+ description: The status of the Worker Deployment Version.
12628
+ format: enum
12275
12629
  deploymentVersion:
12276
12630
  allOf:
12277
12631
  - $ref: '#/components/schemas/WorkerDeploymentVersion'
@@ -12290,14 +12644,22 @@ components:
12290
12644
  description: |-
12291
12645
  (-- api-linter: core::0140::prepositions=disabled
12292
12646
  aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
12293
- Nil if not current.
12647
+ Unset if not current.
12294
12648
  format: date-time
12295
12649
  rampingSinceTime:
12296
12650
  type: string
12297
12651
  description: |-
12298
12652
  (-- api-linter: core::0140::prepositions=disabled
12299
12653
  aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)
12300
- Nil if not ramping. Updated when the version first starts ramping, not on each ramp change.
12654
+ Unset if not ramping. Updated when the version first starts ramping, not on each ramp change.
12655
+ format: date-time
12656
+ firstActivationTime:
12657
+ type: string
12658
+ description: Timestamp when this version first became current or ramping.
12659
+ format: date-time
12660
+ lastDeactivationTime:
12661
+ type: string
12662
+ description: Timestamp when this version last stopped being current or ramping.
12301
12663
  format: date-time
12302
12664
  rampPercentage:
12303
12665
  type: number
@@ -12309,7 +12671,9 @@ components:
12309
12671
  type: array
12310
12672
  items:
12311
12673
  $ref: '#/components/schemas/WorkerDeploymentVersionInfo_VersionTaskQueueInfo'
12312
- description: All the Task Queues that have ever polled from this Deployment version.
12674
+ description: |-
12675
+ All the Task Queues that have ever polled from this Deployment version.
12676
+ Deprecated. Use `version_task_queues` in DescribeWorkerDeploymentVersionResponse instead.
12313
12677
  drainageInfo:
12314
12678
  allOf:
12315
12679
  - $ref: '#/components/schemas/VersionDrainageInfo'
@@ -12345,6 +12709,179 @@ components:
12345
12709
  - TASK_QUEUE_TYPE_NEXUS
12346
12710
  type: string
12347
12711
  format: enum
12712
+ WorkerHeartbeat:
12713
+ type: object
12714
+ properties:
12715
+ workerInstanceKey:
12716
+ type: string
12717
+ description: |-
12718
+ Worker identifier, should be unique for the namespace.
12719
+ It is distinct from worker identity, which is not necessarily namespace-unique.
12720
+ workerIdentity:
12721
+ type: string
12722
+ description: |-
12723
+ Worker identity, set by the client, may not be unique.
12724
+ Usually host_name+(user group name)+process_id, but can be overwritten by the user.
12725
+ hostInfo:
12726
+ allOf:
12727
+ - $ref: '#/components/schemas/WorkerHostInfo'
12728
+ description: Worker host information.
12729
+ taskQueue:
12730
+ type: string
12731
+ description: Task queue this worker is polling for tasks.
12732
+ deploymentVersion:
12733
+ $ref: '#/components/schemas/WorkerDeploymentVersion'
12734
+ sdkName:
12735
+ type: string
12736
+ sdkVersion:
12737
+ type: string
12738
+ status:
12739
+ enum:
12740
+ - WORKER_STATUS_UNSPECIFIED
12741
+ - WORKER_STATUS_RUNNING
12742
+ - WORKER_STATUS_SHUTTING_DOWN
12743
+ - WORKER_STATUS_SHUTDOWN
12744
+ type: string
12745
+ description: Worker status. Defined by SDK.
12746
+ format: enum
12747
+ startTime:
12748
+ type: string
12749
+ description: |-
12750
+ Worker start time.
12751
+ It can be used to determine worker uptime. (current time - start time)
12752
+ format: date-time
12753
+ heartbeatTime:
12754
+ type: string
12755
+ description: |-
12756
+ Timestamp of this heartbeat, coming from the worker. Worker should set it to "now".
12757
+ Note that this timestamp comes directly from the worker and is subject to workers' clock skew.
12758
+ format: date-time
12759
+ elapsedSinceLastHeartbeat:
12760
+ pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
12761
+ type: string
12762
+ description: Elapsed time since the last heartbeat from the worker.
12763
+ workflowTaskSlotsInfo:
12764
+ $ref: '#/components/schemas/WorkerSlotsInfo'
12765
+ activityTaskSlotsInfo:
12766
+ $ref: '#/components/schemas/WorkerSlotsInfo'
12767
+ nexusTaskSlotsInfo:
12768
+ $ref: '#/components/schemas/WorkerSlotsInfo'
12769
+ localActivitySlotsInfo:
12770
+ $ref: '#/components/schemas/WorkerSlotsInfo'
12771
+ workflowPollerInfo:
12772
+ $ref: '#/components/schemas/WorkerPollerInfo'
12773
+ workflowStickyPollerInfo:
12774
+ $ref: '#/components/schemas/WorkerPollerInfo'
12775
+ activityPollerInfo:
12776
+ $ref: '#/components/schemas/WorkerPollerInfo'
12777
+ nexusPollerInfo:
12778
+ $ref: '#/components/schemas/WorkerPollerInfo'
12779
+ totalStickyCacheHit:
12780
+ type: integer
12781
+ description: A Workflow Task found a cached Workflow Execution to run against.
12782
+ format: int32
12783
+ totalStickyCacheMiss:
12784
+ type: integer
12785
+ description: A Workflow Task did not find a cached Workflow execution to run against.
12786
+ format: int32
12787
+ currentStickyCacheSize:
12788
+ type: integer
12789
+ description: Current cache size, expressed in number of Workflow Executions.
12790
+ format: int32
12791
+ description: |-
12792
+ Worker info message, contains information about the worker and its current state.
12793
+ All information is provided by the worker itself.
12794
+ (-- api-linter: core::0140::prepositions=disabled
12795
+ aip.dev/not-precedent: Removing those words make names less clear. --)
12796
+ WorkerHostInfo:
12797
+ type: object
12798
+ properties:
12799
+ hostName:
12800
+ type: string
12801
+ description: Worker host identifier.
12802
+ processKey:
12803
+ type: string
12804
+ description: |-
12805
+ Worker process identifier. This id should be unique for all _processes_
12806
+ running workers in the namespace, and should be shared by all workers
12807
+ in the same process.
12808
+ This will be used to build the worker command nexus task queue name:
12809
+ "temporal-sys/worker-commands/{process_key}"
12810
+ processId:
12811
+ type: string
12812
+ description: |-
12813
+ Worker process identifier. Unlike process_key, this id only needs to be unique
12814
+ within one host (so using e.g. a unix pid would be appropriate).
12815
+ currentHostCpuUsage:
12816
+ type: number
12817
+ description: |-
12818
+ System used CPU as a float in the range [0.0, 1.0] where 1.0 is defined as all
12819
+ cores on the host pegged.
12820
+ format: float
12821
+ currentHostMemUsage:
12822
+ type: number
12823
+ description: |-
12824
+ System used memory as a float in the range [0.0, 1.0] where 1.0 is defined as
12825
+ all available memory on the host is used.
12826
+ format: float
12827
+ description: Holds everything needed to identify the worker host/process context
12828
+ WorkerInfo:
12829
+ type: object
12830
+ properties:
12831
+ workerHeartbeat:
12832
+ $ref: '#/components/schemas/WorkerHeartbeat'
12833
+ WorkerPollerInfo:
12834
+ type: object
12835
+ properties:
12836
+ currentPollers:
12837
+ type: integer
12838
+ description: Number of polling RPCs that are currently in flight.
12839
+ format: int32
12840
+ lastSuccessfulPollTime:
12841
+ type: string
12842
+ format: date-time
12843
+ isAutoscaling:
12844
+ type: boolean
12845
+ description: Set true if the number of concurrent pollers is auto-scaled
12846
+ WorkerSlotsInfo:
12847
+ type: object
12848
+ properties:
12849
+ currentAvailableSlots:
12850
+ type: integer
12851
+ description: |-
12852
+ Number of slots available for the worker to specific tasks.
12853
+ May be -1 if the upper bound is not known.
12854
+ format: int32
12855
+ currentUsedSlots:
12856
+ type: integer
12857
+ description: Number of slots used by the worker for specific tasks.
12858
+ format: int32
12859
+ slotSupplierKind:
12860
+ type: string
12861
+ description: |-
12862
+ Kind of the slot supplier, which is used to determine how the slots are allocated.
12863
+ Possible values: "Fixed | ResourceBased | Custom String"
12864
+ totalProcessedTasks:
12865
+ type: integer
12866
+ description: |-
12867
+ Total number of tasks processed (completed both successfully and unsuccesfully, or any other way)
12868
+ by the worker since the worker started. This is a cumulative counter.
12869
+ format: int32
12870
+ totalFailedTasks:
12871
+ type: integer
12872
+ description: Total number of failed tasks processed by the worker so far.
12873
+ format: int32
12874
+ lastIntervalProcessedTasks:
12875
+ type: integer
12876
+ description: |-
12877
+ Number of tasks processed in since the last heartbeat from the worker.
12878
+ This is a cumulative counter, and it is reset to 0 each time the worker sends a heartbeat.
12879
+ Contains both successful and failed tasks.
12880
+ format: int32
12881
+ lastIntervalFailureTasks:
12882
+ type: integer
12883
+ description: Number of failed tasks processed since the last heartbeat from the worker.
12884
+ format: int32
12348
12885
  WorkerVersionCapabilities:
12349
12886
  type: object
12350
12887
  properties:
@@ -12640,6 +13177,7 @@ components:
12640
13177
  description: |-
12641
13178
  If this is set, the new execution inherits the Build ID of the current execution. Otherwise,
12642
13179
  the assignment rules will be used to independently assign a Build ID to the new execution.
13180
+ Deprecated. Only considered for versioning v0.2.
12643
13181
  WorkflowExecutionExtendedInfo:
12644
13182
  type: object
12645
13183
  properties:
@@ -12870,10 +13408,12 @@ components:
12870
13408
  header:
12871
13409
  allOf:
12872
13410
  - $ref: '#/components/schemas/Header'
12873
- description: "Headers that were passed by the sender of the signal and copied by temporal \n server into the workflow task."
13411
+ description: |-
13412
+ Headers that were passed by the sender of the signal and copied by temporal
13413
+ server into the workflow task.
12874
13414
  skipGenerateWorkflowTask:
12875
13415
  type: boolean
12876
- description: This field is deprecated and never respected. It should always be set to false.
13416
+ description: Deprecated. This field is never respected and should always be set to false.
12877
13417
  externalWorkflowExecution:
12878
13418
  allOf:
12879
13419
  - $ref: '#/components/schemas/WorkflowExecution'
@@ -12920,7 +13460,7 @@ components:
12920
13460
  continuedExecutionRunId:
12921
13461
  type: string
12922
13462
  description: |-
12923
- Run id of the previous workflow which continued-as-new or retired or cron executed into this
13463
+ Run id of the previous workflow which continued-as-new or retried or cron executed into this
12924
13464
  workflow.
12925
13465
  initiator:
12926
13466
  enum:
@@ -13035,7 +13575,10 @@ components:
13035
13575
  versioningOverride:
13036
13576
  allOf:
13037
13577
  - $ref: '#/components/schemas/VersioningOverride'
13038
- description: Versioning override applied to this workflow when it was started.
13578
+ description: |-
13579
+ Versioning override applied to this workflow when it was started.
13580
+ Children, crons, retries, and continue-as-new will inherit source run's override if pinned
13581
+ and if the new workflow's Task Queue belongs to the override version.
13039
13582
  parentPinnedWorkerDeploymentVersion:
13040
13583
  type: string
13041
13584
  description: |-
@@ -13044,20 +13587,29 @@ components:
13044
13587
  of starting on the Current Version of its Task Queue.
13045
13588
  This is set only if the child workflow is starting on a Task Queue belonging to the same
13046
13589
  Worker Deployment Version.
13047
- Deprecated. Use `parent_pinned_deployment_version`.
13048
- parentPinnedDeploymentVersion:
13049
- allOf:
13050
- - $ref: '#/components/schemas/WorkerDeploymentVersion'
13051
- description: |-
13052
- When present, it means this is a child workflow of a parent that is Pinned to this Worker
13053
- Deployment Version. In this case, child workflow will start as Pinned to this Version instead
13054
- of starting on the Current Version of its Task Queue.
13055
- This is set only if the child workflow is starting on a Task Queue belonging to the same
13056
- Worker Deployment Version.
13590
+ Deprecated. Use `parent_versioning_info`.
13057
13591
  priority:
13058
13592
  allOf:
13059
13593
  - $ref: '#/components/schemas/Priority'
13060
13594
  description: Priority metadata
13595
+ inheritedPinnedVersion:
13596
+ allOf:
13597
+ - $ref: '#/components/schemas/WorkerDeploymentVersion'
13598
+ description: |-
13599
+ If present, the new workflow should start on this version with pinned base behavior.
13600
+ Child of pinned parent will inherit the parent's version if the Child's Task Queue belongs to that version.
13601
+
13602
+ New run initiated by workflow ContinueAsNew of pinned run, will inherit the previous run's version if the
13603
+ new run's Task Queue belongs to that version.
13604
+
13605
+ New run initiated by workflow Cron will never inherit.
13606
+
13607
+ New run initiated by workflow Retry will only inherit if the retried run is effectively pinned at the time
13608
+ of retry, and the retried run inherited a pinned version when it started (ie. it is a child of a pinned
13609
+ parent, or a CaN of a pinned run, and is running on a Task Queue in the inherited version).
13610
+
13611
+ Pinned override is inherited if Task Queue of new run is compatible with the override version.
13612
+ Override is inherited separately and takes precedence over inherited base version.
13061
13613
  description: Always the first event in workflow history
13062
13614
  WorkflowExecutionTerminatedEventAttributes:
13063
13615
  type: object
@@ -13178,7 +13730,7 @@ components:
13178
13730
  behaviors.
13179
13731
  This field is first set after an execution completes its first workflow task on a versioned
13180
13732
  worker, and set again on completion of every subsequent workflow task.
13181
- For child workflows of Pinned parents, this will be set to Pinned (along with `version`) when
13733
+ For child workflows of Pinned parents, this will be set to Pinned (along with `deployment_version`) when
13182
13734
  the the child starts so that child's first workflow task goes to the same Version as the
13183
13735
  parent. After the first workflow task, it depends on the child workflow itself if it wants
13184
13736
  to stay pinned or become unpinned (according to Versioning Behavior set in the worker).
@@ -13219,7 +13771,8 @@ components:
13219
13771
  precedence over SDK-sent `behavior` (and `version` when override is PINNED). An
13220
13772
  override can be set when starting a new execution, as well as afterwards by calling the
13221
13773
  `UpdateWorkflowExecutionOptions` API.
13222
- Pinned overrides are automatically inherited by child workflows.
13774
+ Pinned overrides are automatically inherited by child workflows, continue-as-new workflows,
13775
+ workflow retries, and cron workflows.
13223
13776
  deploymentTransition:
13224
13777
  allOf:
13225
13778
  - $ref: '#/components/schemas/DeploymentTransition'
@@ -13260,7 +13813,7 @@ components:
13260
13813
  start a transition to that version and continue execution there.
13261
13814
  A version transition can only exist while there is a pending or started workflow task.
13262
13815
  Once the pending workflow task completes on the transition's target version, the
13263
- transition completes and the workflow's `behavior`, and `version` fields are updated per the
13816
+ transition completes and the workflow's `behavior`, and `deployment_version` fields are updated per the
13264
13817
  worker's task completion response.
13265
13818
  Pending activities will not start new attempts during a transition. Once the transition is
13266
13819
  completed, pending activities will start their next attempt on the new version.
@@ -13580,6 +14133,7 @@ components:
13580
14133
  - WORKFLOW_TASK_FAILED_CAUSE_PENDING_NEXUS_OPERATIONS_LIMIT_EXCEEDED
13581
14134
  - WORKFLOW_TASK_FAILED_CAUSE_BAD_REQUEST_CANCEL_NEXUS_OPERATION_ATTRIBUTES
13582
14135
  - WORKFLOW_TASK_FAILED_CAUSE_FEATURE_DISABLED
14136
+ - WORKFLOW_TASK_FAILED_CAUSE_GRPC_MESSAGE_TOO_LARGE
13583
14137
  type: string
13584
14138
  format: enum
13585
14139
  failure:
@@ -13601,7 +14155,7 @@ components:
13601
14155
  binaryChecksum:
13602
14156
  type: string
13603
14157
  description: |-
13604
- DEPRECATED since 1.21 - This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
14158
+ Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
13605
14159
  If a worker explicitly failed this task, its binary id
13606
14160
  workerVersion:
13607
14161
  allOf: