@temporalio/core-bridge 1.12.0 → 1.12.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Cargo.lock +64 -119
- package/Cargo.toml +1 -1
- package/index.js +3 -2
- package/package.json +3 -3
- package/releases/aarch64-apple-darwin/index.node +0 -0
- package/releases/aarch64-unknown-linux-gnu/index.node +0 -0
- package/releases/x86_64-apple-darwin/index.node +0 -0
- package/releases/x86_64-pc-windows-msvc/index.node +0 -0
- package/releases/x86_64-unknown-linux-gnu/index.node +0 -0
- package/sdk-core/.cargo/config.toml +1 -2
- package/sdk-core/.github/workflows/per-pr.yml +2 -0
- package/sdk-core/AGENTS.md +7 -0
- package/sdk-core/Cargo.toml +9 -5
- package/sdk-core/README.md +6 -5
- package/sdk-core/client/Cargo.toml +3 -2
- package/sdk-core/client/src/lib.rs +17 -8
- package/sdk-core/client/src/metrics.rs +57 -23
- package/sdk-core/client/src/raw.rs +33 -15
- package/sdk-core/core/Cargo.toml +11 -9
- package/sdk-core/core/benches/workflow_replay.rs +114 -15
- package/sdk-core/core/src/core_tests/activity_tasks.rs +18 -18
- package/sdk-core/core/src/core_tests/child_workflows.rs +4 -4
- package/sdk-core/core/src/core_tests/determinism.rs +6 -6
- package/sdk-core/core/src/core_tests/local_activities.rs +20 -20
- package/sdk-core/core/src/core_tests/mod.rs +40 -5
- package/sdk-core/core/src/core_tests/queries.rs +25 -16
- package/sdk-core/core/src/core_tests/replay_flag.rs +3 -3
- package/sdk-core/core/src/core_tests/updates.rs +3 -3
- package/sdk-core/core/src/core_tests/workers.rs +9 -7
- package/sdk-core/core/src/core_tests/workflow_tasks.rs +40 -42
- package/sdk-core/core/src/ephemeral_server/mod.rs +1 -19
- package/sdk-core/core/src/lib.rs +10 -1
- package/sdk-core/core/src/pollers/poll_buffer.rs +2 -2
- package/sdk-core/core/src/replay/mod.rs +3 -3
- package/sdk-core/core/src/telemetry/metrics.rs +306 -152
- package/sdk-core/core/src/telemetry/mod.rs +11 -4
- package/sdk-core/core/src/telemetry/otel.rs +134 -131
- package/sdk-core/core/src/telemetry/prometheus_meter.rs +885 -0
- package/sdk-core/core/src/telemetry/prometheus_server.rs +48 -28
- package/sdk-core/core/src/test_help/mod.rs +27 -12
- package/sdk-core/core/src/worker/activities/activity_heartbeat_manager.rs +7 -7
- package/sdk-core/core/src/worker/activities.rs +4 -4
- package/sdk-core/core/src/worker/client/mocks.rs +10 -3
- package/sdk-core/core/src/worker/client.rs +68 -5
- package/sdk-core/core/src/worker/heartbeat.rs +229 -0
- package/sdk-core/core/src/worker/mod.rs +35 -14
- package/sdk-core/core/src/worker/tuner/resource_based.rs +4 -4
- package/sdk-core/core/src/worker/workflow/history_update.rs +71 -19
- package/sdk-core/core/src/worker/workflow/machines/cancel_external_state_machine.rs +1 -2
- package/sdk-core/core/src/worker/workflow/machines/child_workflow_state_machine.rs +1 -1
- package/sdk-core/core/src/worker/workflow/machines/nexus_operation_state_machine.rs +31 -48
- package/sdk-core/core/src/worker/workflow/machines/signal_external_state_machine.rs +1 -2
- package/sdk-core/core/src/worker/workflow/machines/upsert_search_attributes_state_machine.rs +3 -3
- package/sdk-core/core/src/worker/workflow/machines/workflow_machines.rs +4 -1
- package/sdk-core/core/src/worker/workflow/managed_run.rs +1 -1
- package/sdk-core/core/src/worker/workflow/mod.rs +15 -15
- package/sdk-core/core-api/Cargo.toml +2 -2
- package/sdk-core/core-api/src/envconfig.rs +204 -99
- package/sdk-core/core-api/src/lib.rs +9 -0
- package/sdk-core/core-api/src/telemetry/metrics.rs +548 -100
- package/sdk-core/core-api/src/worker.rs +11 -5
- package/sdk-core/core-c-bridge/Cargo.toml +49 -0
- package/sdk-core/core-c-bridge/build.rs +26 -0
- package/sdk-core/core-c-bridge/include/temporal-sdk-core-c-bridge.h +817 -0
- package/sdk-core/core-c-bridge/src/client.rs +679 -0
- package/sdk-core/core-c-bridge/src/lib.rs +245 -0
- package/sdk-core/core-c-bridge/src/metric.rs +682 -0
- package/sdk-core/core-c-bridge/src/random.rs +61 -0
- package/sdk-core/core-c-bridge/src/runtime.rs +445 -0
- package/sdk-core/core-c-bridge/src/testing.rs +282 -0
- package/sdk-core/core-c-bridge/src/tests/context.rs +644 -0
- package/sdk-core/core-c-bridge/src/tests/mod.rs +178 -0
- package/sdk-core/core-c-bridge/src/tests/utils.rs +108 -0
- package/sdk-core/core-c-bridge/src/worker.rs +1069 -0
- package/sdk-core/etc/deps.svg +64 -64
- package/sdk-core/sdk/src/activity_context.rs +6 -4
- package/sdk-core/sdk/src/lib.rs +49 -27
- package/sdk-core/sdk/src/workflow_future.rs +18 -25
- package/sdk-core/sdk-core-protos/protos/api_upstream/README.md +4 -0
- package/sdk-core/sdk-core-protos/protos/api_upstream/buf.yaml +0 -2
- package/sdk-core/sdk-core-protos/protos/api_upstream/openapi/openapiv2.json +630 -83
- package/sdk-core/sdk-core-protos/protos/api_upstream/openapi/openapiv3.yaml +632 -78
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/batch/v1/message.proto +4 -4
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/command/v1/message.proto +6 -4
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/common/v1/message.proto +2 -2
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/deployment/v1/message.proto +32 -2
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/common.proto +10 -1
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/deployment.proto +26 -0
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/failed_cause.proto +2 -0
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/reset.proto +4 -4
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/failure/v1/message.proto +2 -2
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/history/v1/message.proto +47 -31
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/nexus/v1/message.proto +4 -4
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/schedule/v1/message.proto +7 -1
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/worker/v1/message.proto +134 -0
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflow/v1/message.proto +14 -11
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflowservice/v1/request_response.proto +148 -37
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflowservice/v1/service.proto +21 -0
- package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/workflow_activation/workflow_activation.proto +4 -4
- package/sdk-core/sdk-core-protos/src/history_builder.rs +9 -5
- package/sdk-core/sdk-core-protos/src/lib.rs +96 -6
- package/sdk-core/test-utils/src/lib.rs +11 -3
- package/sdk-core/tests/cloud_tests.rs +3 -3
- package/sdk-core/tests/heavy_tests.rs +11 -3
- package/sdk-core/tests/integ_tests/client_tests.rs +12 -13
- package/sdk-core/tests/integ_tests/ephemeral_server_tests.rs +1 -1
- package/sdk-core/tests/integ_tests/metrics_tests.rs +188 -83
- package/sdk-core/tests/integ_tests/polling_tests.rs +1 -1
- package/sdk-core/tests/integ_tests/queries_tests.rs +56 -40
- package/sdk-core/tests/integ_tests/update_tests.rs +2 -7
- package/sdk-core/tests/integ_tests/worker_tests.rs +3 -4
- package/sdk-core/tests/integ_tests/worker_versioning_tests.rs +3 -7
- package/sdk-core/tests/integ_tests/workflow_tests/local_activities.rs +3 -5
- package/sdk-core/tests/integ_tests/workflow_tests/nexus.rs +24 -17
- package/src/client.rs +6 -0
- package/src/metrics.rs +6 -6
|
@@ -1510,7 +1510,7 @@
|
|
|
1510
1510
|
},
|
|
1511
1511
|
{
|
|
1512
1512
|
"name": "taskQueueType",
|
|
1513
|
-
"description": "
|
|
1513
|
+
"description": "If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.\nOnly supported in default mode (use `task_queue_types` in ENHANCED mode instead).\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
|
|
1514
1514
|
"in": "query",
|
|
1515
1515
|
"required": false,
|
|
1516
1516
|
"type": "string",
|
|
@@ -1522,16 +1522,23 @@
|
|
|
1522
1522
|
],
|
|
1523
1523
|
"default": "TASK_QUEUE_TYPE_UNSPECIFIED"
|
|
1524
1524
|
},
|
|
1525
|
+
{
|
|
1526
|
+
"name": "reportStats",
|
|
1527
|
+
"description": "Report stats for the requested task queue type(s).",
|
|
1528
|
+
"in": "query",
|
|
1529
|
+
"required": false,
|
|
1530
|
+
"type": "boolean"
|
|
1531
|
+
},
|
|
1525
1532
|
{
|
|
1526
1533
|
"name": "includeTaskQueueStatus",
|
|
1527
|
-
"description": "Deprecated
|
|
1534
|
+
"description": "Deprecated, use `report_stats` instead.\nIf true, the task queue status will be included in the response.",
|
|
1528
1535
|
"in": "query",
|
|
1529
1536
|
"required": false,
|
|
1530
1537
|
"type": "boolean"
|
|
1531
1538
|
},
|
|
1532
1539
|
{
|
|
1533
1540
|
"name": "apiMode",
|
|
1534
|
-
"description": "
|
|
1541
|
+
"description": "Deprecated. ENHANCED mode is also being deprecated.\nSelect the API mode to use for this request: DEFAULT mode (if unset) or ENHANCED mode.\nConsult the documentation for each field to understand which mode it is supported in.\n\n - DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED: Unspecified means legacy behavior.\n - DESCRIBE_TASK_QUEUE_MODE_ENHANCED: Enhanced mode reports aggregated results for all partitions, supports Build IDs, and reports richer info.",
|
|
1535
1542
|
"in": "query",
|
|
1536
1543
|
"required": false,
|
|
1537
1544
|
"type": "string",
|
|
@@ -1568,7 +1575,7 @@
|
|
|
1568
1575
|
},
|
|
1569
1576
|
{
|
|
1570
1577
|
"name": "taskQueueTypes",
|
|
1571
|
-
"description": "
|
|
1578
|
+
"description": "Deprecated (as part of the ENHANCED mode deprecation).\nTask queue types to report info about. If not specified, all types are considered.\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
|
|
1572
1579
|
"in": "query",
|
|
1573
1580
|
"required": false,
|
|
1574
1581
|
"type": "array",
|
|
@@ -1583,23 +1590,16 @@
|
|
|
1583
1590
|
},
|
|
1584
1591
|
"collectionFormat": "multi"
|
|
1585
1592
|
},
|
|
1586
|
-
{
|
|
1587
|
-
"name": "reportStats",
|
|
1588
|
-
"description": "Report stats for the requested task queue types and versions",
|
|
1589
|
-
"in": "query",
|
|
1590
|
-
"required": false,
|
|
1591
|
-
"type": "boolean"
|
|
1592
|
-
},
|
|
1593
1593
|
{
|
|
1594
1594
|
"name": "reportPollers",
|
|
1595
|
-
"description": "
|
|
1595
|
+
"description": "Deprecated (as part of the ENHANCED mode deprecation).\nReport list of pollers for requested task queue types and versions.",
|
|
1596
1596
|
"in": "query",
|
|
1597
1597
|
"required": false,
|
|
1598
1598
|
"type": "boolean"
|
|
1599
1599
|
},
|
|
1600
1600
|
{
|
|
1601
1601
|
"name": "reportTaskReachability",
|
|
1602
|
-
"description": "
|
|
1602
|
+
"description": "Deprecated (as part of the ENHANCED mode deprecation).\nReport task reachability for the requested versions and all task types (task reachability is not reported\nper task type).",
|
|
1603
1603
|
"in": "query",
|
|
1604
1604
|
"required": false,
|
|
1605
1605
|
"type": "boolean"
|
|
@@ -1777,6 +1777,13 @@
|
|
|
1777
1777
|
"in": "query",
|
|
1778
1778
|
"required": false,
|
|
1779
1779
|
"type": "string"
|
|
1780
|
+
},
|
|
1781
|
+
{
|
|
1782
|
+
"name": "reportTaskQueueStats",
|
|
1783
|
+
"description": "Report stats for task queues which have been polled by this version.",
|
|
1784
|
+
"in": "query",
|
|
1785
|
+
"required": false,
|
|
1786
|
+
"type": "boolean"
|
|
1780
1787
|
}
|
|
1781
1788
|
],
|
|
1782
1789
|
"tags": [
|
|
@@ -2184,6 +2191,98 @@
|
|
|
2184
2191
|
]
|
|
2185
2192
|
}
|
|
2186
2193
|
},
|
|
2194
|
+
"/api/v1/namespaces/{namespace}/workers": {
|
|
2195
|
+
"get": {
|
|
2196
|
+
"summary": "ListWorkers is a visibility API to list worker status information in a specific namespace.",
|
|
2197
|
+
"operationId": "ListWorkers2",
|
|
2198
|
+
"responses": {
|
|
2199
|
+
"200": {
|
|
2200
|
+
"description": "A successful response.",
|
|
2201
|
+
"schema": {
|
|
2202
|
+
"$ref": "#/definitions/v1ListWorkersResponse"
|
|
2203
|
+
}
|
|
2204
|
+
},
|
|
2205
|
+
"default": {
|
|
2206
|
+
"description": "An unexpected error response.",
|
|
2207
|
+
"schema": {
|
|
2208
|
+
"$ref": "#/definitions/rpcStatus"
|
|
2209
|
+
}
|
|
2210
|
+
}
|
|
2211
|
+
},
|
|
2212
|
+
"parameters": [
|
|
2213
|
+
{
|
|
2214
|
+
"name": "namespace",
|
|
2215
|
+
"in": "path",
|
|
2216
|
+
"required": true,
|
|
2217
|
+
"type": "string"
|
|
2218
|
+
},
|
|
2219
|
+
{
|
|
2220
|
+
"name": "pageSize",
|
|
2221
|
+
"in": "query",
|
|
2222
|
+
"required": false,
|
|
2223
|
+
"type": "integer",
|
|
2224
|
+
"format": "int32"
|
|
2225
|
+
},
|
|
2226
|
+
{
|
|
2227
|
+
"name": "nextPageToken",
|
|
2228
|
+
"in": "query",
|
|
2229
|
+
"required": false,
|
|
2230
|
+
"type": "string",
|
|
2231
|
+
"format": "byte"
|
|
2232
|
+
},
|
|
2233
|
+
{
|
|
2234
|
+
"name": "query",
|
|
2235
|
+
"description": "`query` in ListWorkers is used to filter workers based on worker status info.\nThe following worker status attributes are expected are supported as part of the query:\n* WorkerInstanceKey\n* WorkerIdentity\n* HostName\n* TaskQueue\n* DeploymentName\n* BuildId\n* SdkName\n* SdkVersion\n* StartTime\n* LastHeartbeatTime\n* Status\nCurrently metrics are not supported as a part of ListWorkers query.",
|
|
2236
|
+
"in": "query",
|
|
2237
|
+
"required": false,
|
|
2238
|
+
"type": "string"
|
|
2239
|
+
}
|
|
2240
|
+
],
|
|
2241
|
+
"tags": [
|
|
2242
|
+
"WorkflowService"
|
|
2243
|
+
]
|
|
2244
|
+
}
|
|
2245
|
+
},
|
|
2246
|
+
"/api/v1/namespaces/{namespace}/workers/heartbeat": {
|
|
2247
|
+
"post": {
|
|
2248
|
+
"summary": "WorkerHeartbeat receive heartbeat request from the worker.",
|
|
2249
|
+
"operationId": "RecordWorkerHeartbeat2",
|
|
2250
|
+
"responses": {
|
|
2251
|
+
"200": {
|
|
2252
|
+
"description": "A successful response.",
|
|
2253
|
+
"schema": {
|
|
2254
|
+
"$ref": "#/definitions/v1RecordWorkerHeartbeatResponse"
|
|
2255
|
+
}
|
|
2256
|
+
},
|
|
2257
|
+
"default": {
|
|
2258
|
+
"description": "An unexpected error response.",
|
|
2259
|
+
"schema": {
|
|
2260
|
+
"$ref": "#/definitions/rpcStatus"
|
|
2261
|
+
}
|
|
2262
|
+
}
|
|
2263
|
+
},
|
|
2264
|
+
"parameters": [
|
|
2265
|
+
{
|
|
2266
|
+
"name": "namespace",
|
|
2267
|
+
"description": "Namespace this worker belongs to.",
|
|
2268
|
+
"in": "path",
|
|
2269
|
+
"required": true,
|
|
2270
|
+
"type": "string"
|
|
2271
|
+
},
|
|
2272
|
+
{
|
|
2273
|
+
"name": "body",
|
|
2274
|
+
"in": "body",
|
|
2275
|
+
"required": true,
|
|
2276
|
+
"schema": {
|
|
2277
|
+
"$ref": "#/definitions/WorkflowServiceRecordWorkerHeartbeatBody"
|
|
2278
|
+
}
|
|
2279
|
+
}
|
|
2280
|
+
],
|
|
2281
|
+
"tags": [
|
|
2282
|
+
"WorkflowService"
|
|
2283
|
+
]
|
|
2284
|
+
}
|
|
2285
|
+
},
|
|
2187
2286
|
"/api/v1/namespaces/{namespace}/workflow-count": {
|
|
2188
2287
|
"get": {
|
|
2189
2288
|
"summary": "CountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.",
|
|
@@ -5058,7 +5157,7 @@
|
|
|
5058
5157
|
},
|
|
5059
5158
|
{
|
|
5060
5159
|
"name": "taskQueueType",
|
|
5061
|
-
"description": "
|
|
5160
|
+
"description": "If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.\nOnly supported in default mode (use `task_queue_types` in ENHANCED mode instead).\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
|
|
5062
5161
|
"in": "query",
|
|
5063
5162
|
"required": false,
|
|
5064
5163
|
"type": "string",
|
|
@@ -5070,16 +5169,23 @@
|
|
|
5070
5169
|
],
|
|
5071
5170
|
"default": "TASK_QUEUE_TYPE_UNSPECIFIED"
|
|
5072
5171
|
},
|
|
5172
|
+
{
|
|
5173
|
+
"name": "reportStats",
|
|
5174
|
+
"description": "Report stats for the requested task queue type(s).",
|
|
5175
|
+
"in": "query",
|
|
5176
|
+
"required": false,
|
|
5177
|
+
"type": "boolean"
|
|
5178
|
+
},
|
|
5073
5179
|
{
|
|
5074
5180
|
"name": "includeTaskQueueStatus",
|
|
5075
|
-
"description": "Deprecated
|
|
5181
|
+
"description": "Deprecated, use `report_stats` instead.\nIf true, the task queue status will be included in the response.",
|
|
5076
5182
|
"in": "query",
|
|
5077
5183
|
"required": false,
|
|
5078
5184
|
"type": "boolean"
|
|
5079
5185
|
},
|
|
5080
5186
|
{
|
|
5081
5187
|
"name": "apiMode",
|
|
5082
|
-
"description": "
|
|
5188
|
+
"description": "Deprecated. ENHANCED mode is also being deprecated.\nSelect the API mode to use for this request: DEFAULT mode (if unset) or ENHANCED mode.\nConsult the documentation for each field to understand which mode it is supported in.\n\n - DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED: Unspecified means legacy behavior.\n - DESCRIBE_TASK_QUEUE_MODE_ENHANCED: Enhanced mode reports aggregated results for all partitions, supports Build IDs, and reports richer info.",
|
|
5083
5189
|
"in": "query",
|
|
5084
5190
|
"required": false,
|
|
5085
5191
|
"type": "string",
|
|
@@ -5116,7 +5222,7 @@
|
|
|
5116
5222
|
},
|
|
5117
5223
|
{
|
|
5118
5224
|
"name": "taskQueueTypes",
|
|
5119
|
-
"description": "
|
|
5225
|
+
"description": "Deprecated (as part of the ENHANCED mode deprecation).\nTask queue types to report info about. If not specified, all types are considered.\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
|
|
5120
5226
|
"in": "query",
|
|
5121
5227
|
"required": false,
|
|
5122
5228
|
"type": "array",
|
|
@@ -5131,23 +5237,16 @@
|
|
|
5131
5237
|
},
|
|
5132
5238
|
"collectionFormat": "multi"
|
|
5133
5239
|
},
|
|
5134
|
-
{
|
|
5135
|
-
"name": "reportStats",
|
|
5136
|
-
"description": "Report stats for the requested task queue types and versions",
|
|
5137
|
-
"in": "query",
|
|
5138
|
-
"required": false,
|
|
5139
|
-
"type": "boolean"
|
|
5140
|
-
},
|
|
5141
5240
|
{
|
|
5142
5241
|
"name": "reportPollers",
|
|
5143
|
-
"description": "
|
|
5242
|
+
"description": "Deprecated (as part of the ENHANCED mode deprecation).\nReport list of pollers for requested task queue types and versions.",
|
|
5144
5243
|
"in": "query",
|
|
5145
5244
|
"required": false,
|
|
5146
5245
|
"type": "boolean"
|
|
5147
5246
|
},
|
|
5148
5247
|
{
|
|
5149
5248
|
"name": "reportTaskReachability",
|
|
5150
|
-
"description": "
|
|
5249
|
+
"description": "Deprecated (as part of the ENHANCED mode deprecation).\nReport task reachability for the requested versions and all task types (task reachability is not reported\nper task type).",
|
|
5151
5250
|
"in": "query",
|
|
5152
5251
|
"required": false,
|
|
5153
5252
|
"type": "boolean"
|
|
@@ -5286,6 +5385,13 @@
|
|
|
5286
5385
|
"in": "query",
|
|
5287
5386
|
"required": false,
|
|
5288
5387
|
"type": "string"
|
|
5388
|
+
},
|
|
5389
|
+
{
|
|
5390
|
+
"name": "reportTaskQueueStats",
|
|
5391
|
+
"description": "Report stats for task queues which have been polled by this version.",
|
|
5392
|
+
"in": "query",
|
|
5393
|
+
"required": false,
|
|
5394
|
+
"type": "boolean"
|
|
5289
5395
|
}
|
|
5290
5396
|
],
|
|
5291
5397
|
"tags": [
|
|
@@ -5693,6 +5799,98 @@
|
|
|
5693
5799
|
]
|
|
5694
5800
|
}
|
|
5695
5801
|
},
|
|
5802
|
+
"/namespaces/{namespace}/workers": {
|
|
5803
|
+
"get": {
|
|
5804
|
+
"summary": "ListWorkers is a visibility API to list worker status information in a specific namespace.",
|
|
5805
|
+
"operationId": "ListWorkers",
|
|
5806
|
+
"responses": {
|
|
5807
|
+
"200": {
|
|
5808
|
+
"description": "A successful response.",
|
|
5809
|
+
"schema": {
|
|
5810
|
+
"$ref": "#/definitions/v1ListWorkersResponse"
|
|
5811
|
+
}
|
|
5812
|
+
},
|
|
5813
|
+
"default": {
|
|
5814
|
+
"description": "An unexpected error response.",
|
|
5815
|
+
"schema": {
|
|
5816
|
+
"$ref": "#/definitions/rpcStatus"
|
|
5817
|
+
}
|
|
5818
|
+
}
|
|
5819
|
+
},
|
|
5820
|
+
"parameters": [
|
|
5821
|
+
{
|
|
5822
|
+
"name": "namespace",
|
|
5823
|
+
"in": "path",
|
|
5824
|
+
"required": true,
|
|
5825
|
+
"type": "string"
|
|
5826
|
+
},
|
|
5827
|
+
{
|
|
5828
|
+
"name": "pageSize",
|
|
5829
|
+
"in": "query",
|
|
5830
|
+
"required": false,
|
|
5831
|
+
"type": "integer",
|
|
5832
|
+
"format": "int32"
|
|
5833
|
+
},
|
|
5834
|
+
{
|
|
5835
|
+
"name": "nextPageToken",
|
|
5836
|
+
"in": "query",
|
|
5837
|
+
"required": false,
|
|
5838
|
+
"type": "string",
|
|
5839
|
+
"format": "byte"
|
|
5840
|
+
},
|
|
5841
|
+
{
|
|
5842
|
+
"name": "query",
|
|
5843
|
+
"description": "`query` in ListWorkers is used to filter workers based on worker status info.\nThe following worker status attributes are expected are supported as part of the query:\n* WorkerInstanceKey\n* WorkerIdentity\n* HostName\n* TaskQueue\n* DeploymentName\n* BuildId\n* SdkName\n* SdkVersion\n* StartTime\n* LastHeartbeatTime\n* Status\nCurrently metrics are not supported as a part of ListWorkers query.",
|
|
5844
|
+
"in": "query",
|
|
5845
|
+
"required": false,
|
|
5846
|
+
"type": "string"
|
|
5847
|
+
}
|
|
5848
|
+
],
|
|
5849
|
+
"tags": [
|
|
5850
|
+
"WorkflowService"
|
|
5851
|
+
]
|
|
5852
|
+
}
|
|
5853
|
+
},
|
|
5854
|
+
"/namespaces/{namespace}/workers/heartbeat": {
|
|
5855
|
+
"post": {
|
|
5856
|
+
"summary": "WorkerHeartbeat receive heartbeat request from the worker.",
|
|
5857
|
+
"operationId": "RecordWorkerHeartbeat",
|
|
5858
|
+
"responses": {
|
|
5859
|
+
"200": {
|
|
5860
|
+
"description": "A successful response.",
|
|
5861
|
+
"schema": {
|
|
5862
|
+
"$ref": "#/definitions/v1RecordWorkerHeartbeatResponse"
|
|
5863
|
+
}
|
|
5864
|
+
},
|
|
5865
|
+
"default": {
|
|
5866
|
+
"description": "An unexpected error response.",
|
|
5867
|
+
"schema": {
|
|
5868
|
+
"$ref": "#/definitions/rpcStatus"
|
|
5869
|
+
}
|
|
5870
|
+
}
|
|
5871
|
+
},
|
|
5872
|
+
"parameters": [
|
|
5873
|
+
{
|
|
5874
|
+
"name": "namespace",
|
|
5875
|
+
"description": "Namespace this worker belongs to.",
|
|
5876
|
+
"in": "path",
|
|
5877
|
+
"required": true,
|
|
5878
|
+
"type": "string"
|
|
5879
|
+
},
|
|
5880
|
+
{
|
|
5881
|
+
"name": "body",
|
|
5882
|
+
"in": "body",
|
|
5883
|
+
"required": true,
|
|
5884
|
+
"schema": {
|
|
5885
|
+
"$ref": "#/definitions/WorkflowServiceRecordWorkerHeartbeatBody"
|
|
5886
|
+
}
|
|
5887
|
+
}
|
|
5888
|
+
],
|
|
5889
|
+
"tags": [
|
|
5890
|
+
"WorkflowService"
|
|
5891
|
+
]
|
|
5892
|
+
}
|
|
5893
|
+
},
|
|
5696
5894
|
"/namespaces/{namespace}/workflow-count": {
|
|
5697
5895
|
"get": {
|
|
5698
5896
|
"summary": "CountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.",
|
|
@@ -6734,6 +6932,21 @@
|
|
|
6734
6932
|
}
|
|
6735
6933
|
}
|
|
6736
6934
|
},
|
|
6935
|
+
"DescribeWorkerDeploymentVersionResponseVersionTaskQueue": {
|
|
6936
|
+
"type": "object",
|
|
6937
|
+
"properties": {
|
|
6938
|
+
"name": {
|
|
6939
|
+
"type": "string"
|
|
6940
|
+
},
|
|
6941
|
+
"type": {
|
|
6942
|
+
"$ref": "#/definitions/v1TaskQueueType"
|
|
6943
|
+
},
|
|
6944
|
+
"stats": {
|
|
6945
|
+
"$ref": "#/definitions/v1TaskQueueStats",
|
|
6946
|
+
"description": "Only set if `report_task_queue_stats` is set on the request."
|
|
6947
|
+
}
|
|
6948
|
+
}
|
|
6949
|
+
},
|
|
6737
6950
|
"EndpointTargetExternal": {
|
|
6738
6951
|
"type": "object",
|
|
6739
6952
|
"properties": {
|
|
@@ -6812,6 +7025,18 @@
|
|
|
6812
7025
|
},
|
|
6813
7026
|
"routingConfig": {
|
|
6814
7027
|
"$ref": "#/definitions/v1RoutingConfig"
|
|
7028
|
+
},
|
|
7029
|
+
"latestVersionSummary": {
|
|
7030
|
+
"$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary",
|
|
7031
|
+
"description": "Summary of the version that was added most recently in the Worker Deployment."
|
|
7032
|
+
},
|
|
7033
|
+
"currentVersionSummary": {
|
|
7034
|
+
"$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary",
|
|
7035
|
+
"description": "Summary of the current version of the Worker Deployment."
|
|
7036
|
+
},
|
|
7037
|
+
"rampingVersionSummary": {
|
|
7038
|
+
"$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary",
|
|
7039
|
+
"description": "Summary of the ramping version of the Worker Deployment."
|
|
6815
7040
|
}
|
|
6816
7041
|
},
|
|
6817
7042
|
"title": "A subset of WorkerDeploymentInfo"
|
|
@@ -6922,7 +7147,7 @@
|
|
|
6922
7147
|
"properties": {
|
|
6923
7148
|
"operationId": {
|
|
6924
7149
|
"type": "string",
|
|
6925
|
-
"description": "Deprecated
|
|
7150
|
+
"description": "Deprecated. Renamed to operation_token."
|
|
6926
7151
|
},
|
|
6927
7152
|
"links": {
|
|
6928
7153
|
"type": "array",
|
|
@@ -7095,6 +7320,10 @@
|
|
|
7095
7320
|
"type": "string",
|
|
7096
7321
|
"description": "Deprecated. Use `deployment_version`."
|
|
7097
7322
|
},
|
|
7323
|
+
"status": {
|
|
7324
|
+
"$ref": "#/definitions/v1WorkerDeploymentVersionStatus",
|
|
7325
|
+
"description": "The status of the Worker Deployment Version."
|
|
7326
|
+
},
|
|
7098
7327
|
"deploymentVersion": {
|
|
7099
7328
|
"$ref": "#/definitions/v1WorkerDeploymentVersion",
|
|
7100
7329
|
"description": "Required."
|
|
@@ -7104,7 +7333,37 @@
|
|
|
7104
7333
|
"format": "date-time"
|
|
7105
7334
|
},
|
|
7106
7335
|
"drainageStatus": {
|
|
7107
|
-
"$ref": "#/definitions/v1VersionDrainageStatus"
|
|
7336
|
+
"$ref": "#/definitions/v1VersionDrainageStatus",
|
|
7337
|
+
"description": "Deprecated. Use `drainage_info` instead."
|
|
7338
|
+
},
|
|
7339
|
+
"drainageInfo": {
|
|
7340
|
+
"$ref": "#/definitions/v1VersionDrainageInfo",
|
|
7341
|
+
"title": "Information about workflow drainage to help the user determine when it is safe\nto decommission a Version. Not present while version is current or ramping"
|
|
7342
|
+
},
|
|
7343
|
+
"currentSinceTime": {
|
|
7344
|
+
"type": "string",
|
|
7345
|
+
"format": "date-time",
|
|
7346
|
+
"description": "Unset if not current."
|
|
7347
|
+
},
|
|
7348
|
+
"rampingSinceTime": {
|
|
7349
|
+
"type": "string",
|
|
7350
|
+
"format": "date-time",
|
|
7351
|
+
"description": "Unset if not ramping. Updated when the version first starts ramping, not on each ramp change."
|
|
7352
|
+
},
|
|
7353
|
+
"routingUpdateTime": {
|
|
7354
|
+
"type": "string",
|
|
7355
|
+
"format": "date-time",
|
|
7356
|
+
"description": "Last time `current_since_time`, `ramping_since_time, or `ramp_percentage` of this version changed."
|
|
7357
|
+
},
|
|
7358
|
+
"firstActivationTime": {
|
|
7359
|
+
"type": "string",
|
|
7360
|
+
"format": "date-time",
|
|
7361
|
+
"description": "Timestamp when this version first became current or ramping."
|
|
7362
|
+
},
|
|
7363
|
+
"lastDeactivationTime": {
|
|
7364
|
+
"type": "string",
|
|
7365
|
+
"format": "date-time",
|
|
7366
|
+
"description": "Timestamp when this version last stopped being current or ramping."
|
|
7108
7367
|
}
|
|
7109
7368
|
}
|
|
7110
7369
|
},
|
|
@@ -7339,6 +7598,22 @@
|
|
|
7339
7598
|
}
|
|
7340
7599
|
}
|
|
7341
7600
|
},
|
|
7601
|
+
"WorkflowServiceRecordWorkerHeartbeatBody": {
|
|
7602
|
+
"type": "object",
|
|
7603
|
+
"properties": {
|
|
7604
|
+
"identity": {
|
|
7605
|
+
"type": "string",
|
|
7606
|
+
"description": "The identity of the client who initiated this request."
|
|
7607
|
+
},
|
|
7608
|
+
"workerHeartbeat": {
|
|
7609
|
+
"type": "array",
|
|
7610
|
+
"items": {
|
|
7611
|
+
"type": "object",
|
|
7612
|
+
"$ref": "#/definitions/v1WorkerHeartbeat"
|
|
7613
|
+
}
|
|
7614
|
+
}
|
|
7615
|
+
}
|
|
7616
|
+
},
|
|
7342
7617
|
"WorkflowServiceRequestCancelWorkflowExecutionBody": {
|
|
7343
7618
|
"type": "object",
|
|
7344
7619
|
"properties": {
|
|
@@ -7407,6 +7682,10 @@
|
|
|
7407
7682
|
"jitter": {
|
|
7408
7683
|
"type": "string",
|
|
7409
7684
|
"title": "If set, and activity is in backoff, the activity will start at a random time within the specified jitter duration.\n(unless it is paused and keep_paused is set)"
|
|
7685
|
+
},
|
|
7686
|
+
"restoreOriginalOptions": {
|
|
7687
|
+
"type": "boolean",
|
|
7688
|
+
"description": "If set, the activity options will be restored to the defaults.\nDefault options are then options activity was created with.\nThey are part of the first SCHEDULE event."
|
|
7410
7689
|
}
|
|
7411
7690
|
}
|
|
7412
7691
|
},
|
|
@@ -7437,7 +7716,7 @@
|
|
|
7437
7716
|
},
|
|
7438
7717
|
"resetReapplyType": {
|
|
7439
7718
|
"$ref": "#/definitions/v1ResetReapplyType",
|
|
7440
|
-
"title": "
|
|
7719
|
+
"title": "Deprecated. Use `options`.\nDefault: RESET_REAPPLY_TYPE_SIGNAL"
|
|
7441
7720
|
},
|
|
7442
7721
|
"resetReapplyExcludeTypes": {
|
|
7443
7722
|
"type": "array",
|
|
@@ -7453,6 +7732,10 @@
|
|
|
7453
7732
|
"$ref": "#/definitions/v1PostResetOperation"
|
|
7454
7733
|
},
|
|
7455
7734
|
"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"
|
|
7735
|
+
},
|
|
7736
|
+
"identity": {
|
|
7737
|
+
"type": "string",
|
|
7738
|
+
"title": "The identity of the worker/client"
|
|
7456
7739
|
}
|
|
7457
7740
|
}
|
|
7458
7741
|
},
|
|
@@ -7764,7 +8047,7 @@
|
|
|
7764
8047
|
},
|
|
7765
8048
|
"control": {
|
|
7766
8049
|
"type": "string",
|
|
7767
|
-
"
|
|
8050
|
+
"description": "Deprecated."
|
|
7768
8051
|
},
|
|
7769
8052
|
"retryPolicy": {
|
|
7770
8053
|
"$ref": "#/definitions/v1RetryPolicy",
|
|
@@ -7835,7 +8118,7 @@
|
|
|
7835
8118
|
},
|
|
7836
8119
|
"control": {
|
|
7837
8120
|
"type": "string",
|
|
7838
|
-
"
|
|
8121
|
+
"description": "Deprecated."
|
|
7839
8122
|
},
|
|
7840
8123
|
"header": {
|
|
7841
8124
|
"$ref": "#/definitions/v1Header",
|
|
@@ -8144,6 +8427,10 @@
|
|
|
8144
8427
|
"type": {
|
|
8145
8428
|
"type": "string",
|
|
8146
8429
|
"description": "Update all running activities of this type."
|
|
8430
|
+
},
|
|
8431
|
+
"restoreOriginal": {
|
|
8432
|
+
"type": "boolean",
|
|
8433
|
+
"description": "If set, the activity options will be restored to the default.\nDefault options are then options activity was created with.\nThey are part of the first SCHEDULE event.\nThis flag cannot be combined with any other option; if you supply\nrestore_original together with other options, the request will be rejected."
|
|
8147
8434
|
}
|
|
8148
8435
|
}
|
|
8149
8436
|
},
|
|
@@ -8221,6 +8508,10 @@
|
|
|
8221
8508
|
"type": "string"
|
|
8222
8509
|
},
|
|
8223
8510
|
"description": "List of keys to remove from the metadata."
|
|
8511
|
+
},
|
|
8512
|
+
"identity": {
|
|
8513
|
+
"type": "string",
|
|
8514
|
+
"description": "Optional. The identity of the client who initiated this request."
|
|
8224
8515
|
}
|
|
8225
8516
|
},
|
|
8226
8517
|
"description": "Used to update the user-defined metadata of a Worker Deployment Version."
|
|
@@ -8917,11 +9208,11 @@
|
|
|
8917
9208
|
},
|
|
8918
9209
|
"resetType": {
|
|
8919
9210
|
"$ref": "#/definitions/v1ResetType",
|
|
8920
|
-
"description": "
|
|
9211
|
+
"description": "Deprecated. Use `options`."
|
|
8921
9212
|
},
|
|
8922
9213
|
"resetReapplyType": {
|
|
8923
9214
|
"$ref": "#/definitions/v1ResetReapplyType",
|
|
8924
|
-
"description": "
|
|
9215
|
+
"description": "Deprecated. Use `options`."
|
|
8925
9216
|
},
|
|
8926
9217
|
"postResetOperations": {
|
|
8927
9218
|
"type": "array",
|
|
@@ -9220,7 +9511,7 @@
|
|
|
9220
9511
|
},
|
|
9221
9512
|
"operationId": {
|
|
9222
9513
|
"type": "string",
|
|
9223
|
-
"description": "Operation ID as originally generated by a Handler.\n\nDeprecated
|
|
9514
|
+
"description": "Operation ID as originally generated by a Handler.\n\nDeprecated. Renamed to operation_token."
|
|
9224
9515
|
},
|
|
9225
9516
|
"operationToken": {
|
|
9226
9517
|
"type": "string",
|
|
@@ -9695,7 +9986,7 @@
|
|
|
9695
9986
|
},
|
|
9696
9987
|
"inheritBuildId": {
|
|
9697
9988
|
"type": "boolean",
|
|
9698
|
-
"description": "If this is set, the new execution inherits the Build ID of the current execution. Otherwise,\nthe assignment rules will be used to independently assign a Build ID to the new execution."
|
|
9989
|
+
"description": "If this is set, the new execution inherits the Build ID of the current execution. Otherwise,\nthe assignment rules will be used to independently assign a Build ID to the new execution.\nDeprecated. Only considered for versioning v0.2."
|
|
9699
9990
|
}
|
|
9700
9991
|
}
|
|
9701
9992
|
},
|
|
@@ -10027,23 +10318,26 @@
|
|
|
10027
10318
|
"items": {
|
|
10028
10319
|
"type": "object",
|
|
10029
10320
|
"$ref": "#/definitions/v1PollerInfo"
|
|
10030
|
-
}
|
|
10031
|
-
|
|
10321
|
+
}
|
|
10322
|
+
},
|
|
10323
|
+
"stats": {
|
|
10324
|
+
"$ref": "#/definitions/v1TaskQueueStats",
|
|
10325
|
+
"description": "Statistics for the task queue. Only populated when `report_stats` is set to true in the request."
|
|
10326
|
+
},
|
|
10327
|
+
"versioningInfo": {
|
|
10328
|
+
"$ref": "#/definitions/v1TaskQueueVersioningInfo",
|
|
10329
|
+
"description": "Specifies which Worker Deployment Version(s) Server routes this Task Queue's tasks to.\nWhen not present, it means the tasks are routed to Unversioned workers (workers with\nUNVERSIONED or unspecified WorkerVersioningMode.)\nTask Queue Versioning info is updated indirectly by calling SetWorkerDeploymentCurrentVersion\nand SetWorkerDeploymentRampingVersion on Worker Deployments.\nNote: This information is not relevant to Pinned workflow executions and their activities as\nthey are always routed to their Pinned Deployment Version. However, new workflow executions\nare typically not Pinned until they complete their first task (unless they are started with\na Pinned VersioningOverride or are Child Workflows of a Pinned parent)."
|
|
10032
10330
|
},
|
|
10033
10331
|
"taskQueueStatus": {
|
|
10034
10332
|
"$ref": "#/definitions/v1TaskQueueStatus",
|
|
10035
|
-
"description": "Deprecated.
|
|
10333
|
+
"description": "Deprecated.\nStatus of the task queue. Only populated when `include_task_queue_status` is set to true in the request."
|
|
10036
10334
|
},
|
|
10037
10335
|
"versionsInfo": {
|
|
10038
10336
|
"type": "object",
|
|
10039
10337
|
"additionalProperties": {
|
|
10040
10338
|
"$ref": "#/definitions/v1TaskQueueVersionInfo"
|
|
10041
10339
|
},
|
|
10042
|
-
"description": "
|
|
10043
|
-
},
|
|
10044
|
-
"versioningInfo": {
|
|
10045
|
-
"$ref": "#/definitions/v1TaskQueueVersioningInfo",
|
|
10046
|
-
"description": "Specifies which Worker Deployment Version(s) Server routes this Task Queue's tasks to.\nWhen not present, it means the tasks are routed to Unversioned workers (workers with\nUNVERSIONED or unspecified WorkerVersioningMode.)\nTask Queue Versioning info is updated indirectly by calling SetWorkerDeploymentCurrentVersion\nand SetWorkerDeploymentRampingVersion on Worker Deployments.\nNote: This information is not relevant to Pinned workflow executions and their activities as\nthey are always routed to their Pinned Deployment Version. However, new workflow executions\nare typically not Pinned until they complete their first task (unless they are started with\na Pinned VersioningOverride or are Child Workflows of a Pinned parent)."
|
|
10340
|
+
"description": "Deprecated.\nOnly returned in ENHANCED mode.\nThis map contains Task Queue information for each Build ID. Empty string as key value means unversioned."
|
|
10047
10341
|
}
|
|
10048
10342
|
}
|
|
10049
10343
|
},
|
|
@@ -10065,6 +10359,14 @@
|
|
|
10065
10359
|
"properties": {
|
|
10066
10360
|
"workerDeploymentVersionInfo": {
|
|
10067
10361
|
"$ref": "#/definitions/v1WorkerDeploymentVersionInfo"
|
|
10362
|
+
},
|
|
10363
|
+
"versionTaskQueues": {
|
|
10364
|
+
"type": "array",
|
|
10365
|
+
"items": {
|
|
10366
|
+
"type": "object",
|
|
10367
|
+
"$ref": "#/definitions/DescribeWorkerDeploymentVersionResponseVersionTaskQueue"
|
|
10368
|
+
},
|
|
10369
|
+
"description": "All the Task Queues that have ever polled from this Deployment version."
|
|
10068
10370
|
}
|
|
10069
10371
|
}
|
|
10070
10372
|
},
|
|
@@ -10324,7 +10626,7 @@
|
|
|
10324
10626
|
},
|
|
10325
10627
|
"control": {
|
|
10326
10628
|
"type": "string",
|
|
10327
|
-
"
|
|
10629
|
+
"description": "Deprecated."
|
|
10328
10630
|
}
|
|
10329
10631
|
}
|
|
10330
10632
|
},
|
|
@@ -11113,6 +11415,23 @@
|
|
|
11113
11415
|
}
|
|
11114
11416
|
}
|
|
11115
11417
|
},
|
|
11418
|
+
"v1ListWorkersResponse": {
|
|
11419
|
+
"type": "object",
|
|
11420
|
+
"properties": {
|
|
11421
|
+
"workersInfo": {
|
|
11422
|
+
"type": "array",
|
|
11423
|
+
"items": {
|
|
11424
|
+
"type": "object",
|
|
11425
|
+
"$ref": "#/definitions/v1WorkerInfo"
|
|
11426
|
+
}
|
|
11427
|
+
},
|
|
11428
|
+
"nextPageToken": {
|
|
11429
|
+
"type": "string",
|
|
11430
|
+
"format": "byte",
|
|
11431
|
+
"title": "Next page token"
|
|
11432
|
+
}
|
|
11433
|
+
}
|
|
11434
|
+
},
|
|
11116
11435
|
"v1ListWorkflowExecutionsResponse": {
|
|
11117
11436
|
"type": "object",
|
|
11118
11437
|
"properties": {
|
|
@@ -11642,7 +11961,7 @@
|
|
|
11642
11961
|
},
|
|
11643
11962
|
"operationId": {
|
|
11644
11963
|
"type": "string",
|
|
11645
|
-
"description": "Operation ID - may be empty if the operation completed synchronously.\n\nDeprecated
|
|
11964
|
+
"description": "Operation ID - may be empty if the operation completed synchronously.\n\nDeprecated. Renamed to operation_token."
|
|
11646
11965
|
},
|
|
11647
11966
|
"operationToken": {
|
|
11648
11967
|
"type": "string",
|
|
@@ -11850,15 +12169,15 @@
|
|
|
11850
12169
|
"useWorkflowBuildId": {
|
|
11851
12170
|
"type": "object",
|
|
11852
12171
|
"properties": {},
|
|
11853
|
-
"description": "When present, it means this activity is assigned to the build ID of its workflow."
|
|
12172
|
+
"description": "Deprecated. When present, it means this activity is assigned to the build ID of its workflow."
|
|
11854
12173
|
},
|
|
11855
12174
|
"lastIndependentlyAssignedBuildId": {
|
|
11856
12175
|
"type": "string",
|
|
11857
|
-
"description": "This means the activity is independently versioned and not bound to the build ID of its workflow.\nThe activity will use the build id in this field instead.\nIf the task fails and is scheduled again, the assigned build ID may change according to the latest versioning\nrules."
|
|
12176
|
+
"description": "Deprecated. This means the activity is independently versioned and not bound to the build ID of its workflow.\nThe activity will use the build id in this field instead.\nIf the task fails and is scheduled again, the assigned build ID may change according to the latest versioning\nrules."
|
|
11858
12177
|
},
|
|
11859
12178
|
"lastWorkerVersionStamp": {
|
|
11860
12179
|
"$ref": "#/definitions/v1WorkerVersionStamp",
|
|
11861
|
-
"title": "The version stamp of the worker to whom this activity was most recently dispatched\
|
|
12180
|
+
"title": "Deprecated. The version stamp of the worker to whom this activity was most recently dispatched\nThis field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]"
|
|
11862
12181
|
},
|
|
11863
12182
|
"currentRetryInterval": {
|
|
11864
12183
|
"type": "string",
|
|
@@ -11955,7 +12274,7 @@
|
|
|
11955
12274
|
},
|
|
11956
12275
|
"operationId": {
|
|
11957
12276
|
"type": "string",
|
|
11958
|
-
"description": "Operation ID. Only set for asynchronous operations after a successful StartOperation call.\n\nDeprecated
|
|
12277
|
+
"description": "Operation ID. Only set for asynchronous operations after a successful StartOperation call.\n\nDeprecated. Renamed to operation_token."
|
|
11959
12278
|
},
|
|
11960
12279
|
"scheduleToCloseTimeout": {
|
|
11961
12280
|
"type": "string",
|
|
@@ -12446,6 +12765,9 @@
|
|
|
12446
12765
|
}
|
|
12447
12766
|
}
|
|
12448
12767
|
},
|
|
12768
|
+
"v1RecordWorkerHeartbeatResponse": {
|
|
12769
|
+
"type": "object"
|
|
12770
|
+
},
|
|
12449
12771
|
"v1RegisterNamespaceRequest": {
|
|
12450
12772
|
"type": "object",
|
|
12451
12773
|
"properties": {
|
|
@@ -12598,7 +12920,7 @@
|
|
|
12598
12920
|
},
|
|
12599
12921
|
"control": {
|
|
12600
12922
|
"type": "string",
|
|
12601
|
-
"
|
|
12923
|
+
"description": "Deprecated."
|
|
12602
12924
|
}
|
|
12603
12925
|
}
|
|
12604
12926
|
},
|
|
@@ -12622,7 +12944,7 @@
|
|
|
12622
12944
|
},
|
|
12623
12945
|
"control": {
|
|
12624
12946
|
"type": "string",
|
|
12625
|
-
"
|
|
12947
|
+
"description": "Deprecated."
|
|
12626
12948
|
},
|
|
12627
12949
|
"childWorkflowOnly": {
|
|
12628
12950
|
"type": "boolean",
|
|
@@ -12693,7 +13015,7 @@
|
|
|
12693
13015
|
},
|
|
12694
13016
|
"resetReapplyType": {
|
|
12695
13017
|
"$ref": "#/definitions/v1ResetReapplyType",
|
|
12696
|
-
"title": "
|
|
13018
|
+
"title": "Deprecated. Use `options`.\nDefault: RESET_REAPPLY_TYPE_SIGNAL"
|
|
12697
13019
|
},
|
|
12698
13020
|
"currentRunOnly": {
|
|
12699
13021
|
"type": "boolean",
|
|
@@ -12718,7 +13040,7 @@
|
|
|
12718
13040
|
},
|
|
12719
13041
|
"binaryChecksum": {
|
|
12720
13042
|
"type": "string",
|
|
12721
|
-
"description": "A worker binary version identifier
|
|
13043
|
+
"description": "Deprecated. A worker binary version identifier."
|
|
12722
13044
|
},
|
|
12723
13045
|
"runId": {
|
|
12724
13046
|
"type": "string",
|
|
@@ -12778,7 +13100,7 @@
|
|
|
12778
13100
|
"RESET_REAPPLY_TYPE_ALL_ELIGIBLE"
|
|
12779
13101
|
],
|
|
12780
13102
|
"default": "RESET_REAPPLY_TYPE_UNSPECIFIED",
|
|
12781
|
-
"description": "
|
|
13103
|
+
"description": "Deprecated: applications should use ResetReapplyExcludeType to specify\nexclusions from this set, and new event types should be added to ResetReapplyExcludeType\ninstead of here.\n\n - RESET_REAPPLY_TYPE_SIGNAL: Signals are reapplied when workflow is reset.\n - RESET_REAPPLY_TYPE_NONE: No events are reapplied when workflow is reset.\n - RESET_REAPPLY_TYPE_ALL_ELIGIBLE: All eligible events are reapplied when workflow is reset."
|
|
12782
13104
|
},
|
|
12783
13105
|
"v1ResetStickyTaskQueueResponse": {
|
|
12784
13106
|
"type": "object"
|
|
@@ -12791,7 +13113,7 @@
|
|
|
12791
13113
|
"RESET_TYPE_LAST_WORKFLOW_TASK"
|
|
12792
13114
|
],
|
|
12793
13115
|
"default": "RESET_TYPE_UNSPECIFIED",
|
|
12794
|
-
"description": "
|
|
13116
|
+
"description": "Deprecated, see temporal.api.common.v1.ResetOptions.\n\n - RESET_TYPE_FIRST_WORKFLOW_TASK: Resets to event of the first workflow task completed, or if it does not exist, the event after task scheduled.\n - RESET_TYPE_LAST_WORKFLOW_TASK: Resets to event of the last workflow task completed, or if it does not exist, the event after task scheduled."
|
|
12795
13117
|
},
|
|
12796
13118
|
"v1ResetWorkflowExecutionResponse": {
|
|
12797
13119
|
"type": "object",
|
|
@@ -13157,7 +13479,8 @@
|
|
|
13157
13479
|
"format": "date-time"
|
|
13158
13480
|
},
|
|
13159
13481
|
"invalidScheduleError": {
|
|
13160
|
-
"type": "string"
|
|
13482
|
+
"type": "string",
|
|
13483
|
+
"description": "Deprecated."
|
|
13161
13484
|
}
|
|
13162
13485
|
}
|
|
13163
13486
|
},
|
|
@@ -13346,7 +13669,7 @@
|
|
|
13346
13669
|
"type": "object",
|
|
13347
13670
|
"$ref": "#/definitions/v1CalendarSpec"
|
|
13348
13671
|
},
|
|
13349
|
-
"description": "Any timestamps matching any of exclude_* will be skipped.\
|
|
13672
|
+
"description": "Any timestamps matching any of exclude_* will be skipped.\nDeprecated. Use exclude_structured_calendar."
|
|
13350
13673
|
},
|
|
13351
13674
|
"excludeStructuredCalendar": {
|
|
13352
13675
|
"type": "array",
|
|
@@ -13557,7 +13880,7 @@
|
|
|
13557
13880
|
},
|
|
13558
13881
|
"control": {
|
|
13559
13882
|
"type": "string",
|
|
13560
|
-
"
|
|
13883
|
+
"description": "Deprecated."
|
|
13561
13884
|
}
|
|
13562
13885
|
}
|
|
13563
13886
|
},
|
|
@@ -13589,7 +13912,7 @@
|
|
|
13589
13912
|
},
|
|
13590
13913
|
"control": {
|
|
13591
13914
|
"type": "string",
|
|
13592
|
-
"
|
|
13915
|
+
"description": "Deprecated."
|
|
13593
13916
|
},
|
|
13594
13917
|
"childWorkflowOnly": {
|
|
13595
13918
|
"type": "boolean",
|
|
@@ -13678,7 +14001,7 @@
|
|
|
13678
14001
|
},
|
|
13679
14002
|
"inheritBuildId": {
|
|
13680
14003
|
"type": "boolean",
|
|
13681
|
-
"description": "If this is set, the child workflow inherits the Build ID of the parent. Otherwise, the assignment\nrules of the child's Task Queue will be used to independently assign a Build ID to it."
|
|
14004
|
+
"description": "If this is set, the child workflow inherits the Build ID of the parent. Otherwise, the assignment\nrules of the child's Task Queue will be used to independently assign a Build ID to it.\nDeprecated. Only considered for versioning v0.2."
|
|
13682
14005
|
},
|
|
13683
14006
|
"priority": {
|
|
13684
14007
|
"$ref": "#/definitions/v1Priority",
|
|
@@ -13716,7 +14039,7 @@
|
|
|
13716
14039
|
},
|
|
13717
14040
|
"control": {
|
|
13718
14041
|
"type": "string",
|
|
13719
|
-
"
|
|
14042
|
+
"description": "Deprecated."
|
|
13720
14043
|
},
|
|
13721
14044
|
"initiatedEventId": {
|
|
13722
14045
|
"type": "string",
|
|
@@ -13770,7 +14093,7 @@
|
|
|
13770
14093
|
},
|
|
13771
14094
|
"control": {
|
|
13772
14095
|
"type": "string",
|
|
13773
|
-
"
|
|
14096
|
+
"description": "Deprecated."
|
|
13774
14097
|
},
|
|
13775
14098
|
"workflowTaskCompletedEventId": {
|
|
13776
14099
|
"type": "string",
|
|
@@ -13799,7 +14122,7 @@
|
|
|
13799
14122
|
},
|
|
13800
14123
|
"inheritBuildId": {
|
|
13801
14124
|
"type": "boolean",
|
|
13802
|
-
"description": "If this is set, the child workflow inherits the Build ID of the parent. Otherwise, the assignment\nrules of the child's Task Queue will be used to independently assign a Build ID to it."
|
|
14125
|
+
"description": "If this is set, the child workflow inherits the Build ID of the parent. Otherwise, the assignment\nrules of the child's Task Queue will be used to independently assign a Build ID to it.\nDeprecated. Only considered for versioning v0.2."
|
|
13803
14126
|
},
|
|
13804
14127
|
"priority": {
|
|
13805
14128
|
"$ref": "#/definitions/v1Priority",
|
|
@@ -14466,6 +14789,11 @@
|
|
|
14466
14789
|
"overlapPolicy": {
|
|
14467
14790
|
"$ref": "#/definitions/v1ScheduleOverlapPolicy",
|
|
14468
14791
|
"description": "If set, override overlap policy for this one request."
|
|
14792
|
+
},
|
|
14793
|
+
"scheduledTime": {
|
|
14794
|
+
"type": "string",
|
|
14795
|
+
"format": "date-time",
|
|
14796
|
+
"description": "Timestamp used for the identity of the target workflow.\nIf not set the default value is the current time."
|
|
14469
14797
|
}
|
|
14470
14798
|
}
|
|
14471
14799
|
},
|
|
@@ -14834,7 +15162,7 @@
|
|
|
14834
15162
|
"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`."
|
|
14835
15163
|
}
|
|
14836
15164
|
},
|
|
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."
|
|
15165
|
+
"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.\nPinned overrides are automatically inherited by child workflows, continue-as-new workflows,\nworkflow retries, and cron workflows."
|
|
14838
15166
|
},
|
|
14839
15167
|
"v1WaitPolicy": {
|
|
14840
15168
|
"type": "object",
|
|
@@ -14914,6 +15242,10 @@
|
|
|
14914
15242
|
"type": "string",
|
|
14915
15243
|
"description": "Deprecated. Use `deployment_version`."
|
|
14916
15244
|
},
|
|
15245
|
+
"status": {
|
|
15246
|
+
"$ref": "#/definitions/v1WorkerDeploymentVersionStatus",
|
|
15247
|
+
"description": "The status of the Worker Deployment Version."
|
|
15248
|
+
},
|
|
14917
15249
|
"deploymentVersion": {
|
|
14918
15250
|
"$ref": "#/definitions/v1WorkerDeploymentVersion",
|
|
14919
15251
|
"description": "Required."
|
|
@@ -14933,12 +15265,22 @@
|
|
|
14933
15265
|
"currentSinceTime": {
|
|
14934
15266
|
"type": "string",
|
|
14935
15267
|
"format": "date-time",
|
|
14936
|
-
"description": "\
|
|
15268
|
+
"description": "\nUnset if not current."
|
|
14937
15269
|
},
|
|
14938
15270
|
"rampingSinceTime": {
|
|
14939
15271
|
"type": "string",
|
|
14940
15272
|
"format": "date-time",
|
|
14941
|
-
"description": "\
|
|
15273
|
+
"description": "\nUnset if not ramping. Updated when the version first starts ramping, not on each ramp change."
|
|
15274
|
+
},
|
|
15275
|
+
"firstActivationTime": {
|
|
15276
|
+
"type": "string",
|
|
15277
|
+
"format": "date-time",
|
|
15278
|
+
"description": "Timestamp when this version first became current or ramping."
|
|
15279
|
+
},
|
|
15280
|
+
"lastDeactivationTime": {
|
|
15281
|
+
"type": "string",
|
|
15282
|
+
"format": "date-time",
|
|
15283
|
+
"description": "Timestamp when this version last stopped being current or ramping."
|
|
14942
15284
|
},
|
|
14943
15285
|
"rampPercentage": {
|
|
14944
15286
|
"type": "number",
|
|
@@ -14951,7 +15293,7 @@
|
|
|
14951
15293
|
"type": "object",
|
|
14952
15294
|
"$ref": "#/definitions/WorkerDeploymentVersionInfoVersionTaskQueueInfo"
|
|
14953
15295
|
},
|
|
14954
|
-
"description": "All the Task Queues that have ever polled from this Deployment version."
|
|
15296
|
+
"description": "All the Task Queues that have ever polled from this Deployment version.\nDeprecated. Use `version_task_queues` in DescribeWorkerDeploymentVersionResponse instead."
|
|
14955
15297
|
},
|
|
14956
15298
|
"drainageInfo": {
|
|
14957
15299
|
"$ref": "#/definitions/v1VersionDrainageInfo",
|
|
@@ -14964,6 +15306,210 @@
|
|
|
14964
15306
|
},
|
|
14965
15307
|
"description": "A Worker Deployment Version (Version, for short) represents all workers of the same \ncode and config within a Deployment. Workers of the same Version are expected to \nbehave exactly the same so when executions move between them there are no \nnon-determinism issues.\nWorker Deployment Versions are created in Temporal server automatically when \ntheir first poller arrives to the server.\nExperimental. Worker Deployments are experimental and might significantly change in the future."
|
|
14966
15308
|
},
|
|
15309
|
+
"v1WorkerDeploymentVersionStatus": {
|
|
15310
|
+
"type": "string",
|
|
15311
|
+
"enum": [
|
|
15312
|
+
"WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED",
|
|
15313
|
+
"WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE",
|
|
15314
|
+
"WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT",
|
|
15315
|
+
"WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING",
|
|
15316
|
+
"WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING",
|
|
15317
|
+
"WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED"
|
|
15318
|
+
],
|
|
15319
|
+
"default": "WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED",
|
|
15320
|
+
"description": "Specify the status of a Worker Deployment Version.\nExperimental. Worker Deployments are experimental and might significantly change in the future.\n\n - WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE: The Worker Deployment Version has been created inside the Worker Deployment but is not used by any\nworkflow executions. These Versions can still have workflows if they have an explicit Versioning Override targeting\nthis Version. Such Versioning Override could be set at workflow start time, or at a later time via `UpdateWorkflowExecutionOptions`.\n - WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT: The Worker Deployment Version is the current version of the Worker Deployment. All new workflow executions \nand tasks of existing unversioned or AutoUpgrade workflows are routed to this version.\n - WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING: The Worker Deployment Version is the ramping version of the Worker Deployment. A subset of new Pinned workflow executions are \nrouted to this version. Moreover, a portion of existing unversioned or AutoUpgrade workflow executions are also routed to this version.\n - WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING: The Worker Deployment Version is not used by new workflows but is still used by\nopen pinned workflows. The version cannot be decommissioned safely.\n - WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED: The Worker Deployment Version is not used by new or open workflows, but might be still needed by\nQueries sent to closed workflows. The version can be decommissioned safely if user does\nnot query closed workflows. If the user does query closed workflows for some time x after\nworkflows are closed, they should decommission the version after it has been drained for that duration."
|
|
15321
|
+
},
|
|
15322
|
+
"v1WorkerHeartbeat": {
|
|
15323
|
+
"type": "object",
|
|
15324
|
+
"properties": {
|
|
15325
|
+
"workerInstanceKey": {
|
|
15326
|
+
"type": "string",
|
|
15327
|
+
"description": "Worker identifier, should be unique for the namespace.\nIt is distinct from worker identity, which is not necessarily namespace-unique."
|
|
15328
|
+
},
|
|
15329
|
+
"workerIdentity": {
|
|
15330
|
+
"type": "string",
|
|
15331
|
+
"description": "Worker identity, set by the client, may not be unique.\nUsually host_name+(user group name)+process_id, but can be overwritten by the user."
|
|
15332
|
+
},
|
|
15333
|
+
"hostInfo": {
|
|
15334
|
+
"$ref": "#/definitions/v1WorkerHostInfo",
|
|
15335
|
+
"description": "Worker host information."
|
|
15336
|
+
},
|
|
15337
|
+
"taskQueue": {
|
|
15338
|
+
"type": "string",
|
|
15339
|
+
"description": "Task queue this worker is polling for tasks."
|
|
15340
|
+
},
|
|
15341
|
+
"deploymentVersion": {
|
|
15342
|
+
"$ref": "#/definitions/v1WorkerDeploymentVersion"
|
|
15343
|
+
},
|
|
15344
|
+
"sdkName": {
|
|
15345
|
+
"type": "string"
|
|
15346
|
+
},
|
|
15347
|
+
"sdkVersion": {
|
|
15348
|
+
"type": "string"
|
|
15349
|
+
},
|
|
15350
|
+
"status": {
|
|
15351
|
+
"$ref": "#/definitions/v1WorkerStatus",
|
|
15352
|
+
"description": "Worker status. Defined by SDK."
|
|
15353
|
+
},
|
|
15354
|
+
"startTime": {
|
|
15355
|
+
"type": "string",
|
|
15356
|
+
"format": "date-time",
|
|
15357
|
+
"title": "Worker start time.\nIt can be used to determine worker uptime. (current time - start time)"
|
|
15358
|
+
},
|
|
15359
|
+
"heartbeatTime": {
|
|
15360
|
+
"type": "string",
|
|
15361
|
+
"format": "date-time",
|
|
15362
|
+
"description": "Timestamp of this heartbeat, coming from the worker. Worker should set it to \"now\".\nNote that this timestamp comes directly from the worker and is subject to workers' clock skew."
|
|
15363
|
+
},
|
|
15364
|
+
"elapsedSinceLastHeartbeat": {
|
|
15365
|
+
"type": "string",
|
|
15366
|
+
"description": "Elapsed time since the last heartbeat from the worker."
|
|
15367
|
+
},
|
|
15368
|
+
"workflowTaskSlotsInfo": {
|
|
15369
|
+
"$ref": "#/definitions/v1WorkerSlotsInfo"
|
|
15370
|
+
},
|
|
15371
|
+
"activityTaskSlotsInfo": {
|
|
15372
|
+
"$ref": "#/definitions/v1WorkerSlotsInfo"
|
|
15373
|
+
},
|
|
15374
|
+
"nexusTaskSlotsInfo": {
|
|
15375
|
+
"$ref": "#/definitions/v1WorkerSlotsInfo"
|
|
15376
|
+
},
|
|
15377
|
+
"localActivitySlotsInfo": {
|
|
15378
|
+
"$ref": "#/definitions/v1WorkerSlotsInfo"
|
|
15379
|
+
},
|
|
15380
|
+
"workflowPollerInfo": {
|
|
15381
|
+
"$ref": "#/definitions/v1WorkerPollerInfo"
|
|
15382
|
+
},
|
|
15383
|
+
"workflowStickyPollerInfo": {
|
|
15384
|
+
"$ref": "#/definitions/v1WorkerPollerInfo"
|
|
15385
|
+
},
|
|
15386
|
+
"activityPollerInfo": {
|
|
15387
|
+
"$ref": "#/definitions/v1WorkerPollerInfo"
|
|
15388
|
+
},
|
|
15389
|
+
"nexusPollerInfo": {
|
|
15390
|
+
"$ref": "#/definitions/v1WorkerPollerInfo"
|
|
15391
|
+
},
|
|
15392
|
+
"totalStickyCacheHit": {
|
|
15393
|
+
"type": "integer",
|
|
15394
|
+
"format": "int32",
|
|
15395
|
+
"description": "A Workflow Task found a cached Workflow Execution to run against."
|
|
15396
|
+
},
|
|
15397
|
+
"totalStickyCacheMiss": {
|
|
15398
|
+
"type": "integer",
|
|
15399
|
+
"format": "int32",
|
|
15400
|
+
"description": "A Workflow Task did not find a cached Workflow execution to run against."
|
|
15401
|
+
},
|
|
15402
|
+
"currentStickyCacheSize": {
|
|
15403
|
+
"type": "integer",
|
|
15404
|
+
"format": "int32",
|
|
15405
|
+
"description": "Current cache size, expressed in number of Workflow Executions."
|
|
15406
|
+
}
|
|
15407
|
+
},
|
|
15408
|
+
"description": "Worker info message, contains information about the worker and its current state.\nAll information is provided by the worker itself."
|
|
15409
|
+
},
|
|
15410
|
+
"v1WorkerHostInfo": {
|
|
15411
|
+
"type": "object",
|
|
15412
|
+
"properties": {
|
|
15413
|
+
"hostName": {
|
|
15414
|
+
"type": "string",
|
|
15415
|
+
"description": "Worker host identifier."
|
|
15416
|
+
},
|
|
15417
|
+
"processKey": {
|
|
15418
|
+
"type": "string",
|
|
15419
|
+
"title": "Worker process identifier. This id should be unique for all _processes_\nrunning workers in the namespace, and should be shared by all workers\nin the same process.\nThis will be used to build the worker command nexus task queue name:\n\"temporal-sys/worker-commands/{process_key}\""
|
|
15420
|
+
},
|
|
15421
|
+
"processId": {
|
|
15422
|
+
"type": "string",
|
|
15423
|
+
"description": "Worker process identifier. Unlike process_key, this id only needs to be unique\nwithin one host (so using e.g. a unix pid would be appropriate)."
|
|
15424
|
+
},
|
|
15425
|
+
"currentHostCpuUsage": {
|
|
15426
|
+
"type": "number",
|
|
15427
|
+
"format": "float",
|
|
15428
|
+
"description": "System used CPU as a float in the range [0.0, 1.0] where 1.0 is defined as all\ncores on the host pegged."
|
|
15429
|
+
},
|
|
15430
|
+
"currentHostMemUsage": {
|
|
15431
|
+
"type": "number",
|
|
15432
|
+
"format": "float",
|
|
15433
|
+
"description": "System used memory as a float in the range [0.0, 1.0] where 1.0 is defined as\nall available memory on the host is used."
|
|
15434
|
+
}
|
|
15435
|
+
},
|
|
15436
|
+
"title": "Holds everything needed to identify the worker host/process context"
|
|
15437
|
+
},
|
|
15438
|
+
"v1WorkerInfo": {
|
|
15439
|
+
"type": "object",
|
|
15440
|
+
"properties": {
|
|
15441
|
+
"workerHeartbeat": {
|
|
15442
|
+
"$ref": "#/definitions/v1WorkerHeartbeat"
|
|
15443
|
+
}
|
|
15444
|
+
}
|
|
15445
|
+
},
|
|
15446
|
+
"v1WorkerPollerInfo": {
|
|
15447
|
+
"type": "object",
|
|
15448
|
+
"properties": {
|
|
15449
|
+
"currentPollers": {
|
|
15450
|
+
"type": "integer",
|
|
15451
|
+
"format": "int32",
|
|
15452
|
+
"description": "Number of polling RPCs that are currently in flight."
|
|
15453
|
+
},
|
|
15454
|
+
"lastSuccessfulPollTime": {
|
|
15455
|
+
"type": "string",
|
|
15456
|
+
"format": "date-time"
|
|
15457
|
+
},
|
|
15458
|
+
"isAutoscaling": {
|
|
15459
|
+
"type": "boolean",
|
|
15460
|
+
"title": "Set true if the number of concurrent pollers is auto-scaled"
|
|
15461
|
+
}
|
|
15462
|
+
}
|
|
15463
|
+
},
|
|
15464
|
+
"v1WorkerSlotsInfo": {
|
|
15465
|
+
"type": "object",
|
|
15466
|
+
"properties": {
|
|
15467
|
+
"currentAvailableSlots": {
|
|
15468
|
+
"type": "integer",
|
|
15469
|
+
"format": "int32",
|
|
15470
|
+
"description": "Number of slots available for the worker to specific tasks.\nMay be -1 if the upper bound is not known."
|
|
15471
|
+
},
|
|
15472
|
+
"currentUsedSlots": {
|
|
15473
|
+
"type": "integer",
|
|
15474
|
+
"format": "int32",
|
|
15475
|
+
"description": "Number of slots used by the worker for specific tasks."
|
|
15476
|
+
},
|
|
15477
|
+
"slotSupplierKind": {
|
|
15478
|
+
"type": "string",
|
|
15479
|
+
"title": "Kind of the slot supplier, which is used to determine how the slots are allocated.\nPossible values: \"Fixed | ResourceBased | Custom String\""
|
|
15480
|
+
},
|
|
15481
|
+
"totalProcessedTasks": {
|
|
15482
|
+
"type": "integer",
|
|
15483
|
+
"format": "int32",
|
|
15484
|
+
"description": "Total number of tasks processed (completed both successfully and unsuccesfully, or any other way)\nby the worker since the worker started. This is a cumulative counter."
|
|
15485
|
+
},
|
|
15486
|
+
"totalFailedTasks": {
|
|
15487
|
+
"type": "integer",
|
|
15488
|
+
"format": "int32",
|
|
15489
|
+
"description": "Total number of failed tasks processed by the worker so far."
|
|
15490
|
+
},
|
|
15491
|
+
"lastIntervalProcessedTasks": {
|
|
15492
|
+
"type": "integer",
|
|
15493
|
+
"format": "int32",
|
|
15494
|
+
"description": "Number of tasks processed in since the last heartbeat from the worker.\nThis is a cumulative counter, and it is reset to 0 each time the worker sends a heartbeat.\nContains both successful and failed tasks."
|
|
15495
|
+
},
|
|
15496
|
+
"lastIntervalFailureTasks": {
|
|
15497
|
+
"type": "integer",
|
|
15498
|
+
"format": "int32",
|
|
15499
|
+
"description": "Number of failed tasks processed since the last heartbeat from the worker."
|
|
15500
|
+
}
|
|
15501
|
+
}
|
|
15502
|
+
},
|
|
15503
|
+
"v1WorkerStatus": {
|
|
15504
|
+
"type": "string",
|
|
15505
|
+
"enum": [
|
|
15506
|
+
"WORKER_STATUS_UNSPECIFIED",
|
|
15507
|
+
"WORKER_STATUS_RUNNING",
|
|
15508
|
+
"WORKER_STATUS_SHUTTING_DOWN",
|
|
15509
|
+
"WORKER_STATUS_SHUTDOWN"
|
|
15510
|
+
],
|
|
15511
|
+
"default": "WORKER_STATUS_UNSPECIFIED"
|
|
15512
|
+
},
|
|
14967
15513
|
"v1WorkerVersionCapabilities": {
|
|
14968
15514
|
"type": "object",
|
|
14969
15515
|
"properties": {
|
|
@@ -15146,7 +15692,7 @@
|
|
|
15146
15692
|
},
|
|
15147
15693
|
"inheritBuildId": {
|
|
15148
15694
|
"type": "boolean",
|
|
15149
|
-
"description": "If this is set, the new execution inherits the Build ID of the current execution. Otherwise,\nthe assignment rules will be used to independently assign a Build ID to the new execution."
|
|
15695
|
+
"description": "If this is set, the new execution inherits the Build ID of the current execution. Otherwise,\nthe assignment rules will be used to independently assign a Build ID to the new execution.\nDeprecated. Only considered for versioning v0.2."
|
|
15150
15696
|
}
|
|
15151
15697
|
}
|
|
15152
15698
|
},
|
|
@@ -15367,11 +15913,11 @@
|
|
|
15367
15913
|
},
|
|
15368
15914
|
"header": {
|
|
15369
15915
|
"$ref": "#/definitions/v1Header",
|
|
15370
|
-
"description": "Headers that were passed by the sender of the signal and copied by temporal
|
|
15916
|
+
"description": "Headers that were passed by the sender of the signal and copied by temporal\nserver into the workflow task."
|
|
15371
15917
|
},
|
|
15372
15918
|
"skipGenerateWorkflowTask": {
|
|
15373
15919
|
"type": "boolean",
|
|
15374
|
-
"description": "This field is
|
|
15920
|
+
"description": "Deprecated. This field is never respected and should always be set to false."
|
|
15375
15921
|
},
|
|
15376
15922
|
"externalWorkflowExecution": {
|
|
15377
15923
|
"$ref": "#/definitions/v1WorkflowExecution",
|
|
@@ -15422,7 +15968,7 @@
|
|
|
15422
15968
|
},
|
|
15423
15969
|
"continuedExecutionRunId": {
|
|
15424
15970
|
"type": "string",
|
|
15425
|
-
"description": "Run id of the previous workflow which continued-as-new or
|
|
15971
|
+
"description": "Run id of the previous workflow which continued-as-new or retried or cron executed into this\nworkflow."
|
|
15426
15972
|
},
|
|
15427
15973
|
"initiator": {
|
|
15428
15974
|
"$ref": "#/definitions/v1ContinueAsNewInitiator"
|
|
@@ -15509,19 +16055,19 @@
|
|
|
15509
16055
|
},
|
|
15510
16056
|
"versioningOverride": {
|
|
15511
16057
|
"$ref": "#/definitions/v1VersioningOverride",
|
|
15512
|
-
"description": "Versioning override applied to this workflow when it was started."
|
|
16058
|
+
"description": "Versioning override applied to this workflow when it was started.\nChildren, crons, retries, and continue-as-new will inherit source run's override if pinned\nand if the new workflow's Task Queue belongs to the override version."
|
|
15513
16059
|
},
|
|
15514
16060
|
"parentPinnedWorkerDeploymentVersion": {
|
|
15515
16061
|
"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 `
|
|
15517
|
-
},
|
|
15518
|
-
"parentPinnedDeploymentVersion": {
|
|
15519
|
-
"$ref": "#/definitions/v1WorkerDeploymentVersion",
|
|
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."
|
|
16062
|
+
"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_versioning_info`."
|
|
15521
16063
|
},
|
|
15522
16064
|
"priority": {
|
|
15523
16065
|
"$ref": "#/definitions/v1Priority",
|
|
15524
16066
|
"title": "Priority metadata"
|
|
16067
|
+
},
|
|
16068
|
+
"inheritedPinnedVersion": {
|
|
16069
|
+
"$ref": "#/definitions/v1WorkerDeploymentVersion",
|
|
16070
|
+
"description": "If present, the new workflow should start on this version with pinned base behavior.\nChild of pinned parent will inherit the parent's version if the Child's Task Queue belongs to that version.\n\nNew run initiated by workflow ContinueAsNew of pinned run, will inherit the previous run's version if the\nnew run's Task Queue belongs to that version.\n\nNew run initiated by workflow Cron will never inherit.\n\nNew run initiated by workflow Retry will only inherit if the retried run is effectively pinned at the time\nof retry, and the retried run inherited a pinned version when it started (ie. it is a child of a pinned\nparent, or a CaN of a pinned run, and is running on a Task Queue in the inherited version).\n\nPinned override is inherited if Task Queue of new run is compatible with the override version.\nOverride is inherited separately and takes precedence over inherited base version."
|
|
15525
16071
|
}
|
|
15526
16072
|
},
|
|
15527
16073
|
"title": "Always the first event in workflow history"
|
|
@@ -15653,7 +16199,7 @@
|
|
|
15653
16199
|
"properties": {
|
|
15654
16200
|
"behavior": {
|
|
15655
16201
|
"$ref": "#/definitions/v1VersioningBehavior",
|
|
15656
|
-
"description": "Versioning behavior determines how the server should treat this execution when workers are\nupgraded. When present it means this workflow execution is versioned; UNSPECIFIED means\nunversioned. See the comments in `VersioningBehavior` enum for more info about different\nbehaviors.\nThis field is first set after an execution completes its first workflow task on a versioned\nworker, and set again on completion of every subsequent workflow task.\nFor child workflows of Pinned parents, this will be set to Pinned (along with `
|
|
16202
|
+
"description": "Versioning behavior determines how the server should treat this execution when workers are\nupgraded. When present it means this workflow execution is versioned; UNSPECIFIED means\nunversioned. See the comments in `VersioningBehavior` enum for more info about different\nbehaviors.\nThis field is first set after an execution completes its first workflow task on a versioned\nworker, and set again on completion of every subsequent workflow task.\nFor child workflows of Pinned parents, this will be set to Pinned (along with `deployment_version`) when\nthe the child starts so that child's first workflow task goes to the same Version as the\nparent. After the first workflow task, it depends on the child workflow itself if it wants\nto stay pinned or become unpinned (according to Versioning Behavior set in the worker).\nNote that `behavior` is overridden by `versioning_override` if the latter is present."
|
|
15657
16203
|
},
|
|
15658
16204
|
"deployment": {
|
|
15659
16205
|
"$ref": "#/definitions/v1Deployment",
|
|
@@ -15669,7 +16215,7 @@
|
|
|
15669
16215
|
},
|
|
15670
16216
|
"versioningOverride": {
|
|
15671
16217
|
"$ref": "#/definitions/v1VersioningOverride",
|
|
15672
|
-
"description": "Present if user has set an execution-specific versioning override. This override takes\nprecedence over SDK-sent `behavior` (and `version` when override is PINNED). An\noverride can be set when starting a new execution, as well as afterwards by calling the\n`UpdateWorkflowExecutionOptions` API.\nPinned overrides are automatically inherited by child workflows."
|
|
16218
|
+
"description": "Present if user has set an execution-specific versioning override. This override takes\nprecedence over SDK-sent `behavior` (and `version` when override is PINNED). An\noverride can be set when starting a new execution, as well as afterwards by calling the\n`UpdateWorkflowExecutionOptions` API.\nPinned overrides are automatically inherited by child workflows, continue-as-new workflows,\nworkflow retries, and cron workflows."
|
|
15673
16219
|
},
|
|
15674
16220
|
"deploymentTransition": {
|
|
15675
16221
|
"$ref": "#/definitions/v1DeploymentTransition",
|
|
@@ -15677,7 +16223,7 @@
|
|
|
15677
16223
|
},
|
|
15678
16224
|
"versionTransition": {
|
|
15679
16225
|
"$ref": "#/definitions/v1DeploymentVersionTransition",
|
|
15680
|
-
"description": "When present, indicates the workflow is transitioning to a different deployment version\n(which may belong to the same deployment name or another). Can indicate one of the following\ntransitions: unversioned -> versioned, versioned -> versioned\non a different deployment version, or versioned -> unversioned.\nNot applicable to workflows with PINNED behavior.\nWhen a workflow with AUTO_UPGRADE behavior creates a new workflow task, it will automatically\nstart a transition to the task queue's current version if the task queue's current version is\ndifferent from the workflow's current deployment version.\nIf the AUTO_UPGRADE workflow is stuck due to backlogged activity or workflow tasks, those\ntasks will be redirected to the task queue's current version. As soon as a poller from\nthat deployment version is available to receive the task, the workflow will automatically\nstart a transition to that version and continue execution there.\nA version transition can only exist while there is a pending or started workflow task.\nOnce the pending workflow task completes on the transition's target version, the\ntransition completes and the workflow's `behavior`, and `
|
|
16226
|
+
"description": "When present, indicates the workflow is transitioning to a different deployment version\n(which may belong to the same deployment name or another). Can indicate one of the following\ntransitions: unversioned -> versioned, versioned -> versioned\non a different deployment version, or versioned -> unversioned.\nNot applicable to workflows with PINNED behavior.\nWhen a workflow with AUTO_UPGRADE behavior creates a new workflow task, it will automatically\nstart a transition to the task queue's current version if the task queue's current version is\ndifferent from the workflow's current deployment version.\nIf the AUTO_UPGRADE workflow is stuck due to backlogged activity or workflow tasks, those\ntasks will be redirected to the task queue's current version. As soon as a poller from\nthat deployment version is available to receive the task, the workflow will automatically\nstart a transition to that version and continue execution there.\nA version transition can only exist while there is a pending or started workflow task.\nOnce the pending workflow task completes on the transition's target version, the\ntransition completes and the workflow's `behavior`, and `deployment_version` fields are updated per the\nworker's task completion response.\nPending activities will not start new attempts during a transition. Once the transition is\ncompleted, pending activities will start their next attempt on the new version."
|
|
15681
16227
|
}
|
|
15682
16228
|
},
|
|
15683
16229
|
"description": "Holds all the information about worker versioning for a particular workflow execution.\nExperimental. Versioning info is experimental and might change in the future."
|
|
@@ -15968,10 +16514,11 @@
|
|
|
15968
16514
|
"WORKFLOW_TASK_FAILED_CAUSE_BAD_SCHEDULE_NEXUS_OPERATION_ATTRIBUTES",
|
|
15969
16515
|
"WORKFLOW_TASK_FAILED_CAUSE_PENDING_NEXUS_OPERATIONS_LIMIT_EXCEEDED",
|
|
15970
16516
|
"WORKFLOW_TASK_FAILED_CAUSE_BAD_REQUEST_CANCEL_NEXUS_OPERATION_ATTRIBUTES",
|
|
15971
|
-
"WORKFLOW_TASK_FAILED_CAUSE_FEATURE_DISABLED"
|
|
16517
|
+
"WORKFLOW_TASK_FAILED_CAUSE_FEATURE_DISABLED",
|
|
16518
|
+
"WORKFLOW_TASK_FAILED_CAUSE_GRPC_MESSAGE_TOO_LARGE"
|
|
15972
16519
|
],
|
|
15973
16520
|
"default": "WORKFLOW_TASK_FAILED_CAUSE_UNSPECIFIED",
|
|
15974
|
-
"description": "Workflow tasks can fail for various reasons. Note that some of these reasons can only originate\nfrom the server, and some of them can only originate from the SDK/worker.\n\n - WORKFLOW_TASK_FAILED_CAUSE_UNHANDLED_COMMAND: Between starting and completing the workflow task (with a workflow completion command), some\nnew command (like a signal) was processed into workflow history. The outstanding task will be\nfailed with this reason, and a worker must pick up a new task.\n - WORKFLOW_TASK_FAILED_CAUSE_RESET_STICKY_TASK_QUEUE: The worker wishes to fail the task and have the next one be generated on a normal, not sticky\nqueue. Generally workers should prefer to use the explicit `ResetStickyTaskQueue` RPC call.\n - WORKFLOW_TASK_FAILED_CAUSE_NON_DETERMINISTIC_ERROR: The worker encountered a mismatch while replaying history between what was expected, and\nwhat the workflow code actually did.\n - WORKFLOW_TASK_FAILED_CAUSE_PENDING_CHILD_WORKFLOWS_LIMIT_EXCEEDED: We send the below error codes to users when their requests would violate a size constraint\nof their workflow. We do this to ensure that the state of their workflow does not become too\nlarge because that can cause severe performance degradation. You can modify the thresholds for\neach of these errors within your dynamic config.\n\nSpawning a new child workflow would cause this workflow to exceed its limit of pending child\nworkflows.\n - WORKFLOW_TASK_FAILED_CAUSE_PENDING_ACTIVITIES_LIMIT_EXCEEDED: Starting a new activity would cause this workflow to exceed its limit of pending activities\nthat we track.\n - WORKFLOW_TASK_FAILED_CAUSE_PENDING_SIGNALS_LIMIT_EXCEEDED: A workflow has a buffer of signals that have not yet reached their destination. We return this\nerror when sending a new signal would exceed the capacity of this buffer.\n - WORKFLOW_TASK_FAILED_CAUSE_PENDING_REQUEST_CANCEL_LIMIT_EXCEEDED: Similarly, we have a buffer of pending requests to cancel other workflows. We return this error\nwhen our capacity for pending cancel requests is already reached.\n - WORKFLOW_TASK_FAILED_CAUSE_BAD_UPDATE_WORKFLOW_EXECUTION_MESSAGE: Workflow execution update message (update.Acceptance, update.Rejection, or update.Response)\nhas wrong format, or missing required fields.\n - WORKFLOW_TASK_FAILED_CAUSE_UNHANDLED_UPDATE: Similar to WORKFLOW_TASK_FAILED_CAUSE_UNHANDLED_COMMAND, but for updates.\n - WORKFLOW_TASK_FAILED_CAUSE_BAD_SCHEDULE_NEXUS_OPERATION_ATTRIBUTES: A workflow task completed with an invalid ScheduleNexusOperation command.\n - WORKFLOW_TASK_FAILED_CAUSE_PENDING_NEXUS_OPERATIONS_LIMIT_EXCEEDED: A workflow task completed requesting to schedule a Nexus Operation exceeding the server configured limit.\n - WORKFLOW_TASK_FAILED_CAUSE_BAD_REQUEST_CANCEL_NEXUS_OPERATION_ATTRIBUTES: A workflow task completed with an invalid RequestCancelNexusOperation command.\n - WORKFLOW_TASK_FAILED_CAUSE_FEATURE_DISABLED: A workflow task completed requesting a feature that's disabled on the server (either system wide or - typically -\nfor the workflow's namespace).\nCheck the workflow task failure message for more information."
|
|
16521
|
+
"description": "Workflow tasks can fail for various reasons. Note that some of these reasons can only originate\nfrom the server, and some of them can only originate from the SDK/worker.\n\n - WORKFLOW_TASK_FAILED_CAUSE_UNHANDLED_COMMAND: Between starting and completing the workflow task (with a workflow completion command), some\nnew command (like a signal) was processed into workflow history. The outstanding task will be\nfailed with this reason, and a worker must pick up a new task.\n - WORKFLOW_TASK_FAILED_CAUSE_RESET_STICKY_TASK_QUEUE: The worker wishes to fail the task and have the next one be generated on a normal, not sticky\nqueue. Generally workers should prefer to use the explicit `ResetStickyTaskQueue` RPC call.\n - WORKFLOW_TASK_FAILED_CAUSE_NON_DETERMINISTIC_ERROR: The worker encountered a mismatch while replaying history between what was expected, and\nwhat the workflow code actually did.\n - WORKFLOW_TASK_FAILED_CAUSE_PENDING_CHILD_WORKFLOWS_LIMIT_EXCEEDED: We send the below error codes to users when their requests would violate a size constraint\nof their workflow. We do this to ensure that the state of their workflow does not become too\nlarge because that can cause severe performance degradation. You can modify the thresholds for\neach of these errors within your dynamic config.\n\nSpawning a new child workflow would cause this workflow to exceed its limit of pending child\nworkflows.\n - WORKFLOW_TASK_FAILED_CAUSE_PENDING_ACTIVITIES_LIMIT_EXCEEDED: Starting a new activity would cause this workflow to exceed its limit of pending activities\nthat we track.\n - WORKFLOW_TASK_FAILED_CAUSE_PENDING_SIGNALS_LIMIT_EXCEEDED: A workflow has a buffer of signals that have not yet reached their destination. We return this\nerror when sending a new signal would exceed the capacity of this buffer.\n - WORKFLOW_TASK_FAILED_CAUSE_PENDING_REQUEST_CANCEL_LIMIT_EXCEEDED: Similarly, we have a buffer of pending requests to cancel other workflows. We return this error\nwhen our capacity for pending cancel requests is already reached.\n - WORKFLOW_TASK_FAILED_CAUSE_BAD_UPDATE_WORKFLOW_EXECUTION_MESSAGE: Workflow execution update message (update.Acceptance, update.Rejection, or update.Response)\nhas wrong format, or missing required fields.\n - WORKFLOW_TASK_FAILED_CAUSE_UNHANDLED_UPDATE: Similar to WORKFLOW_TASK_FAILED_CAUSE_UNHANDLED_COMMAND, but for updates.\n - WORKFLOW_TASK_FAILED_CAUSE_BAD_SCHEDULE_NEXUS_OPERATION_ATTRIBUTES: A workflow task completed with an invalid ScheduleNexusOperation command.\n - WORKFLOW_TASK_FAILED_CAUSE_PENDING_NEXUS_OPERATIONS_LIMIT_EXCEEDED: A workflow task completed requesting to schedule a Nexus Operation exceeding the server configured limit.\n - WORKFLOW_TASK_FAILED_CAUSE_BAD_REQUEST_CANCEL_NEXUS_OPERATION_ATTRIBUTES: A workflow task completed with an invalid RequestCancelNexusOperation command.\n - WORKFLOW_TASK_FAILED_CAUSE_FEATURE_DISABLED: A workflow task completed requesting a feature that's disabled on the server (either system wide or - typically -\nfor the workflow's namespace).\nCheck the workflow task failure message for more information.\n - WORKFLOW_TASK_FAILED_CAUSE_GRPC_MESSAGE_TOO_LARGE: A workflow task failed because a grpc message was too large."
|
|
15975
16522
|
},
|
|
15976
16523
|
"v1WorkflowTaskFailedEventAttributes": {
|
|
15977
16524
|
"type": "object",
|
|
@@ -16012,7 +16559,7 @@
|
|
|
16012
16559
|
},
|
|
16013
16560
|
"binaryChecksum": {
|
|
16014
16561
|
"type": "string",
|
|
16015
|
-
"title": "
|
|
16562
|
+
"title": "Deprecated. 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"
|
|
16016
16563
|
},
|
|
16017
16564
|
"workerVersion": {
|
|
16018
16565
|
"$ref": "#/definitions/v1WorkerVersionStamp",
|