@temporalio/core-bridge 1.11.8 → 1.12.0

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 (205) hide show
  1. package/Cargo.lock +219 -193
  2. package/Cargo.toml +27 -8
  3. package/README.md +5 -0
  4. package/index.js +72 -12
  5. package/lib/errors.d.ts +25 -0
  6. package/lib/errors.js +76 -1
  7. package/lib/errors.js.map +1 -1
  8. package/lib/index.d.ts +11 -478
  9. package/lib/index.js +28 -5
  10. package/lib/index.js.map +1 -1
  11. package/lib/native.d.ts +330 -0
  12. package/lib/{worker-tuner.js → native.js} +1 -1
  13. package/lib/native.js.map +1 -0
  14. package/package.json +7 -3
  15. package/releases/aarch64-apple-darwin/index.node +0 -0
  16. package/releases/aarch64-unknown-linux-gnu/index.node +0 -0
  17. package/releases/x86_64-apple-darwin/index.node +0 -0
  18. package/releases/x86_64-pc-windows-msvc/index.node +0 -0
  19. package/releases/x86_64-unknown-linux-gnu/index.node +0 -0
  20. package/sdk-core/.cargo/config.toml +8 -2
  21. package/sdk-core/.cargo/multi-worker-manual-test +15 -0
  22. package/sdk-core/.github/workflows/per-pr.yml +40 -11
  23. package/sdk-core/AGENTS.md +73 -0
  24. package/sdk-core/ARCHITECTURE.md +71 -23
  25. package/sdk-core/Cargo.toml +1 -1
  26. package/sdk-core/README.md +4 -4
  27. package/sdk-core/arch_docs/workflow_task_chunking.md +51 -0
  28. package/sdk-core/client/Cargo.toml +1 -1
  29. package/sdk-core/client/src/lib.rs +49 -13
  30. package/sdk-core/client/src/metrics.rs +15 -16
  31. package/sdk-core/client/src/proxy.rs +2 -2
  32. package/sdk-core/client/src/raw.rs +54 -8
  33. package/sdk-core/client/src/retry.rs +109 -13
  34. package/sdk-core/client/src/worker_registry/mod.rs +4 -4
  35. package/sdk-core/client/src/workflow_handle/mod.rs +1 -1
  36. package/sdk-core/core/Cargo.toml +28 -8
  37. package/sdk-core/core/src/abstractions.rs +62 -10
  38. package/sdk-core/core/src/core_tests/activity_tasks.rs +180 -8
  39. package/sdk-core/core/src/core_tests/mod.rs +4 -4
  40. package/sdk-core/core/src/core_tests/queries.rs +18 -4
  41. package/sdk-core/core/src/core_tests/workers.rs +3 -3
  42. package/sdk-core/core/src/core_tests/workflow_tasks.rs +191 -25
  43. package/sdk-core/core/src/ephemeral_server/mod.rs +10 -3
  44. package/sdk-core/core/src/internal_flags.rs +14 -14
  45. package/sdk-core/core/src/lib.rs +5 -2
  46. package/sdk-core/core/src/pollers/mod.rs +1 -1
  47. package/sdk-core/core/src/pollers/poll_buffer.rs +495 -164
  48. package/sdk-core/core/src/protosext/mod.rs +3 -3
  49. package/sdk-core/core/src/replay/mod.rs +3 -3
  50. package/sdk-core/core/src/telemetry/metrics.rs +13 -4
  51. package/sdk-core/core/src/telemetry/mod.rs +72 -70
  52. package/sdk-core/core/src/telemetry/otel.rs +51 -54
  53. package/sdk-core/core/src/test_help/mod.rs +9 -3
  54. package/sdk-core/core/src/worker/activities/activity_heartbeat_manager.rs +31 -11
  55. package/sdk-core/core/src/worker/activities/local_activities.rs +35 -28
  56. package/sdk-core/core/src/worker/activities.rs +58 -30
  57. package/sdk-core/core/src/worker/client/mocks.rs +3 -3
  58. package/sdk-core/core/src/worker/client.rs +155 -53
  59. package/sdk-core/core/src/worker/mod.rs +103 -95
  60. package/sdk-core/core/src/worker/nexus.rs +100 -73
  61. package/sdk-core/core/src/worker/tuner/resource_based.rs +14 -6
  62. package/sdk-core/core/src/worker/tuner.rs +4 -13
  63. package/sdk-core/core/src/worker/workflow/history_update.rs +47 -51
  64. package/sdk-core/core/src/worker/workflow/machines/child_workflow_state_machine.rs +1 -4
  65. package/sdk-core/core/src/worker/workflow/machines/nexus_operation_state_machine.rs +127 -32
  66. package/sdk-core/core/src/worker/workflow/machines/transition_coverage.rs +1 -2
  67. package/sdk-core/core/src/worker/workflow/machines/update_state_machine.rs +1 -1
  68. package/sdk-core/core/src/worker/workflow/machines/workflow_machines.rs +55 -42
  69. package/sdk-core/core/src/worker/workflow/managed_run.rs +45 -35
  70. package/sdk-core/core/src/worker/workflow/mod.rs +200 -97
  71. package/sdk-core/core/src/worker/workflow/wft_poller.rs +175 -4
  72. package/sdk-core/core/src/worker/workflow/workflow_stream.rs +38 -36
  73. package/sdk-core/core-api/Cargo.toml +8 -0
  74. package/sdk-core/core-api/src/envconfig.rs +1544 -0
  75. package/sdk-core/core-api/src/lib.rs +2 -0
  76. package/sdk-core/core-api/src/telemetry/metrics.rs +8 -0
  77. package/sdk-core/core-api/src/telemetry.rs +36 -3
  78. package/sdk-core/core-api/src/worker.rs +301 -75
  79. package/sdk-core/docker/docker-compose-telem.yaml +1 -0
  80. package/sdk-core/etc/prometheus.yaml +6 -2
  81. package/sdk-core/histories/long_local_activity_with_update-0_history.bin +0 -0
  82. package/sdk-core/histories/long_local_activity_with_update-1_history.bin +0 -0
  83. package/sdk-core/histories/long_local_activity_with_update-2_history.bin +0 -0
  84. package/sdk-core/histories/long_local_activity_with_update-3_history.bin +0 -0
  85. package/sdk-core/sdk/src/activity_context.rs +5 -0
  86. package/sdk-core/sdk/src/interceptors.rs +73 -3
  87. package/sdk-core/sdk/src/lib.rs +15 -16
  88. package/sdk-core/sdk/src/workflow_context/options.rs +10 -0
  89. package/sdk-core/sdk/src/workflow_context.rs +48 -29
  90. package/sdk-core/sdk/src/workflow_future.rs +5 -6
  91. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/.github/workflows/push-to-buf.yml +20 -0
  92. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/CODEOWNERS +6 -0
  93. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/README.md +17 -6
  94. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/VERSION +1 -1
  95. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/buf.lock +7 -2
  96. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/buf.yaml +2 -0
  97. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/cloudservice/v1/request_response.proto +78 -0
  98. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/cloudservice/v1/service.proto +29 -0
  99. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/identity/v1/message.proto +74 -32
  100. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/namespace/v1/message.proto +45 -15
  101. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/nexus/v1/message.proto +7 -1
  102. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/operation/v1/message.proto +3 -3
  103. package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/region/v1/message.proto +3 -3
  104. package/sdk-core/sdk-core-protos/protos/api_upstream/LICENSE +1 -1
  105. package/sdk-core/sdk-core-protos/protos/api_upstream/buf.yaml +2 -0
  106. package/sdk-core/sdk-core-protos/protos/api_upstream/openapi/openapiv2.json +1103 -88
  107. package/sdk-core/sdk-core-protos/protos/api_upstream/openapi/openapiv3.yaml +1233 -151
  108. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/activity/v1/message.proto +0 -22
  109. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/batch/v1/message.proto +19 -24
  110. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/command/v1/message.proto +0 -22
  111. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/common/v1/message.proto +12 -22
  112. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/deployment/v1/message.proto +45 -45
  113. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/batch_operation.proto +0 -22
  114. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/command_type.proto +0 -22
  115. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/common.proto +15 -22
  116. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/deployment.proto +0 -22
  117. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/event_type.proto +4 -22
  118. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/failed_cause.proto +0 -22
  119. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/namespace.proto +0 -22
  120. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/nexus.proto +0 -20
  121. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/query.proto +0 -22
  122. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/reset.proto +0 -22
  123. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/schedule.proto +0 -22
  124. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/task_queue.proto +0 -22
  125. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/update.proto +0 -22
  126. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/workflow.proto +4 -22
  127. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/errordetails/v1/message.proto +0 -22
  128. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/export/v1/message.proto +0 -22
  129. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/failure/v1/message.proto +2 -22
  130. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/filter/v1/message.proto +0 -22
  131. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/history/v1/message.proto +75 -49
  132. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/namespace/v1/message.proto +0 -22
  133. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/nexus/v1/message.proto +0 -20
  134. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/operatorservice/v1/request_response.proto +0 -22
  135. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/operatorservice/v1/service.proto +0 -22
  136. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/protocol/v1/message.proto +0 -22
  137. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/query/v1/message.proto +0 -22
  138. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/replication/v1/message.proto +0 -22
  139. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/rules/v1/message.proto +90 -0
  140. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/schedule/v1/message.proto +0 -22
  141. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/sdk/v1/enhanced_stack_trace.proto +0 -22
  142. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/sdk/v1/task_complete_metadata.proto +0 -22
  143. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/sdk/v1/user_metadata.proto +0 -22
  144. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/sdk/v1/workflow_metadata.proto +0 -22
  145. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/taskqueue/v1/message.proto +17 -38
  146. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/update/v1/message.proto +0 -22
  147. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/version/v1/message.proto +0 -22
  148. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflow/v1/message.proto +151 -44
  149. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflowservice/v1/request_response.proto +172 -65
  150. package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflowservice/v1/service.proto +69 -28
  151. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/activity_task/activity_task.proto +18 -0
  152. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/common/common.proto +5 -0
  153. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/nexus/nexus.proto +16 -1
  154. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/workflow_activation/workflow_activation.proto +21 -15
  155. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/workflow_commands/workflow_commands.proto +3 -0
  156. package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/workflow_completion/workflow_completion.proto +3 -0
  157. package/sdk-core/sdk-core-protos/src/lib.rs +60 -16
  158. package/sdk-core/test-utils/src/lib.rs +157 -39
  159. package/sdk-core/tests/cloud_tests.rs +86 -0
  160. package/sdk-core/tests/fuzzy_workflow.rs +23 -26
  161. package/sdk-core/tests/global_metric_tests.rs +116 -0
  162. package/sdk-core/tests/heavy_tests.rs +127 -7
  163. package/sdk-core/tests/integ_tests/client_tests.rs +2 -8
  164. package/sdk-core/tests/integ_tests/metrics_tests.rs +100 -106
  165. package/sdk-core/tests/integ_tests/polling_tests.rs +94 -8
  166. package/sdk-core/tests/integ_tests/update_tests.rs +75 -6
  167. package/sdk-core/tests/integ_tests/worker_tests.rs +54 -5
  168. package/sdk-core/tests/integ_tests/worker_versioning_tests.rs +240 -0
  169. package/sdk-core/tests/integ_tests/workflow_tests/determinism.rs +41 -3
  170. package/sdk-core/tests/integ_tests/workflow_tests/local_activities.rs +168 -8
  171. package/sdk-core/tests/integ_tests/workflow_tests/nexus.rs +285 -15
  172. package/sdk-core/tests/integ_tests/workflow_tests/priority.rs +12 -4
  173. package/sdk-core/tests/integ_tests/workflow_tests/stickyness.rs +3 -2
  174. package/sdk-core/tests/integ_tests/workflow_tests.rs +124 -74
  175. package/sdk-core/tests/main.rs +3 -51
  176. package/sdk-core/tests/manual_tests.rs +430 -0
  177. package/sdk-core/tests/runner.rs +28 -2
  178. package/src/client.rs +565 -0
  179. package/src/helpers/abort_controller.rs +204 -0
  180. package/src/helpers/callbacks.rs +299 -0
  181. package/src/helpers/errors.rs +302 -0
  182. package/src/helpers/future.rs +44 -0
  183. package/src/helpers/handles.rs +191 -0
  184. package/src/helpers/inspect.rs +18 -0
  185. package/src/helpers/json_string.rs +58 -0
  186. package/src/helpers/mod.rs +20 -0
  187. package/src/helpers/properties.rs +71 -0
  188. package/src/helpers/try_from_js.rs +213 -0
  189. package/src/helpers/try_into_js.rs +129 -0
  190. package/src/lib.rs +28 -40
  191. package/src/logs.rs +111 -0
  192. package/src/metrics.rs +325 -0
  193. package/src/runtime.rs +409 -498
  194. package/src/testing.rs +315 -57
  195. package/src/worker.rs +907 -378
  196. package/ts/errors.ts +57 -0
  197. package/ts/index.ts +10 -596
  198. package/ts/native.ts +496 -0
  199. package/lib/worker-tuner.d.ts +0 -167
  200. package/lib/worker-tuner.js.map +0 -1
  201. package/src/conversions/slot_supplier_bridge.rs +0 -291
  202. package/src/conversions.rs +0 -618
  203. package/src/errors.rs +0 -38
  204. package/src/helpers.rs +0 -297
  205. package/ts/worker-tuner.ts +0 -193
@@ -1732,7 +1732,7 @@
1732
1732
  ]
1733
1733
  }
1734
1734
  },
1735
- "/api/v1/namespaces/{namespace}/worker-deployment-versions/{version}": {
1735
+ "/api/v1/namespaces/{namespace}/worker-deployment-versions/{deploymentVersion.deploymentName}/{deploymentVersion.buildId}": {
1736
1736
  "get": {
1737
1737
  "summary": "Describes a worker deployment version.\nExperimental. This API might significantly change or be removed in a future release.",
1738
1738
  "operationId": "DescribeWorkerDeploymentVersion2",
@@ -1758,11 +1758,25 @@
1758
1758
  "type": "string"
1759
1759
  },
1760
1760
  {
1761
- "name": "version",
1762
- "description": "Deployment Version identifier in the form \"<deployment_name>.<build_id>\".",
1761
+ "name": "deploymentVersion.deploymentName",
1762
+ "description": "Identifies the Worker Deployment this Version is part of.",
1763
+ "in": "path",
1764
+ "required": true,
1765
+ "type": "string"
1766
+ },
1767
+ {
1768
+ "name": "deploymentVersion.buildId",
1769
+ "description": "A unique identifier for this Version within the Deployment it is a part of.\nNot necessarily unique within the namespace.\nThe combination of `deployment_name` and `build_id` uniquely identifies this\nVersion within the namespace, because Deployment names are unique within a namespace.",
1763
1770
  "in": "path",
1764
1771
  "required": true,
1765
1772
  "type": "string"
1773
+ },
1774
+ {
1775
+ "name": "version",
1776
+ "description": "Deprecated. Use `deployment_version`.",
1777
+ "in": "query",
1778
+ "required": false,
1779
+ "type": "string"
1766
1780
  }
1767
1781
  ],
1768
1782
  "tags": [
@@ -1794,12 +1808,26 @@
1794
1808
  "type": "string"
1795
1809
  },
1796
1810
  {
1797
- "name": "version",
1798
- "description": "Deployment Version identifier in the form \"<deployment_name>.<build_id>\".",
1811
+ "name": "deploymentVersion.deploymentName",
1812
+ "description": "Identifies the Worker Deployment this Version is part of.",
1813
+ "in": "path",
1814
+ "required": true,
1815
+ "type": "string"
1816
+ },
1817
+ {
1818
+ "name": "deploymentVersion.buildId",
1819
+ "description": "A unique identifier for this Version within the Deployment it is a part of.\nNot necessarily unique within the namespace.\nThe combination of `deployment_name` and `build_id` uniquely identifies this\nVersion within the namespace, because Deployment names are unique within a namespace.",
1799
1820
  "in": "path",
1800
1821
  "required": true,
1801
1822
  "type": "string"
1802
1823
  },
1824
+ {
1825
+ "name": "version",
1826
+ "description": "Deprecated. Use `deployment_version`.",
1827
+ "in": "query",
1828
+ "required": false,
1829
+ "type": "string"
1830
+ },
1803
1831
  {
1804
1832
  "name": "skipDrainage",
1805
1833
  "description": "Pass to force deletion even if the Version is draining. In this case the open pinned\nworkflows will be stuck until manually moved to another version by UpdateWorkflowExecutionOptions.",
@@ -1820,7 +1848,7 @@
1820
1848
  ]
1821
1849
  }
1822
1850
  },
1823
- "/api/v1/namespaces/{namespace}/worker-deployment-versions/{version}/update-metadata": {
1851
+ "/api/v1/namespaces/{namespace}/worker-deployment-versions/{deploymentVersion.deploymentName}/{deploymentVersion.buildId}/update-metadata": {
1824
1852
  "post": {
1825
1853
  "summary": "Updates the user-given metadata attached to a Worker Deployment Version.\nExperimental. This API might significantly change or be removed in a future release.",
1826
1854
  "operationId": "UpdateWorkerDeploymentVersionMetadata2",
@@ -1846,8 +1874,15 @@
1846
1874
  "type": "string"
1847
1875
  },
1848
1876
  {
1849
- "name": "version",
1850
- "description": "Deployment Version identifier in the form \"<deployment_name>.<build_id>\".",
1877
+ "name": "deploymentVersion.deploymentName",
1878
+ "description": "Identifies the Worker Deployment this Version is part of.",
1879
+ "in": "path",
1880
+ "required": true,
1881
+ "type": "string"
1882
+ },
1883
+ {
1884
+ "name": "deploymentVersion.buildId",
1885
+ "description": "A unique identifier for this Version within the Deployment it is a part of.\nNot necessarily unique within the namespace.\nThe combination of `deployment_name` and `build_id` uniquely identifies this\nVersion within the namespace, because Deployment names are unique within a namespace.",
1851
1886
  "in": "path",
1852
1887
  "required": true,
1853
1888
  "type": "string"
@@ -2186,6 +2221,155 @@
2186
2221
  ]
2187
2222
  }
2188
2223
  },
2224
+ "/api/v1/namespaces/{namespace}/workflow-rules": {
2225
+ "get": {
2226
+ "summary": "Return all namespace workflow rules",
2227
+ "operationId": "ListWorkflowRules2",
2228
+ "responses": {
2229
+ "200": {
2230
+ "description": "A successful response.",
2231
+ "schema": {
2232
+ "$ref": "#/definitions/v1ListWorkflowRulesResponse"
2233
+ }
2234
+ },
2235
+ "default": {
2236
+ "description": "An unexpected error response.",
2237
+ "schema": {
2238
+ "$ref": "#/definitions/rpcStatus"
2239
+ }
2240
+ }
2241
+ },
2242
+ "parameters": [
2243
+ {
2244
+ "name": "namespace",
2245
+ "in": "path",
2246
+ "required": true,
2247
+ "type": "string"
2248
+ },
2249
+ {
2250
+ "name": "nextPageToken",
2251
+ "in": "query",
2252
+ "required": false,
2253
+ "type": "string",
2254
+ "format": "byte"
2255
+ }
2256
+ ],
2257
+ "tags": [
2258
+ "WorkflowService"
2259
+ ]
2260
+ },
2261
+ "post": {
2262
+ "summary": "Create a new workflow rule. The rules are used to control the workflow execution.\nThe rule will be applied to all running and new workflows in the namespace.\nIf the rule with such ID already exist this call will fail\nNote: the rules are part of namespace configuration and will be stored in the namespace config.\nNamespace config is eventually consistent.",
2263
+ "operationId": "CreateWorkflowRule2",
2264
+ "responses": {
2265
+ "200": {
2266
+ "description": "A successful response.",
2267
+ "schema": {
2268
+ "$ref": "#/definitions/v1CreateWorkflowRuleResponse"
2269
+ }
2270
+ },
2271
+ "default": {
2272
+ "description": "An unexpected error response.",
2273
+ "schema": {
2274
+ "$ref": "#/definitions/rpcStatus"
2275
+ }
2276
+ }
2277
+ },
2278
+ "parameters": [
2279
+ {
2280
+ "name": "namespace",
2281
+ "in": "path",
2282
+ "required": true,
2283
+ "type": "string"
2284
+ },
2285
+ {
2286
+ "name": "body",
2287
+ "in": "body",
2288
+ "required": true,
2289
+ "schema": {
2290
+ "$ref": "#/definitions/WorkflowServiceCreateWorkflowRuleBody"
2291
+ }
2292
+ }
2293
+ ],
2294
+ "tags": [
2295
+ "WorkflowService"
2296
+ ]
2297
+ }
2298
+ },
2299
+ "/api/v1/namespaces/{namespace}/workflow-rules/{ruleId}": {
2300
+ "get": {
2301
+ "summary": "DescribeWorkflowRule return the rule specification for existing rule id.\nIf there is no rule with such id - NOT FOUND error will be returned.",
2302
+ "operationId": "DescribeWorkflowRule2",
2303
+ "responses": {
2304
+ "200": {
2305
+ "description": "A successful response.",
2306
+ "schema": {
2307
+ "$ref": "#/definitions/v1DescribeWorkflowRuleResponse"
2308
+ }
2309
+ },
2310
+ "default": {
2311
+ "description": "An unexpected error response.",
2312
+ "schema": {
2313
+ "$ref": "#/definitions/rpcStatus"
2314
+ }
2315
+ }
2316
+ },
2317
+ "parameters": [
2318
+ {
2319
+ "name": "namespace",
2320
+ "in": "path",
2321
+ "required": true,
2322
+ "type": "string"
2323
+ },
2324
+ {
2325
+ "name": "ruleId",
2326
+ "description": "User-specified ID of the rule to read. Unique within the namespace.",
2327
+ "in": "path",
2328
+ "required": true,
2329
+ "type": "string"
2330
+ }
2331
+ ],
2332
+ "tags": [
2333
+ "WorkflowService"
2334
+ ]
2335
+ },
2336
+ "delete": {
2337
+ "summary": "Delete rule by rule id",
2338
+ "operationId": "DeleteWorkflowRule2",
2339
+ "responses": {
2340
+ "200": {
2341
+ "description": "A successful response.",
2342
+ "schema": {
2343
+ "$ref": "#/definitions/v1DeleteWorkflowRuleResponse"
2344
+ }
2345
+ },
2346
+ "default": {
2347
+ "description": "An unexpected error response.",
2348
+ "schema": {
2349
+ "$ref": "#/definitions/rpcStatus"
2350
+ }
2351
+ }
2352
+ },
2353
+ "parameters": [
2354
+ {
2355
+ "name": "namespace",
2356
+ "in": "path",
2357
+ "required": true,
2358
+ "type": "string"
2359
+ },
2360
+ {
2361
+ "name": "ruleId",
2362
+ "description": "ID of the rule to delete. Unique within the namespace.",
2363
+ "in": "path",
2364
+ "required": true,
2365
+ "type": "string"
2366
+ }
2367
+ ],
2368
+ "tags": [
2369
+ "WorkflowService"
2370
+ ]
2371
+ }
2372
+ },
2189
2373
  "/api/v1/namespaces/{namespace}/workflows": {
2190
2374
  "get": {
2191
2375
  "summary": "ListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.",
@@ -2513,6 +2697,51 @@
2513
2697
  ]
2514
2698
  }
2515
2699
  },
2700
+ "/api/v1/namespaces/{namespace}/workflows/{execution.workflowId}/trigger-rule": {
2701
+ "post": {
2702
+ "summary": "TriggerWorkflowRule allows to:\n * trigger existing rule for a specific workflow execution;\n * trigger rule for a specific workflow execution without creating a rule;\nThis is useful for one-off operations.",
2703
+ "operationId": "TriggerWorkflowRule2",
2704
+ "responses": {
2705
+ "200": {
2706
+ "description": "A successful response.",
2707
+ "schema": {
2708
+ "$ref": "#/definitions/v1TriggerWorkflowRuleResponse"
2709
+ }
2710
+ },
2711
+ "default": {
2712
+ "description": "An unexpected error response.",
2713
+ "schema": {
2714
+ "$ref": "#/definitions/rpcStatus"
2715
+ }
2716
+ }
2717
+ },
2718
+ "parameters": [
2719
+ {
2720
+ "name": "namespace",
2721
+ "in": "path",
2722
+ "required": true,
2723
+ "type": "string"
2724
+ },
2725
+ {
2726
+ "name": "execution.workflowId",
2727
+ "in": "path",
2728
+ "required": true,
2729
+ "type": "string"
2730
+ },
2731
+ {
2732
+ "name": "body",
2733
+ "in": "body",
2734
+ "required": true,
2735
+ "schema": {
2736
+ "$ref": "#/definitions/WorkflowServiceTriggerWorkflowRuleBody"
2737
+ }
2738
+ }
2739
+ ],
2740
+ "tags": [
2741
+ "WorkflowService"
2742
+ ]
2743
+ }
2744
+ },
2516
2745
  "/api/v1/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/cancel": {
2517
2746
  "post": {
2518
2747
  "summary": "RequestCancelWorkflowExecution is called by workers when they want to request cancellation of\na workflow execution.",
@@ -5012,7 +5241,7 @@
5012
5241
  ]
5013
5242
  }
5014
5243
  },
5015
- "/namespaces/{namespace}/worker-deployment-versions/{version}": {
5244
+ "/namespaces/{namespace}/worker-deployment-versions/{deploymentVersion.deploymentName}/{deploymentVersion.buildId}": {
5016
5245
  "get": {
5017
5246
  "summary": "Describes a worker deployment version.\nExperimental. This API might significantly change or be removed in a future release.",
5018
5247
  "operationId": "DescribeWorkerDeploymentVersion",
@@ -5038,11 +5267,25 @@
5038
5267
  "type": "string"
5039
5268
  },
5040
5269
  {
5041
- "name": "version",
5042
- "description": "Deployment Version identifier in the form \"<deployment_name>.<build_id>\".",
5270
+ "name": "deploymentVersion.deploymentName",
5271
+ "description": "Identifies the Worker Deployment this Version is part of.",
5272
+ "in": "path",
5273
+ "required": true,
5274
+ "type": "string"
5275
+ },
5276
+ {
5277
+ "name": "deploymentVersion.buildId",
5278
+ "description": "A unique identifier for this Version within the Deployment it is a part of.\nNot necessarily unique within the namespace.\nThe combination of `deployment_name` and `build_id` uniquely identifies this\nVersion within the namespace, because Deployment names are unique within a namespace.",
5043
5279
  "in": "path",
5044
5280
  "required": true,
5045
5281
  "type": "string"
5282
+ },
5283
+ {
5284
+ "name": "version",
5285
+ "description": "Deprecated. Use `deployment_version`.",
5286
+ "in": "query",
5287
+ "required": false,
5288
+ "type": "string"
5046
5289
  }
5047
5290
  ],
5048
5291
  "tags": [
@@ -5074,12 +5317,26 @@
5074
5317
  "type": "string"
5075
5318
  },
5076
5319
  {
5077
- "name": "version",
5078
- "description": "Deployment Version identifier in the form \"<deployment_name>.<build_id>\".",
5320
+ "name": "deploymentVersion.deploymentName",
5321
+ "description": "Identifies the Worker Deployment this Version is part of.",
5322
+ "in": "path",
5323
+ "required": true,
5324
+ "type": "string"
5325
+ },
5326
+ {
5327
+ "name": "deploymentVersion.buildId",
5328
+ "description": "A unique identifier for this Version within the Deployment it is a part of.\nNot necessarily unique within the namespace.\nThe combination of `deployment_name` and `build_id` uniquely identifies this\nVersion within the namespace, because Deployment names are unique within a namespace.",
5079
5329
  "in": "path",
5080
5330
  "required": true,
5081
5331
  "type": "string"
5082
5332
  },
5333
+ {
5334
+ "name": "version",
5335
+ "description": "Deprecated. Use `deployment_version`.",
5336
+ "in": "query",
5337
+ "required": false,
5338
+ "type": "string"
5339
+ },
5083
5340
  {
5084
5341
  "name": "skipDrainage",
5085
5342
  "description": "Pass to force deletion even if the Version is draining. In this case the open pinned\nworkflows will be stuck until manually moved to another version by UpdateWorkflowExecutionOptions.",
@@ -5100,7 +5357,7 @@
5100
5357
  ]
5101
5358
  }
5102
5359
  },
5103
- "/namespaces/{namespace}/worker-deployment-versions/{version}/update-metadata": {
5360
+ "/namespaces/{namespace}/worker-deployment-versions/{deploymentVersion.deploymentName}/{deploymentVersion.buildId}/update-metadata": {
5104
5361
  "post": {
5105
5362
  "summary": "Updates the user-given metadata attached to a Worker Deployment Version.\nExperimental. This API might significantly change or be removed in a future release.",
5106
5363
  "operationId": "UpdateWorkerDeploymentVersionMetadata",
@@ -5126,8 +5383,15 @@
5126
5383
  "type": "string"
5127
5384
  },
5128
5385
  {
5129
- "name": "version",
5130
- "description": "Deployment Version identifier in the form \"<deployment_name>.<build_id>\".",
5386
+ "name": "deploymentVersion.deploymentName",
5387
+ "description": "Identifies the Worker Deployment this Version is part of.",
5388
+ "in": "path",
5389
+ "required": true,
5390
+ "type": "string"
5391
+ },
5392
+ {
5393
+ "name": "deploymentVersion.buildId",
5394
+ "description": "A unique identifier for this Version within the Deployment it is a part of.\nNot necessarily unique within the namespace.\nThe combination of `deployment_name` and `build_id` uniquely identifies this\nVersion within the namespace, because Deployment names are unique within a namespace.",
5131
5395
  "in": "path",
5132
5396
  "required": true,
5133
5397
  "type": "string"
@@ -5466,15 +5730,15 @@
5466
5730
  ]
5467
5731
  }
5468
5732
  },
5469
- "/namespaces/{namespace}/workflows": {
5733
+ "/namespaces/{namespace}/workflow-rules": {
5470
5734
  "get": {
5471
- "summary": "ListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.",
5472
- "operationId": "ListWorkflowExecutions",
5735
+ "summary": "Return all namespace workflow rules",
5736
+ "operationId": "ListWorkflowRules",
5473
5737
  "responses": {
5474
5738
  "200": {
5475
5739
  "description": "A successful response.",
5476
5740
  "schema": {
5477
- "$ref": "#/definitions/v1ListWorkflowExecutionsResponse"
5741
+ "$ref": "#/definitions/v1ListWorkflowRulesResponse"
5478
5742
  }
5479
5743
  },
5480
5744
  "default": {
@@ -5491,42 +5755,26 @@
5491
5755
  "required": true,
5492
5756
  "type": "string"
5493
5757
  },
5494
- {
5495
- "name": "pageSize",
5496
- "in": "query",
5497
- "required": false,
5498
- "type": "integer",
5499
- "format": "int32"
5500
- },
5501
5758
  {
5502
5759
  "name": "nextPageToken",
5503
5760
  "in": "query",
5504
5761
  "required": false,
5505
5762
  "type": "string",
5506
5763
  "format": "byte"
5507
- },
5508
- {
5509
- "name": "query",
5510
- "in": "query",
5511
- "required": false,
5512
- "type": "string"
5513
5764
  }
5514
5765
  ],
5515
5766
  "tags": [
5516
5767
  "WorkflowService"
5517
5768
  ]
5518
- }
5519
- },
5520
- "/namespaces/{namespace}/workflows/execute-multi-operation": {
5769
+ },
5521
5770
  "post": {
5522
- "summary": "ExecuteMultiOperation executes multiple operations within a single workflow.",
5523
- "description": "Operations are started atomically, meaning if *any* operation fails to be started, none are,\nand the request fails. Upon start, the API returns only when *all* operations have a response.\n\nUpon failure, it returns `MultiOperationExecutionFailure` where the status code\nequals the status code of the *first* operation that failed to be started.\n\nNOTE: Experimental API.",
5524
- "operationId": "ExecuteMultiOperation",
5771
+ "summary": "Create a new workflow rule. The rules are used to control the workflow execution.\nThe rule will be applied to all running and new workflows in the namespace.\nIf the rule with such ID already exist this call will fail\nNote: the rules are part of namespace configuration and will be stored in the namespace config.\nNamespace config is eventually consistent.",
5772
+ "operationId": "CreateWorkflowRule",
5525
5773
  "responses": {
5526
5774
  "200": {
5527
5775
  "description": "A successful response.",
5528
5776
  "schema": {
5529
- "$ref": "#/definitions/v1ExecuteMultiOperationResponse"
5777
+ "$ref": "#/definitions/v1CreateWorkflowRuleResponse"
5530
5778
  }
5531
5779
  },
5532
5780
  "default": {
@@ -5548,7 +5796,172 @@
5548
5796
  "in": "body",
5549
5797
  "required": true,
5550
5798
  "schema": {
5551
- "$ref": "#/definitions/WorkflowServiceExecuteMultiOperationBody"
5799
+ "$ref": "#/definitions/WorkflowServiceCreateWorkflowRuleBody"
5800
+ }
5801
+ }
5802
+ ],
5803
+ "tags": [
5804
+ "WorkflowService"
5805
+ ]
5806
+ }
5807
+ },
5808
+ "/namespaces/{namespace}/workflow-rules/{ruleId}": {
5809
+ "get": {
5810
+ "summary": "DescribeWorkflowRule return the rule specification for existing rule id.\nIf there is no rule with such id - NOT FOUND error will be returned.",
5811
+ "operationId": "DescribeWorkflowRule",
5812
+ "responses": {
5813
+ "200": {
5814
+ "description": "A successful response.",
5815
+ "schema": {
5816
+ "$ref": "#/definitions/v1DescribeWorkflowRuleResponse"
5817
+ }
5818
+ },
5819
+ "default": {
5820
+ "description": "An unexpected error response.",
5821
+ "schema": {
5822
+ "$ref": "#/definitions/rpcStatus"
5823
+ }
5824
+ }
5825
+ },
5826
+ "parameters": [
5827
+ {
5828
+ "name": "namespace",
5829
+ "in": "path",
5830
+ "required": true,
5831
+ "type": "string"
5832
+ },
5833
+ {
5834
+ "name": "ruleId",
5835
+ "description": "User-specified ID of the rule to read. Unique within the namespace.",
5836
+ "in": "path",
5837
+ "required": true,
5838
+ "type": "string"
5839
+ }
5840
+ ],
5841
+ "tags": [
5842
+ "WorkflowService"
5843
+ ]
5844
+ },
5845
+ "delete": {
5846
+ "summary": "Delete rule by rule id",
5847
+ "operationId": "DeleteWorkflowRule",
5848
+ "responses": {
5849
+ "200": {
5850
+ "description": "A successful response.",
5851
+ "schema": {
5852
+ "$ref": "#/definitions/v1DeleteWorkflowRuleResponse"
5853
+ }
5854
+ },
5855
+ "default": {
5856
+ "description": "An unexpected error response.",
5857
+ "schema": {
5858
+ "$ref": "#/definitions/rpcStatus"
5859
+ }
5860
+ }
5861
+ },
5862
+ "parameters": [
5863
+ {
5864
+ "name": "namespace",
5865
+ "in": "path",
5866
+ "required": true,
5867
+ "type": "string"
5868
+ },
5869
+ {
5870
+ "name": "ruleId",
5871
+ "description": "ID of the rule to delete. Unique within the namespace.",
5872
+ "in": "path",
5873
+ "required": true,
5874
+ "type": "string"
5875
+ }
5876
+ ],
5877
+ "tags": [
5878
+ "WorkflowService"
5879
+ ]
5880
+ }
5881
+ },
5882
+ "/namespaces/{namespace}/workflows": {
5883
+ "get": {
5884
+ "summary": "ListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.",
5885
+ "operationId": "ListWorkflowExecutions",
5886
+ "responses": {
5887
+ "200": {
5888
+ "description": "A successful response.",
5889
+ "schema": {
5890
+ "$ref": "#/definitions/v1ListWorkflowExecutionsResponse"
5891
+ }
5892
+ },
5893
+ "default": {
5894
+ "description": "An unexpected error response.",
5895
+ "schema": {
5896
+ "$ref": "#/definitions/rpcStatus"
5897
+ }
5898
+ }
5899
+ },
5900
+ "parameters": [
5901
+ {
5902
+ "name": "namespace",
5903
+ "in": "path",
5904
+ "required": true,
5905
+ "type": "string"
5906
+ },
5907
+ {
5908
+ "name": "pageSize",
5909
+ "in": "query",
5910
+ "required": false,
5911
+ "type": "integer",
5912
+ "format": "int32"
5913
+ },
5914
+ {
5915
+ "name": "nextPageToken",
5916
+ "in": "query",
5917
+ "required": false,
5918
+ "type": "string",
5919
+ "format": "byte"
5920
+ },
5921
+ {
5922
+ "name": "query",
5923
+ "in": "query",
5924
+ "required": false,
5925
+ "type": "string"
5926
+ }
5927
+ ],
5928
+ "tags": [
5929
+ "WorkflowService"
5930
+ ]
5931
+ }
5932
+ },
5933
+ "/namespaces/{namespace}/workflows/execute-multi-operation": {
5934
+ "post": {
5935
+ "summary": "ExecuteMultiOperation executes multiple operations within a single workflow.",
5936
+ "description": "Operations are started atomically, meaning if *any* operation fails to be started, none are,\nand the request fails. Upon start, the API returns only when *all* operations have a response.\n\nUpon failure, it returns `MultiOperationExecutionFailure` where the status code\nequals the status code of the *first* operation that failed to be started.\n\nNOTE: Experimental API.",
5937
+ "operationId": "ExecuteMultiOperation",
5938
+ "responses": {
5939
+ "200": {
5940
+ "description": "A successful response.",
5941
+ "schema": {
5942
+ "$ref": "#/definitions/v1ExecuteMultiOperationResponse"
5943
+ }
5944
+ },
5945
+ "default": {
5946
+ "description": "An unexpected error response.",
5947
+ "schema": {
5948
+ "$ref": "#/definitions/rpcStatus"
5949
+ }
5950
+ }
5951
+ },
5952
+ "parameters": [
5953
+ {
5954
+ "name": "namespace",
5955
+ "in": "path",
5956
+ "required": true,
5957
+ "type": "string"
5958
+ },
5959
+ {
5960
+ "name": "body",
5961
+ "in": "body",
5962
+ "required": true,
5963
+ "schema": {
5964
+ "$ref": "#/definitions/WorkflowServiceExecuteMultiOperationBody"
5552
5965
  }
5553
5966
  }
5554
5967
  ],
@@ -5793,6 +6206,51 @@
5793
6206
  ]
5794
6207
  }
5795
6208
  },
6209
+ "/namespaces/{namespace}/workflows/{execution.workflowId}/trigger-rule": {
6210
+ "post": {
6211
+ "summary": "TriggerWorkflowRule allows to:\n * trigger existing rule for a specific workflow execution;\n * trigger rule for a specific workflow execution without creating a rule;\nThis is useful for one-off operations.",
6212
+ "operationId": "TriggerWorkflowRule",
6213
+ "responses": {
6214
+ "200": {
6215
+ "description": "A successful response.",
6216
+ "schema": {
6217
+ "$ref": "#/definitions/v1TriggerWorkflowRuleResponse"
6218
+ }
6219
+ },
6220
+ "default": {
6221
+ "description": "An unexpected error response.",
6222
+ "schema": {
6223
+ "$ref": "#/definitions/rpcStatus"
6224
+ }
6225
+ }
6226
+ },
6227
+ "parameters": [
6228
+ {
6229
+ "name": "namespace",
6230
+ "in": "path",
6231
+ "required": true,
6232
+ "type": "string"
6233
+ },
6234
+ {
6235
+ "name": "execution.workflowId",
6236
+ "in": "path",
6237
+ "required": true,
6238
+ "type": "string"
6239
+ },
6240
+ {
6241
+ "name": "body",
6242
+ "in": "body",
6243
+ "required": true,
6244
+ "schema": {
6245
+ "$ref": "#/definitions/WorkflowServiceTriggerWorkflowRuleBody"
6246
+ }
6247
+ }
6248
+ ],
6249
+ "tags": [
6250
+ "WorkflowService"
6251
+ ]
6252
+ }
6253
+ },
5796
6254
  "/namespaces/{namespace}/workflows/{workflowExecution.workflowId}/cancel": {
5797
6255
  "post": {
5798
6256
  "summary": "RequestCancelWorkflowExecution is called by workers when they want to request cancellation of\na workflow execution.",
@@ -6336,6 +6794,9 @@
6336
6794
  },
6337
6795
  "eventRef": {
6338
6796
  "$ref": "#/definitions/WorkflowEventEventReference"
6797
+ },
6798
+ "requestIdRef": {
6799
+ "$ref": "#/definitions/WorkflowEventRequestIdReference"
6339
6800
  }
6340
6801
  }
6341
6802
  },
@@ -6368,6 +6829,94 @@
6368
6829
  }
6369
6830
  }
6370
6831
  },
6832
+ "PauseInfoManual": {
6833
+ "type": "object",
6834
+ "properties": {
6835
+ "identity": {
6836
+ "type": "string",
6837
+ "description": "The identity of the actor that paused the activity."
6838
+ },
6839
+ "reason": {
6840
+ "type": "string",
6841
+ "description": "Reason for pausing the activity."
6842
+ }
6843
+ }
6844
+ },
6845
+ "PauseInfoRule": {
6846
+ "type": "object",
6847
+ "properties": {
6848
+ "ruleId": {
6849
+ "type": "string",
6850
+ "description": "The rule that paused the activity."
6851
+ },
6852
+ "identity": {
6853
+ "type": "string",
6854
+ "description": "The identity of the actor that created the rule."
6855
+ },
6856
+ "reason": {
6857
+ "type": "string",
6858
+ "description": "Reason why rule was created. Populated from rule description."
6859
+ }
6860
+ }
6861
+ },
6862
+ "PendingActivityInfoPauseInfo": {
6863
+ "type": "object",
6864
+ "properties": {
6865
+ "pauseTime": {
6866
+ "type": "string",
6867
+ "format": "date-time",
6868
+ "description": "The time when the activity was paused."
6869
+ },
6870
+ "manual": {
6871
+ "$ref": "#/definitions/PauseInfoManual",
6872
+ "title": "activity was paused by the manual intervention"
6873
+ },
6874
+ "rule": {
6875
+ "$ref": "#/definitions/PauseInfoRule",
6876
+ "title": "activity was paused by the rule"
6877
+ }
6878
+ }
6879
+ },
6880
+ "PostResetOperationSignalWorkflow": {
6881
+ "type": "object",
6882
+ "properties": {
6883
+ "signalName": {
6884
+ "type": "string",
6885
+ "description": "The workflow author-defined name of the signal to send to the workflow."
6886
+ },
6887
+ "input": {
6888
+ "$ref": "#/definitions/v1Payloads",
6889
+ "description": "Serialized value(s) to provide with the signal."
6890
+ },
6891
+ "header": {
6892
+ "$ref": "#/definitions/v1Header",
6893
+ "description": "Headers that are passed with the signal to the processing workflow."
6894
+ },
6895
+ "links": {
6896
+ "type": "array",
6897
+ "items": {
6898
+ "type": "object",
6899
+ "$ref": "#/definitions/apicommonv1Link"
6900
+ },
6901
+ "description": "Links to be associated with the WorkflowExecutionSignaled event."
6902
+ }
6903
+ },
6904
+ "description": "SignalWorkflow represents sending a signal after a workflow reset.\nKeep the parameter in sync with temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest."
6905
+ },
6906
+ "PostResetOperationUpdateWorkflowOptions": {
6907
+ "type": "object",
6908
+ "properties": {
6909
+ "workflowExecutionOptions": {
6910
+ "$ref": "#/definitions/v1WorkflowExecutionOptions",
6911
+ "description": "Update Workflow options that were originally specified via StartWorkflowExecution. Partial updates are accepted and controlled by update_mask."
6912
+ },
6913
+ "updateMask": {
6914
+ "type": "string",
6915
+ "description": "Controls which fields from `workflow_execution_options` will be applied.\nTo unset a field, set it to null and use the update mask to indicate that it should be mutated."
6916
+ }
6917
+ },
6918
+ "description": "UpdateWorkflowOptions represents updating workflow execution options after a workflow reset.\nKeep the parameters in sync with temporal.api.workflowservice.v1.UpdateWorkflowExecutionOptionsRequest."
6919
+ },
6371
6920
  "StartOperationResponseAsync": {
6372
6921
  "type": "object",
6373
6922
  "properties": {
@@ -6517,12 +7066,38 @@
6517
7066
  },
6518
7067
  "description": "Replaces the routing rule with the given source Build ID."
6519
7068
  },
7069
+ "VersioningOverridePinnedOverride": {
7070
+ "type": "object",
7071
+ "properties": {
7072
+ "behavior": {
7073
+ "$ref": "#/definitions/VersioningOverridePinnedOverrideBehavior",
7074
+ "description": "Defaults to PINNED_OVERRIDE_BEHAVIOR_UNSPECIFIED.\nSee `PinnedOverrideBehavior` for details."
7075
+ },
7076
+ "version": {
7077
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
7078
+ "description": "Required."
7079
+ }
7080
+ }
7081
+ },
7082
+ "VersioningOverridePinnedOverrideBehavior": {
7083
+ "type": "string",
7084
+ "enum": [
7085
+ "PINNED_OVERRIDE_BEHAVIOR_UNSPECIFIED",
7086
+ "PINNED_OVERRIDE_BEHAVIOR_PINNED"
7087
+ ],
7088
+ "default": "PINNED_OVERRIDE_BEHAVIOR_UNSPECIFIED",
7089
+ "description": "Used to specify different sub-types of Pinned override that we plan to add in the future.\n\n - PINNED_OVERRIDE_BEHAVIOR_UNSPECIFIED: Unspecified.\n - PINNED_OVERRIDE_BEHAVIOR_PINNED: Override workflow behavior to be Pinned."
7090
+ },
6520
7091
  "WorkerDeploymentInfoWorkerDeploymentVersionSummary": {
6521
7092
  "type": "object",
6522
7093
  "properties": {
6523
7094
  "version": {
6524
7095
  "type": "string",
6525
- "description": "The fully-qualified string representation of the version, in the form \"<deployment_name>.<build_id>\"."
7096
+ "description": "Deprecated. Use `deployment_version`."
7097
+ },
7098
+ "deploymentVersion": {
7099
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
7100
+ "description": "Required."
6526
7101
  },
6527
7102
  "createTime": {
6528
7103
  "type": "string",
@@ -6554,7 +7129,33 @@
6554
7129
  "eventType": {
6555
7130
  "$ref": "#/definitions/v1EventType"
6556
7131
  }
6557
- }
7132
+ },
7133
+ "description": "EventReference is a direct reference to a history event through the event ID."
7134
+ },
7135
+ "WorkflowEventRequestIdReference": {
7136
+ "type": "object",
7137
+ "properties": {
7138
+ "requestId": {
7139
+ "type": "string"
7140
+ },
7141
+ "eventType": {
7142
+ "$ref": "#/definitions/v1EventType"
7143
+ }
7144
+ },
7145
+ "description": "RequestIdReference is a indirect reference to a history event through the request ID."
7146
+ },
7147
+ "WorkflowRuleActionActionActivityPause": {
7148
+ "type": "object"
7149
+ },
7150
+ "WorkflowRuleSpecActivityStartingTrigger": {
7151
+ "type": "object",
7152
+ "properties": {
7153
+ "predicate": {
7154
+ "type": "string",
7155
+ "title": "Activity predicate is a SQL-like string filter parameter.\nIt is used to match against workflow data.\nThe following activity attributes are supported as part of the predicate:\n- ActivityType: An Activity Type is the mapping of a name to an Activity Definition..\n- ActivityId: The ID of the activity.\n- ActivityAttempt: The number attempts of the activity.\n- BackoffInterval: The current amount of time between scheduled attempts of the activity.\n- ActivityStatus: The status of the activity. Can be one of \"Scheduled\", \"Started\", \"Paused\".\n- TaskQueue: The name of the task queue the workflow specified that the activity should run on.\nActivity predicate support the following operators:\n * =, !=, >, >=, <, <=\n * AND, OR, ()\n * BETWEEN ... AND\n STARTS_WITH"
7156
+ }
7157
+ },
7158
+ "description": "Activity trigger will be triggered when an activity is about to start."
6558
7159
  },
6559
7160
  "WorkflowServiceCreateScheduleBody": {
6560
7161
  "type": "object",
@@ -6579,8 +7180,33 @@
6579
7180
  "$ref": "#/definitions/v1Memo",
6580
7181
  "description": "Memo and search attributes to attach to the schedule itself."
6581
7182
  },
6582
- "searchAttributes": {
6583
- "$ref": "#/definitions/v1SearchAttributes"
7183
+ "searchAttributes": {
7184
+ "$ref": "#/definitions/v1SearchAttributes"
7185
+ }
7186
+ }
7187
+ },
7188
+ "WorkflowServiceCreateWorkflowRuleBody": {
7189
+ "type": "object",
7190
+ "properties": {
7191
+ "spec": {
7192
+ "$ref": "#/definitions/v1WorkflowRuleSpec",
7193
+ "description": "The rule specification ."
7194
+ },
7195
+ "forceScan": {
7196
+ "type": "boolean",
7197
+ "description": "If true, the rule will be applied to the currently running workflows via batch job.\nIf not set , the rule will only be applied when triggering condition is satisfied.\nvisibility_query in the rule will be used to select the workflows to apply the rule to."
7198
+ },
7199
+ "requestId": {
7200
+ "type": "string",
7201
+ "description": "Used to de-dupe requests. Typically should be UUID."
7202
+ },
7203
+ "identity": {
7204
+ "type": "string",
7205
+ "description": "Identity of the actor who created the rule. Will be stored with the rule."
7206
+ },
7207
+ "description": {
7208
+ "type": "string",
7209
+ "description": "Rule description.Will be stored with the rule."
6584
7210
  }
6585
7211
  }
6586
7212
  },
@@ -6631,6 +7257,10 @@
6631
7257
  "type": {
6632
7258
  "type": "string",
6633
7259
  "description": "Pause all running activities of this type."
7260
+ },
7261
+ "reason": {
7262
+ "type": "string",
7263
+ "description": "Reason to pause the activity."
6634
7264
  }
6635
7265
  }
6636
7266
  },
@@ -6815,6 +7445,14 @@
6815
7445
  "$ref": "#/definitions/v1ResetReapplyExcludeType"
6816
7446
  },
6817
7447
  "title": "Event types not to be reapplied"
7448
+ },
7449
+ "postResetOperations": {
7450
+ "type": "array",
7451
+ "items": {
7452
+ "type": "object",
7453
+ "$ref": "#/definitions/v1PostResetOperation"
7454
+ },
7455
+ "title": "Operations to perform after the workflow has been reset. These operations will be applied\nto the *new* run of the workflow execution in the order they are provided.\nAll operations are applied to the workflow before the first new workflow task is generated"
6818
7456
  }
6819
7457
  }
6820
7458
  },
@@ -6836,7 +7474,7 @@
6836
7474
  },
6837
7475
  "workerVersion": {
6838
7476
  "$ref": "#/definitions/v1WorkerVersionStamp",
6839
- "description": "Version info of the worker who processed this task. This message's `build_id` field should\nalways be set by SDKs. Workers opting into versioning will also set the `use_versioning`\nfield to true. See message docstrings for more.\nDeprecated. Use `deployment` instead."
7477
+ "description": "Version info of the worker who processed this task. This message's `build_id` field should\nalways be set by SDKs. Workers opting into versioning will also set the `use_versioning`\nfield to true. See message docstrings for more.\nDeprecated. Use `deployment_options` instead."
6840
7478
  },
6841
7479
  "deployment": {
6842
7480
  "$ref": "#/definitions/v1Deployment",
@@ -6870,6 +7508,10 @@
6870
7508
  "identity": {
6871
7509
  "type": "string",
6872
7510
  "title": "The identity of the worker/client"
7511
+ },
7512
+ "deploymentOptions": {
7513
+ "$ref": "#/definitions/v1WorkerDeploymentOptions",
7514
+ "description": "Worker deployment options that user has set in the worker."
6873
7515
  }
6874
7516
  }
6875
7517
  },
@@ -6891,7 +7533,7 @@
6891
7533
  },
6892
7534
  "workerVersion": {
6893
7535
  "$ref": "#/definitions/v1WorkerVersionStamp",
6894
- "description": "Version info of the worker who processed this task. This message's `build_id` field should\nalways be set by SDKs. Workers opting into versioning will also set the `use_versioning`\nfield to true. See message docstrings for more.\nDeprecated. Use `deployment` instead."
7536
+ "description": "Version info of the worker who processed this task. This message's `build_id` field should\nalways be set by SDKs. Workers opting into versioning will also set the `use_versioning`\nfield to true. See message docstrings for more.\nDeprecated. Use `deployment_options` instead."
6895
7537
  },
6896
7538
  "deployment": {
6897
7539
  "$ref": "#/definitions/v1Deployment",
@@ -6950,7 +7592,7 @@
6950
7592
  },
6951
7593
  "workerVersion": {
6952
7594
  "$ref": "#/definitions/v1WorkerVersionStamp",
6953
- "description": "Version info of the worker who processed this task. This message's `build_id` field should\nalways be set by SDKs. Workers opting into versioning will also set the `use_versioning`\nfield to true. See message docstrings for more.\nDeprecated. Use `deployment` instead."
7595
+ "description": "Version info of the worker who processed this task. This message's `build_id` field should\nalways be set by SDKs. Workers opting into versioning will also set the `use_versioning`\nfield to true. See message docstrings for more.\nDeprecated. Use `deployment_options` instead."
6954
7596
  },
6955
7597
  "deployment": {
6956
7598
  "$ref": "#/definitions/v1Deployment",
@@ -7020,7 +7662,11 @@
7020
7662
  "properties": {
7021
7663
  "version": {
7022
7664
  "type": "string",
7023
- "title": "Required. Can be one of the following:\n- A Deployment Version identifier in the form \"<deployment_name>.<build_id>\".\n- Or, the \"__unversioned__\" special value, to represent all the unversioned workers (those\n with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)"
7665
+ "description": "Deprecated. Use `build_id`."
7666
+ },
7667
+ "buildId": {
7668
+ "type": "string",
7669
+ "title": "The build id of the Version that you want to set as Current.\nPass an empty value to set the Current Version to nil.\nA nil Current Version represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)"
7024
7670
  },
7025
7671
  "conflictToken": {
7026
7672
  "type": "string",
@@ -7043,7 +7689,11 @@
7043
7689
  "properties": {
7044
7690
  "version": {
7045
7691
  "type": "string",
7046
- "title": "Can be one of the following:\n- Absent/empty value to unset the Ramping Version. Must be paired with `percentage=0`.\n- A Deployment Version identifier in the form \"<deployment_name>.<build_id>\".\n- Or, the \"__unversioned__\" special value, to represent all the unversioned workers (those\n with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)"
7692
+ "description": "Deprecated. Use `build_id`."
7693
+ },
7694
+ "buildId": {
7695
+ "type": "string",
7696
+ "title": "The build id of the Version that you want to ramp traffic to.\nPass an empty value to set the Ramping Version to nil.\nA nil Ramping Version represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)"
7047
7697
  },
7048
7698
  "percentage": {
7049
7699
  "type": "number",
@@ -7199,7 +7849,8 @@
7199
7849
  },
7200
7850
  "description": "Links to be associated with the WorkflowExecutionSignaled event."
7201
7851
  }
7202
- }
7852
+ },
7853
+ "description": "Keep the parameters in sync with:\n - temporal.api.batch.v1.BatchOperationSignal.\n - temporal.api.workflow.v1.PostResetOperation.SignalWorkflow."
7203
7854
  },
7204
7855
  "WorkflowServiceStartBatchOperationBody": {
7205
7856
  "type": "object",
@@ -7405,6 +8056,31 @@
7405
8056
  }
7406
8057
  }
7407
8058
  },
8059
+ "WorkflowServiceTriggerWorkflowRuleBody": {
8060
+ "type": "object",
8061
+ "properties": {
8062
+ "execution": {
8063
+ "type": "object",
8064
+ "properties": {
8065
+ "runId": {
8066
+ "type": "string"
8067
+ }
8068
+ },
8069
+ "title": "Execution info of the workflow which scheduled this activity"
8070
+ },
8071
+ "id": {
8072
+ "type": "string"
8073
+ },
8074
+ "spec": {
8075
+ "$ref": "#/definitions/v1WorkflowRuleSpec",
8076
+ "description": "Note: Rule ID and expiration date are not used in the trigger request."
8077
+ },
8078
+ "identity": {
8079
+ "type": "string",
8080
+ "title": "The identity of the client who initiated this request"
8081
+ }
8082
+ }
8083
+ },
7408
8084
  "WorkflowServiceUnpauseActivityBody": {
7409
8085
  "type": "object",
7410
8086
  "properties": {
@@ -7524,6 +8200,15 @@
7524
8200
  "WorkflowServiceUpdateWorkerDeploymentVersionMetadataBody": {
7525
8201
  "type": "object",
7526
8202
  "properties": {
8203
+ "version": {
8204
+ "type": "string",
8205
+ "description": "Deprecated. Use `deployment_version`."
8206
+ },
8207
+ "deploymentVersion": {
8208
+ "type": "object",
8209
+ "description": "Required.",
8210
+ "title": "Required."
8211
+ },
7527
8212
  "upsertEntries": {
7528
8213
  "type": "object",
7529
8214
  "additionalProperties": {
@@ -7607,7 +8292,8 @@
7607
8292
  "type": "string",
7608
8293
  "description": "Controls which fields from `workflow_execution_options` will be applied.\nTo unset a field, set it to null and use the update mask to indicate that it should be mutated."
7609
8294
  }
7610
- }
8295
+ },
8296
+ "description": "Keep the parameters in sync with:\n - temporal.api.batch.v1.BatchOperationUpdateWorkflowExecutionOptions.\n - temporal.api.workflow.v1.PostResetOperation.UpdateWorkflowOptions."
7611
8297
  },
7612
8298
  "apicommonv1Link": {
7613
8299
  "type": "object",
@@ -7892,7 +8578,7 @@
7892
8578
  },
7893
8579
  "workerVersion": {
7894
8580
  "$ref": "#/definitions/v1WorkerVersionStamp",
7895
- "title": "Version info of the worker who processed this workflow task.\nDeprecated. Use the info inside the corresponding ActivityTaskStartedEvent"
8581
+ "title": "Version info of the worker who processed this workflow task.\nDeprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]"
7896
8582
  }
7897
8583
  }
7898
8584
  },
@@ -7919,7 +8605,7 @@
7919
8605
  },
7920
8606
  "workerVersion": {
7921
8607
  "$ref": "#/definitions/v1WorkerVersionStamp",
7922
- "title": "Version info of the worker who processed this workflow task.\nDeprecated. Use the info inside the corresponding ActivityTaskStartedEvent"
8608
+ "title": "Version info of the worker who processed this workflow task.\nDeprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]"
7923
8609
  }
7924
8610
  }
7925
8611
  },
@@ -7949,7 +8635,7 @@
7949
8635
  },
7950
8636
  "workerVersion": {
7951
8637
  "$ref": "#/definitions/v1WorkerVersionStamp",
7952
- "title": "Version info of the worker who processed this workflow task.\nDeprecated. Use the info inside the corresponding ActivityTaskStartedEvent"
8638
+ "title": "Version info of the worker who processed this workflow task.\nDeprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]"
7953
8639
  }
7954
8640
  }
7955
8641
  },
@@ -7999,7 +8685,7 @@
7999
8685
  },
8000
8686
  "useWorkflowBuildId": {
8001
8687
  "type": "boolean",
8002
- "description": "If this is set, the activity would be assigned to the Build ID of the workflow. Otherwise,\nAssignment rules of the activity's Task Queue will be used to determine the Build ID."
8688
+ "title": "If this is set, the activity would be assigned to the Build ID of the workflow. Otherwise,\nAssignment rules of the activity's Task Queue will be used to determine the Build ID.\nDeprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]"
8003
8689
  },
8004
8690
  "priority": {
8005
8691
  "$ref": "#/definitions/v1Priority",
@@ -8092,6 +8778,15 @@
8092
8778
  },
8093
8779
  "description": "Alert contains notification and severity."
8094
8780
  },
8781
+ "v1ApplicationErrorCategory": {
8782
+ "type": "string",
8783
+ "enum": [
8784
+ "APPLICATION_ERROR_CATEGORY_UNSPECIFIED",
8785
+ "APPLICATION_ERROR_CATEGORY_BENIGN"
8786
+ ],
8787
+ "default": "APPLICATION_ERROR_CATEGORY_UNSPECIFIED",
8788
+ "description": " - APPLICATION_ERROR_CATEGORY_BENIGN: Expected application error with little/no severity."
8789
+ },
8095
8790
  "v1ApplicationFailureInfo": {
8096
8791
  "type": "object",
8097
8792
  "properties": {
@@ -8107,6 +8802,9 @@
8107
8802
  "nextRetryDelay": {
8108
8803
  "type": "string",
8109
8804
  "description": "next_retry_delay can be used by the client to override the activity\nretry interval calculated by the retry policy. Retry attempts will\nstill be subject to the maximum retries limit and total time limit\ndefined by the policy."
8805
+ },
8806
+ "category": {
8807
+ "$ref": "#/definitions/v1ApplicationErrorCategory"
8110
8808
  }
8111
8809
  }
8112
8810
  },
@@ -8224,6 +8922,14 @@
8224
8922
  "resetReapplyType": {
8225
8923
  "$ref": "#/definitions/v1ResetReapplyType",
8226
8924
  "description": "History event reapply options (deprecated, use `options`)."
8925
+ },
8926
+ "postResetOperations": {
8927
+ "type": "array",
8928
+ "items": {
8929
+ "type": "object",
8930
+ "$ref": "#/definitions/v1PostResetOperation"
8931
+ },
8932
+ "title": "Operations to perform after the workflow has been reset. These operations will be applied\nto the *new* run of the workflow execution in the order they are provided.\nAll operations are applied to the workflow before the first new workflow task is generated"
8227
8933
  }
8228
8934
  },
8229
8935
  "description": "BatchOperationReset sends reset requests to batch workflows.\nKeep the parameter in sync with temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest."
@@ -8324,7 +9030,7 @@
8324
9030
  },
8325
9031
  "workflowExecutionOptions": {
8326
9032
  "$ref": "#/definitions/v1WorkflowExecutionOptions",
8327
- "description": "Workflow Execution options. Partial updates are accepted and controlled by update_mask."
9033
+ "description": "Update Workflow options that were originally specified via StartWorkflowExecution. Partial updates are accepted and controlled by update_mask."
8328
9034
  },
8329
9035
  "updateMask": {
8330
9036
  "type": "string",
@@ -8421,6 +9127,14 @@
8421
9127
  },
8422
9128
  "internal": {
8423
9129
  "$ref": "#/definitions/CallbackInternal"
9130
+ },
9131
+ "links": {
9132
+ "type": "array",
9133
+ "items": {
9134
+ "type": "object",
9135
+ "$ref": "#/definitions/apicommonv1Link"
9136
+ },
9137
+ "description": "Links associated with the callback. It can be used to link to underlying resources of the\ncallback."
8424
9138
  }
8425
9139
  },
8426
9140
  "description": "Callback to attach to various events in the system, e.g. workflow run completion."
@@ -9030,6 +9744,19 @@
9030
9744
  }
9031
9745
  }
9032
9746
  },
9747
+ "v1CreateWorkflowRuleResponse": {
9748
+ "type": "object",
9749
+ "properties": {
9750
+ "rule": {
9751
+ "$ref": "#/definitions/v1WorkflowRule",
9752
+ "description": "Created rule."
9753
+ },
9754
+ "jobId": {
9755
+ "type": "string",
9756
+ "description": "Batch Job ID if force-scan flag was provided. Otherwise empty."
9757
+ }
9758
+ }
9759
+ },
9033
9760
  "v1DataBlob": {
9034
9761
  "type": "object",
9035
9762
  "properties": {
@@ -9066,6 +9793,9 @@
9066
9793
  "v1DeleteWorkflowExecutionResponse": {
9067
9794
  "type": "object"
9068
9795
  },
9796
+ "v1DeleteWorkflowRuleResponse": {
9797
+ "type": "object"
9798
+ },
9069
9799
  "v1Deployment": {
9070
9800
  "type": "object",
9071
9801
  "properties": {
@@ -9154,7 +9884,11 @@
9154
9884
  "properties": {
9155
9885
  "version": {
9156
9886
  "type": "string",
9157
- "description": "Required. The target Version of the transition. May be `__unversioned__` which means a\nso-far-versioned workflow is transitioning to unversioned workers."
9887
+ "description": "Deprecated. Use `deployment_version`."
9888
+ },
9889
+ "deploymentVersion": {
9890
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
9891
+ "description": "The target Version of the transition.\nIf nil, a so-far-versioned workflow is transitioning to unversioned workers."
9158
9892
  }
9159
9893
  },
9160
9894
  "description": "Holds information about ongoing transition of a workflow execution from one worker\ndeployment version to another.\nExperimental. Might change in the future."
@@ -9379,6 +10113,15 @@
9379
10113
  }
9380
10114
  }
9381
10115
  },
10116
+ "v1DescribeWorkflowRuleResponse": {
10117
+ "type": "object",
10118
+ "properties": {
10119
+ "rule": {
10120
+ "$ref": "#/definitions/v1WorkflowRule",
10121
+ "description": "The rule that was read."
10122
+ }
10123
+ }
10124
+ },
9382
10125
  "v1EncodingType": {
9383
10126
  "type": "string",
9384
10127
  "enum": [
@@ -9509,10 +10252,12 @@
9509
10252
  "EVENT_TYPE_NEXUS_OPERATION_CANCELED",
9510
10253
  "EVENT_TYPE_NEXUS_OPERATION_TIMED_OUT",
9511
10254
  "EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUESTED",
9512
- "EVENT_TYPE_WORKFLOW_EXECUTION_OPTIONS_UPDATED"
10255
+ "EVENT_TYPE_WORKFLOW_EXECUTION_OPTIONS_UPDATED",
10256
+ "EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUEST_COMPLETED",
10257
+ "EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUEST_FAILED"
9513
10258
  ],
9514
10259
  "default": "EVENT_TYPE_UNSPECIFIED",
9515
- "description": "- EVENT_TYPE_UNSPECIFIED: Place holder and should never appear in a Workflow execution history\n - EVENT_TYPE_WORKFLOW_EXECUTION_STARTED: Workflow execution has been triggered/started\nIt contains Workflow execution inputs, as well as Workflow timeout configurations\n - EVENT_TYPE_WORKFLOW_EXECUTION_COMPLETED: Workflow execution has successfully completed and contains Workflow execution results\n - EVENT_TYPE_WORKFLOW_EXECUTION_FAILED: Workflow execution has unsuccessfully completed and contains the Workflow execution error\n - EVENT_TYPE_WORKFLOW_EXECUTION_TIMED_OUT: Workflow execution has timed out by the Temporal Server\nUsually due to the Workflow having not been completed within timeout settings\n - EVENT_TYPE_WORKFLOW_TASK_SCHEDULED: Workflow Task has been scheduled and the SDK client should now be able to process any new history events\n - EVENT_TYPE_WORKFLOW_TASK_STARTED: Workflow Task has started and the SDK client has picked up the Workflow Task and is processing new history events\n - EVENT_TYPE_WORKFLOW_TASK_COMPLETED: Workflow Task has completed\nThe SDK client picked up the Workflow Task and processed new history events\nSDK client may or may not ask the Temporal Server to do additional work, such as:\nEVENT_TYPE_ACTIVITY_TASK_SCHEDULED\nEVENT_TYPE_TIMER_STARTED\nEVENT_TYPE_UPSERT_WORKFLOW_SEARCH_ATTRIBUTES\nEVENT_TYPE_MARKER_RECORDED\nEVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_INITIATED\nEVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED\nEVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED\nEVENT_TYPE_WORKFLOW_EXECUTION_COMPLETED\nEVENT_TYPE_WORKFLOW_EXECUTION_FAILED\nEVENT_TYPE_WORKFLOW_EXECUTION_CANCELED\nEVENT_TYPE_WORKFLOW_EXECUTION_CONTINUED_AS_NEW\n - EVENT_TYPE_WORKFLOW_TASK_TIMED_OUT: Workflow Task encountered a timeout\nEither an SDK client with a local cache was not available at the time, or it took too long for the SDK client to process the task\n - EVENT_TYPE_WORKFLOW_TASK_FAILED: Workflow Task encountered a failure\nUsually this means that the Workflow was non-deterministic\nHowever, the Workflow reset functionality also uses this event\n - EVENT_TYPE_ACTIVITY_TASK_SCHEDULED: Activity Task was scheduled\nThe SDK client should pick up this activity task and execute\nThis event type contains activity inputs, as well as activity timeout configurations\n - EVENT_TYPE_ACTIVITY_TASK_STARTED: Activity Task has started executing\nThe SDK client has picked up the Activity Task and is processing the Activity invocation\n - EVENT_TYPE_ACTIVITY_TASK_COMPLETED: Activity Task has finished successfully\nThe SDK client has picked up and successfully completed the Activity Task\nThis event type contains Activity execution results\n - EVENT_TYPE_ACTIVITY_TASK_FAILED: Activity Task has finished unsuccessfully\nThe SDK picked up the Activity Task but unsuccessfully completed it\nThis event type contains Activity execution errors\n - EVENT_TYPE_ACTIVITY_TASK_TIMED_OUT: Activity has timed out according to the Temporal Server\nActivity did not complete within the timeout settings\n - EVENT_TYPE_ACTIVITY_TASK_CANCEL_REQUESTED: A request to cancel the Activity has occurred\nThe SDK client will be able to confirm cancellation of an Activity during an Activity heartbeat\n - EVENT_TYPE_ACTIVITY_TASK_CANCELED: Activity has been cancelled\n - EVENT_TYPE_TIMER_STARTED: A timer has started\n - EVENT_TYPE_TIMER_FIRED: A timer has fired\n - EVENT_TYPE_TIMER_CANCELED: A time has been cancelled\n - EVENT_TYPE_WORKFLOW_EXECUTION_CANCEL_REQUESTED: A request has been made to cancel the Workflow execution\n - EVENT_TYPE_WORKFLOW_EXECUTION_CANCELED: SDK client has confirmed the cancellation request and the Workflow execution has been cancelled\n - EVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED: Workflow has requested that the Temporal Server try to cancel another Workflow\n - EVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_FAILED: Temporal Server could not cancel the targeted Workflow\nThis is usually because the target Workflow could not be found\n - EVENT_TYPE_EXTERNAL_WORKFLOW_EXECUTION_CANCEL_REQUESTED: Temporal Server has successfully requested the cancellation of the target Workflow\n - EVENT_TYPE_MARKER_RECORDED: A marker has been recorded.\nThis event type is transparent to the Temporal Server\nThe Server will only store it and will not try to understand it.\n - EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED: Workflow has received a Signal event\nThe event type contains the Signal name, as well as a Signal payload\n - EVENT_TYPE_WORKFLOW_EXECUTION_TERMINATED: Workflow execution has been forcefully terminated\nThis is usually because the terminate Workflow API was called\n - EVENT_TYPE_WORKFLOW_EXECUTION_CONTINUED_AS_NEW: Workflow has successfully completed and a new Workflow has been started within the same transaction\nContains last Workflow execution results as well as new Workflow execution inputs\n - EVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_INITIATED: Temporal Server will try to start a child Workflow\n - EVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_FAILED: Child Workflow execution cannot be started/triggered\nUsually due to a child Workflow ID collision\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_STARTED: Child Workflow execution has successfully started/triggered\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_COMPLETED: Child Workflow execution has successfully completed\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_FAILED: Child Workflow execution has unsuccessfully completed\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_CANCELED: Child Workflow execution has been cancelled\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_TIMED_OUT: Child Workflow execution has timed out by the Temporal Server\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_TERMINATED: Child Workflow execution has been terminated\n - EVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED: Temporal Server will try to Signal the targeted Workflow\nContains the Signal name, as well as a Signal payload\n - EVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_FAILED: Temporal Server cannot Signal the targeted Workflow\nUsually because the Workflow could not be found\n - EVENT_TYPE_EXTERNAL_WORKFLOW_EXECUTION_SIGNALED: Temporal Server has successfully Signaled the targeted Workflow\n - EVENT_TYPE_UPSERT_WORKFLOW_SEARCH_ATTRIBUTES: Workflow search attributes should be updated and synchronized with the visibility store\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ADMITTED: An update was admitted. Note that not all admitted updates result in this\nevent. See UpdateAdmittedEventOrigin for situations in which this event\nis created.\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ACCEPTED: An update was accepted (i.e. passed validation, perhaps because no validator was defined)\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_REJECTED: This event is never written to history.\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_COMPLETED: An update completed\n - EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED_EXTERNALLY: Some property or properties of the workflow as a whole have changed by non-workflow code.\nThe distinction of external vs. command-based modification is important so the SDK can\nmaintain determinism when using the command-based approach.\n - EVENT_TYPE_ACTIVITY_PROPERTIES_MODIFIED_EXTERNALLY: Some property or properties of an already-scheduled activity have changed by non-workflow code.\nThe distinction of external vs. command-based modification is important so the SDK can\nmaintain determinism when using the command-based approach.\n - EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED: Workflow properties modified by user workflow code\n - EVENT_TYPE_NEXUS_OPERATION_SCHEDULED: A Nexus operation was scheduled using a ScheduleNexusOperation command.\n - EVENT_TYPE_NEXUS_OPERATION_STARTED: An asynchronous Nexus operation was started by a Nexus handler.\n - EVENT_TYPE_NEXUS_OPERATION_COMPLETED: A Nexus operation completed successfully.\n - EVENT_TYPE_NEXUS_OPERATION_FAILED: A Nexus operation failed.\n - EVENT_TYPE_NEXUS_OPERATION_CANCELED: A Nexus operation completed as canceled.\n - EVENT_TYPE_NEXUS_OPERATION_TIMED_OUT: A Nexus operation timed out.\n - EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUESTED: A Nexus operation was requested to be canceled using a RequestCancelNexusOperation command.\n - EVENT_TYPE_WORKFLOW_EXECUTION_OPTIONS_UPDATED: Workflow execution options updated by user.",
10260
+ "description": "- EVENT_TYPE_UNSPECIFIED: Place holder and should never appear in a Workflow execution history\n - EVENT_TYPE_WORKFLOW_EXECUTION_STARTED: Workflow execution has been triggered/started\nIt contains Workflow execution inputs, as well as Workflow timeout configurations\n - EVENT_TYPE_WORKFLOW_EXECUTION_COMPLETED: Workflow execution has successfully completed and contains Workflow execution results\n - EVENT_TYPE_WORKFLOW_EXECUTION_FAILED: Workflow execution has unsuccessfully completed and contains the Workflow execution error\n - EVENT_TYPE_WORKFLOW_EXECUTION_TIMED_OUT: Workflow execution has timed out by the Temporal Server\nUsually due to the Workflow having not been completed within timeout settings\n - EVENT_TYPE_WORKFLOW_TASK_SCHEDULED: Workflow Task has been scheduled and the SDK client should now be able to process any new history events\n - EVENT_TYPE_WORKFLOW_TASK_STARTED: Workflow Task has started and the SDK client has picked up the Workflow Task and is processing new history events\n - EVENT_TYPE_WORKFLOW_TASK_COMPLETED: Workflow Task has completed\nThe SDK client picked up the Workflow Task and processed new history events\nSDK client may or may not ask the Temporal Server to do additional work, such as:\nEVENT_TYPE_ACTIVITY_TASK_SCHEDULED\nEVENT_TYPE_TIMER_STARTED\nEVENT_TYPE_UPSERT_WORKFLOW_SEARCH_ATTRIBUTES\nEVENT_TYPE_MARKER_RECORDED\nEVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_INITIATED\nEVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED\nEVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED\nEVENT_TYPE_WORKFLOW_EXECUTION_COMPLETED\nEVENT_TYPE_WORKFLOW_EXECUTION_FAILED\nEVENT_TYPE_WORKFLOW_EXECUTION_CANCELED\nEVENT_TYPE_WORKFLOW_EXECUTION_CONTINUED_AS_NEW\n - EVENT_TYPE_WORKFLOW_TASK_TIMED_OUT: Workflow Task encountered a timeout\nEither an SDK client with a local cache was not available at the time, or it took too long for the SDK client to process the task\n - EVENT_TYPE_WORKFLOW_TASK_FAILED: Workflow Task encountered a failure\nUsually this means that the Workflow was non-deterministic\nHowever, the Workflow reset functionality also uses this event\n - EVENT_TYPE_ACTIVITY_TASK_SCHEDULED: Activity Task was scheduled\nThe SDK client should pick up this activity task and execute\nThis event type contains activity inputs, as well as activity timeout configurations\n - EVENT_TYPE_ACTIVITY_TASK_STARTED: Activity Task has started executing\nThe SDK client has picked up the Activity Task and is processing the Activity invocation\n - EVENT_TYPE_ACTIVITY_TASK_COMPLETED: Activity Task has finished successfully\nThe SDK client has picked up and successfully completed the Activity Task\nThis event type contains Activity execution results\n - EVENT_TYPE_ACTIVITY_TASK_FAILED: Activity Task has finished unsuccessfully\nThe SDK picked up the Activity Task but unsuccessfully completed it\nThis event type contains Activity execution errors\n - EVENT_TYPE_ACTIVITY_TASK_TIMED_OUT: Activity has timed out according to the Temporal Server\nActivity did not complete within the timeout settings\n - EVENT_TYPE_ACTIVITY_TASK_CANCEL_REQUESTED: A request to cancel the Activity has occurred\nThe SDK client will be able to confirm cancellation of an Activity during an Activity heartbeat\n - EVENT_TYPE_ACTIVITY_TASK_CANCELED: Activity has been cancelled\n - EVENT_TYPE_TIMER_STARTED: A timer has started\n - EVENT_TYPE_TIMER_FIRED: A timer has fired\n - EVENT_TYPE_TIMER_CANCELED: A time has been cancelled\n - EVENT_TYPE_WORKFLOW_EXECUTION_CANCEL_REQUESTED: A request has been made to cancel the Workflow execution\n - EVENT_TYPE_WORKFLOW_EXECUTION_CANCELED: SDK client has confirmed the cancellation request and the Workflow execution has been cancelled\n - EVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED: Workflow has requested that the Temporal Server try to cancel another Workflow\n - EVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_FAILED: Temporal Server could not cancel the targeted Workflow\nThis is usually because the target Workflow could not be found\n - EVENT_TYPE_EXTERNAL_WORKFLOW_EXECUTION_CANCEL_REQUESTED: Temporal Server has successfully requested the cancellation of the target Workflow\n - EVENT_TYPE_MARKER_RECORDED: A marker has been recorded.\nThis event type is transparent to the Temporal Server\nThe Server will only store it and will not try to understand it.\n - EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED: Workflow has received a Signal event\nThe event type contains the Signal name, as well as a Signal payload\n - EVENT_TYPE_WORKFLOW_EXECUTION_TERMINATED: Workflow execution has been forcefully terminated\nThis is usually because the terminate Workflow API was called\n - EVENT_TYPE_WORKFLOW_EXECUTION_CONTINUED_AS_NEW: Workflow has successfully completed and a new Workflow has been started within the same transaction\nContains last Workflow execution results as well as new Workflow execution inputs\n - EVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_INITIATED: Temporal Server will try to start a child Workflow\n - EVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_FAILED: Child Workflow execution cannot be started/triggered\nUsually due to a child Workflow ID collision\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_STARTED: Child Workflow execution has successfully started/triggered\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_COMPLETED: Child Workflow execution has successfully completed\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_FAILED: Child Workflow execution has unsuccessfully completed\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_CANCELED: Child Workflow execution has been cancelled\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_TIMED_OUT: Child Workflow execution has timed out by the Temporal Server\n - EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_TERMINATED: Child Workflow execution has been terminated\n - EVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED: Temporal Server will try to Signal the targeted Workflow\nContains the Signal name, as well as a Signal payload\n - EVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_FAILED: Temporal Server cannot Signal the targeted Workflow\nUsually because the Workflow could not be found\n - EVENT_TYPE_EXTERNAL_WORKFLOW_EXECUTION_SIGNALED: Temporal Server has successfully Signaled the targeted Workflow\n - EVENT_TYPE_UPSERT_WORKFLOW_SEARCH_ATTRIBUTES: Workflow search attributes should be updated and synchronized with the visibility store\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ADMITTED: An update was admitted. Note that not all admitted updates result in this\nevent. See UpdateAdmittedEventOrigin for situations in which this event\nis created.\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ACCEPTED: An update was accepted (i.e. passed validation, perhaps because no validator was defined)\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_REJECTED: This event is never written to history.\n - EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_COMPLETED: An update completed\n - EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED_EXTERNALLY: Some property or properties of the workflow as a whole have changed by non-workflow code.\nThe distinction of external vs. command-based modification is important so the SDK can\nmaintain determinism when using the command-based approach.\n - EVENT_TYPE_ACTIVITY_PROPERTIES_MODIFIED_EXTERNALLY: Some property or properties of an already-scheduled activity have changed by non-workflow code.\nThe distinction of external vs. command-based modification is important so the SDK can\nmaintain determinism when using the command-based approach.\n - EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED: Workflow properties modified by user workflow code\n - EVENT_TYPE_NEXUS_OPERATION_SCHEDULED: A Nexus operation was scheduled using a ScheduleNexusOperation command.\n - EVENT_TYPE_NEXUS_OPERATION_STARTED: An asynchronous Nexus operation was started by a Nexus handler.\n - EVENT_TYPE_NEXUS_OPERATION_COMPLETED: A Nexus operation completed successfully.\n - EVENT_TYPE_NEXUS_OPERATION_FAILED: A Nexus operation failed.\n - EVENT_TYPE_NEXUS_OPERATION_CANCELED: A Nexus operation completed as canceled.\n - EVENT_TYPE_NEXUS_OPERATION_TIMED_OUT: A Nexus operation timed out.\n - EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUESTED: A Nexus operation was requested to be canceled using a RequestCancelNexusOperation command.\n - EVENT_TYPE_WORKFLOW_EXECUTION_OPTIONS_UPDATED: Workflow execution options updated by user.\n - EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUEST_COMPLETED: A cancellation request for a Nexus operation was successfully delivered to the Nexus handler.\n - EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUEST_FAILED: A cancellation request for a Nexus operation resulted in an error.",
9516
10261
  "title": "Whenever this list of events is changed do change the function shouldBufferEvent in mutableStateBuilder.go to make sure to do the correct event ordering"
9517
10262
  },
9518
10263
  "v1ExecuteMultiOperationResponse": {
@@ -9525,7 +10270,8 @@
9525
10270
  "$ref": "#/definitions/v1ExecuteMultiOperationResponseResponse"
9526
10271
  }
9527
10272
  }
9528
- }
10273
+ },
10274
+ "description": "IMPORTANT: For [StartWorkflow, UpdateWorkflow] combination (\"Update-with-Start\") when both\n 1. the workflow update for the requested update ID has already completed, and\n 2. the workflow for the requested workflow ID has already been closed,\nthen you'll receive\n - an update response containing the update's outcome, and\n - a start response with a `status` field that reflects the workflow's current state."
9529
10275
  },
9530
10276
  "v1ExecuteMultiOperationResponseResponse": {
9531
10277
  "type": "object",
@@ -10083,6 +10829,12 @@
10083
10829
  },
10084
10830
  "workflowExecutionOptionsUpdatedEventAttributes": {
10085
10831
  "$ref": "#/definitions/v1WorkflowExecutionOptionsUpdatedEventAttributes"
10832
+ },
10833
+ "nexusOperationCancelRequestCompletedEventAttributes": {
10834
+ "$ref": "#/definitions/v1NexusOperationCancelRequestCompletedEventAttributes"
10835
+ },
10836
+ "nexusOperationCancelRequestFailedEventAttributes": {
10837
+ "$ref": "#/definitions/v1NexusOperationCancelRequestFailedEventAttributes"
10086
10838
  }
10087
10839
  },
10088
10840
  "description": "History events are the method by which Temporal SDKs advance (or recreate) workflow state.\nSee the `EventType` enum for more info about what each event is for."
@@ -10377,6 +11129,22 @@
10377
11129
  }
10378
11130
  }
10379
11131
  },
11132
+ "v1ListWorkflowRulesResponse": {
11133
+ "type": "object",
11134
+ "properties": {
11135
+ "rules": {
11136
+ "type": "array",
11137
+ "items": {
11138
+ "type": "object",
11139
+ "$ref": "#/definitions/v1WorkflowRule"
11140
+ }
11141
+ },
11142
+ "nextPageToken": {
11143
+ "type": "string",
11144
+ "format": "byte"
11145
+ }
11146
+ }
11147
+ },
10380
11148
  "v1MarkerRecordedEventAttributes": {
10381
11149
  "type": "object",
10382
11150
  "properties": {
@@ -10685,6 +11453,50 @@
10685
11453
  }
10686
11454
  }
10687
11455
  },
11456
+ "v1NexusOperationCancelRequestCompletedEventAttributes": {
11457
+ "type": "object",
11458
+ "properties": {
11459
+ "requestedEventId": {
11460
+ "type": "string",
11461
+ "format": "int64",
11462
+ "description": "The ID of the `NEXUS_OPERATION_CANCEL_REQUESTED` event."
11463
+ },
11464
+ "workflowTaskCompletedEventId": {
11465
+ "type": "string",
11466
+ "format": "int64",
11467
+ "description": "The `WORKFLOW_TASK_COMPLETED` event that the corresponding RequestCancelNexusOperation command was reported\nwith."
11468
+ },
11469
+ "scheduledEventId": {
11470
+ "type": "string",
11471
+ "format": "int64",
11472
+ "description": "The id of the `NEXUS_OPERATION_SCHEDULED` event this cancel request corresponds to."
11473
+ }
11474
+ }
11475
+ },
11476
+ "v1NexusOperationCancelRequestFailedEventAttributes": {
11477
+ "type": "object",
11478
+ "properties": {
11479
+ "requestedEventId": {
11480
+ "type": "string",
11481
+ "format": "int64",
11482
+ "description": "The ID of the `NEXUS_OPERATION_CANCEL_REQUESTED` event."
11483
+ },
11484
+ "workflowTaskCompletedEventId": {
11485
+ "type": "string",
11486
+ "format": "int64",
11487
+ "description": "The `WORKFLOW_TASK_COMPLETED` event that the corresponding RequestCancelNexusOperation command was reported\nwith."
11488
+ },
11489
+ "failure": {
11490
+ "$ref": "#/definitions/apifailurev1Failure",
11491
+ "description": "Failure details. A NexusOperationFailureInfo wrapping a CanceledFailureInfo."
11492
+ },
11493
+ "scheduledEventId": {
11494
+ "type": "string",
11495
+ "format": "int64",
11496
+ "description": "The id of the `NEXUS_OPERATION_SCHEDULED` event this cancel request corresponds to."
11497
+ }
11498
+ }
11499
+ },
10688
11500
  "v1NexusOperationCancelRequestedEventAttributes": {
10689
11501
  "type": "object",
10690
11502
  "properties": {
@@ -11068,15 +11880,26 @@
11068
11880
  },
11069
11881
  "lastDeployment": {
11070
11882
  "$ref": "#/definitions/v1Deployment",
11071
- "description": "The deployment this activity was dispatched to most recently. Present only if the activity\nwas dispatched to a versioned worker.\nDeprecated. Use `last_worker_deployment_version`."
11883
+ "description": "The deployment this activity was dispatched to most recently. Present only if the activity\nwas dispatched to a versioned worker.\nDeprecated. Use `last_deployment_version`."
11072
11884
  },
11073
11885
  "lastWorkerDeploymentVersion": {
11074
11886
  "type": "string",
11075
- "description": "The Worker Deployment Version this activity was dispatched to most recently."
11887
+ "description": "The Worker Deployment Version this activity was dispatched to most recently.\nDeprecated. Use `last_deployment_version`."
11888
+ },
11889
+ "lastDeploymentVersion": {
11890
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
11891
+ "description": "The Worker Deployment Version this activity was dispatched to most recently.\nIf nil, the activity has not yet been dispatched or was last dispatched to an unversioned worker."
11076
11892
  },
11077
11893
  "priority": {
11078
11894
  "$ref": "#/definitions/v1Priority",
11079
11895
  "title": "Priority metadata"
11896
+ },
11897
+ "pauseInfo": {
11898
+ "$ref": "#/definitions/PendingActivityInfoPauseInfo"
11899
+ },
11900
+ "activityOptions": {
11901
+ "$ref": "#/definitions/v1ActivityOptions",
11902
+ "description": "Current activity options. May be different from the one used to start the activity."
11080
11903
  }
11081
11904
  }
11082
11905
  },
@@ -11086,9 +11909,12 @@
11086
11909
  "PENDING_ACTIVITY_STATE_UNSPECIFIED",
11087
11910
  "PENDING_ACTIVITY_STATE_SCHEDULED",
11088
11911
  "PENDING_ACTIVITY_STATE_STARTED",
11089
- "PENDING_ACTIVITY_STATE_CANCEL_REQUESTED"
11912
+ "PENDING_ACTIVITY_STATE_CANCEL_REQUESTED",
11913
+ "PENDING_ACTIVITY_STATE_PAUSED",
11914
+ "PENDING_ACTIVITY_STATE_PAUSE_REQUESTED"
11090
11915
  ],
11091
- "default": "PENDING_ACTIVITY_STATE_UNSPECIFIED"
11916
+ "default": "PENDING_ACTIVITY_STATE_UNSPECIFIED",
11917
+ "title": "- PENDING_ACTIVITY_STATE_PAUSED: PAUSED means activity is paused on the server, and is not running in the worker\n - PENDING_ACTIVITY_STATE_PAUSE_REQUESTED: PAUSE_REQUESTED means activity is currently running on the worker, but paused on the server"
11092
11918
  },
11093
11919
  "v1PendingChildExecutionInfo": {
11094
11920
  "type": "object",
@@ -11464,6 +12290,18 @@
11464
12290
  },
11465
12291
  "description": "Attached to task responses to give hints to the SDK about how it may adjust its number of\npollers."
11466
12292
  },
12293
+ "v1PostResetOperation": {
12294
+ "type": "object",
12295
+ "properties": {
12296
+ "signalWorkflow": {
12297
+ "$ref": "#/definitions/PostResetOperationSignalWorkflow"
12298
+ },
12299
+ "updateWorkflowOptions": {
12300
+ "$ref": "#/definitions/PostResetOperationUpdateWorkflowOptions"
12301
+ }
12302
+ },
12303
+ "description": "PostResetOperation represents an operation to be performed on the new workflow execution after a workflow reset."
12304
+ },
11467
12305
  "v1Priority": {
11468
12306
  "type": "object",
11469
12307
  "properties": {
@@ -11564,6 +12402,10 @@
11564
12402
  "activityPaused": {
11565
12403
  "type": "boolean",
11566
12404
  "description": "Will be set to true if the activity is paused."
12405
+ },
12406
+ "activityReset": {
12407
+ "type": "boolean",
12408
+ "description": "Will be set to true if the activity was reset.\nApplies only to the current run."
11567
12409
  }
11568
12410
  }
11569
12411
  },
@@ -11577,6 +12419,10 @@
11577
12419
  "activityPaused": {
11578
12420
  "type": "boolean",
11579
12421
  "description": "Will be set to true if the activity is paused."
12422
+ },
12423
+ "activityReset": {
12424
+ "type": "boolean",
12425
+ "description": "Will be set to true if the activity was reset.\nApplies only to the current run."
11580
12426
  }
11581
12427
  }
11582
12428
  },
@@ -11801,6 +12647,25 @@
11801
12647
  "v1RequestCancelWorkflowExecutionResponse": {
11802
12648
  "type": "object"
11803
12649
  },
12650
+ "v1RequestIdInfo": {
12651
+ "type": "object",
12652
+ "properties": {
12653
+ "eventType": {
12654
+ "$ref": "#/definitions/v1EventType",
12655
+ "description": "The event type of the history event generated by the request."
12656
+ },
12657
+ "eventId": {
12658
+ "type": "string",
12659
+ "format": "int64",
12660
+ "description": "The event id of the history event generated by the request. It's possible the event ID is not\nknown (unflushed buffered event). In this case, the value will be zero or a negative value,\nrepresenting an invalid ID."
12661
+ },
12662
+ "buffered": {
12663
+ "type": "boolean",
12664
+ "description": "Indicate if the request is still buffered. If so, the event ID is not known and its value\nwill be an invalid event ID."
12665
+ }
12666
+ },
12667
+ "description": "RequestIdInfo contains details of a request ID."
12668
+ },
11804
12669
  "v1ResetActivityResponse": {
11805
12670
  "type": "object"
11806
12671
  },
@@ -12074,18 +12939,26 @@
12074
12939
  "v1RoutingConfig": {
12075
12940
  "type": "object",
12076
12941
  "properties": {
12942
+ "currentDeploymentVersion": {
12943
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
12944
+ "description": "Specifies which Deployment Version should receive new workflow executions and tasks of\nexisting unversioned or AutoUpgrade workflows.\nNil value means no Version in this Deployment (except Ramping Version, if present) receives traffic other than tasks of previously Pinned workflows. In absence of a Current Version, remaining traffic after any ramp (if set) goes to unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.). \nNote: Current Version is overridden by the Ramping Version for a portion of traffic when ramp percentage\nis non-zero (see `ramping_deployment_version` and `ramping_version_percentage`)."
12945
+ },
12077
12946
  "currentVersion": {
12078
12947
  "type": "string",
12079
- "title": "Always present. Specifies which Deployment Version should should receive new workflow\nexecutions and tasks of existing unversioned or AutoUpgrade workflows.\nCan be one of the following:\n- A Deployment Version identifier in the form \"<deployment_name>.<build_id>\".\n- Or, the \"__unversioned__\" special value, to represent all the unversioned workers (those\n with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)\nNote: Current Version is overridden by the Ramping Version for a portion of traffic when a ramp\nis set (see `ramping_version`.)"
12948
+ "description": "Deprecated. Use `current_deployment_version`."
12949
+ },
12950
+ "rampingDeploymentVersion": {
12951
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
12952
+ "description": "When ramp percentage is non-zero, that portion of traffic is shifted from the Current Version to the Ramping Version.\nMust always be different from `current_deployment_version` unless both are nil.\nNil value represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)\nNote that it is possible to ramp from one Version to another Version, or from unversioned\nworkers to a particular Version, or from a particular Version to unversioned workers."
12080
12953
  },
12081
12954
  "rampingVersion": {
12082
12955
  "type": "string",
12083
- "description": "When present, it means the traffic is being shifted from the Current Version to the Ramping\nVersion.\nMust always be different from Current Version. Can be one of the following:\n- A Deployment Version identifier in the form \"<deployment_name>.<build_id>\".\n- Or, the \"__unversioned__\" special value, to represent all the unversioned workers (those\n with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)\nNote that it is possible to ramp from one Version to another Version, or from unversioned\nworkers to a particular Version, or from a particular Version to unversioned workers."
12956
+ "description": "Deprecated. Use `ramping_deployment_version`."
12084
12957
  },
12085
12958
  "rampingVersionPercentage": {
12086
12959
  "type": "number",
12087
12960
  "format": "float",
12088
- "description": "Percentage of tasks that are routed to the Ramping Version instead of the Current Version.\nValid range: [0, 100]. A 100% value means the Ramping Version is receiving full traffic but\nnot yet \"promoted\" to be the Current Version, likely due to pending validations."
12961
+ "description": "Percentage of tasks that are routed to the Ramping Version instead of the Current Version.\nValid range: [0, 100]. A 100% value means the Ramping Version is receiving full traffic but\nnot yet \"promoted\" to be the Current Version, likely due to pending validations.\nA 0% value means the Ramping Version is receiving no traffic."
12089
12962
  },
12090
12963
  "currentVersionChangedTime": {
12091
12964
  "type": "string",
@@ -12571,7 +13444,11 @@
12571
13444
  },
12572
13445
  "previousVersion": {
12573
13446
  "type": "string",
12574
- "description": "The version that was current before executing this operation, in the form\n\"<deployment_name>.<build_id>\". Can also be the `__unversioned__` special value."
13447
+ "description": "Deprecated. Use `previous_deployment_version`."
13448
+ },
13449
+ "previousDeploymentVersion": {
13450
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
13451
+ "description": "The version that was current before executing this operation."
12575
13452
  }
12576
13453
  }
12577
13454
  },
@@ -12585,7 +13462,11 @@
12585
13462
  },
12586
13463
  "previousVersion": {
12587
13464
  "type": "string",
12588
- "description": "The version that was ramping before executing this operation, in the form\n\"<deployment_name>.<build_id>\". Can also be the `__unversioned__` special value."
13465
+ "description": "Deprecated. Use `previous_deployment_version`."
13466
+ },
13467
+ "previousDeploymentVersion": {
13468
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
13469
+ "description": "The version that was ramping before executing this operation."
12589
13470
  },
12590
13471
  "previousPercentage": {
12591
13472
  "type": "number",
@@ -13133,9 +14014,17 @@
13133
14014
  "type": "boolean",
13134
14015
  "description": "If true, a new workflow was started."
13135
14016
  },
14017
+ "status": {
14018
+ "$ref": "#/definitions/v1WorkflowExecutionStatus",
14019
+ "description": "Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING\nunless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs)."
14020
+ },
13136
14021
  "eagerWorkflowTask": {
13137
14022
  "$ref": "#/definitions/v1PollWorkflowTaskQueueResponse",
13138
14023
  "description": "When `request_eager_execution` is set on the `StartWorkflowExecutionRequest`, the server - if supported - will\nreturn the first workflow task to be eagerly executed.\nThe caller is expected to have a worker available to process the task."
14024
+ },
14025
+ "link": {
14026
+ "$ref": "#/definitions/apicommonv1Link",
14027
+ "description": "Link to the workflow event."
13139
14028
  }
13140
14029
  }
13141
14030
  },
@@ -13423,18 +14312,26 @@
13423
14312
  "v1TaskQueueVersioningInfo": {
13424
14313
  "type": "object",
13425
14314
  "properties": {
14315
+ "currentDeploymentVersion": {
14316
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
14317
+ "description": "Specifies which Deployment Version should receive new workflow executions and tasks of\nexisting unversioned or AutoUpgrade workflows.\nNil value represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)\nNote: Current Version is overridden by the Ramping Version for a portion of traffic when ramp percentage\nis non-zero (see `ramping_deployment_version` and `ramping_version_percentage`)."
14318
+ },
13426
14319
  "currentVersion": {
13427
14320
  "type": "string",
13428
- "title": "Always present. Specifies which Deployment Version should receive new workflow\nexecutions and tasks of existing unversioned or AutoUpgrade workflows.\nCan be one of the following:\n- A Deployment Version identifier in the form \"<deployment_name>.<build_id>\".\n- Or, the \"__unversioned__\" special value, to represent all the unversioned workers (those\n with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)\nNote: Current Version is overridden by the Ramping Version for a portion of traffic when a ramp\nis set (see `ramping_version`.)"
14321
+ "description": "Deprecated. Use `current_deployment_version`."
14322
+ },
14323
+ "rampingDeploymentVersion": {
14324
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
14325
+ "description": "When ramp percentage is non-zero, that portion of traffic is shifted from the Current Version to the Ramping Version.\nMust always be different from `current_deployment_version` unless both are nil.\nNil value represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)\nNote that it is possible to ramp from one Version to another Version, or from unversioned\nworkers to a particular Version, or from a particular Version to unversioned workers."
13429
14326
  },
13430
14327
  "rampingVersion": {
13431
14328
  "type": "string",
13432
- "description": "When present, it means the traffic is being shifted from the Current Version to the Ramping\nVersion.\nMust always be different from `current_version`. Can be one of the following:\n- A Deployment Version identifier in the form \"<deployment_name>.<build_id>\".\n- Or, the \"__unversioned__\" special value, to represent all the unversioned workers (those\n with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)\nNote that it is possible to ramp from one Version to another Version, or from unversioned\nworkers to a particular Version, or from a particular Version to unversioned workers."
14329
+ "description": "Deprecated. Use `ramping_deployment_version`."
13433
14330
  },
13434
14331
  "rampingVersionPercentage": {
13435
14332
  "type": "number",
13436
14333
  "format": "float",
13437
- "description": "Percentage of tasks that are routed to the Ramping Version instead of the Current Version.\nValid range: [0, 100]. A 100% value means the Ramping Version is receiving full traffic but\nnot yet \"promoted\" to be the Current Version, likely due to pending validations."
14334
+ "description": "Percentage of tasks that are routed to the Ramping Version instead of the Current Version.\nValid range: [0, 100]. A 100% value means the Ramping Version is receiving full traffic but\nnot yet \"promoted\" to be the Current Version, likely due to pending validations.\nA 0% value means the Ramping Version is receiving no traffic."
13438
14335
  },
13439
14336
  "updateTime": {
13440
14337
  "type": "string",
@@ -13572,6 +14469,15 @@
13572
14469
  }
13573
14470
  }
13574
14471
  },
14472
+ "v1TriggerWorkflowRuleResponse": {
14473
+ "type": "object",
14474
+ "properties": {
14475
+ "applied": {
14476
+ "type": "boolean",
14477
+ "description": "True is the rule was applied, based on the rule conditions (predicate/visibility_query)."
14478
+ }
14479
+ }
14480
+ },
13575
14481
  "v1UnpauseActivityResponse": {
13576
14482
  "type": "object"
13577
14483
  },
@@ -13907,17 +14813,25 @@
13907
14813
  "v1VersioningOverride": {
13908
14814
  "type": "object",
13909
14815
  "properties": {
14816
+ "pinned": {
14817
+ "$ref": "#/definitions/VersioningOverridePinnedOverride",
14818
+ "description": "Send the next workflow task to the Version specified in the override."
14819
+ },
14820
+ "autoUpgrade": {
14821
+ "type": "boolean",
14822
+ "description": "Send the next workflow task to the Current Deployment Version\nof its Task Queue when the next workflow task is dispatched."
14823
+ },
13910
14824
  "behavior": {
13911
14825
  "$ref": "#/definitions/v1VersioningBehavior",
13912
- "description": "Required."
14826
+ "description": "Required.\nDeprecated. Use `override`."
13913
14827
  },
13914
14828
  "deployment": {
13915
14829
  "$ref": "#/definitions/v1Deployment",
13916
- "description": "Required if behavior is `PINNED`. Must be null if behavior is `AUTO_UPGRADE`.\nIdentifies the worker deployment to pin the workflow to.\nDeprecated. Use `pinned_version`."
14830
+ "description": "Required if behavior is `PINNED`. Must be null if behavior is `AUTO_UPGRADE`.\nIdentifies the worker deployment to pin the workflow to.\nDeprecated. Use `override.pinned.version`."
13917
14831
  },
13918
14832
  "pinnedVersion": {
13919
14833
  "type": "string",
13920
- "description": "Required if behavior is `PINNED`. Must be absent if behavior is not `PINNED`.\nIdentifies the worker deployment version to pin the workflow to, in the format\n\"<deployment_name>.<build_id>\"."
14834
+ "description": "Required if behavior is `PINNED`. Must be absent if behavior is not `PINNED`.\nIdentifies the worker deployment version to pin the workflow to, in the format\n\"<deployment_name>.<build_id>\".\nDeprecated. Use `override.pinned.version`."
13921
14835
  }
13922
14836
  },
13923
14837
  "description": "Used to override the versioning behavior (and pinned deployment version, if applicable) of a\nspecific workflow execution. If set, takes precedence over the worker-sent values. See\n`WorkflowExecutionInfo.VersioningInfo` for more information. To remove the override, call\n`UpdateWorkflowExecutionOptions` with a null `VersioningOverride`, and use the `update_mask`\nto indicate that it should be mutated."
@@ -13970,21 +14884,39 @@
13970
14884
  },
13971
14885
  "buildId": {
13972
14886
  "type": "string",
13973
- "description": "The Build ID of the worker. Required when `worker_versioning_mode==VERSIONED`, in which case,\nthe worker will be part of a Deployment Version identified by \"<deployment_name>.<build_id>\"."
14887
+ "description": "The Build ID of the worker. Required when `worker_versioning_mode==VERSIONED`, in which case,\nthe worker will be part of a Deployment Version."
13974
14888
  },
13975
14889
  "workerVersioningMode": {
13976
14890
  "$ref": "#/definitions/v1WorkerVersioningMode",
13977
- "description": "Required. Versioning Mode for this worker. Must be the same for all workers with the\nsame `deployment_name` and `build_id` combination, across all Task Queues.\nWhen `worker_versioning_mode==VERSIONED`, the worker will be part of a Deployment Version\nidentified by \"<deployment_name>.<build_id>\"."
14891
+ "description": "Required. Versioning Mode for this worker. Must be the same for all workers with the\nsame `deployment_name` and `build_id` combination, across all Task Queues.\nWhen `worker_versioning_mode==VERSIONED`, the worker will be part of a Deployment Version."
13978
14892
  }
13979
14893
  },
13980
14894
  "description": "Worker Deployment options set in SDK that need to be sent to server in every poll.\nExperimental. Worker Deployments are experimental and might significantly change in the future."
13981
14895
  },
14896
+ "v1WorkerDeploymentVersion": {
14897
+ "type": "object",
14898
+ "properties": {
14899
+ "buildId": {
14900
+ "type": "string",
14901
+ "description": "A unique identifier for this Version within the Deployment it is a part of.\nNot necessarily unique within the namespace.\nThe combination of `deployment_name` and `build_id` uniquely identifies this\nVersion within the namespace, because Deployment names are unique within a namespace."
14902
+ },
14903
+ "deploymentName": {
14904
+ "type": "string",
14905
+ "description": "Identifies the Worker Deployment this Version is part of."
14906
+ }
14907
+ },
14908
+ "description": "A Worker Deployment Version (Version, for short) represents a\nversion of workers within a Worker Deployment. (see documentation of WorkerDeploymentVersionInfo)\nVersion records are created in Temporal server automatically when their\nfirst poller arrives to the server.\nExperimental. Worker Deployment Versions are experimental and might significantly change in the future."
14909
+ },
13982
14910
  "v1WorkerDeploymentVersionInfo": {
13983
14911
  "type": "object",
13984
14912
  "properties": {
13985
14913
  "version": {
13986
14914
  "type": "string",
13987
- "description": "The fully-qualified string representation of the version, in the form \"<deployment_name>.<build_id>\"."
14915
+ "description": "Deprecated. Use `deployment_version`."
14916
+ },
14917
+ "deploymentVersion": {
14918
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
14919
+ "description": "Required."
13988
14920
  },
13989
14921
  "deploymentName": {
13990
14922
  "type": "string"
@@ -14244,6 +15176,17 @@
14244
15176
  "type": "string",
14245
15177
  "format": "date-time",
14246
15178
  "description": "Original workflow start time."
15179
+ },
15180
+ "resetRunId": {
15181
+ "type": "string",
15182
+ "description": "Reset Run ID points to the new run when this execution is reset. If the execution is reset multiple times, it points to the latest run."
15183
+ },
15184
+ "requestIdInfos": {
15185
+ "type": "object",
15186
+ "additionalProperties": {
15187
+ "$ref": "#/definitions/v1RequestIdInfo"
15188
+ },
15189
+ "description": "Request ID information (eg: history event information associated with the request ID).\nNote: It only contains request IDs from StartWorkflowExecution requests, including indirect\ncalls (eg: if SignalWithStartWorkflowExecution starts a new workflow, then the request ID is\nused in the StartWorkflowExecution request)."
14247
15190
  }
14248
15191
  },
14249
15192
  "description": "Holds all the extra information about workflow execution that is not part of Visibility."
@@ -14558,7 +15501,7 @@
14558
15501
  },
14559
15502
  "rootWorkflowExecution": {
14560
15503
  "$ref": "#/definitions/v1WorkflowExecution",
14561
- "description": "Contains information about the root workflow execution.\nThe root workflow execution is defined as follows:\n1. A workflow without parent workflow is its own root workflow.\n2. A workflow that has a parent workflow has the same root workflow as its parent workflow.\nNote: workflows continued as new or reseted may or may not have parents, check examples below.\n\nExamples:\n Scenario 1: Workflow W1 starts child workflow W2, and W2 starts child workflow W3.\n - The root workflow of all three workflows is W1.\n Scenario 2: Workflow W1 starts child workflow W2, and W2 continued as new W3.\n - The root workflow of all three workflows is W1.\n Scenario 3: Workflow W1 continued as new W2.\n - The root workflow of W1 is W1 and the root workflow of W2 is W2.\n Scenario 4: Workflow W1 starts child workflow W2, and W2 is reseted, creating W3\n - The root workflow of all three workflows is W1.\n Scenario 5: Workflow W1 is reseted, creating W2.\n - The root workflow of W1 is W1 and the root workflow of W2 is W2."
15504
+ "description": "Contains information about the root workflow execution.\nThe root workflow execution is defined as follows:\n 1. A workflow without parent workflow is its own root workflow.\n 2. A workflow that has a parent workflow has the same root workflow as its parent workflow.\nWhen the workflow is its own root workflow, then root_workflow_execution is nil.\nNote: workflows continued as new or reseted may or may not have parents, check examples below.\n\nExamples:\n Scenario 1: Workflow W1 starts child workflow W2, and W2 starts child workflow W3.\n - The root workflow of all three workflows is W1.\n - W1 has root_workflow_execution set to nil.\n - W2 and W3 have root_workflow_execution set to W1.\n Scenario 2: Workflow W1 starts child workflow W2, and W2 continued as new W3.\n - The root workflow of all three workflows is W1.\n - W1 has root_workflow_execution set to nil.\n - W2 and W3 have root_workflow_execution set to W1.\n Scenario 3: Workflow W1 continued as new W2.\n - The root workflow of W1 is W1 and the root workflow of W2 is W2.\n - W1 and W2 have root_workflow_execution set to nil.\n Scenario 4: Workflow W1 starts child workflow W2, and W2 is reseted, creating W3\n - The root workflow of all three workflows is W1.\n - W1 has root_workflow_execution set to nil.\n - W2 and W3 have root_workflow_execution set to W1.\n Scenario 5: Workflow W1 is reseted, creating W2.\n - The root workflow of W1 is W1 and the root workflow of W2 is W2.\n - W1 and W2 have root_workflow_execution set to nil."
14562
15505
  },
14563
15506
  "inheritedBuildId": {
14564
15507
  "type": "string",
@@ -14570,6 +15513,10 @@
14570
15513
  },
14571
15514
  "parentPinnedWorkerDeploymentVersion": {
14572
15515
  "type": "string",
15516
+ "description": "When present, it means this is a child workflow of a parent that is Pinned to this Worker\nDeployment Version. In this case, child workflow will start as Pinned to this Version instead\nof starting on the Current Version of its Task Queue.\nThis is set only if the child workflow is starting on a Task Queue belonging to the same\nWorker Deployment Version.\nDeprecated. Use `parent_pinned_deployment_version`."
15517
+ },
15518
+ "parentPinnedDeploymentVersion": {
15519
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
14573
15520
  "description": "When present, it means this is a child workflow of a parent that is Pinned to this Worker\nDeployment Version. In this case, child workflow will start as Pinned to this Version instead\nof starting on the Current Version of its Task Queue.\nThis is set only if the child workflow is starting on a Task Queue belonging to the same\nWorker Deployment Version."
14574
15521
  },
14575
15522
  "priority": {
@@ -14710,11 +15657,15 @@
14710
15657
  },
14711
15658
  "deployment": {
14712
15659
  "$ref": "#/definitions/v1Deployment",
14713
- "description": "The worker deployment that completed the last workflow task of this workflow execution. Must\nbe present if `behavior` is set. Absent value means no workflow task is completed, or the\nlast workflow task was completed by an unversioned worker. Unversioned workers may still send\na deployment value which will be stored here, so the right way to check if an execution is\nversioned if an execution is versioned or not is via the `behavior` field.\nNote that `deployment` is overridden by `versioning_override` if the latter is present.\nDeprecated. Use `version`."
15660
+ "description": "The worker deployment that completed the last workflow task of this workflow execution. Must\nbe present if `behavior` is set. Absent value means no workflow task is completed, or the\nlast workflow task was completed by an unversioned worker. Unversioned workers may still send\na deployment value which will be stored here, so the right way to check if an execution is\nversioned if an execution is versioned or not is via the `behavior` field.\nNote that `deployment` is overridden by `versioning_override` if the latter is present.\nDeprecated. Use `deployment_version`."
14714
15661
  },
14715
15662
  "version": {
14716
15663
  "type": "string",
14717
- "description": "The Worker Deployment Version that completed the last workflow task of this workflow\nexecution, in the form \"<deployment_name>.<build_id>\".\nMust be present if and only if `behavior` is set. An absent value means no workflow task is\ncompleted, or the workflow is unversioned.\nFor child workflows of Pinned parents, this will be set to parent's Pinned Version when the\nthe child starts so that child's first workflow task goes to the same Version as the parent.\nNote that if `versioning_override.behavior` is PINNED then `versioning_override.pinned_version`\nwill override this value."
15664
+ "description": "Deprecated. Use `deployment_version`."
15665
+ },
15666
+ "deploymentVersion": {
15667
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
15668
+ "description": "The Worker Deployment Version that completed the last workflow task of this workflow execution.\nAn absent value means no workflow task is completed, or the workflow is unversioned.\nIf present, and `behavior` is UNSPECIFIED, the last task of this workflow execution was completed\nby a worker that is not using versioning but _is_ passing Deployment Name and Build ID.\n\nFor child workflows of Pinned parents, this will be set to the parent's Pinned Version when\nthe child starts, so that the child's first workflow task goes to the same Version as the parent.\nNote that if `versioning_override.behavior` is PINNED then `versioning_override.pinned_version`\nwill override this value."
14718
15669
  },
14719
15670
  "versioningOverride": {
14720
15671
  "$ref": "#/definitions/v1VersioningOverride",
@@ -14834,6 +15785,66 @@
14834
15785
  },
14835
15786
  "title": "Answer to a `WorkflowQuery`"
14836
15787
  },
15788
+ "v1WorkflowRule": {
15789
+ "type": "object",
15790
+ "properties": {
15791
+ "createTime": {
15792
+ "type": "string",
15793
+ "format": "date-time",
15794
+ "description": "Rule creation time."
15795
+ },
15796
+ "spec": {
15797
+ "$ref": "#/definitions/v1WorkflowRuleSpec",
15798
+ "title": "Rule specification"
15799
+ },
15800
+ "createdByIdentity": {
15801
+ "type": "string",
15802
+ "title": "Identity of the actor that created the rule"
15803
+ },
15804
+ "description": {
15805
+ "type": "string",
15806
+ "description": "Rule description."
15807
+ }
15808
+ },
15809
+ "description": "WorkflowRule describes a rule that can be applied to any workflow in this namespace."
15810
+ },
15811
+ "v1WorkflowRuleAction": {
15812
+ "type": "object",
15813
+ "properties": {
15814
+ "activityPause": {
15815
+ "$ref": "#/definitions/WorkflowRuleActionActionActivityPause"
15816
+ }
15817
+ }
15818
+ },
15819
+ "v1WorkflowRuleSpec": {
15820
+ "type": "object",
15821
+ "properties": {
15822
+ "id": {
15823
+ "type": "string",
15824
+ "description": "The id of the new workflow rule. Must be unique within the namespace.\nCan be set by the user, and can have business meaning."
15825
+ },
15826
+ "activityStart": {
15827
+ "$ref": "#/definitions/WorkflowRuleSpecActivityStartingTrigger"
15828
+ },
15829
+ "visibilityQuery": {
15830
+ "type": "string",
15831
+ "title": "Restricted Visibility query.\nThis query is used to filter workflows in this namespace to which this rule should apply.\nIt is applied to any running workflow each time a triggering event occurs, before the trigger predicate is evaluated.\nThe following workflow attributes are supported:\n- WorkflowType\n- WorkflowId\n- StartTime\n- ExecutionStatus"
15832
+ },
15833
+ "actions": {
15834
+ "type": "array",
15835
+ "items": {
15836
+ "type": "object",
15837
+ "$ref": "#/definitions/v1WorkflowRuleAction"
15838
+ },
15839
+ "description": "WorkflowRuleAction to be taken when the rule is triggered and predicate is matched."
15840
+ },
15841
+ "expirationTime": {
15842
+ "type": "string",
15843
+ "format": "date-time",
15844
+ "description": "Expiration time of the rule. After this time, the rule will be deleted.\nCan be empty if the rule should never expire."
15845
+ }
15846
+ }
15847
+ },
14837
15848
  "v1WorkflowTaskCompletedEventAttributes": {
14838
15849
  "type": "object",
14839
15850
  "properties": {
@@ -14853,11 +15864,11 @@
14853
15864
  },
14854
15865
  "binaryChecksum": {
14855
15866
  "type": "string",
14856
- "title": "Binary ID of the worker who completed this task"
15867
+ "description": "Binary ID of the worker who completed this task\nDeprecated. Replaced with `deployment_version`."
14857
15868
  },
14858
15869
  "workerVersion": {
14859
15870
  "$ref": "#/definitions/v1WorkerVersionStamp",
14860
- "description": "Version info of the worker who processed this workflow task. If present, the `build_id` field\nwithin is also used as `binary_checksum`, which may be omitted in that case (it may also be\npopulated to preserve compatibility).\nDeprecated. Use `deployment` and `versioning_behavior` instead."
15871
+ "description": "Version info of the worker who processed this workflow task. If present, the `build_id` field\nwithin is also used as `binary_checksum`, which may be omitted in that case (it may also be\npopulated to preserve compatibility).\nDeprecated. Use `deployment_version` and `versioning_behavior` instead."
14861
15872
  },
14862
15873
  "sdkMetadata": {
14863
15874
  "$ref": "#/definitions/v1WorkflowTaskCompletedMetadata",
@@ -14869,7 +15880,7 @@
14869
15880
  },
14870
15881
  "deployment": {
14871
15882
  "$ref": "#/definitions/v1Deployment",
14872
- "description": "The deployment that completed this task. May or may not be set for unversioned workers,\ndepending on whether a value is sent by the SDK. This value updates workflow execution's\n`versioning_info.deployment`.\nDeprecated. Replaced with `worker_deployment_version`."
15883
+ "description": "The deployment that completed this task. May or may not be set for unversioned workers,\ndepending on whether a value is sent by the SDK. This value updates workflow execution's\n`versioning_info.deployment`.\nDeprecated. Replaced with `deployment_version`."
14873
15884
  },
14874
15885
  "versioningBehavior": {
14875
15886
  "$ref": "#/definitions/v1VersioningBehavior",
@@ -14877,11 +15888,15 @@
14877
15888
  },
14878
15889
  "workerDeploymentVersion": {
14879
15890
  "type": "string",
14880
- "description": "The Worker Deployment Version that completed this task. Must be set if `versioning_behavior`\nis set. This value updates workflow execution's `versioning_info.version`.\nExperimental. Worker Deployments are experimental and might significantly change in the future."
15891
+ "description": "The Worker Deployment Version that completed this task. Must be set if `versioning_behavior`\nis set. This value updates workflow execution's `versioning_info.version`.\nExperimental. Worker Deployments are experimental and might significantly change in the future.\nDeprecated. Replaced with `deployment_version`."
14881
15892
  },
14882
15893
  "workerDeploymentName": {
14883
15894
  "type": "string",
14884
15895
  "description": "The name of Worker Deployment that completed this task. Must be set if `versioning_behavior`\nis set. This value updates workflow execution's `worker_deployment_name`.\nExperimental. Worker Deployments are experimental and might significantly change in the future."
15896
+ },
15897
+ "deploymentVersion": {
15898
+ "$ref": "#/definitions/v1WorkerDeploymentVersion",
15899
+ "description": "The Worker Deployment Version that completed this task. Must be set if `versioning_behavior`\nis set. This value updates workflow execution's `versioning_info.deployment_version`.\nExperimental. Worker Deployments are experimental and might significantly change in the future."
14885
15900
  }
14886
15901
  }
14887
15902
  },
@@ -14997,11 +16012,11 @@
14997
16012
  },
14998
16013
  "binaryChecksum": {
14999
16014
  "type": "string",
15000
- "title": "DEPRECATED since 1.21 - use `worker_version` instead.\nIf a worker explicitly failed this task, its binary id"
16015
+ "title": "DEPRECATED since 1.21 - This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]\nIf a worker explicitly failed this task, its binary id"
15001
16016
  },
15002
16017
  "workerVersion": {
15003
16018
  "$ref": "#/definitions/v1WorkerVersionStamp",
15004
- "title": "Version info of the worker who processed this workflow task. If present, the `build_id` field\nwithin is also used as `binary_checksum`, which may be omitted in that case (it may also be\npopulated to preserve compatibility).\nDeprecated. Use the info inside the corresponding WorkflowTaskStartedEvent"
16019
+ "title": "Version info of the worker who processed this workflow task. If present, the `build_id` field\nwithin is also used as `binary_checksum`, which may be omitted in that case (it may also be\npopulated to preserve compatibility).\nDeprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]"
15005
16020
  }
15006
16021
  }
15007
16022
  },