@temporalio/core-bridge 1.12.1 → 1.12.3
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/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/callback_based.rs +123 -0
- package/sdk-core/client/src/lib.rs +113 -36
- package/sdk-core/client/src/metrics.rs +89 -27
- package/sdk-core/client/src/raw.rs +73 -16
- package/sdk-core/client/src/retry.rs +12 -3
- 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 +12 -1
- package/sdk-core/core/src/pollers/poll_buffer.rs +64 -16
- 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 +72 -5
- package/sdk-core/core/src/worker/heartbeat.rs +231 -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 +51 -0
- package/sdk-core/core-c-bridge/build.rs +26 -0
- package/sdk-core/core-c-bridge/include/temporal-sdk-core-c-bridge.h +922 -0
- package/sdk-core/core-c-bridge/src/client.rs +936 -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 +655 -0
- package/sdk-core/core-c-bridge/src/tests/mod.rs +354 -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_cloud_upstream/CODEOWNERS +1 -1
- package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/README.md +1 -1
- package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/VERSION +1 -1
- package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/buf.yaml +1 -0
- package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/cloudservice/v1/request_response.proto +83 -0
- package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/cloudservice/v1/service.proto +37 -0
- package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/connectivityrule/v1/message.proto +64 -0
- package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/identity/v1/message.proto +3 -1
- package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/namespace/v1/message.proto +10 -0
- package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/operation/v1/message.proto +1 -0
- 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 +1285 -103
- package/sdk-core/sdk-core-protos/protos/api_upstream/openapi/openapiv3.yaml +1290 -122
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/batch/v1/message.proto +64 -6
- 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 +86 -17
- 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/batch_operation.proto +3 -0
- 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/enums/v1/task_queue.proto +11 -0
- 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 +52 -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/sdk/v1/task_complete_metadata.proto +1 -1
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/sdk/v1/worker_config.proto +36 -0
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/taskqueue/v1/message.proto +29 -0
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/worker/v1/message.proto +144 -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 +268 -39
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflowservice/v1/service.proto +62 -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 +100 -6
- package/sdk-core/test-utils/Cargo.toml +1 -0
- package/sdk-core/test-utils/src/lib.rs +101 -6
- package/sdk-core/tests/cloud_tests.rs +11 -74
- package/sdk-core/tests/heavy_tests.rs +11 -3
- package/sdk-core/tests/integ_tests/client_tests.rs +22 -19
- 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 +8 -3
- package/sdk-core/tests/integ_tests/worker_versioning_tests.rs +3 -7
- package/sdk-core/tests/integ_tests/workflow_tests/activities.rs +13 -0
- 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/sdk-core/tests/integ_tests/workflow_tests/priority.rs +2 -108
- package/sdk-core/tests/main.rs +3 -0
- package/sdk-core/tests/shared_tests/mod.rs +43 -0
- package/sdk-core/tests/shared_tests/priority.rs +155 -0
- package/src/client.rs +11 -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,30 @@
|
|
|
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
|
+
},
|
|
1532
|
+
{
|
|
1533
|
+
"name": "reportConfig",
|
|
1534
|
+
"description": "Report Task Queue Config",
|
|
1535
|
+
"in": "query",
|
|
1536
|
+
"required": false,
|
|
1537
|
+
"type": "boolean"
|
|
1538
|
+
},
|
|
1525
1539
|
{
|
|
1526
1540
|
"name": "includeTaskQueueStatus",
|
|
1527
|
-
"description": "Deprecated
|
|
1541
|
+
"description": "Deprecated, use `report_stats` instead.\nIf true, the task queue status will be included in the response.",
|
|
1528
1542
|
"in": "query",
|
|
1529
1543
|
"required": false,
|
|
1530
1544
|
"type": "boolean"
|
|
1531
1545
|
},
|
|
1532
1546
|
{
|
|
1533
1547
|
"name": "apiMode",
|
|
1534
|
-
"description": "
|
|
1548
|
+
"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
1549
|
"in": "query",
|
|
1536
1550
|
"required": false,
|
|
1537
1551
|
"type": "string",
|
|
@@ -1568,7 +1582,7 @@
|
|
|
1568
1582
|
},
|
|
1569
1583
|
{
|
|
1570
1584
|
"name": "taskQueueTypes",
|
|
1571
|
-
"description": "
|
|
1585
|
+
"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
1586
|
"in": "query",
|
|
1573
1587
|
"required": false,
|
|
1574
1588
|
"type": "array",
|
|
@@ -1583,23 +1597,16 @@
|
|
|
1583
1597
|
},
|
|
1584
1598
|
"collectionFormat": "multi"
|
|
1585
1599
|
},
|
|
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
1600
|
{
|
|
1594
1601
|
"name": "reportPollers",
|
|
1595
|
-
"description": "
|
|
1602
|
+
"description": "Deprecated (as part of the ENHANCED mode deprecation).\nReport list of pollers for requested task queue types and versions.",
|
|
1596
1603
|
"in": "query",
|
|
1597
1604
|
"required": false,
|
|
1598
1605
|
"type": "boolean"
|
|
1599
1606
|
},
|
|
1600
1607
|
{
|
|
1601
1608
|
"name": "reportTaskReachability",
|
|
1602
|
-
"description": "
|
|
1609
|
+
"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
1610
|
"in": "query",
|
|
1604
1611
|
"required": false,
|
|
1605
1612
|
"type": "boolean"
|
|
@@ -1610,6 +1617,52 @@
|
|
|
1610
1617
|
]
|
|
1611
1618
|
}
|
|
1612
1619
|
},
|
|
1620
|
+
"/api/v1/namespaces/{namespace}/task-queues/{taskQueue}/update-config": {
|
|
1621
|
+
"post": {
|
|
1622
|
+
"summary": "Updates task queue configuration.\nFor the overall queue rate limit: the rate limit set by this api overrides the worker-set rate limit,\nwhich uncouples the rate limit from the worker lifecycle.\nIf the overall queue rate limit is unset, the worker-set rate limit takes effect.",
|
|
1623
|
+
"operationId": "UpdateTaskQueueConfig2",
|
|
1624
|
+
"responses": {
|
|
1625
|
+
"200": {
|
|
1626
|
+
"description": "A successful response.",
|
|
1627
|
+
"schema": {
|
|
1628
|
+
"$ref": "#/definitions/v1UpdateTaskQueueConfigResponse"
|
|
1629
|
+
}
|
|
1630
|
+
},
|
|
1631
|
+
"default": {
|
|
1632
|
+
"description": "An unexpected error response.",
|
|
1633
|
+
"schema": {
|
|
1634
|
+
"$ref": "#/definitions/rpcStatus"
|
|
1635
|
+
}
|
|
1636
|
+
}
|
|
1637
|
+
},
|
|
1638
|
+
"parameters": [
|
|
1639
|
+
{
|
|
1640
|
+
"name": "namespace",
|
|
1641
|
+
"in": "path",
|
|
1642
|
+
"required": true,
|
|
1643
|
+
"type": "string"
|
|
1644
|
+
},
|
|
1645
|
+
{
|
|
1646
|
+
"name": "taskQueue",
|
|
1647
|
+
"description": "Selects the task queue to update.",
|
|
1648
|
+
"in": "path",
|
|
1649
|
+
"required": true,
|
|
1650
|
+
"type": "string"
|
|
1651
|
+
},
|
|
1652
|
+
{
|
|
1653
|
+
"name": "body",
|
|
1654
|
+
"in": "body",
|
|
1655
|
+
"required": true,
|
|
1656
|
+
"schema": {
|
|
1657
|
+
"$ref": "#/definitions/WorkflowServiceUpdateTaskQueueConfigBody"
|
|
1658
|
+
}
|
|
1659
|
+
}
|
|
1660
|
+
],
|
|
1661
|
+
"tags": [
|
|
1662
|
+
"WorkflowService"
|
|
1663
|
+
]
|
|
1664
|
+
}
|
|
1665
|
+
},
|
|
1613
1666
|
"/api/v1/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility": {
|
|
1614
1667
|
"get": {
|
|
1615
1668
|
"summary": "Deprecated. Use `GetWorkerVersioningRules`.\nFetches the worker build id versioning sets for a task queue.",
|
|
@@ -1777,6 +1830,13 @@
|
|
|
1777
1830
|
"in": "query",
|
|
1778
1831
|
"required": false,
|
|
1779
1832
|
"type": "string"
|
|
1833
|
+
},
|
|
1834
|
+
{
|
|
1835
|
+
"name": "reportTaskQueueStats",
|
|
1836
|
+
"description": "Report stats for task queues which have been polled by this version.",
|
|
1837
|
+
"in": "query",
|
|
1838
|
+
"required": false,
|
|
1839
|
+
"type": "boolean"
|
|
1780
1840
|
}
|
|
1781
1841
|
],
|
|
1782
1842
|
"tags": [
|
|
@@ -2184,6 +2244,178 @@
|
|
|
2184
2244
|
]
|
|
2185
2245
|
}
|
|
2186
2246
|
},
|
|
2247
|
+
"/api/v1/namespaces/{namespace}/workers": {
|
|
2248
|
+
"get": {
|
|
2249
|
+
"summary": "ListWorkers is a visibility API to list worker status information in a specific namespace.",
|
|
2250
|
+
"operationId": "ListWorkers2",
|
|
2251
|
+
"responses": {
|
|
2252
|
+
"200": {
|
|
2253
|
+
"description": "A successful response.",
|
|
2254
|
+
"schema": {
|
|
2255
|
+
"$ref": "#/definitions/v1ListWorkersResponse"
|
|
2256
|
+
}
|
|
2257
|
+
},
|
|
2258
|
+
"default": {
|
|
2259
|
+
"description": "An unexpected error response.",
|
|
2260
|
+
"schema": {
|
|
2261
|
+
"$ref": "#/definitions/rpcStatus"
|
|
2262
|
+
}
|
|
2263
|
+
}
|
|
2264
|
+
},
|
|
2265
|
+
"parameters": [
|
|
2266
|
+
{
|
|
2267
|
+
"name": "namespace",
|
|
2268
|
+
"in": "path",
|
|
2269
|
+
"required": true,
|
|
2270
|
+
"type": "string"
|
|
2271
|
+
},
|
|
2272
|
+
{
|
|
2273
|
+
"name": "pageSize",
|
|
2274
|
+
"in": "query",
|
|
2275
|
+
"required": false,
|
|
2276
|
+
"type": "integer",
|
|
2277
|
+
"format": "int32"
|
|
2278
|
+
},
|
|
2279
|
+
{
|
|
2280
|
+
"name": "nextPageToken",
|
|
2281
|
+
"in": "query",
|
|
2282
|
+
"required": false,
|
|
2283
|
+
"type": "string",
|
|
2284
|
+
"format": "byte"
|
|
2285
|
+
},
|
|
2286
|
+
{
|
|
2287
|
+
"name": "query",
|
|
2288
|
+
"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.",
|
|
2289
|
+
"in": "query",
|
|
2290
|
+
"required": false,
|
|
2291
|
+
"type": "string"
|
|
2292
|
+
}
|
|
2293
|
+
],
|
|
2294
|
+
"tags": [
|
|
2295
|
+
"WorkflowService"
|
|
2296
|
+
]
|
|
2297
|
+
}
|
|
2298
|
+
},
|
|
2299
|
+
"/api/v1/namespaces/{namespace}/workers/fetch-config": {
|
|
2300
|
+
"post": {
|
|
2301
|
+
"summary": "FetchWorkerConfig returns the worker configuration for a specific worker.",
|
|
2302
|
+
"operationId": "FetchWorkerConfig2",
|
|
2303
|
+
"responses": {
|
|
2304
|
+
"200": {
|
|
2305
|
+
"description": "A successful response.",
|
|
2306
|
+
"schema": {
|
|
2307
|
+
"$ref": "#/definitions/v1FetchWorkerConfigResponse"
|
|
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
|
+
"description": "Namespace this worker belongs to.",
|
|
2321
|
+
"in": "path",
|
|
2322
|
+
"required": true,
|
|
2323
|
+
"type": "string"
|
|
2324
|
+
},
|
|
2325
|
+
{
|
|
2326
|
+
"name": "body",
|
|
2327
|
+
"in": "body",
|
|
2328
|
+
"required": true,
|
|
2329
|
+
"schema": {
|
|
2330
|
+
"$ref": "#/definitions/WorkflowServiceFetchWorkerConfigBody"
|
|
2331
|
+
}
|
|
2332
|
+
}
|
|
2333
|
+
],
|
|
2334
|
+
"tags": [
|
|
2335
|
+
"WorkflowService"
|
|
2336
|
+
]
|
|
2337
|
+
}
|
|
2338
|
+
},
|
|
2339
|
+
"/api/v1/namespaces/{namespace}/workers/heartbeat": {
|
|
2340
|
+
"post": {
|
|
2341
|
+
"summary": "WorkerHeartbeat receive heartbeat request from the worker.",
|
|
2342
|
+
"operationId": "RecordWorkerHeartbeat2",
|
|
2343
|
+
"responses": {
|
|
2344
|
+
"200": {
|
|
2345
|
+
"description": "A successful response.",
|
|
2346
|
+
"schema": {
|
|
2347
|
+
"$ref": "#/definitions/v1RecordWorkerHeartbeatResponse"
|
|
2348
|
+
}
|
|
2349
|
+
},
|
|
2350
|
+
"default": {
|
|
2351
|
+
"description": "An unexpected error response.",
|
|
2352
|
+
"schema": {
|
|
2353
|
+
"$ref": "#/definitions/rpcStatus"
|
|
2354
|
+
}
|
|
2355
|
+
}
|
|
2356
|
+
},
|
|
2357
|
+
"parameters": [
|
|
2358
|
+
{
|
|
2359
|
+
"name": "namespace",
|
|
2360
|
+
"description": "Namespace this worker belongs to.",
|
|
2361
|
+
"in": "path",
|
|
2362
|
+
"required": true,
|
|
2363
|
+
"type": "string"
|
|
2364
|
+
},
|
|
2365
|
+
{
|
|
2366
|
+
"name": "body",
|
|
2367
|
+
"in": "body",
|
|
2368
|
+
"required": true,
|
|
2369
|
+
"schema": {
|
|
2370
|
+
"$ref": "#/definitions/WorkflowServiceRecordWorkerHeartbeatBody"
|
|
2371
|
+
}
|
|
2372
|
+
}
|
|
2373
|
+
],
|
|
2374
|
+
"tags": [
|
|
2375
|
+
"WorkflowService"
|
|
2376
|
+
]
|
|
2377
|
+
}
|
|
2378
|
+
},
|
|
2379
|
+
"/api/v1/namespaces/{namespace}/workers/update-config": {
|
|
2380
|
+
"post": {
|
|
2381
|
+
"summary": "UpdateWorkerConfig updates the worker configuration of one or more workers.\nCan be used to partially update the worker configuration.\nCan be used to update the configuration of multiple workers.",
|
|
2382
|
+
"operationId": "UpdateWorkerConfig2",
|
|
2383
|
+
"responses": {
|
|
2384
|
+
"200": {
|
|
2385
|
+
"description": "A successful response.",
|
|
2386
|
+
"schema": {
|
|
2387
|
+
"$ref": "#/definitions/v1UpdateWorkerConfigResponse"
|
|
2388
|
+
}
|
|
2389
|
+
},
|
|
2390
|
+
"default": {
|
|
2391
|
+
"description": "An unexpected error response.",
|
|
2392
|
+
"schema": {
|
|
2393
|
+
"$ref": "#/definitions/rpcStatus"
|
|
2394
|
+
}
|
|
2395
|
+
}
|
|
2396
|
+
},
|
|
2397
|
+
"parameters": [
|
|
2398
|
+
{
|
|
2399
|
+
"name": "namespace",
|
|
2400
|
+
"description": "Namespace this worker belongs to.",
|
|
2401
|
+
"in": "path",
|
|
2402
|
+
"required": true,
|
|
2403
|
+
"type": "string"
|
|
2404
|
+
},
|
|
2405
|
+
{
|
|
2406
|
+
"name": "body",
|
|
2407
|
+
"in": "body",
|
|
2408
|
+
"required": true,
|
|
2409
|
+
"schema": {
|
|
2410
|
+
"$ref": "#/definitions/WorkflowServiceUpdateWorkerConfigBody"
|
|
2411
|
+
}
|
|
2412
|
+
}
|
|
2413
|
+
],
|
|
2414
|
+
"tags": [
|
|
2415
|
+
"WorkflowService"
|
|
2416
|
+
]
|
|
2417
|
+
}
|
|
2418
|
+
},
|
|
2187
2419
|
"/api/v1/namespaces/{namespace}/workflow-count": {
|
|
2188
2420
|
"get": {
|
|
2189
2421
|
"summary": "CountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.",
|
|
@@ -5058,7 +5290,7 @@
|
|
|
5058
5290
|
},
|
|
5059
5291
|
{
|
|
5060
5292
|
"name": "taskQueueType",
|
|
5061
|
-
"description": "
|
|
5293
|
+
"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
5294
|
"in": "query",
|
|
5063
5295
|
"required": false,
|
|
5064
5296
|
"type": "string",
|
|
@@ -5070,16 +5302,30 @@
|
|
|
5070
5302
|
],
|
|
5071
5303
|
"default": "TASK_QUEUE_TYPE_UNSPECIFIED"
|
|
5072
5304
|
},
|
|
5305
|
+
{
|
|
5306
|
+
"name": "reportStats",
|
|
5307
|
+
"description": "Report stats for the requested task queue type(s).",
|
|
5308
|
+
"in": "query",
|
|
5309
|
+
"required": false,
|
|
5310
|
+
"type": "boolean"
|
|
5311
|
+
},
|
|
5312
|
+
{
|
|
5313
|
+
"name": "reportConfig",
|
|
5314
|
+
"description": "Report Task Queue Config",
|
|
5315
|
+
"in": "query",
|
|
5316
|
+
"required": false,
|
|
5317
|
+
"type": "boolean"
|
|
5318
|
+
},
|
|
5073
5319
|
{
|
|
5074
5320
|
"name": "includeTaskQueueStatus",
|
|
5075
|
-
"description": "Deprecated
|
|
5321
|
+
"description": "Deprecated, use `report_stats` instead.\nIf true, the task queue status will be included in the response.",
|
|
5076
5322
|
"in": "query",
|
|
5077
5323
|
"required": false,
|
|
5078
5324
|
"type": "boolean"
|
|
5079
5325
|
},
|
|
5080
5326
|
{
|
|
5081
5327
|
"name": "apiMode",
|
|
5082
|
-
"description": "
|
|
5328
|
+
"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
5329
|
"in": "query",
|
|
5084
5330
|
"required": false,
|
|
5085
5331
|
"type": "string",
|
|
@@ -5116,7 +5362,7 @@
|
|
|
5116
5362
|
},
|
|
5117
5363
|
{
|
|
5118
5364
|
"name": "taskQueueTypes",
|
|
5119
|
-
"description": "
|
|
5365
|
+
"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
5366
|
"in": "query",
|
|
5121
5367
|
"required": false,
|
|
5122
5368
|
"type": "array",
|
|
@@ -5131,23 +5377,16 @@
|
|
|
5131
5377
|
},
|
|
5132
5378
|
"collectionFormat": "multi"
|
|
5133
5379
|
},
|
|
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
5380
|
{
|
|
5142
5381
|
"name": "reportPollers",
|
|
5143
|
-
"description": "
|
|
5382
|
+
"description": "Deprecated (as part of the ENHANCED mode deprecation).\nReport list of pollers for requested task queue types and versions.",
|
|
5144
5383
|
"in": "query",
|
|
5145
5384
|
"required": false,
|
|
5146
5385
|
"type": "boolean"
|
|
5147
5386
|
},
|
|
5148
5387
|
{
|
|
5149
5388
|
"name": "reportTaskReachability",
|
|
5150
|
-
"description": "
|
|
5389
|
+
"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
5390
|
"in": "query",
|
|
5152
5391
|
"required": false,
|
|
5153
5392
|
"type": "boolean"
|
|
@@ -5158,6 +5397,52 @@
|
|
|
5158
5397
|
]
|
|
5159
5398
|
}
|
|
5160
5399
|
},
|
|
5400
|
+
"/namespaces/{namespace}/task-queues/{taskQueue}/update-config": {
|
|
5401
|
+
"post": {
|
|
5402
|
+
"summary": "Updates task queue configuration.\nFor the overall queue rate limit: the rate limit set by this api overrides the worker-set rate limit,\nwhich uncouples the rate limit from the worker lifecycle.\nIf the overall queue rate limit is unset, the worker-set rate limit takes effect.",
|
|
5403
|
+
"operationId": "UpdateTaskQueueConfig",
|
|
5404
|
+
"responses": {
|
|
5405
|
+
"200": {
|
|
5406
|
+
"description": "A successful response.",
|
|
5407
|
+
"schema": {
|
|
5408
|
+
"$ref": "#/definitions/v1UpdateTaskQueueConfigResponse"
|
|
5409
|
+
}
|
|
5410
|
+
},
|
|
5411
|
+
"default": {
|
|
5412
|
+
"description": "An unexpected error response.",
|
|
5413
|
+
"schema": {
|
|
5414
|
+
"$ref": "#/definitions/rpcStatus"
|
|
5415
|
+
}
|
|
5416
|
+
}
|
|
5417
|
+
},
|
|
5418
|
+
"parameters": [
|
|
5419
|
+
{
|
|
5420
|
+
"name": "namespace",
|
|
5421
|
+
"in": "path",
|
|
5422
|
+
"required": true,
|
|
5423
|
+
"type": "string"
|
|
5424
|
+
},
|
|
5425
|
+
{
|
|
5426
|
+
"name": "taskQueue",
|
|
5427
|
+
"description": "Selects the task queue to update.",
|
|
5428
|
+
"in": "path",
|
|
5429
|
+
"required": true,
|
|
5430
|
+
"type": "string"
|
|
5431
|
+
},
|
|
5432
|
+
{
|
|
5433
|
+
"name": "body",
|
|
5434
|
+
"in": "body",
|
|
5435
|
+
"required": true,
|
|
5436
|
+
"schema": {
|
|
5437
|
+
"$ref": "#/definitions/WorkflowServiceUpdateTaskQueueConfigBody"
|
|
5438
|
+
}
|
|
5439
|
+
}
|
|
5440
|
+
],
|
|
5441
|
+
"tags": [
|
|
5442
|
+
"WorkflowService"
|
|
5443
|
+
]
|
|
5444
|
+
}
|
|
5445
|
+
},
|
|
5161
5446
|
"/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility": {
|
|
5162
5447
|
"get": {
|
|
5163
5448
|
"summary": "Deprecated. Use `GetWorkerVersioningRules`.\nFetches the worker build id versioning sets for a task queue.",
|
|
@@ -5286,6 +5571,13 @@
|
|
|
5286
5571
|
"in": "query",
|
|
5287
5572
|
"required": false,
|
|
5288
5573
|
"type": "string"
|
|
5574
|
+
},
|
|
5575
|
+
{
|
|
5576
|
+
"name": "reportTaskQueueStats",
|
|
5577
|
+
"description": "Report stats for task queues which have been polled by this version.",
|
|
5578
|
+
"in": "query",
|
|
5579
|
+
"required": false,
|
|
5580
|
+
"type": "boolean"
|
|
5289
5581
|
}
|
|
5290
5582
|
],
|
|
5291
5583
|
"tags": [
|
|
@@ -5673,19 +5965,191 @@
|
|
|
5673
5965
|
"collectionFormat": "multi"
|
|
5674
5966
|
},
|
|
5675
5967
|
{
|
|
5676
|
-
"name": "reachability",
|
|
5677
|
-
"description": "Type of reachability to query for.\n`TASK_REACHABILITY_NEW_WORKFLOWS` is always returned in the response.\nUse `TASK_REACHABILITY_EXISTING_WORKFLOWS` if your application needs to respond to queries on closed workflows.\nOtherwise, use `TASK_REACHABILITY_OPEN_WORKFLOWS`. Default is `TASK_REACHABILITY_EXISTING_WORKFLOWS` if left\nunspecified.\nSee the TaskReachability docstring for information about each enum variant.\n\n - TASK_REACHABILITY_NEW_WORKFLOWS: There's a possiblity for a worker to receive new workflow tasks. Workers should *not* be retired.\n - TASK_REACHABILITY_EXISTING_WORKFLOWS: There's a possiblity for a worker to receive existing workflow and activity tasks from existing workflows. Workers\nshould *not* be retired.\nThis enum value does not distinguish between open and closed workflows.\n - TASK_REACHABILITY_OPEN_WORKFLOWS: There's a possiblity for a worker to receive existing workflow and activity tasks from open workflows. Workers\nshould *not* be retired.\n - TASK_REACHABILITY_CLOSED_WORKFLOWS: There's a possiblity for a worker to receive existing workflow tasks from closed workflows. Workers may be\nretired dependending on application requirements. For example, if there's no need to query closed workflows.",
|
|
5678
|
-
"in": "query",
|
|
5679
|
-
"required": false,
|
|
5680
|
-
"type": "string",
|
|
5681
|
-
"enum": [
|
|
5682
|
-
"TASK_REACHABILITY_UNSPECIFIED",
|
|
5683
|
-
"TASK_REACHABILITY_NEW_WORKFLOWS",
|
|
5684
|
-
"TASK_REACHABILITY_EXISTING_WORKFLOWS",
|
|
5685
|
-
"TASK_REACHABILITY_OPEN_WORKFLOWS",
|
|
5686
|
-
"TASK_REACHABILITY_CLOSED_WORKFLOWS"
|
|
5687
|
-
],
|
|
5688
|
-
"default": "TASK_REACHABILITY_UNSPECIFIED"
|
|
5968
|
+
"name": "reachability",
|
|
5969
|
+
"description": "Type of reachability to query for.\n`TASK_REACHABILITY_NEW_WORKFLOWS` is always returned in the response.\nUse `TASK_REACHABILITY_EXISTING_WORKFLOWS` if your application needs to respond to queries on closed workflows.\nOtherwise, use `TASK_REACHABILITY_OPEN_WORKFLOWS`. Default is `TASK_REACHABILITY_EXISTING_WORKFLOWS` if left\nunspecified.\nSee the TaskReachability docstring for information about each enum variant.\n\n - TASK_REACHABILITY_NEW_WORKFLOWS: There's a possiblity for a worker to receive new workflow tasks. Workers should *not* be retired.\n - TASK_REACHABILITY_EXISTING_WORKFLOWS: There's a possiblity for a worker to receive existing workflow and activity tasks from existing workflows. Workers\nshould *not* be retired.\nThis enum value does not distinguish between open and closed workflows.\n - TASK_REACHABILITY_OPEN_WORKFLOWS: There's a possiblity for a worker to receive existing workflow and activity tasks from open workflows. Workers\nshould *not* be retired.\n - TASK_REACHABILITY_CLOSED_WORKFLOWS: There's a possiblity for a worker to receive existing workflow tasks from closed workflows. Workers may be\nretired dependending on application requirements. For example, if there's no need to query closed workflows.",
|
|
5970
|
+
"in": "query",
|
|
5971
|
+
"required": false,
|
|
5972
|
+
"type": "string",
|
|
5973
|
+
"enum": [
|
|
5974
|
+
"TASK_REACHABILITY_UNSPECIFIED",
|
|
5975
|
+
"TASK_REACHABILITY_NEW_WORKFLOWS",
|
|
5976
|
+
"TASK_REACHABILITY_EXISTING_WORKFLOWS",
|
|
5977
|
+
"TASK_REACHABILITY_OPEN_WORKFLOWS",
|
|
5978
|
+
"TASK_REACHABILITY_CLOSED_WORKFLOWS"
|
|
5979
|
+
],
|
|
5980
|
+
"default": "TASK_REACHABILITY_UNSPECIFIED"
|
|
5981
|
+
}
|
|
5982
|
+
],
|
|
5983
|
+
"tags": [
|
|
5984
|
+
"WorkflowService"
|
|
5985
|
+
]
|
|
5986
|
+
}
|
|
5987
|
+
},
|
|
5988
|
+
"/namespaces/{namespace}/workers": {
|
|
5989
|
+
"get": {
|
|
5990
|
+
"summary": "ListWorkers is a visibility API to list worker status information in a specific namespace.",
|
|
5991
|
+
"operationId": "ListWorkers",
|
|
5992
|
+
"responses": {
|
|
5993
|
+
"200": {
|
|
5994
|
+
"description": "A successful response.",
|
|
5995
|
+
"schema": {
|
|
5996
|
+
"$ref": "#/definitions/v1ListWorkersResponse"
|
|
5997
|
+
}
|
|
5998
|
+
},
|
|
5999
|
+
"default": {
|
|
6000
|
+
"description": "An unexpected error response.",
|
|
6001
|
+
"schema": {
|
|
6002
|
+
"$ref": "#/definitions/rpcStatus"
|
|
6003
|
+
}
|
|
6004
|
+
}
|
|
6005
|
+
},
|
|
6006
|
+
"parameters": [
|
|
6007
|
+
{
|
|
6008
|
+
"name": "namespace",
|
|
6009
|
+
"in": "path",
|
|
6010
|
+
"required": true,
|
|
6011
|
+
"type": "string"
|
|
6012
|
+
},
|
|
6013
|
+
{
|
|
6014
|
+
"name": "pageSize",
|
|
6015
|
+
"in": "query",
|
|
6016
|
+
"required": false,
|
|
6017
|
+
"type": "integer",
|
|
6018
|
+
"format": "int32"
|
|
6019
|
+
},
|
|
6020
|
+
{
|
|
6021
|
+
"name": "nextPageToken",
|
|
6022
|
+
"in": "query",
|
|
6023
|
+
"required": false,
|
|
6024
|
+
"type": "string",
|
|
6025
|
+
"format": "byte"
|
|
6026
|
+
},
|
|
6027
|
+
{
|
|
6028
|
+
"name": "query",
|
|
6029
|
+
"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.",
|
|
6030
|
+
"in": "query",
|
|
6031
|
+
"required": false,
|
|
6032
|
+
"type": "string"
|
|
6033
|
+
}
|
|
6034
|
+
],
|
|
6035
|
+
"tags": [
|
|
6036
|
+
"WorkflowService"
|
|
6037
|
+
]
|
|
6038
|
+
}
|
|
6039
|
+
},
|
|
6040
|
+
"/namespaces/{namespace}/workers/fetch-config": {
|
|
6041
|
+
"post": {
|
|
6042
|
+
"summary": "FetchWorkerConfig returns the worker configuration for a specific worker.",
|
|
6043
|
+
"operationId": "FetchWorkerConfig",
|
|
6044
|
+
"responses": {
|
|
6045
|
+
"200": {
|
|
6046
|
+
"description": "A successful response.",
|
|
6047
|
+
"schema": {
|
|
6048
|
+
"$ref": "#/definitions/v1FetchWorkerConfigResponse"
|
|
6049
|
+
}
|
|
6050
|
+
},
|
|
6051
|
+
"default": {
|
|
6052
|
+
"description": "An unexpected error response.",
|
|
6053
|
+
"schema": {
|
|
6054
|
+
"$ref": "#/definitions/rpcStatus"
|
|
6055
|
+
}
|
|
6056
|
+
}
|
|
6057
|
+
},
|
|
6058
|
+
"parameters": [
|
|
6059
|
+
{
|
|
6060
|
+
"name": "namespace",
|
|
6061
|
+
"description": "Namespace this worker belongs to.",
|
|
6062
|
+
"in": "path",
|
|
6063
|
+
"required": true,
|
|
6064
|
+
"type": "string"
|
|
6065
|
+
},
|
|
6066
|
+
{
|
|
6067
|
+
"name": "body",
|
|
6068
|
+
"in": "body",
|
|
6069
|
+
"required": true,
|
|
6070
|
+
"schema": {
|
|
6071
|
+
"$ref": "#/definitions/WorkflowServiceFetchWorkerConfigBody"
|
|
6072
|
+
}
|
|
6073
|
+
}
|
|
6074
|
+
],
|
|
6075
|
+
"tags": [
|
|
6076
|
+
"WorkflowService"
|
|
6077
|
+
]
|
|
6078
|
+
}
|
|
6079
|
+
},
|
|
6080
|
+
"/namespaces/{namespace}/workers/heartbeat": {
|
|
6081
|
+
"post": {
|
|
6082
|
+
"summary": "WorkerHeartbeat receive heartbeat request from the worker.",
|
|
6083
|
+
"operationId": "RecordWorkerHeartbeat",
|
|
6084
|
+
"responses": {
|
|
6085
|
+
"200": {
|
|
6086
|
+
"description": "A successful response.",
|
|
6087
|
+
"schema": {
|
|
6088
|
+
"$ref": "#/definitions/v1RecordWorkerHeartbeatResponse"
|
|
6089
|
+
}
|
|
6090
|
+
},
|
|
6091
|
+
"default": {
|
|
6092
|
+
"description": "An unexpected error response.",
|
|
6093
|
+
"schema": {
|
|
6094
|
+
"$ref": "#/definitions/rpcStatus"
|
|
6095
|
+
}
|
|
6096
|
+
}
|
|
6097
|
+
},
|
|
6098
|
+
"parameters": [
|
|
6099
|
+
{
|
|
6100
|
+
"name": "namespace",
|
|
6101
|
+
"description": "Namespace this worker belongs to.",
|
|
6102
|
+
"in": "path",
|
|
6103
|
+
"required": true,
|
|
6104
|
+
"type": "string"
|
|
6105
|
+
},
|
|
6106
|
+
{
|
|
6107
|
+
"name": "body",
|
|
6108
|
+
"in": "body",
|
|
6109
|
+
"required": true,
|
|
6110
|
+
"schema": {
|
|
6111
|
+
"$ref": "#/definitions/WorkflowServiceRecordWorkerHeartbeatBody"
|
|
6112
|
+
}
|
|
6113
|
+
}
|
|
6114
|
+
],
|
|
6115
|
+
"tags": [
|
|
6116
|
+
"WorkflowService"
|
|
6117
|
+
]
|
|
6118
|
+
}
|
|
6119
|
+
},
|
|
6120
|
+
"/namespaces/{namespace}/workers/update-config": {
|
|
6121
|
+
"post": {
|
|
6122
|
+
"summary": "UpdateWorkerConfig updates the worker configuration of one or more workers.\nCan be used to partially update the worker configuration.\nCan be used to update the configuration of multiple workers.",
|
|
6123
|
+
"operationId": "UpdateWorkerConfig",
|
|
6124
|
+
"responses": {
|
|
6125
|
+
"200": {
|
|
6126
|
+
"description": "A successful response.",
|
|
6127
|
+
"schema": {
|
|
6128
|
+
"$ref": "#/definitions/v1UpdateWorkerConfigResponse"
|
|
6129
|
+
}
|
|
6130
|
+
},
|
|
6131
|
+
"default": {
|
|
6132
|
+
"description": "An unexpected error response.",
|
|
6133
|
+
"schema": {
|
|
6134
|
+
"$ref": "#/definitions/rpcStatus"
|
|
6135
|
+
}
|
|
6136
|
+
}
|
|
6137
|
+
},
|
|
6138
|
+
"parameters": [
|
|
6139
|
+
{
|
|
6140
|
+
"name": "namespace",
|
|
6141
|
+
"description": "Namespace this worker belongs to.",
|
|
6142
|
+
"in": "path",
|
|
6143
|
+
"required": true,
|
|
6144
|
+
"type": "string"
|
|
6145
|
+
},
|
|
6146
|
+
{
|
|
6147
|
+
"name": "body",
|
|
6148
|
+
"in": "body",
|
|
6149
|
+
"required": true,
|
|
6150
|
+
"schema": {
|
|
6151
|
+
"$ref": "#/definitions/WorkflowServiceUpdateWorkerConfigBody"
|
|
6152
|
+
}
|
|
5689
6153
|
}
|
|
5690
6154
|
],
|
|
5691
6155
|
"tags": [
|
|
@@ -6734,6 +7198,42 @@
|
|
|
6734
7198
|
}
|
|
6735
7199
|
}
|
|
6736
7200
|
},
|
|
7201
|
+
"DescribeTaskQueueResponseEffectiveRateLimit": {
|
|
7202
|
+
"type": "object",
|
|
7203
|
+
"properties": {
|
|
7204
|
+
"requestsPerSecond": {
|
|
7205
|
+
"type": "number",
|
|
7206
|
+
"format": "float",
|
|
7207
|
+
"description": "The effective rate limit for the task queue."
|
|
7208
|
+
},
|
|
7209
|
+
"rateLimitSource": {
|
|
7210
|
+
"$ref": "#/definitions/v1RateLimitSource",
|
|
7211
|
+
"title": "Source of the RateLimit Configuration,which can be one of the following values:\n- SOURCE_API: The rate limit that is set via the TaskQueueConfig api.\n- SOURCE_WORKER: The rate limit is the value set using the workerOptions in TaskQueueActivitiesPerSecond.\n- SOURCE_SYSTEM: The rate limit is the default value set by the system"
|
|
7212
|
+
}
|
|
7213
|
+
}
|
|
7214
|
+
},
|
|
7215
|
+
"DescribeWorkerDeploymentVersionResponseVersionTaskQueue": {
|
|
7216
|
+
"type": "object",
|
|
7217
|
+
"properties": {
|
|
7218
|
+
"name": {
|
|
7219
|
+
"type": "string"
|
|
7220
|
+
},
|
|
7221
|
+
"type": {
|
|
7222
|
+
"$ref": "#/definitions/v1TaskQueueType"
|
|
7223
|
+
},
|
|
7224
|
+
"stats": {
|
|
7225
|
+
"$ref": "#/definitions/v1TaskQueueStats",
|
|
7226
|
+
"description": "Only set if `report_task_queue_stats` is set on the request."
|
|
7227
|
+
},
|
|
7228
|
+
"statsByPriorityKey": {
|
|
7229
|
+
"type": "object",
|
|
7230
|
+
"additionalProperties": {
|
|
7231
|
+
"$ref": "#/definitions/v1TaskQueueStats"
|
|
7232
|
+
},
|
|
7233
|
+
"description": "Task queue stats breakdown by priority key. Only contains actively used priority keys.\nOnly set if `report_task_queue_stats` is set to true in the request."
|
|
7234
|
+
}
|
|
7235
|
+
}
|
|
7236
|
+
},
|
|
6737
7237
|
"EndpointTargetExternal": {
|
|
6738
7238
|
"type": "object",
|
|
6739
7239
|
"properties": {
|
|
@@ -6812,6 +7312,18 @@
|
|
|
6812
7312
|
},
|
|
6813
7313
|
"routingConfig": {
|
|
6814
7314
|
"$ref": "#/definitions/v1RoutingConfig"
|
|
7315
|
+
},
|
|
7316
|
+
"latestVersionSummary": {
|
|
7317
|
+
"$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary",
|
|
7318
|
+
"description": "Summary of the version that was added most recently in the Worker Deployment."
|
|
7319
|
+
},
|
|
7320
|
+
"currentVersionSummary": {
|
|
7321
|
+
"$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary",
|
|
7322
|
+
"description": "Summary of the current version of the Worker Deployment."
|
|
7323
|
+
},
|
|
7324
|
+
"rampingVersionSummary": {
|
|
7325
|
+
"$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary",
|
|
7326
|
+
"description": "Summary of the ramping version of the Worker Deployment."
|
|
6815
7327
|
}
|
|
6816
7328
|
},
|
|
6817
7329
|
"title": "A subset of WorkerDeploymentInfo"
|
|
@@ -6922,7 +7434,7 @@
|
|
|
6922
7434
|
"properties": {
|
|
6923
7435
|
"operationId": {
|
|
6924
7436
|
"type": "string",
|
|
6925
|
-
"description": "Deprecated
|
|
7437
|
+
"description": "Deprecated. Renamed to operation_token."
|
|
6926
7438
|
},
|
|
6927
7439
|
"links": {
|
|
6928
7440
|
"type": "array",
|
|
@@ -6953,6 +7465,19 @@
|
|
|
6953
7465
|
},
|
|
6954
7466
|
"description": "An operation completed successfully."
|
|
6955
7467
|
},
|
|
7468
|
+
"UpdateTaskQueueConfigRequestRateLimitUpdate": {
|
|
7469
|
+
"type": "object",
|
|
7470
|
+
"properties": {
|
|
7471
|
+
"rateLimit": {
|
|
7472
|
+
"$ref": "#/definitions/v1RateLimit",
|
|
7473
|
+
"title": "Rate Limit to be updated"
|
|
7474
|
+
},
|
|
7475
|
+
"reason": {
|
|
7476
|
+
"type": "string",
|
|
7477
|
+
"description": "Reason for why the rate limit was set."
|
|
7478
|
+
}
|
|
7479
|
+
}
|
|
7480
|
+
},
|
|
6956
7481
|
"UpdateWorkerBuildIdCompatibilityRequestAddNewCompatibleVersion": {
|
|
6957
7482
|
"type": "object",
|
|
6958
7483
|
"properties": {
|
|
@@ -7088,6 +7613,35 @@
|
|
|
7088
7613
|
"default": "PINNED_OVERRIDE_BEHAVIOR_UNSPECIFIED",
|
|
7089
7614
|
"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
7615
|
},
|
|
7616
|
+
"WorkerConfigAutoscalingPollerBehavior": {
|
|
7617
|
+
"type": "object",
|
|
7618
|
+
"properties": {
|
|
7619
|
+
"minPollers": {
|
|
7620
|
+
"type": "integer",
|
|
7621
|
+
"format": "int32",
|
|
7622
|
+
"description": "At least this many poll calls will always be attempted (assuming slots are available).\nCannot be zero."
|
|
7623
|
+
},
|
|
7624
|
+
"maxPollers": {
|
|
7625
|
+
"type": "integer",
|
|
7626
|
+
"format": "int32",
|
|
7627
|
+
"description": "At most this many poll calls will ever be open at once. Must be >= `minimum`."
|
|
7628
|
+
},
|
|
7629
|
+
"initialPollers": {
|
|
7630
|
+
"type": "integer",
|
|
7631
|
+
"format": "int32",
|
|
7632
|
+
"description": "This many polls will be attempted initially before scaling kicks in. Must be between\n `minimum` and `maximum`."
|
|
7633
|
+
}
|
|
7634
|
+
}
|
|
7635
|
+
},
|
|
7636
|
+
"WorkerConfigSimplePollerBehavior": {
|
|
7637
|
+
"type": "object",
|
|
7638
|
+
"properties": {
|
|
7639
|
+
"maxPollers": {
|
|
7640
|
+
"type": "integer",
|
|
7641
|
+
"format": "int32"
|
|
7642
|
+
}
|
|
7643
|
+
}
|
|
7644
|
+
},
|
|
7091
7645
|
"WorkerDeploymentInfoWorkerDeploymentVersionSummary": {
|
|
7092
7646
|
"type": "object",
|
|
7093
7647
|
"properties": {
|
|
@@ -7095,6 +7649,10 @@
|
|
|
7095
7649
|
"type": "string",
|
|
7096
7650
|
"description": "Deprecated. Use `deployment_version`."
|
|
7097
7651
|
},
|
|
7652
|
+
"status": {
|
|
7653
|
+
"$ref": "#/definitions/v1WorkerDeploymentVersionStatus",
|
|
7654
|
+
"description": "The status of the Worker Deployment Version."
|
|
7655
|
+
},
|
|
7098
7656
|
"deploymentVersion": {
|
|
7099
7657
|
"$ref": "#/definitions/v1WorkerDeploymentVersion",
|
|
7100
7658
|
"description": "Required."
|
|
@@ -7104,7 +7662,37 @@
|
|
|
7104
7662
|
"format": "date-time"
|
|
7105
7663
|
},
|
|
7106
7664
|
"drainageStatus": {
|
|
7107
|
-
"$ref": "#/definitions/v1VersionDrainageStatus"
|
|
7665
|
+
"$ref": "#/definitions/v1VersionDrainageStatus",
|
|
7666
|
+
"description": "Deprecated. Use `drainage_info` instead."
|
|
7667
|
+
},
|
|
7668
|
+
"drainageInfo": {
|
|
7669
|
+
"$ref": "#/definitions/v1VersionDrainageInfo",
|
|
7670
|
+
"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"
|
|
7671
|
+
},
|
|
7672
|
+
"currentSinceTime": {
|
|
7673
|
+
"type": "string",
|
|
7674
|
+
"format": "date-time",
|
|
7675
|
+
"description": "Unset if not current."
|
|
7676
|
+
},
|
|
7677
|
+
"rampingSinceTime": {
|
|
7678
|
+
"type": "string",
|
|
7679
|
+
"format": "date-time",
|
|
7680
|
+
"description": "Unset if not ramping. Updated when the version first starts ramping, not on each ramp change."
|
|
7681
|
+
},
|
|
7682
|
+
"routingUpdateTime": {
|
|
7683
|
+
"type": "string",
|
|
7684
|
+
"format": "date-time",
|
|
7685
|
+
"description": "Last time `current_since_time`, `ramping_since_time, or `ramp_percentage` of this version changed."
|
|
7686
|
+
},
|
|
7687
|
+
"firstActivationTime": {
|
|
7688
|
+
"type": "string",
|
|
7689
|
+
"format": "date-time",
|
|
7690
|
+
"description": "Timestamp when this version first became current or ramping."
|
|
7691
|
+
},
|
|
7692
|
+
"lastDeactivationTime": {
|
|
7693
|
+
"type": "string",
|
|
7694
|
+
"format": "date-time",
|
|
7695
|
+
"description": "Timestamp when this version last stopped being current or ramping."
|
|
7108
7696
|
}
|
|
7109
7697
|
}
|
|
7110
7698
|
},
|
|
@@ -7223,6 +7811,23 @@
|
|
|
7223
7811
|
}
|
|
7224
7812
|
}
|
|
7225
7813
|
},
|
|
7814
|
+
"WorkflowServiceFetchWorkerConfigBody": {
|
|
7815
|
+
"type": "object",
|
|
7816
|
+
"properties": {
|
|
7817
|
+
"identity": {
|
|
7818
|
+
"type": "string",
|
|
7819
|
+
"description": "The identity of the client who initiated this request."
|
|
7820
|
+
},
|
|
7821
|
+
"reason": {
|
|
7822
|
+
"type": "string",
|
|
7823
|
+
"description": "Reason for sending worker command, can be used for audit purpose."
|
|
7824
|
+
},
|
|
7825
|
+
"selector": {
|
|
7826
|
+
"$ref": "#/definitions/v1WorkerSelector",
|
|
7827
|
+
"description": "Defines which workers should receive this command.\nonly single worker is supported at this time."
|
|
7828
|
+
}
|
|
7829
|
+
}
|
|
7830
|
+
},
|
|
7226
7831
|
"WorkflowServicePatchScheduleBody": {
|
|
7227
7832
|
"type": "object",
|
|
7228
7833
|
"properties": {
|
|
@@ -7339,6 +7944,22 @@
|
|
|
7339
7944
|
}
|
|
7340
7945
|
}
|
|
7341
7946
|
},
|
|
7947
|
+
"WorkflowServiceRecordWorkerHeartbeatBody": {
|
|
7948
|
+
"type": "object",
|
|
7949
|
+
"properties": {
|
|
7950
|
+
"identity": {
|
|
7951
|
+
"type": "string",
|
|
7952
|
+
"description": "The identity of the client who initiated this request."
|
|
7953
|
+
},
|
|
7954
|
+
"workerHeartbeat": {
|
|
7955
|
+
"type": "array",
|
|
7956
|
+
"items": {
|
|
7957
|
+
"type": "object",
|
|
7958
|
+
"$ref": "#/definitions/v1WorkerHeartbeat"
|
|
7959
|
+
}
|
|
7960
|
+
}
|
|
7961
|
+
}
|
|
7962
|
+
},
|
|
7342
7963
|
"WorkflowServiceRequestCancelWorkflowExecutionBody": {
|
|
7343
7964
|
"type": "object",
|
|
7344
7965
|
"properties": {
|
|
@@ -7396,19 +8017,28 @@
|
|
|
7396
8017
|
"type": "string",
|
|
7397
8018
|
"description": "Reset all running activities with of this type."
|
|
7398
8019
|
},
|
|
8020
|
+
"matchAll": {
|
|
8021
|
+
"type": "boolean",
|
|
8022
|
+
"description": "Reset all running activities."
|
|
8023
|
+
},
|
|
7399
8024
|
"resetHeartbeat": {
|
|
7400
8025
|
"type": "boolean",
|
|
7401
8026
|
"description": "Indicates that activity should reset heartbeat details.\nThis flag will be applied only to the new instance of the activity."
|
|
7402
8027
|
},
|
|
7403
8028
|
"keepPaused": {
|
|
7404
8029
|
"type": "boolean",
|
|
7405
|
-
"title": "
|
|
8030
|
+
"title": "If activity is paused, it will remain paused after reset"
|
|
7406
8031
|
},
|
|
7407
8032
|
"jitter": {
|
|
7408
8033
|
"type": "string",
|
|
7409
8034
|
"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)"
|
|
8035
|
+
},
|
|
8036
|
+
"restoreOriginalOptions": {
|
|
8037
|
+
"type": "boolean",
|
|
8038
|
+
"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
8039
|
}
|
|
7411
|
-
}
|
|
8040
|
+
},
|
|
8041
|
+
"title": "NOTE: keep in sync with temporal.api.batch.v1.BatchOperationResetActivities"
|
|
7412
8042
|
},
|
|
7413
8043
|
"WorkflowServiceResetWorkflowExecutionBody": {
|
|
7414
8044
|
"type": "object",
|
|
@@ -7437,7 +8067,7 @@
|
|
|
7437
8067
|
},
|
|
7438
8068
|
"resetReapplyType": {
|
|
7439
8069
|
"$ref": "#/definitions/v1ResetReapplyType",
|
|
7440
|
-
"title": "
|
|
8070
|
+
"title": "Deprecated. Use `options`.\nDefault: RESET_REAPPLY_TYPE_SIGNAL"
|
|
7441
8071
|
},
|
|
7442
8072
|
"resetReapplyExcludeTypes": {
|
|
7443
8073
|
"type": "array",
|
|
@@ -7453,6 +8083,10 @@
|
|
|
7453
8083
|
"$ref": "#/definitions/v1PostResetOperation"
|
|
7454
8084
|
},
|
|
7455
8085
|
"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"
|
|
8086
|
+
},
|
|
8087
|
+
"identity": {
|
|
8088
|
+
"type": "string",
|
|
8089
|
+
"title": "The identity of the worker/client"
|
|
7456
8090
|
}
|
|
7457
8091
|
}
|
|
7458
8092
|
},
|
|
@@ -7764,7 +8398,7 @@
|
|
|
7764
8398
|
},
|
|
7765
8399
|
"control": {
|
|
7766
8400
|
"type": "string",
|
|
7767
|
-
"
|
|
8401
|
+
"description": "Deprecated."
|
|
7768
8402
|
},
|
|
7769
8403
|
"retryPolicy": {
|
|
7770
8404
|
"$ref": "#/definitions/v1RetryPolicy",
|
|
@@ -7835,7 +8469,7 @@
|
|
|
7835
8469
|
},
|
|
7836
8470
|
"control": {
|
|
7837
8471
|
"type": "string",
|
|
7838
|
-
"
|
|
8472
|
+
"description": "Deprecated."
|
|
7839
8473
|
},
|
|
7840
8474
|
"header": {
|
|
7841
8475
|
"$ref": "#/definitions/v1Header",
|
|
@@ -7896,6 +8530,12 @@
|
|
|
7896
8530
|
},
|
|
7897
8531
|
"unpauseActivitiesOperation": {
|
|
7898
8532
|
"$ref": "#/definitions/v1BatchOperationUnpauseActivities"
|
|
8533
|
+
},
|
|
8534
|
+
"resetActivitiesOperation": {
|
|
8535
|
+
"$ref": "#/definitions/v1BatchOperationResetActivities"
|
|
8536
|
+
},
|
|
8537
|
+
"updateActivityOptionsOperation": {
|
|
8538
|
+
"$ref": "#/definitions/v1BatchOperationUpdateActivityOptions"
|
|
7899
8539
|
}
|
|
7900
8540
|
}
|
|
7901
8541
|
},
|
|
@@ -8144,8 +8784,17 @@
|
|
|
8144
8784
|
"type": {
|
|
8145
8785
|
"type": "string",
|
|
8146
8786
|
"description": "Update all running activities of this type."
|
|
8787
|
+
},
|
|
8788
|
+
"matchAll": {
|
|
8789
|
+
"type": "boolean",
|
|
8790
|
+
"description": "Update all running activities."
|
|
8791
|
+
},
|
|
8792
|
+
"restoreOriginal": {
|
|
8793
|
+
"type": "boolean",
|
|
8794
|
+
"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
8795
|
}
|
|
8148
|
-
}
|
|
8796
|
+
},
|
|
8797
|
+
"title": "NOTE: keep in sync with temporal.api.batch.v1.BatchOperationUpdateActivityOptions"
|
|
8149
8798
|
},
|
|
8150
8799
|
"WorkflowServiceUpdateNamespaceBody": {
|
|
8151
8800
|
"type": "object",
|
|
@@ -8197,6 +8846,50 @@
|
|
|
8197
8846
|
}
|
|
8198
8847
|
}
|
|
8199
8848
|
},
|
|
8849
|
+
"WorkflowServiceUpdateTaskQueueConfigBody": {
|
|
8850
|
+
"type": "object",
|
|
8851
|
+
"properties": {
|
|
8852
|
+
"identity": {
|
|
8853
|
+
"type": "string"
|
|
8854
|
+
},
|
|
8855
|
+
"taskQueueType": {
|
|
8856
|
+
"$ref": "#/definitions/v1TaskQueueType"
|
|
8857
|
+
},
|
|
8858
|
+
"updateQueueRateLimit": {
|
|
8859
|
+
"$ref": "#/definitions/UpdateTaskQueueConfigRequestRateLimitUpdate",
|
|
8860
|
+
"description": "Update to queue-wide rate limit.\nIf not set, this configuration is unchanged.\nNOTE: A limit set by the worker is overriden; and restored again when reset.\nIf the `rate_limit` field in the `RateLimitUpdate` is missing, remove the existing rate limit."
|
|
8861
|
+
},
|
|
8862
|
+
"updateFairnessKeyRateLimitDefault": {
|
|
8863
|
+
"$ref": "#/definitions/UpdateTaskQueueConfigRequestRateLimitUpdate",
|
|
8864
|
+
"description": "Update to the default fairness key rate limit.\nIf not set, this configuration is unchanged.\nIf the `rate_limit` field in the `RateLimitUpdate` is missing, remove the existing rate limit."
|
|
8865
|
+
}
|
|
8866
|
+
}
|
|
8867
|
+
},
|
|
8868
|
+
"WorkflowServiceUpdateWorkerConfigBody": {
|
|
8869
|
+
"type": "object",
|
|
8870
|
+
"properties": {
|
|
8871
|
+
"identity": {
|
|
8872
|
+
"type": "string",
|
|
8873
|
+
"description": "The identity of the client who initiated this request."
|
|
8874
|
+
},
|
|
8875
|
+
"reason": {
|
|
8876
|
+
"type": "string",
|
|
8877
|
+
"description": "Reason for sending worker command, can be used for audit purpose."
|
|
8878
|
+
},
|
|
8879
|
+
"workerConfig": {
|
|
8880
|
+
"$ref": "#/definitions/v1WorkerConfig",
|
|
8881
|
+
"description": "Partial updates are accepted and controlled by update_mask.\nThe worker configuration to set."
|
|
8882
|
+
},
|
|
8883
|
+
"updateMask": {
|
|
8884
|
+
"type": "string",
|
|
8885
|
+
"title": "Controls which fields from `worker_config` will be applied"
|
|
8886
|
+
},
|
|
8887
|
+
"selector": {
|
|
8888
|
+
"$ref": "#/definitions/v1WorkerSelector",
|
|
8889
|
+
"description": "Defines which workers should receive this command."
|
|
8890
|
+
}
|
|
8891
|
+
}
|
|
8892
|
+
},
|
|
8200
8893
|
"WorkflowServiceUpdateWorkerDeploymentVersionMetadataBody": {
|
|
8201
8894
|
"type": "object",
|
|
8202
8895
|
"properties": {
|
|
@@ -8221,6 +8914,10 @@
|
|
|
8221
8914
|
"type": "string"
|
|
8222
8915
|
},
|
|
8223
8916
|
"description": "List of keys to remove from the metadata."
|
|
8917
|
+
},
|
|
8918
|
+
"identity": {
|
|
8919
|
+
"type": "string",
|
|
8920
|
+
"description": "Optional. The identity of the client who initiated this request."
|
|
8224
8921
|
}
|
|
8225
8922
|
},
|
|
8226
8923
|
"description": "Used to update the user-defined metadata of a Worker Deployment Version."
|
|
@@ -8917,11 +9614,11 @@
|
|
|
8917
9614
|
},
|
|
8918
9615
|
"resetType": {
|
|
8919
9616
|
"$ref": "#/definitions/v1ResetType",
|
|
8920
|
-
"description": "
|
|
9617
|
+
"description": "Deprecated. Use `options`."
|
|
8921
9618
|
},
|
|
8922
9619
|
"resetReapplyType": {
|
|
8923
9620
|
"$ref": "#/definitions/v1ResetReapplyType",
|
|
8924
|
-
"description": "
|
|
9621
|
+
"description": "Deprecated. Use `options`."
|
|
8925
9622
|
},
|
|
8926
9623
|
"postResetOperations": {
|
|
8927
9624
|
"type": "array",
|
|
@@ -8934,6 +9631,42 @@
|
|
|
8934
9631
|
},
|
|
8935
9632
|
"description": "BatchOperationReset sends reset requests to batch workflows.\nKeep the parameter in sync with temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest."
|
|
8936
9633
|
},
|
|
9634
|
+
"v1BatchOperationResetActivities": {
|
|
9635
|
+
"type": "object",
|
|
9636
|
+
"properties": {
|
|
9637
|
+
"identity": {
|
|
9638
|
+
"type": "string",
|
|
9639
|
+
"description": "The identity of the worker/client."
|
|
9640
|
+
},
|
|
9641
|
+
"type": {
|
|
9642
|
+
"type": "string"
|
|
9643
|
+
},
|
|
9644
|
+
"matchAll": {
|
|
9645
|
+
"type": "boolean"
|
|
9646
|
+
},
|
|
9647
|
+
"resetAttempts": {
|
|
9648
|
+
"type": "boolean",
|
|
9649
|
+
"description": "Setting this flag will also reset the number of attempts."
|
|
9650
|
+
},
|
|
9651
|
+
"resetHeartbeat": {
|
|
9652
|
+
"type": "boolean",
|
|
9653
|
+
"description": "Setting this flag will also reset the heartbeat details."
|
|
9654
|
+
},
|
|
9655
|
+
"keepPaused": {
|
|
9656
|
+
"type": "boolean",
|
|
9657
|
+
"title": "If activity is paused, it will remain paused after reset"
|
|
9658
|
+
},
|
|
9659
|
+
"jitter": {
|
|
9660
|
+
"type": "string",
|
|
9661
|
+
"description": "If set, the activity will start at a random time within the specified jitter\nduration, introducing variability to the start time."
|
|
9662
|
+
},
|
|
9663
|
+
"restoreOriginalOptions": {
|
|
9664
|
+
"type": "boolean",
|
|
9665
|
+
"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 ActivityTaskScheduled event."
|
|
9666
|
+
}
|
|
9667
|
+
},
|
|
9668
|
+
"title": "BatchOperationResetActivities sends activity reset requests in a batch.\nNOTE: keep in sync with temporal.api.workflowservice.v1.ResetActivityRequest"
|
|
9669
|
+
},
|
|
8937
9670
|
"v1BatchOperationSignal": {
|
|
8938
9671
|
"type": "object",
|
|
8939
9672
|
"properties": {
|
|
@@ -8989,7 +9722,10 @@
|
|
|
8989
9722
|
"BATCH_OPERATION_TYPE_SIGNAL",
|
|
8990
9723
|
"BATCH_OPERATION_TYPE_DELETE",
|
|
8991
9724
|
"BATCH_OPERATION_TYPE_RESET",
|
|
8992
|
-
"BATCH_OPERATION_TYPE_UPDATE_EXECUTION_OPTIONS"
|
|
9725
|
+
"BATCH_OPERATION_TYPE_UPDATE_EXECUTION_OPTIONS",
|
|
9726
|
+
"BATCH_OPERATION_TYPE_UNPAUSE_ACTIVITY",
|
|
9727
|
+
"BATCH_OPERATION_TYPE_UPDATE_ACTIVITY_OPTIONS",
|
|
9728
|
+
"BATCH_OPERATION_TYPE_RESET_ACTIVITY"
|
|
8993
9729
|
],
|
|
8994
9730
|
"default": "BATCH_OPERATION_TYPE_UNSPECIFIED"
|
|
8995
9731
|
},
|
|
@@ -9008,11 +9744,11 @@
|
|
|
9008
9744
|
},
|
|
9009
9745
|
"resetAttempts": {
|
|
9010
9746
|
"type": "boolean",
|
|
9011
|
-
"description": "
|
|
9747
|
+
"description": "Setting this flag will also reset the number of attempts."
|
|
9012
9748
|
},
|
|
9013
9749
|
"resetHeartbeat": {
|
|
9014
9750
|
"type": "boolean",
|
|
9015
|
-
"description": "
|
|
9751
|
+
"description": "Setting this flag will also reset the heartbeat details."
|
|
9016
9752
|
},
|
|
9017
9753
|
"jitter": {
|
|
9018
9754
|
"type": "string",
|
|
@@ -9021,6 +9757,34 @@
|
|
|
9021
9757
|
},
|
|
9022
9758
|
"description": "BatchOperationUnpauseActivities sends unpause requests to batch workflows."
|
|
9023
9759
|
},
|
|
9760
|
+
"v1BatchOperationUpdateActivityOptions": {
|
|
9761
|
+
"type": "object",
|
|
9762
|
+
"properties": {
|
|
9763
|
+
"identity": {
|
|
9764
|
+
"type": "string",
|
|
9765
|
+
"description": "The identity of the worker/client."
|
|
9766
|
+
},
|
|
9767
|
+
"type": {
|
|
9768
|
+
"type": "string"
|
|
9769
|
+
},
|
|
9770
|
+
"matchAll": {
|
|
9771
|
+
"type": "boolean"
|
|
9772
|
+
},
|
|
9773
|
+
"activityOptions": {
|
|
9774
|
+
"$ref": "#/definitions/v1ActivityOptions",
|
|
9775
|
+
"description": "Update Activity options. Partial updates are accepted and controlled by update_mask."
|
|
9776
|
+
},
|
|
9777
|
+
"updateMask": {
|
|
9778
|
+
"type": "string",
|
|
9779
|
+
"title": "Controls which fields from `activity_options` will be applied"
|
|
9780
|
+
},
|
|
9781
|
+
"restoreOriginal": {
|
|
9782
|
+
"type": "boolean",
|
|
9783
|
+
"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 ActivityTaskScheduled event.\nThis flag cannot be combined with any other option; if you supply\nrestore_original together with other options, the request will be rejected."
|
|
9784
|
+
}
|
|
9785
|
+
},
|
|
9786
|
+
"title": "BatchOperationUpdateActivityOptions sends an update-activity-options requests in a batch.\nNOTE: keep in sync with temporal.api.workflowservice.v1.UpdateActivityRequest"
|
|
9787
|
+
},
|
|
9024
9788
|
"v1BatchOperationUpdateWorkflowExecutionOptions": {
|
|
9025
9789
|
"type": "object",
|
|
9026
9790
|
"properties": {
|
|
@@ -9220,7 +9984,7 @@
|
|
|
9220
9984
|
},
|
|
9221
9985
|
"operationId": {
|
|
9222
9986
|
"type": "string",
|
|
9223
|
-
"description": "Operation ID as originally generated by a Handler.\n\nDeprecated
|
|
9987
|
+
"description": "Operation ID as originally generated by a Handler.\n\nDeprecated. Renamed to operation_token."
|
|
9224
9988
|
},
|
|
9225
9989
|
"operationToken": {
|
|
9226
9990
|
"type": "string",
|
|
@@ -9630,6 +10394,24 @@
|
|
|
9630
10394
|
}
|
|
9631
10395
|
}
|
|
9632
10396
|
},
|
|
10397
|
+
"v1ConfigMetadata": {
|
|
10398
|
+
"type": "object",
|
|
10399
|
+
"properties": {
|
|
10400
|
+
"reason": {
|
|
10401
|
+
"type": "string",
|
|
10402
|
+
"description": "Reason for why the config was set."
|
|
10403
|
+
},
|
|
10404
|
+
"updateIdentity": {
|
|
10405
|
+
"type": "string",
|
|
10406
|
+
"description": "Identity of the last updater.\nSet by the request's identity field."
|
|
10407
|
+
},
|
|
10408
|
+
"updateTime": {
|
|
10409
|
+
"type": "string",
|
|
10410
|
+
"format": "date-time",
|
|
10411
|
+
"description": "Time of the last update."
|
|
10412
|
+
}
|
|
10413
|
+
}
|
|
10414
|
+
},
|
|
9633
10415
|
"v1ContinueAsNewInitiator": {
|
|
9634
10416
|
"type": "string",
|
|
9635
10417
|
"enum": [
|
|
@@ -9695,7 +10477,7 @@
|
|
|
9695
10477
|
},
|
|
9696
10478
|
"inheritBuildId": {
|
|
9697
10479
|
"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."
|
|
10480
|
+
"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
10481
|
}
|
|
9700
10482
|
}
|
|
9701
10483
|
},
|
|
@@ -10027,23 +10809,40 @@
|
|
|
10027
10809
|
"items": {
|
|
10028
10810
|
"type": "object",
|
|
10029
10811
|
"$ref": "#/definitions/v1PollerInfo"
|
|
10812
|
+
}
|
|
10813
|
+
},
|
|
10814
|
+
"stats": {
|
|
10815
|
+
"$ref": "#/definitions/v1TaskQueueStats",
|
|
10816
|
+
"description": "Statistics for the task queue.\nOnly set if `report_stats` is set on the request."
|
|
10817
|
+
},
|
|
10818
|
+
"statsByPriorityKey": {
|
|
10819
|
+
"type": "object",
|
|
10820
|
+
"additionalProperties": {
|
|
10821
|
+
"$ref": "#/definitions/v1TaskQueueStats"
|
|
10030
10822
|
},
|
|
10031
|
-
"description": "
|
|
10823
|
+
"description": "Task queue stats breakdown by priority key. Only contains actively used priority keys.\nOnly set if `report_stats` is set on the request."
|
|
10824
|
+
},
|
|
10825
|
+
"versioningInfo": {
|
|
10826
|
+
"$ref": "#/definitions/v1TaskQueueVersioningInfo",
|
|
10827
|
+
"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)."
|
|
10828
|
+
},
|
|
10829
|
+
"config": {
|
|
10830
|
+
"$ref": "#/definitions/v1TaskQueueConfig",
|
|
10831
|
+
"description": "Only populated if report_task_queue_config is set to true."
|
|
10832
|
+
},
|
|
10833
|
+
"effectiveRateLimit": {
|
|
10834
|
+
"$ref": "#/definitions/DescribeTaskQueueResponseEffectiveRateLimit"
|
|
10032
10835
|
},
|
|
10033
10836
|
"taskQueueStatus": {
|
|
10034
10837
|
"$ref": "#/definitions/v1TaskQueueStatus",
|
|
10035
|
-
"description": "Deprecated.
|
|
10838
|
+
"description": "Deprecated.\nStatus of the task queue. Only populated when `include_task_queue_status` is set to true in the request."
|
|
10036
10839
|
},
|
|
10037
10840
|
"versionsInfo": {
|
|
10038
10841
|
"type": "object",
|
|
10039
10842
|
"additionalProperties": {
|
|
10040
10843
|
"$ref": "#/definitions/v1TaskQueueVersionInfo"
|
|
10041
10844
|
},
|
|
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)."
|
|
10845
|
+
"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
10846
|
}
|
|
10048
10847
|
}
|
|
10049
10848
|
},
|
|
@@ -10065,6 +10864,14 @@
|
|
|
10065
10864
|
"properties": {
|
|
10066
10865
|
"workerDeploymentVersionInfo": {
|
|
10067
10866
|
"$ref": "#/definitions/v1WorkerDeploymentVersionInfo"
|
|
10867
|
+
},
|
|
10868
|
+
"versionTaskQueues": {
|
|
10869
|
+
"type": "array",
|
|
10870
|
+
"items": {
|
|
10871
|
+
"type": "object",
|
|
10872
|
+
"$ref": "#/definitions/DescribeWorkerDeploymentVersionResponseVersionTaskQueue"
|
|
10873
|
+
},
|
|
10874
|
+
"description": "All the Task Queues that have ever polled from this Deployment version."
|
|
10068
10875
|
}
|
|
10069
10876
|
}
|
|
10070
10877
|
},
|
|
@@ -10324,7 +11131,7 @@
|
|
|
10324
11131
|
},
|
|
10325
11132
|
"control": {
|
|
10326
11133
|
"type": "string",
|
|
10327
|
-
"
|
|
11134
|
+
"description": "Deprecated."
|
|
10328
11135
|
}
|
|
10329
11136
|
}
|
|
10330
11137
|
},
|
|
@@ -10351,6 +11158,15 @@
|
|
|
10351
11158
|
},
|
|
10352
11159
|
"title": "Represents a historical replication status of a Namespace"
|
|
10353
11160
|
},
|
|
11161
|
+
"v1FetchWorkerConfigResponse": {
|
|
11162
|
+
"type": "object",
|
|
11163
|
+
"properties": {
|
|
11164
|
+
"workerConfig": {
|
|
11165
|
+
"$ref": "#/definitions/v1WorkerConfig",
|
|
11166
|
+
"description": "The worker configuration."
|
|
11167
|
+
}
|
|
11168
|
+
}
|
|
11169
|
+
},
|
|
10354
11170
|
"v1GetClusterInfoResponse": {
|
|
10355
11171
|
"type": "object",
|
|
10356
11172
|
"properties": {
|
|
@@ -11113,6 +11929,23 @@
|
|
|
11113
11929
|
}
|
|
11114
11930
|
}
|
|
11115
11931
|
},
|
|
11932
|
+
"v1ListWorkersResponse": {
|
|
11933
|
+
"type": "object",
|
|
11934
|
+
"properties": {
|
|
11935
|
+
"workersInfo": {
|
|
11936
|
+
"type": "array",
|
|
11937
|
+
"items": {
|
|
11938
|
+
"type": "object",
|
|
11939
|
+
"$ref": "#/definitions/v1WorkerInfo"
|
|
11940
|
+
}
|
|
11941
|
+
},
|
|
11942
|
+
"nextPageToken": {
|
|
11943
|
+
"type": "string",
|
|
11944
|
+
"format": "byte",
|
|
11945
|
+
"title": "Next page token"
|
|
11946
|
+
}
|
|
11947
|
+
}
|
|
11948
|
+
},
|
|
11116
11949
|
"v1ListWorkflowExecutionsResponse": {
|
|
11117
11950
|
"type": "object",
|
|
11118
11951
|
"properties": {
|
|
@@ -11642,7 +12475,7 @@
|
|
|
11642
12475
|
},
|
|
11643
12476
|
"operationId": {
|
|
11644
12477
|
"type": "string",
|
|
11645
|
-
"description": "Operation ID - may be empty if the operation completed synchronously.\n\nDeprecated
|
|
12478
|
+
"description": "Operation ID - may be empty if the operation completed synchronously.\n\nDeprecated. Renamed to operation_token."
|
|
11646
12479
|
},
|
|
11647
12480
|
"operationToken": {
|
|
11648
12481
|
"type": "string",
|
|
@@ -11850,15 +12683,15 @@
|
|
|
11850
12683
|
"useWorkflowBuildId": {
|
|
11851
12684
|
"type": "object",
|
|
11852
12685
|
"properties": {},
|
|
11853
|
-
"description": "When present, it means this activity is assigned to the build ID of its workflow."
|
|
12686
|
+
"description": "Deprecated. When present, it means this activity is assigned to the build ID of its workflow."
|
|
11854
12687
|
},
|
|
11855
12688
|
"lastIndependentlyAssignedBuildId": {
|
|
11856
12689
|
"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."
|
|
12690
|
+
"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
12691
|
},
|
|
11859
12692
|
"lastWorkerVersionStamp": {
|
|
11860
12693
|
"$ref": "#/definitions/v1WorkerVersionStamp",
|
|
11861
|
-
"title": "The version stamp of the worker to whom this activity was most recently dispatched\
|
|
12694
|
+
"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
12695
|
},
|
|
11863
12696
|
"currentRetryInterval": {
|
|
11864
12697
|
"type": "string",
|
|
@@ -11955,7 +12788,7 @@
|
|
|
11955
12788
|
},
|
|
11956
12789
|
"operationId": {
|
|
11957
12790
|
"type": "string",
|
|
11958
|
-
"description": "Operation ID. Only set for asynchronous operations after a successful StartOperation call.\n\nDeprecated
|
|
12791
|
+
"description": "Operation ID. Only set for asynchronous operations after a successful StartOperation call.\n\nDeprecated. Renamed to operation_token."
|
|
11959
12792
|
},
|
|
11960
12793
|
"scheduleToCloseTimeout": {
|
|
11961
12794
|
"type": "string",
|
|
@@ -12053,6 +12886,19 @@
|
|
|
12053
12886
|
],
|
|
12054
12887
|
"default": "PENDING_WORKFLOW_TASK_STATE_UNSPECIFIED"
|
|
12055
12888
|
},
|
|
12889
|
+
"v1PluginInfo": {
|
|
12890
|
+
"type": "object",
|
|
12891
|
+
"properties": {
|
|
12892
|
+
"name": {
|
|
12893
|
+
"type": "string",
|
|
12894
|
+
"description": "The name of the plugin, required."
|
|
12895
|
+
},
|
|
12896
|
+
"version": {
|
|
12897
|
+
"type": "string",
|
|
12898
|
+
"description": "The version of the plugin, may be empty."
|
|
12899
|
+
}
|
|
12900
|
+
}
|
|
12901
|
+
},
|
|
12056
12902
|
"v1PollActivityTaskQueueResponse": {
|
|
12057
12903
|
"type": "object",
|
|
12058
12904
|
"properties": {
|
|
@@ -12308,10 +13154,19 @@
|
|
|
12308
13154
|
"priorityKey": {
|
|
12309
13155
|
"type": "integer",
|
|
12310
13156
|
"format": "int32",
|
|
12311
|
-
"description": "Priority key is a positive integer from 1 to n, where smaller integers\ncorrespond to higher priorities (tasks run sooner). In general, tasks in\na queue should be processed in close to priority order, although small\ndeviations are possible.\n\nThe maximum priority value (minimum priority) is determined by server\nconfiguration, and defaults to 5.\n\
|
|
13157
|
+
"description": "Priority key is a positive integer from 1 to n, where smaller integers\ncorrespond to higher priorities (tasks run sooner). In general, tasks in\na queue should be processed in close to priority order, although small\ndeviations are possible.\n\nThe maximum priority value (minimum priority) is determined by server\nconfiguration, and defaults to 5.\n\nIf priority is not present (or zero), then the effective priority will be\nthe default priority, which is is calculated by (min+max)/2. With the\ndefault max of 5, and min of 1, that comes out to 3."
|
|
13158
|
+
},
|
|
13159
|
+
"fairnessKey": {
|
|
13160
|
+
"type": "string",
|
|
13161
|
+
"description": "Fairness key is a short string that's used as a key for a fairness\nbalancing mechanism. It may correspond to a tenant id, or to a fixed\nstring like \"high\" or \"low\". The default is the empty string.\n\nThe fairness mechanism attempts to dispatch tasks for a given key in\nproportion to its weight. For example, using a thousand distinct tenant\nids, each with a weight of 1.0 (the default) will result in each tenant\ngetting a roughly equal share of task dispatch throughput.\n\n(Note: this does not imply equal share of worker capacity! Fairness\ndecisions are made based on queue statistics, not\ncurrent worker load.)\n\nAs another example, using keys \"high\" and \"low\" with weight 9.0 and 1.0\nrespectively will prefer dispatching \"high\" tasks over \"low\" tasks at a\n9:1 ratio, while allowing either key to use all worker capacity if the\nother is not present.\n\nAll fairness mechanisms, including rate limits, are best-effort and\nprobabilistic. The results may not match what a \"perfect\" algorithm with\ninfinite resources would produce. The more unique keys are used, the less\naccurate the results will be.\n\nFairness keys are limited to 64 bytes."
|
|
13162
|
+
},
|
|
13163
|
+
"fairnessWeight": {
|
|
13164
|
+
"type": "number",
|
|
13165
|
+
"format": "float",
|
|
13166
|
+
"description": "Fairness weight for a task can come from multiple sources for\nflexibility. From highest to lowest precedence:\n1. Weights for a small set of keys can be overridden in task queue\n configuration with an API.\n2. It can be attached to the workflow/activity in this field.\n3. The default weight of 1.0 will be used.\n\nWeight values are clamped to the range [0.001, 1000]."
|
|
12312
13167
|
}
|
|
12313
13168
|
},
|
|
12314
|
-
"description": "Priority contains metadata that controls relative ordering of task processing\nwhen tasks are
|
|
13169
|
+
"description": "Priority contains metadata that controls relative ordering of task processing\nwhen tasks are backed up in a queue. Initially, Priority will be used in\nmatching (workflow and activity) task queues. Later it may be used in history\ntask queues and in rate limiting decisions.\n\nPriority is attached to workflows and activities. By default, activities\ninherit Priority from the workflow that created them, but may override fields\nwhen an activity is started or modified.\n\nDespite being named \"Priority\", this message also contains fields that\ncontrol \"fairness\" mechanisms.\n\nFor all fields, the field not present or equal to zero/empty string means to\ninherit the value from the calling workflow, or if there is no calling\nworkflow, then use the default value.\n\nFor all fields other than fairness_key, the zero value isn't meaningful so\nthere's no confusion between inherit/default and a meaningful value. For\nfairness_key, the empty string will be interpreted as \"inherit\". This means\nthat if a workflow has a non-empty fairness key, you can't override the\nfairness key of its activity to the empty string.\n\nThe overall semantics of Priority are:\n1. First, consider \"priority\": higher priority (lower number) goes first.\n2. Then, consider fairness: try to dispatch tasks for different fairness keys\n in proportion to their weight.\n\nApplications may use any subset of mechanisms that are useful to them and\nleave the other fields to use default values.\n\nNot all queues in the system may support the \"full\" semantics of all priority\nfields. (Currently only support in matching task queues is planned.)"
|
|
12315
13170
|
},
|
|
12316
13171
|
"v1ProtocolMessageCommandAttributes": {
|
|
12317
13172
|
"type": "object",
|
|
@@ -12392,6 +13247,38 @@
|
|
|
12392
13247
|
},
|
|
12393
13248
|
"description": "Range represents a set of integer values, used to match fields of a calendar\ntime in StructuredCalendarSpec. If end < start, then end is interpreted as\nequal to start. This means you can use a Range with start set to a value, and\nend and step unset (defaulting to 0) to represent a single value."
|
|
12394
13249
|
},
|
|
13250
|
+
"v1RateLimit": {
|
|
13251
|
+
"type": "object",
|
|
13252
|
+
"properties": {
|
|
13253
|
+
"requestsPerSecond": {
|
|
13254
|
+
"type": "number",
|
|
13255
|
+
"format": "float",
|
|
13256
|
+
"description": "Zero is a valid rate limit."
|
|
13257
|
+
}
|
|
13258
|
+
}
|
|
13259
|
+
},
|
|
13260
|
+
"v1RateLimitConfig": {
|
|
13261
|
+
"type": "object",
|
|
13262
|
+
"properties": {
|
|
13263
|
+
"rateLimit": {
|
|
13264
|
+
"$ref": "#/definitions/v1RateLimit"
|
|
13265
|
+
},
|
|
13266
|
+
"metadata": {
|
|
13267
|
+
"$ref": "#/definitions/v1ConfigMetadata"
|
|
13268
|
+
}
|
|
13269
|
+
}
|
|
13270
|
+
},
|
|
13271
|
+
"v1RateLimitSource": {
|
|
13272
|
+
"type": "string",
|
|
13273
|
+
"enum": [
|
|
13274
|
+
"RATE_LIMIT_SOURCE_UNSPECIFIED",
|
|
13275
|
+
"RATE_LIMIT_SOURCE_API",
|
|
13276
|
+
"RATE_LIMIT_SOURCE_WORKER",
|
|
13277
|
+
"RATE_LIMIT_SOURCE_SYSTEM"
|
|
13278
|
+
],
|
|
13279
|
+
"default": "RATE_LIMIT_SOURCE_UNSPECIFIED",
|
|
13280
|
+
"description": "Source for the effective rate limit.\n\n - RATE_LIMIT_SOURCE_API: The value was set by the API.\n - RATE_LIMIT_SOURCE_WORKER: The value was set by a worker.\n - RATE_LIMIT_SOURCE_SYSTEM: The value was set as the system default."
|
|
13281
|
+
},
|
|
12395
13282
|
"v1RecordActivityTaskHeartbeatByIdResponse": {
|
|
12396
13283
|
"type": "object",
|
|
12397
13284
|
"properties": {
|
|
@@ -12446,6 +13333,9 @@
|
|
|
12446
13333
|
}
|
|
12447
13334
|
}
|
|
12448
13335
|
},
|
|
13336
|
+
"v1RecordWorkerHeartbeatResponse": {
|
|
13337
|
+
"type": "object"
|
|
13338
|
+
},
|
|
12449
13339
|
"v1RegisterNamespaceRequest": {
|
|
12450
13340
|
"type": "object",
|
|
12451
13341
|
"properties": {
|
|
@@ -12598,7 +13488,7 @@
|
|
|
12598
13488
|
},
|
|
12599
13489
|
"control": {
|
|
12600
13490
|
"type": "string",
|
|
12601
|
-
"
|
|
13491
|
+
"description": "Deprecated."
|
|
12602
13492
|
}
|
|
12603
13493
|
}
|
|
12604
13494
|
},
|
|
@@ -12622,7 +13512,7 @@
|
|
|
12622
13512
|
},
|
|
12623
13513
|
"control": {
|
|
12624
13514
|
"type": "string",
|
|
12625
|
-
"
|
|
13515
|
+
"description": "Deprecated."
|
|
12626
13516
|
},
|
|
12627
13517
|
"childWorkflowOnly": {
|
|
12628
13518
|
"type": "boolean",
|
|
@@ -12693,7 +13583,7 @@
|
|
|
12693
13583
|
},
|
|
12694
13584
|
"resetReapplyType": {
|
|
12695
13585
|
"$ref": "#/definitions/v1ResetReapplyType",
|
|
12696
|
-
"title": "
|
|
13586
|
+
"title": "Deprecated. Use `options`.\nDefault: RESET_REAPPLY_TYPE_SIGNAL"
|
|
12697
13587
|
},
|
|
12698
13588
|
"currentRunOnly": {
|
|
12699
13589
|
"type": "boolean",
|
|
@@ -12718,7 +13608,7 @@
|
|
|
12718
13608
|
},
|
|
12719
13609
|
"binaryChecksum": {
|
|
12720
13610
|
"type": "string",
|
|
12721
|
-
"description": "A worker binary version identifier
|
|
13611
|
+
"description": "Deprecated. A worker binary version identifier."
|
|
12722
13612
|
},
|
|
12723
13613
|
"runId": {
|
|
12724
13614
|
"type": "string",
|
|
@@ -12778,7 +13668,7 @@
|
|
|
12778
13668
|
"RESET_REAPPLY_TYPE_ALL_ELIGIBLE"
|
|
12779
13669
|
],
|
|
12780
13670
|
"default": "RESET_REAPPLY_TYPE_UNSPECIFIED",
|
|
12781
|
-
"description": "
|
|
13671
|
+
"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
13672
|
},
|
|
12783
13673
|
"v1ResetStickyTaskQueueResponse": {
|
|
12784
13674
|
"type": "object"
|
|
@@ -12791,7 +13681,7 @@
|
|
|
12791
13681
|
"RESET_TYPE_LAST_WORKFLOW_TASK"
|
|
12792
13682
|
],
|
|
12793
13683
|
"default": "RESET_TYPE_UNSPECIFIED",
|
|
12794
|
-
"description": "
|
|
13684
|
+
"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
13685
|
},
|
|
12796
13686
|
"v1ResetWorkflowExecutionResponse": {
|
|
12797
13687
|
"type": "object",
|
|
@@ -13157,7 +14047,8 @@
|
|
|
13157
14047
|
"format": "date-time"
|
|
13158
14048
|
},
|
|
13159
14049
|
"invalidScheduleError": {
|
|
13160
|
-
"type": "string"
|
|
14050
|
+
"type": "string",
|
|
14051
|
+
"description": "Deprecated."
|
|
13161
14052
|
}
|
|
13162
14053
|
}
|
|
13163
14054
|
},
|
|
@@ -13346,7 +14237,7 @@
|
|
|
13346
14237
|
"type": "object",
|
|
13347
14238
|
"$ref": "#/definitions/v1CalendarSpec"
|
|
13348
14239
|
},
|
|
13349
|
-
"description": "Any timestamps matching any of exclude_* will be skipped.\
|
|
14240
|
+
"description": "Any timestamps matching any of exclude_* will be skipped.\nDeprecated. Use exclude_structured_calendar."
|
|
13350
14241
|
},
|
|
13351
14242
|
"excludeStructuredCalendar": {
|
|
13352
14243
|
"type": "array",
|
|
@@ -13557,7 +14448,7 @@
|
|
|
13557
14448
|
},
|
|
13558
14449
|
"control": {
|
|
13559
14450
|
"type": "string",
|
|
13560
|
-
"
|
|
14451
|
+
"description": "Deprecated."
|
|
13561
14452
|
}
|
|
13562
14453
|
}
|
|
13563
14454
|
},
|
|
@@ -13589,7 +14480,7 @@
|
|
|
13589
14480
|
},
|
|
13590
14481
|
"control": {
|
|
13591
14482
|
"type": "string",
|
|
13592
|
-
"
|
|
14483
|
+
"description": "Deprecated."
|
|
13593
14484
|
},
|
|
13594
14485
|
"childWorkflowOnly": {
|
|
13595
14486
|
"type": "boolean",
|
|
@@ -13678,7 +14569,7 @@
|
|
|
13678
14569
|
},
|
|
13679
14570
|
"inheritBuildId": {
|
|
13680
14571
|
"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."
|
|
14572
|
+
"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
14573
|
},
|
|
13683
14574
|
"priority": {
|
|
13684
14575
|
"$ref": "#/definitions/v1Priority",
|
|
@@ -13716,7 +14607,7 @@
|
|
|
13716
14607
|
},
|
|
13717
14608
|
"control": {
|
|
13718
14609
|
"type": "string",
|
|
13719
|
-
"
|
|
14610
|
+
"description": "Deprecated."
|
|
13720
14611
|
},
|
|
13721
14612
|
"initiatedEventId": {
|
|
13722
14613
|
"type": "string",
|
|
@@ -13770,7 +14661,7 @@
|
|
|
13770
14661
|
},
|
|
13771
14662
|
"control": {
|
|
13772
14663
|
"type": "string",
|
|
13773
|
-
"
|
|
14664
|
+
"description": "Deprecated."
|
|
13774
14665
|
},
|
|
13775
14666
|
"workflowTaskCompletedEventId": {
|
|
13776
14667
|
"type": "string",
|
|
@@ -13799,7 +14690,7 @@
|
|
|
13799
14690
|
},
|
|
13800
14691
|
"inheritBuildId": {
|
|
13801
14692
|
"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."
|
|
14693
|
+
"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
14694
|
},
|
|
13804
14695
|
"priority": {
|
|
13805
14696
|
"$ref": "#/definitions/v1Priority",
|
|
@@ -14146,6 +15037,19 @@
|
|
|
14146
15037
|
},
|
|
14147
15038
|
"title": "See https://docs.temporal.io/docs/concepts/task-queues/"
|
|
14148
15039
|
},
|
|
15040
|
+
"v1TaskQueueConfig": {
|
|
15041
|
+
"type": "object",
|
|
15042
|
+
"properties": {
|
|
15043
|
+
"queueRateLimit": {
|
|
15044
|
+
"$ref": "#/definitions/v1RateLimitConfig",
|
|
15045
|
+
"description": "Unless modified, this is the system-defined rate limit."
|
|
15046
|
+
},
|
|
15047
|
+
"fairnessKeysRateLimitDefault": {
|
|
15048
|
+
"$ref": "#/definitions/v1RateLimitConfig",
|
|
15049
|
+
"description": "If set, each individual fairness key will be limited to this rate, scaled by the weight of the fairness key."
|
|
15050
|
+
}
|
|
15051
|
+
}
|
|
15052
|
+
},
|
|
14149
15053
|
"v1TaskQueueKind": {
|
|
14150
15054
|
"type": "string",
|
|
14151
15055
|
"enum": [
|
|
@@ -14466,6 +15370,11 @@
|
|
|
14466
15370
|
"overlapPolicy": {
|
|
14467
15371
|
"$ref": "#/definitions/v1ScheduleOverlapPolicy",
|
|
14468
15372
|
"description": "If set, override overlap policy for this one request."
|
|
15373
|
+
},
|
|
15374
|
+
"scheduledTime": {
|
|
15375
|
+
"type": "string",
|
|
15376
|
+
"format": "date-time",
|
|
15377
|
+
"description": "Timestamp used for the identity of the target workflow.\nIf not set the default value is the current time."
|
|
14469
15378
|
}
|
|
14470
15379
|
}
|
|
14471
15380
|
},
|
|
@@ -14597,10 +15506,27 @@
|
|
|
14597
15506
|
"v1UpdateScheduleResponse": {
|
|
14598
15507
|
"type": "object"
|
|
14599
15508
|
},
|
|
15509
|
+
"v1UpdateTaskQueueConfigResponse": {
|
|
15510
|
+
"type": "object",
|
|
15511
|
+
"properties": {
|
|
15512
|
+
"config": {
|
|
15513
|
+
"$ref": "#/definitions/v1TaskQueueConfig"
|
|
15514
|
+
}
|
|
15515
|
+
}
|
|
15516
|
+
},
|
|
14600
15517
|
"v1UpdateWorkerBuildIdCompatibilityResponse": {
|
|
14601
15518
|
"type": "object",
|
|
14602
15519
|
"title": "[cleanup-wv-pre-release]"
|
|
14603
15520
|
},
|
|
15521
|
+
"v1UpdateWorkerConfigResponse": {
|
|
15522
|
+
"type": "object",
|
|
15523
|
+
"properties": {
|
|
15524
|
+
"workerConfig": {
|
|
15525
|
+
"$ref": "#/definitions/v1WorkerConfig",
|
|
15526
|
+
"description": "The worker configuration. Will be returned if the command was sent to a single worker."
|
|
15527
|
+
}
|
|
15528
|
+
}
|
|
15529
|
+
},
|
|
14604
15530
|
"v1UpdateWorkerDeploymentVersionMetadataResponse": {
|
|
14605
15531
|
"type": "object",
|
|
14606
15532
|
"properties": {
|
|
@@ -14834,7 +15760,7 @@
|
|
|
14834
15760
|
"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
15761
|
}
|
|
14836
15762
|
},
|
|
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."
|
|
15763
|
+
"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
15764
|
},
|
|
14839
15765
|
"v1WaitPolicy": {
|
|
14840
15766
|
"type": "object",
|
|
@@ -14846,6 +15772,21 @@
|
|
|
14846
15772
|
},
|
|
14847
15773
|
"description": "Specifies client's intent to wait for Update results."
|
|
14848
15774
|
},
|
|
15775
|
+
"v1WorkerConfig": {
|
|
15776
|
+
"type": "object",
|
|
15777
|
+
"properties": {
|
|
15778
|
+
"workflowCacheSize": {
|
|
15779
|
+
"type": "integer",
|
|
15780
|
+
"format": "int32"
|
|
15781
|
+
},
|
|
15782
|
+
"simplePollerBehavior": {
|
|
15783
|
+
"$ref": "#/definitions/WorkerConfigSimplePollerBehavior"
|
|
15784
|
+
},
|
|
15785
|
+
"autoscalingPollerBehavior": {
|
|
15786
|
+
"$ref": "#/definitions/WorkerConfigAutoscalingPollerBehavior"
|
|
15787
|
+
}
|
|
15788
|
+
}
|
|
15789
|
+
},
|
|
14849
15790
|
"v1WorkerDeploymentInfo": {
|
|
14850
15791
|
"type": "object",
|
|
14851
15792
|
"properties": {
|
|
@@ -14914,6 +15855,10 @@
|
|
|
14914
15855
|
"type": "string",
|
|
14915
15856
|
"description": "Deprecated. Use `deployment_version`."
|
|
14916
15857
|
},
|
|
15858
|
+
"status": {
|
|
15859
|
+
"$ref": "#/definitions/v1WorkerDeploymentVersionStatus",
|
|
15860
|
+
"description": "The status of the Worker Deployment Version."
|
|
15861
|
+
},
|
|
14917
15862
|
"deploymentVersion": {
|
|
14918
15863
|
"$ref": "#/definitions/v1WorkerDeploymentVersion",
|
|
14919
15864
|
"description": "Required."
|
|
@@ -14933,12 +15878,22 @@
|
|
|
14933
15878
|
"currentSinceTime": {
|
|
14934
15879
|
"type": "string",
|
|
14935
15880
|
"format": "date-time",
|
|
14936
|
-
"description": "\
|
|
15881
|
+
"description": "\nUnset if not current."
|
|
14937
15882
|
},
|
|
14938
15883
|
"rampingSinceTime": {
|
|
14939
15884
|
"type": "string",
|
|
14940
15885
|
"format": "date-time",
|
|
14941
|
-
"description": "\
|
|
15886
|
+
"description": "\nUnset if not ramping. Updated when the version first starts ramping, not on each ramp change."
|
|
15887
|
+
},
|
|
15888
|
+
"firstActivationTime": {
|
|
15889
|
+
"type": "string",
|
|
15890
|
+
"format": "date-time",
|
|
15891
|
+
"description": "Timestamp when this version first became current or ramping."
|
|
15892
|
+
},
|
|
15893
|
+
"lastDeactivationTime": {
|
|
15894
|
+
"type": "string",
|
|
15895
|
+
"format": "date-time",
|
|
15896
|
+
"description": "Timestamp when this version last stopped being current or ramping."
|
|
14942
15897
|
},
|
|
14943
15898
|
"rampPercentage": {
|
|
14944
15899
|
"type": "number",
|
|
@@ -14951,7 +15906,7 @@
|
|
|
14951
15906
|
"type": "object",
|
|
14952
15907
|
"$ref": "#/definitions/WorkerDeploymentVersionInfoVersionTaskQueueInfo"
|
|
14953
15908
|
},
|
|
14954
|
-
"description": "All the Task Queues that have ever polled from this Deployment version."
|
|
15909
|
+
"description": "All the Task Queues that have ever polled from this Deployment version.\nDeprecated. Use `version_task_queues` in DescribeWorkerDeploymentVersionResponse instead."
|
|
14955
15910
|
},
|
|
14956
15911
|
"drainageInfo": {
|
|
14957
15912
|
"$ref": "#/definitions/v1VersionDrainageInfo",
|
|
@@ -14964,6 +15919,228 @@
|
|
|
14964
15919
|
},
|
|
14965
15920
|
"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
15921
|
},
|
|
15922
|
+
"v1WorkerDeploymentVersionStatus": {
|
|
15923
|
+
"type": "string",
|
|
15924
|
+
"enum": [
|
|
15925
|
+
"WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED",
|
|
15926
|
+
"WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE",
|
|
15927
|
+
"WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT",
|
|
15928
|
+
"WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING",
|
|
15929
|
+
"WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING",
|
|
15930
|
+
"WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED"
|
|
15931
|
+
],
|
|
15932
|
+
"default": "WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED",
|
|
15933
|
+
"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."
|
|
15934
|
+
},
|
|
15935
|
+
"v1WorkerHeartbeat": {
|
|
15936
|
+
"type": "object",
|
|
15937
|
+
"properties": {
|
|
15938
|
+
"workerInstanceKey": {
|
|
15939
|
+
"type": "string",
|
|
15940
|
+
"description": "Worker identifier, should be unique for the namespace.\nIt is distinct from worker identity, which is not necessarily namespace-unique."
|
|
15941
|
+
},
|
|
15942
|
+
"workerIdentity": {
|
|
15943
|
+
"type": "string",
|
|
15944
|
+
"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."
|
|
15945
|
+
},
|
|
15946
|
+
"hostInfo": {
|
|
15947
|
+
"$ref": "#/definitions/v1WorkerHostInfo",
|
|
15948
|
+
"description": "Worker host information."
|
|
15949
|
+
},
|
|
15950
|
+
"taskQueue": {
|
|
15951
|
+
"type": "string",
|
|
15952
|
+
"description": "Task queue this worker is polling for tasks."
|
|
15953
|
+
},
|
|
15954
|
+
"deploymentVersion": {
|
|
15955
|
+
"$ref": "#/definitions/v1WorkerDeploymentVersion"
|
|
15956
|
+
},
|
|
15957
|
+
"sdkName": {
|
|
15958
|
+
"type": "string"
|
|
15959
|
+
},
|
|
15960
|
+
"sdkVersion": {
|
|
15961
|
+
"type": "string"
|
|
15962
|
+
},
|
|
15963
|
+
"status": {
|
|
15964
|
+
"$ref": "#/definitions/v1WorkerStatus",
|
|
15965
|
+
"description": "Worker status. Defined by SDK."
|
|
15966
|
+
},
|
|
15967
|
+
"startTime": {
|
|
15968
|
+
"type": "string",
|
|
15969
|
+
"format": "date-time",
|
|
15970
|
+
"title": "Worker start time.\nIt can be used to determine worker uptime. (current time - start time)"
|
|
15971
|
+
},
|
|
15972
|
+
"heartbeatTime": {
|
|
15973
|
+
"type": "string",
|
|
15974
|
+
"format": "date-time",
|
|
15975
|
+
"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."
|
|
15976
|
+
},
|
|
15977
|
+
"elapsedSinceLastHeartbeat": {
|
|
15978
|
+
"type": "string",
|
|
15979
|
+
"description": "Elapsed time since the last heartbeat from the worker."
|
|
15980
|
+
},
|
|
15981
|
+
"workflowTaskSlotsInfo": {
|
|
15982
|
+
"$ref": "#/definitions/v1WorkerSlotsInfo"
|
|
15983
|
+
},
|
|
15984
|
+
"activityTaskSlotsInfo": {
|
|
15985
|
+
"$ref": "#/definitions/v1WorkerSlotsInfo"
|
|
15986
|
+
},
|
|
15987
|
+
"nexusTaskSlotsInfo": {
|
|
15988
|
+
"$ref": "#/definitions/v1WorkerSlotsInfo"
|
|
15989
|
+
},
|
|
15990
|
+
"localActivitySlotsInfo": {
|
|
15991
|
+
"$ref": "#/definitions/v1WorkerSlotsInfo"
|
|
15992
|
+
},
|
|
15993
|
+
"workflowPollerInfo": {
|
|
15994
|
+
"$ref": "#/definitions/v1WorkerPollerInfo"
|
|
15995
|
+
},
|
|
15996
|
+
"workflowStickyPollerInfo": {
|
|
15997
|
+
"$ref": "#/definitions/v1WorkerPollerInfo"
|
|
15998
|
+
},
|
|
15999
|
+
"activityPollerInfo": {
|
|
16000
|
+
"$ref": "#/definitions/v1WorkerPollerInfo"
|
|
16001
|
+
},
|
|
16002
|
+
"nexusPollerInfo": {
|
|
16003
|
+
"$ref": "#/definitions/v1WorkerPollerInfo"
|
|
16004
|
+
},
|
|
16005
|
+
"totalStickyCacheHit": {
|
|
16006
|
+
"type": "integer",
|
|
16007
|
+
"format": "int32",
|
|
16008
|
+
"description": "A Workflow Task found a cached Workflow Execution to run against."
|
|
16009
|
+
},
|
|
16010
|
+
"totalStickyCacheMiss": {
|
|
16011
|
+
"type": "integer",
|
|
16012
|
+
"format": "int32",
|
|
16013
|
+
"description": "A Workflow Task did not find a cached Workflow execution to run against."
|
|
16014
|
+
},
|
|
16015
|
+
"currentStickyCacheSize": {
|
|
16016
|
+
"type": "integer",
|
|
16017
|
+
"format": "int32",
|
|
16018
|
+
"description": "Current cache size, expressed in number of Workflow Executions."
|
|
16019
|
+
},
|
|
16020
|
+
"plugins": {
|
|
16021
|
+
"type": "array",
|
|
16022
|
+
"items": {
|
|
16023
|
+
"type": "object",
|
|
16024
|
+
"$ref": "#/definitions/v1PluginInfo"
|
|
16025
|
+
},
|
|
16026
|
+
"description": "Plugins currently in use by this SDK."
|
|
16027
|
+
}
|
|
16028
|
+
},
|
|
16029
|
+
"description": "Worker info message, contains information about the worker and its current state.\nAll information is provided by the worker itself."
|
|
16030
|
+
},
|
|
16031
|
+
"v1WorkerHostInfo": {
|
|
16032
|
+
"type": "object",
|
|
16033
|
+
"properties": {
|
|
16034
|
+
"hostName": {
|
|
16035
|
+
"type": "string",
|
|
16036
|
+
"description": "Worker host identifier."
|
|
16037
|
+
},
|
|
16038
|
+
"processKey": {
|
|
16039
|
+
"type": "string",
|
|
16040
|
+
"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}\""
|
|
16041
|
+
},
|
|
16042
|
+
"processId": {
|
|
16043
|
+
"type": "string",
|
|
16044
|
+
"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)."
|
|
16045
|
+
},
|
|
16046
|
+
"currentHostCpuUsage": {
|
|
16047
|
+
"type": "number",
|
|
16048
|
+
"format": "float",
|
|
16049
|
+
"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."
|
|
16050
|
+
},
|
|
16051
|
+
"currentHostMemUsage": {
|
|
16052
|
+
"type": "number",
|
|
16053
|
+
"format": "float",
|
|
16054
|
+
"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."
|
|
16055
|
+
}
|
|
16056
|
+
},
|
|
16057
|
+
"title": "Holds everything needed to identify the worker host/process context"
|
|
16058
|
+
},
|
|
16059
|
+
"v1WorkerInfo": {
|
|
16060
|
+
"type": "object",
|
|
16061
|
+
"properties": {
|
|
16062
|
+
"workerHeartbeat": {
|
|
16063
|
+
"$ref": "#/definitions/v1WorkerHeartbeat"
|
|
16064
|
+
}
|
|
16065
|
+
}
|
|
16066
|
+
},
|
|
16067
|
+
"v1WorkerPollerInfo": {
|
|
16068
|
+
"type": "object",
|
|
16069
|
+
"properties": {
|
|
16070
|
+
"currentPollers": {
|
|
16071
|
+
"type": "integer",
|
|
16072
|
+
"format": "int32",
|
|
16073
|
+
"description": "Number of polling RPCs that are currently in flight."
|
|
16074
|
+
},
|
|
16075
|
+
"lastSuccessfulPollTime": {
|
|
16076
|
+
"type": "string",
|
|
16077
|
+
"format": "date-time"
|
|
16078
|
+
},
|
|
16079
|
+
"isAutoscaling": {
|
|
16080
|
+
"type": "boolean",
|
|
16081
|
+
"title": "Set true if the number of concurrent pollers is auto-scaled"
|
|
16082
|
+
}
|
|
16083
|
+
}
|
|
16084
|
+
},
|
|
16085
|
+
"v1WorkerSelector": {
|
|
16086
|
+
"type": "object",
|
|
16087
|
+
"properties": {
|
|
16088
|
+
"workerInstanceKey": {
|
|
16089
|
+
"type": "string",
|
|
16090
|
+
"description": "Worker instance key to which the command should be sent."
|
|
16091
|
+
}
|
|
16092
|
+
},
|
|
16093
|
+
"description": "This is used to send commands to a specific worker or a group of workers.\nRight now, it is used to send commands to a specific worker instance.\nWill be extended to be able to send command to multiple workers."
|
|
16094
|
+
},
|
|
16095
|
+
"v1WorkerSlotsInfo": {
|
|
16096
|
+
"type": "object",
|
|
16097
|
+
"properties": {
|
|
16098
|
+
"currentAvailableSlots": {
|
|
16099
|
+
"type": "integer",
|
|
16100
|
+
"format": "int32",
|
|
16101
|
+
"description": "Number of slots available for the worker to specific tasks.\nMay be -1 if the upper bound is not known."
|
|
16102
|
+
},
|
|
16103
|
+
"currentUsedSlots": {
|
|
16104
|
+
"type": "integer",
|
|
16105
|
+
"format": "int32",
|
|
16106
|
+
"description": "Number of slots used by the worker for specific tasks."
|
|
16107
|
+
},
|
|
16108
|
+
"slotSupplierKind": {
|
|
16109
|
+
"type": "string",
|
|
16110
|
+
"title": "Kind of the slot supplier, which is used to determine how the slots are allocated.\nPossible values: \"Fixed | ResourceBased | Custom String\""
|
|
16111
|
+
},
|
|
16112
|
+
"totalProcessedTasks": {
|
|
16113
|
+
"type": "integer",
|
|
16114
|
+
"format": "int32",
|
|
16115
|
+
"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."
|
|
16116
|
+
},
|
|
16117
|
+
"totalFailedTasks": {
|
|
16118
|
+
"type": "integer",
|
|
16119
|
+
"format": "int32",
|
|
16120
|
+
"description": "Total number of failed tasks processed by the worker so far."
|
|
16121
|
+
},
|
|
16122
|
+
"lastIntervalProcessedTasks": {
|
|
16123
|
+
"type": "integer",
|
|
16124
|
+
"format": "int32",
|
|
16125
|
+
"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."
|
|
16126
|
+
},
|
|
16127
|
+
"lastIntervalFailureTasks": {
|
|
16128
|
+
"type": "integer",
|
|
16129
|
+
"format": "int32",
|
|
16130
|
+
"description": "Number of failed tasks processed since the last heartbeat from the worker."
|
|
16131
|
+
}
|
|
16132
|
+
}
|
|
16133
|
+
},
|
|
16134
|
+
"v1WorkerStatus": {
|
|
16135
|
+
"type": "string",
|
|
16136
|
+
"enum": [
|
|
16137
|
+
"WORKER_STATUS_UNSPECIFIED",
|
|
16138
|
+
"WORKER_STATUS_RUNNING",
|
|
16139
|
+
"WORKER_STATUS_SHUTTING_DOWN",
|
|
16140
|
+
"WORKER_STATUS_SHUTDOWN"
|
|
16141
|
+
],
|
|
16142
|
+
"default": "WORKER_STATUS_UNSPECIFIED"
|
|
16143
|
+
},
|
|
14967
16144
|
"v1WorkerVersionCapabilities": {
|
|
14968
16145
|
"type": "object",
|
|
14969
16146
|
"properties": {
|
|
@@ -15146,7 +16323,7 @@
|
|
|
15146
16323
|
},
|
|
15147
16324
|
"inheritBuildId": {
|
|
15148
16325
|
"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."
|
|
16326
|
+
"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
16327
|
}
|
|
15151
16328
|
}
|
|
15152
16329
|
},
|
|
@@ -15367,11 +16544,11 @@
|
|
|
15367
16544
|
},
|
|
15368
16545
|
"header": {
|
|
15369
16546
|
"$ref": "#/definitions/v1Header",
|
|
15370
|
-
"description": "Headers that were passed by the sender of the signal and copied by temporal
|
|
16547
|
+
"description": "Headers that were passed by the sender of the signal and copied by temporal\nserver into the workflow task."
|
|
15371
16548
|
},
|
|
15372
16549
|
"skipGenerateWorkflowTask": {
|
|
15373
16550
|
"type": "boolean",
|
|
15374
|
-
"description": "This field is
|
|
16551
|
+
"description": "Deprecated. This field is never respected and should always be set to false."
|
|
15375
16552
|
},
|
|
15376
16553
|
"externalWorkflowExecution": {
|
|
15377
16554
|
"$ref": "#/definitions/v1WorkflowExecution",
|
|
@@ -15422,7 +16599,7 @@
|
|
|
15422
16599
|
},
|
|
15423
16600
|
"continuedExecutionRunId": {
|
|
15424
16601
|
"type": "string",
|
|
15425
|
-
"description": "Run id of the previous workflow which continued-as-new or
|
|
16602
|
+
"description": "Run id of the previous workflow which continued-as-new or retried or cron executed into this\nworkflow."
|
|
15426
16603
|
},
|
|
15427
16604
|
"initiator": {
|
|
15428
16605
|
"$ref": "#/definitions/v1ContinueAsNewInitiator"
|
|
@@ -15509,19 +16686,23 @@
|
|
|
15509
16686
|
},
|
|
15510
16687
|
"versioningOverride": {
|
|
15511
16688
|
"$ref": "#/definitions/v1VersioningOverride",
|
|
15512
|
-
"description": "Versioning override applied to this workflow when it was started."
|
|
16689
|
+
"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
16690
|
},
|
|
15514
16691
|
"parentPinnedWorkerDeploymentVersion": {
|
|
15515
16692
|
"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."
|
|
16693
|
+
"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
16694
|
},
|
|
15522
16695
|
"priority": {
|
|
15523
16696
|
"$ref": "#/definitions/v1Priority",
|
|
15524
16697
|
"title": "Priority metadata"
|
|
16698
|
+
},
|
|
16699
|
+
"inheritedPinnedVersion": {
|
|
16700
|
+
"$ref": "#/definitions/v1WorkerDeploymentVersion",
|
|
16701
|
+
"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."
|
|
16702
|
+
},
|
|
16703
|
+
"eagerExecutionAccepted": {
|
|
16704
|
+
"type": "boolean",
|
|
16705
|
+
"description": "A boolean indicating whether the SDK has asked to eagerly execute the first workflow task for this workflow and\neager execution was accepted by the server.\nOnly populated by server with version >= 1.29.0."
|
|
15525
16706
|
}
|
|
15526
16707
|
},
|
|
15527
16708
|
"title": "Always the first event in workflow history"
|
|
@@ -15653,7 +16834,7 @@
|
|
|
15653
16834
|
"properties": {
|
|
15654
16835
|
"behavior": {
|
|
15655
16836
|
"$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 `
|
|
16837
|
+
"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
16838
|
},
|
|
15658
16839
|
"deployment": {
|
|
15659
16840
|
"$ref": "#/definitions/v1Deployment",
|
|
@@ -15669,7 +16850,7 @@
|
|
|
15669
16850
|
},
|
|
15670
16851
|
"versioningOverride": {
|
|
15671
16852
|
"$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."
|
|
16853
|
+
"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
16854
|
},
|
|
15674
16855
|
"deploymentTransition": {
|
|
15675
16856
|
"$ref": "#/definitions/v1DeploymentTransition",
|
|
@@ -15677,7 +16858,7 @@
|
|
|
15677
16858
|
},
|
|
15678
16859
|
"versionTransition": {
|
|
15679
16860
|
"$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 `
|
|
16861
|
+
"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
16862
|
}
|
|
15682
16863
|
},
|
|
15683
16864
|
"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 +17149,11 @@
|
|
|
15968
17149
|
"WORKFLOW_TASK_FAILED_CAUSE_BAD_SCHEDULE_NEXUS_OPERATION_ATTRIBUTES",
|
|
15969
17150
|
"WORKFLOW_TASK_FAILED_CAUSE_PENDING_NEXUS_OPERATIONS_LIMIT_EXCEEDED",
|
|
15970
17151
|
"WORKFLOW_TASK_FAILED_CAUSE_BAD_REQUEST_CANCEL_NEXUS_OPERATION_ATTRIBUTES",
|
|
15971
|
-
"WORKFLOW_TASK_FAILED_CAUSE_FEATURE_DISABLED"
|
|
17152
|
+
"WORKFLOW_TASK_FAILED_CAUSE_FEATURE_DISABLED",
|
|
17153
|
+
"WORKFLOW_TASK_FAILED_CAUSE_GRPC_MESSAGE_TOO_LARGE"
|
|
15972
17154
|
],
|
|
15973
17155
|
"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."
|
|
17156
|
+
"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
17157
|
},
|
|
15976
17158
|
"v1WorkflowTaskFailedEventAttributes": {
|
|
15977
17159
|
"type": "object",
|
|
@@ -16012,7 +17194,7 @@
|
|
|
16012
17194
|
},
|
|
16013
17195
|
"binaryChecksum": {
|
|
16014
17196
|
"type": "string",
|
|
16015
|
-
"title": "
|
|
17197
|
+
"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
17198
|
},
|
|
16017
17199
|
"workerVersion": {
|
|
16018
17200
|
"$ref": "#/definitions/v1WorkerVersionStamp",
|