@temporalio/core-bridge 1.11.2 → 1.11.4
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 +396 -489
- package/Cargo.toml +3 -2
- package/lib/errors.d.ts +2 -0
- package/lib/errors.js +7 -3
- package/lib/errors.js.map +1 -1
- package/lib/index.d.ts +8 -2
- package/lib/index.js.map +1 -1
- package/lib/worker-tuner.d.ts +111 -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/.github/workflows/per-pr.yml +3 -3
- package/sdk-core/Cargo.toml +0 -1
- package/sdk-core/client/Cargo.toml +1 -2
- package/sdk-core/client/src/lib.rs +21 -13
- package/sdk-core/client/src/metrics.rs +1 -1
- package/sdk-core/client/src/raw.rs +46 -1
- package/sdk-core/core/Cargo.toml +7 -7
- package/sdk-core/core/benches/workflow_replay.rs +1 -1
- package/sdk-core/core/src/abstractions/take_cell.rs +1 -1
- package/sdk-core/core/src/abstractions.rs +98 -10
- package/sdk-core/core/src/core_tests/activity_tasks.rs +8 -2
- package/sdk-core/core/src/core_tests/local_activities.rs +1 -1
- package/sdk-core/core/src/core_tests/mod.rs +3 -3
- package/sdk-core/core/src/core_tests/updates.rs +104 -9
- package/sdk-core/core/src/core_tests/workers.rs +72 -3
- package/sdk-core/core/src/core_tests/workflow_tasks.rs +6 -7
- package/sdk-core/core/src/debug_client.rs +78 -0
- package/sdk-core/core/src/ephemeral_server/mod.rs +15 -5
- package/sdk-core/core/src/lib.rs +30 -4
- package/sdk-core/core/src/pollers/mod.rs +1 -1
- package/sdk-core/core/src/pollers/poll_buffer.rs +7 -7
- package/sdk-core/core/src/replay/mod.rs +4 -4
- package/sdk-core/core/src/telemetry/log_export.rs +2 -2
- package/sdk-core/core/src/telemetry/metrics.rs +69 -1
- package/sdk-core/core/src/telemetry/otel.rs +2 -2
- package/sdk-core/core/src/test_help/mod.rs +3 -3
- package/sdk-core/core/src/worker/activities/activity_heartbeat_manager.rs +3 -3
- package/sdk-core/core/src/worker/activities/activity_task_poller_stream.rs +1 -1
- package/sdk-core/core/src/worker/activities/local_activities.rs +68 -24
- package/sdk-core/core/src/worker/activities.rs +26 -15
- package/sdk-core/core/src/worker/client/mocks.rs +10 -4
- package/sdk-core/core/src/worker/client.rs +17 -0
- package/sdk-core/core/src/worker/mod.rs +71 -13
- package/sdk-core/core/src/worker/slot_provider.rs +5 -7
- package/sdk-core/core/src/worker/tuner/fixed_size.rs +4 -3
- package/sdk-core/core/src/worker/tuner/resource_based.rs +171 -32
- package/sdk-core/core/src/worker/tuner.rs +18 -6
- package/sdk-core/core/src/worker/workflow/history_update.rs +43 -13
- package/sdk-core/core/src/worker/workflow/machines/transition_coverage.rs +6 -6
- package/sdk-core/core/src/worker/workflow/machines/workflow_machines.rs +6 -5
- package/sdk-core/core/src/worker/workflow/managed_run.rs +3 -3
- package/sdk-core/core/src/worker/workflow/mod.rs +13 -7
- package/sdk-core/core/src/worker/workflow/wft_extraction.rs +7 -7
- package/sdk-core/core/src/worker/workflow/wft_poller.rs +2 -2
- package/sdk-core/core/src/worker/workflow/workflow_stream.rs +11 -11
- package/sdk-core/core-api/Cargo.toml +1 -0
- package/sdk-core/core-api/src/worker.rs +84 -30
- package/sdk-core/sdk/Cargo.toml +1 -2
- package/sdk-core/sdk/src/lib.rs +1 -1
- package/sdk-core/sdk/src/workflow_context.rs +9 -8
- package/sdk-core/sdk/src/workflow_future.rs +19 -14
- package/sdk-core/sdk-core-protos/Cargo.toml +2 -0
- package/sdk-core/sdk-core-protos/build.rs +6 -1
- package/sdk-core/sdk-core-protos/protos/api_upstream/buf.yaml +1 -0
- package/sdk-core/sdk-core-protos/protos/api_upstream/openapi/openapiv2.json +3207 -158
- package/sdk-core/sdk-core-protos/protos/api_upstream/openapi/openapiv3.yaml +2934 -118
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/activity/v1/message.proto +67 -0
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/common/v1/message.proto +47 -1
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/event_type.proto +6 -7
- 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 +5 -3
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/task_queue.proto +3 -3
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/update.proto +14 -13
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/failure/v1/message.proto +1 -3
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/history/v1/message.proto +22 -0
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/nexus/v1/message.proto +13 -2
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/operatorservice/v1/service.proto +26 -6
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/schedule/v1/message.proto +5 -0
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/sdk/v1/workflow_metadata.proto +6 -0
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/taskqueue/v1/message.proto +46 -12
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/update/v1/message.proto +18 -19
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflow/v1/message.proto +27 -0
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflowservice/v1/request_response.proto +192 -19
- package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflowservice/v1/service.proto +279 -12
- package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/activity_result/activity_result.proto +1 -1
- package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/activity_task/activity_task.proto +1 -1
- package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/child_workflow/child_workflow.proto +1 -1
- package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/common/common.proto +1 -1
- package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/core_interface.proto +17 -1
- package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/external_data/external_data.proto +1 -1
- package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/workflow_activation/workflow_activation.proto +1 -1
- package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/workflow_commands/workflow_commands.proto +1 -1
- package/sdk-core/sdk-core-protos/protos/local/temporal/sdk/core/workflow_completion/workflow_completion.proto +1 -1
- package/sdk-core/sdk-core-protos/src/lib.rs +30 -6
- package/sdk-core/test-utils/Cargo.toml +1 -2
- package/sdk-core/test-utils/src/lib.rs +2 -2
- package/sdk-core/tests/heavy_tests.rs +1 -1
- package/sdk-core/tests/integ_tests/ephemeral_server_tests.rs +2 -2
- package/sdk-core/tests/integ_tests/metrics_tests.rs +144 -7
- package/sdk-core/tests/integ_tests/queries_tests.rs +1 -1
- package/sdk-core/tests/integ_tests/update_tests.rs +109 -5
- package/sdk-core/tests/integ_tests/worker_tests.rs +44 -8
- package/sdk-core/tests/integ_tests/workflow_tests/local_activities.rs +1 -1
- package/sdk-core/tests/integ_tests/workflow_tests/resets.rs +1 -1
- package/sdk-core/tests/integ_tests/workflow_tests/signals.rs +1 -1
- package/sdk-core/tests/integ_tests/workflow_tests.rs +3 -2
- package/src/conversions/slot_supplier_bridge.rs +287 -0
- package/src/conversions.rs +23 -15
- package/src/helpers.rs +35 -1
- package/src/runtime.rs +7 -3
- package/src/worker.rs +1 -1
- package/ts/errors.ts +9 -2
- package/ts/index.ts +19 -4
- package/ts/worker-tuner.ts +123 -1
- package/sdk-core/sdk-core-protos/protos/api_upstream/.gitmodules +0 -3
|
@@ -6,7 +6,7 @@ info:
|
|
|
6
6
|
title: ""
|
|
7
7
|
version: 0.0.1
|
|
8
8
|
paths:
|
|
9
|
-
/cluster-info:
|
|
9
|
+
/api/v1/cluster-info:
|
|
10
10
|
get:
|
|
11
11
|
tags:
|
|
12
12
|
- WorkflowService
|
|
@@ -25,7 +25,7 @@ paths:
|
|
|
25
25
|
application/json:
|
|
26
26
|
schema:
|
|
27
27
|
$ref: '#/components/schemas/Status'
|
|
28
|
-
/namespaces:
|
|
28
|
+
/api/v1/namespaces:
|
|
29
29
|
get:
|
|
30
30
|
tags:
|
|
31
31
|
- WorkflowService
|
|
@@ -93,7 +93,7 @@ paths:
|
|
|
93
93
|
application/json:
|
|
94
94
|
schema:
|
|
95
95
|
$ref: '#/components/schemas/Status'
|
|
96
|
-
/namespaces/{namespace}:
|
|
96
|
+
/api/v1/namespaces/{namespace}:
|
|
97
97
|
get:
|
|
98
98
|
tags:
|
|
99
99
|
- WorkflowService
|
|
@@ -122,7 +122,7 @@ paths:
|
|
|
122
122
|
application/json:
|
|
123
123
|
schema:
|
|
124
124
|
$ref: '#/components/schemas/Status'
|
|
125
|
-
/namespaces/{namespace}/activities/cancel:
|
|
125
|
+
/api/v1/namespaces/{namespace}/activities/cancel:
|
|
126
126
|
post:
|
|
127
127
|
tags:
|
|
128
128
|
- WorkflowService
|
|
@@ -158,7 +158,7 @@ paths:
|
|
|
158
158
|
application/json:
|
|
159
159
|
schema:
|
|
160
160
|
$ref: '#/components/schemas/Status'
|
|
161
|
-
/namespaces/{namespace}/activities/cancel-by-id:
|
|
161
|
+
/api/v1/namespaces/{namespace}/activities/cancel-by-id:
|
|
162
162
|
post:
|
|
163
163
|
tags:
|
|
164
164
|
- WorkflowService
|
|
@@ -195,7 +195,7 @@ paths:
|
|
|
195
195
|
application/json:
|
|
196
196
|
schema:
|
|
197
197
|
$ref: '#/components/schemas/Status'
|
|
198
|
-
/namespaces/{namespace}/activities/complete:
|
|
198
|
+
/api/v1/namespaces/{namespace}/activities/complete:
|
|
199
199
|
post:
|
|
200
200
|
tags:
|
|
201
201
|
- WorkflowService
|
|
@@ -232,7 +232,7 @@ paths:
|
|
|
232
232
|
application/json:
|
|
233
233
|
schema:
|
|
234
234
|
$ref: '#/components/schemas/Status'
|
|
235
|
-
/namespaces/{namespace}/activities/complete-by-id:
|
|
235
|
+
/api/v1/namespaces/{namespace}/activities/complete-by-id:
|
|
236
236
|
post:
|
|
237
237
|
tags:
|
|
238
238
|
- WorkflowService
|
|
@@ -269,7 +269,7 @@ paths:
|
|
|
269
269
|
application/json:
|
|
270
270
|
schema:
|
|
271
271
|
$ref: '#/components/schemas/Status'
|
|
272
|
-
/namespaces/{namespace}/activities/fail:
|
|
272
|
+
/api/v1/namespaces/{namespace}/activities/fail:
|
|
273
273
|
post:
|
|
274
274
|
tags:
|
|
275
275
|
- WorkflowService
|
|
@@ -305,7 +305,7 @@ paths:
|
|
|
305
305
|
application/json:
|
|
306
306
|
schema:
|
|
307
307
|
$ref: '#/components/schemas/Status'
|
|
308
|
-
/namespaces/{namespace}/activities/fail-by-id:
|
|
308
|
+
/api/v1/namespaces/{namespace}/activities/fail-by-id:
|
|
309
309
|
post:
|
|
310
310
|
tags:
|
|
311
311
|
- WorkflowService
|
|
@@ -342,7 +342,7 @@ paths:
|
|
|
342
342
|
application/json:
|
|
343
343
|
schema:
|
|
344
344
|
$ref: '#/components/schemas/Status'
|
|
345
|
-
/namespaces/{namespace}/activities/heartbeat:
|
|
345
|
+
/api/v1/namespaces/{namespace}/activities/heartbeat:
|
|
346
346
|
post:
|
|
347
347
|
tags:
|
|
348
348
|
- WorkflowService
|
|
@@ -379,7 +379,7 @@ paths:
|
|
|
379
379
|
application/json:
|
|
380
380
|
schema:
|
|
381
381
|
$ref: '#/components/schemas/Status'
|
|
382
|
-
/namespaces/{namespace}/activities/heartbeat-by-id:
|
|
382
|
+
/api/v1/namespaces/{namespace}/activities/heartbeat-by-id:
|
|
383
383
|
post:
|
|
384
384
|
tags:
|
|
385
385
|
- WorkflowService
|
|
@@ -416,7 +416,179 @@ paths:
|
|
|
416
416
|
application/json:
|
|
417
417
|
schema:
|
|
418
418
|
$ref: '#/components/schemas/Status'
|
|
419
|
-
/namespaces/{namespace}/
|
|
419
|
+
/api/v1/namespaces/{namespace}/activities/pause-by-id:
|
|
420
|
+
post:
|
|
421
|
+
tags:
|
|
422
|
+
- WorkflowService
|
|
423
|
+
description: |-
|
|
424
|
+
PauseActivityById pauses the execution of an activity specified by its ID.
|
|
425
|
+
Returns a `NotFound` error if there is no pending activity with the provided ID.
|
|
426
|
+
|
|
427
|
+
Pausing an activity means:
|
|
428
|
+
- If the activity is currently waiting for a retry or is running and subsequently fails,
|
|
429
|
+
it will not be rescheduled until it is unpaused.
|
|
430
|
+
- If the activity is already paused, calling this method will have no effect.
|
|
431
|
+
- If the activity is running and finishes successfully, the activity will be completed.
|
|
432
|
+
- If the activity is running and finishes with failure:
|
|
433
|
+
* if there is no retry left - the activity will be completed.
|
|
434
|
+
* if there are more retries left - the activity will be paused.
|
|
435
|
+
For long-running activities:
|
|
436
|
+
- activities in paused state will send a cancellation with "activity_paused" set to 'true' in response to 'RecordActivityTaskHeartbeat'.
|
|
437
|
+
- The activity should respond to the cancellation accordingly.
|
|
438
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
439
|
+
aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
440
|
+
operationId: PauseActivityById
|
|
441
|
+
parameters:
|
|
442
|
+
- name: namespace
|
|
443
|
+
in: path
|
|
444
|
+
description: Namespace of the workflow which scheduled this activity.
|
|
445
|
+
required: true
|
|
446
|
+
schema:
|
|
447
|
+
type: string
|
|
448
|
+
requestBody:
|
|
449
|
+
content:
|
|
450
|
+
application/json:
|
|
451
|
+
schema:
|
|
452
|
+
$ref: '#/components/schemas/PauseActivityByIdRequest'
|
|
453
|
+
required: true
|
|
454
|
+
responses:
|
|
455
|
+
"200":
|
|
456
|
+
description: OK
|
|
457
|
+
content:
|
|
458
|
+
application/json:
|
|
459
|
+
schema:
|
|
460
|
+
$ref: '#/components/schemas/PauseActivityByIdResponse'
|
|
461
|
+
default:
|
|
462
|
+
description: Default error response
|
|
463
|
+
content:
|
|
464
|
+
application/json:
|
|
465
|
+
schema:
|
|
466
|
+
$ref: '#/components/schemas/Status'
|
|
467
|
+
/api/v1/namespaces/{namespace}/activities/reset-by-id:
|
|
468
|
+
post:
|
|
469
|
+
tags:
|
|
470
|
+
- WorkflowService
|
|
471
|
+
description: |-
|
|
472
|
+
ResetActivityById unpauses the execution of an activity specified by its ID.
|
|
473
|
+
Returns a `NotFound` error if there is no pending activity with the provided ID.
|
|
474
|
+
Resetting an activity means:
|
|
475
|
+
* number of attempts will be reset to 0.
|
|
476
|
+
* activity timeouts will be resetted.
|
|
477
|
+
If the activity currently running:
|
|
478
|
+
* if 'no_wait' flag is provided, a new instance of the activity will be scheduled immediately.
|
|
479
|
+
* if 'no_wait' flag is not provided, a new instance of the activity will be scheduled after current instance completes if needed.
|
|
480
|
+
If 'reset_heartbeats' flag is set, the activity heartbeat timer and heartbeats will be reset.
|
|
481
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
482
|
+
aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
483
|
+
operationId: ResetActivityById
|
|
484
|
+
parameters:
|
|
485
|
+
- name: namespace
|
|
486
|
+
in: path
|
|
487
|
+
description: Namespace of the workflow which scheduled this activity.
|
|
488
|
+
required: true
|
|
489
|
+
schema:
|
|
490
|
+
type: string
|
|
491
|
+
requestBody:
|
|
492
|
+
content:
|
|
493
|
+
application/json:
|
|
494
|
+
schema:
|
|
495
|
+
$ref: '#/components/schemas/ResetActivityByIdRequest'
|
|
496
|
+
required: true
|
|
497
|
+
responses:
|
|
498
|
+
"200":
|
|
499
|
+
description: OK
|
|
500
|
+
content:
|
|
501
|
+
application/json:
|
|
502
|
+
schema:
|
|
503
|
+
$ref: '#/components/schemas/ResetActivityByIdResponse'
|
|
504
|
+
default:
|
|
505
|
+
description: Default error response
|
|
506
|
+
content:
|
|
507
|
+
application/json:
|
|
508
|
+
schema:
|
|
509
|
+
$ref: '#/components/schemas/Status'
|
|
510
|
+
/api/v1/namespaces/{namespace}/activities/unpause-by-id:
|
|
511
|
+
post:
|
|
512
|
+
tags:
|
|
513
|
+
- WorkflowService
|
|
514
|
+
description: |-
|
|
515
|
+
UnpauseActivityById unpauses the execution of an activity specified by its ID.
|
|
516
|
+
Returns a `NotFound` error if there is no pending activity with the provided ID.
|
|
517
|
+
There are two 'modes' of unpausing an activity:
|
|
518
|
+
'resume' - If the activity is paused, it will be resumed and scheduled for execution.
|
|
519
|
+
* If the activity is currently running Unpause with 'resume' has no effect.
|
|
520
|
+
* if 'no_wait' flag is set and the activity is waiting, the activity will be scheduled immediately.
|
|
521
|
+
'reset' - If the activity is paused, it will be reset to its initial state and (depending on parameters) scheduled for execution.
|
|
522
|
+
* If the activity is currently running, Unpause with 'reset' will reset the number of attempts.
|
|
523
|
+
* if 'no_wait' flag is set, the activity will be scheduled immediately.
|
|
524
|
+
* if 'reset_heartbeats' flag is set, the activity heartbeat timer and heartbeats will be reset.
|
|
525
|
+
If the activity is in waiting for retry and past it retry timeout, it will be scheduled immediately.
|
|
526
|
+
Once the activity is unpaused, all timeout timers will be regenerated.
|
|
527
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
528
|
+
aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
529
|
+
operationId: UnpauseActivityById
|
|
530
|
+
parameters:
|
|
531
|
+
- name: namespace
|
|
532
|
+
in: path
|
|
533
|
+
description: Namespace of the workflow which scheduled this activity.
|
|
534
|
+
required: true
|
|
535
|
+
schema:
|
|
536
|
+
type: string
|
|
537
|
+
requestBody:
|
|
538
|
+
content:
|
|
539
|
+
application/json:
|
|
540
|
+
schema:
|
|
541
|
+
$ref: '#/components/schemas/UnpauseActivityByIdRequest'
|
|
542
|
+
required: true
|
|
543
|
+
responses:
|
|
544
|
+
"200":
|
|
545
|
+
description: OK
|
|
546
|
+
content:
|
|
547
|
+
application/json:
|
|
548
|
+
schema:
|
|
549
|
+
$ref: '#/components/schemas/UnpauseActivityByIdResponse'
|
|
550
|
+
default:
|
|
551
|
+
description: Default error response
|
|
552
|
+
content:
|
|
553
|
+
application/json:
|
|
554
|
+
schema:
|
|
555
|
+
$ref: '#/components/schemas/Status'
|
|
556
|
+
/api/v1/namespaces/{namespace}/activities/update-options-by-id:
|
|
557
|
+
post:
|
|
558
|
+
tags:
|
|
559
|
+
- WorkflowService
|
|
560
|
+
description: |-
|
|
561
|
+
UpdateActivityOptionsById is called by the client to update the options of an activity
|
|
562
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
563
|
+
aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
564
|
+
operationId: UpdateActivityOptionsById
|
|
565
|
+
parameters:
|
|
566
|
+
- name: namespace
|
|
567
|
+
in: path
|
|
568
|
+
description: Namespace of the workflow which scheduled this activity
|
|
569
|
+
required: true
|
|
570
|
+
schema:
|
|
571
|
+
type: string
|
|
572
|
+
requestBody:
|
|
573
|
+
content:
|
|
574
|
+
application/json:
|
|
575
|
+
schema:
|
|
576
|
+
$ref: '#/components/schemas/UpdateActivityOptionsByIdRequest'
|
|
577
|
+
required: true
|
|
578
|
+
responses:
|
|
579
|
+
"200":
|
|
580
|
+
description: OK
|
|
581
|
+
content:
|
|
582
|
+
application/json:
|
|
583
|
+
schema:
|
|
584
|
+
$ref: '#/components/schemas/UpdateActivityOptionsByIdResponse'
|
|
585
|
+
default:
|
|
586
|
+
description: Default error response
|
|
587
|
+
content:
|
|
588
|
+
application/json:
|
|
589
|
+
schema:
|
|
590
|
+
$ref: '#/components/schemas/Status'
|
|
591
|
+
/api/v1/namespaces/{namespace}/archived-workflows:
|
|
420
592
|
get:
|
|
421
593
|
tags:
|
|
422
594
|
- WorkflowService
|
|
@@ -455,7 +627,7 @@ paths:
|
|
|
455
627
|
application/json:
|
|
456
628
|
schema:
|
|
457
629
|
$ref: '#/components/schemas/Status'
|
|
458
|
-
/namespaces/{namespace}/batch-operations:
|
|
630
|
+
/api/v1/namespaces/{namespace}/batch-operations:
|
|
459
631
|
get:
|
|
460
632
|
tags:
|
|
461
633
|
- WorkflowService
|
|
@@ -493,7 +665,7 @@ paths:
|
|
|
493
665
|
application/json:
|
|
494
666
|
schema:
|
|
495
667
|
$ref: '#/components/schemas/Status'
|
|
496
|
-
/namespaces/{namespace}/batch-operations/{jobId}:
|
|
668
|
+
/api/v1/namespaces/{namespace}/batch-operations/{jobId}:
|
|
497
669
|
get:
|
|
498
670
|
tags:
|
|
499
671
|
- WorkflowService
|
|
@@ -562,7 +734,7 @@ paths:
|
|
|
562
734
|
application/json:
|
|
563
735
|
schema:
|
|
564
736
|
$ref: '#/components/schemas/Status'
|
|
565
|
-
/namespaces/{namespace}/batch-operations/{jobId}/stop:
|
|
737
|
+
/api/v1/namespaces/{namespace}/batch-operations/{jobId}/stop:
|
|
566
738
|
post:
|
|
567
739
|
tags:
|
|
568
740
|
- WorkflowService
|
|
@@ -600,7 +772,7 @@ paths:
|
|
|
600
772
|
application/json:
|
|
601
773
|
schema:
|
|
602
774
|
$ref: '#/components/schemas/Status'
|
|
603
|
-
/namespaces/{namespace}/schedules:
|
|
775
|
+
/api/v1/namespaces/{namespace}/schedules:
|
|
604
776
|
get:
|
|
605
777
|
tags:
|
|
606
778
|
- WorkflowService
|
|
@@ -643,7 +815,7 @@ paths:
|
|
|
643
815
|
application/json:
|
|
644
816
|
schema:
|
|
645
817
|
$ref: '#/components/schemas/Status'
|
|
646
|
-
/namespaces/{namespace}/schedules/{scheduleId}:
|
|
818
|
+
/api/v1/namespaces/{namespace}/schedules/{scheduleId}:
|
|
647
819
|
get:
|
|
648
820
|
tags:
|
|
649
821
|
- WorkflowService
|
|
@@ -748,7 +920,7 @@ paths:
|
|
|
748
920
|
application/json:
|
|
749
921
|
schema:
|
|
750
922
|
$ref: '#/components/schemas/Status'
|
|
751
|
-
/namespaces/{namespace}/schedules/{scheduleId}/matching-times:
|
|
923
|
+
/api/v1/namespaces/{namespace}/schedules/{scheduleId}/matching-times:
|
|
752
924
|
get:
|
|
753
925
|
tags:
|
|
754
926
|
- WorkflowService
|
|
@@ -791,7 +963,7 @@ paths:
|
|
|
791
963
|
application/json:
|
|
792
964
|
schema:
|
|
793
965
|
$ref: '#/components/schemas/Status'
|
|
794
|
-
/namespaces/{namespace}/schedules/{scheduleId}/patch:
|
|
966
|
+
/api/v1/namespaces/{namespace}/schedules/{scheduleId}/patch:
|
|
795
967
|
post:
|
|
796
968
|
tags:
|
|
797
969
|
- WorkflowService
|
|
@@ -829,7 +1001,7 @@ paths:
|
|
|
829
1001
|
application/json:
|
|
830
1002
|
schema:
|
|
831
1003
|
$ref: '#/components/schemas/Status'
|
|
832
|
-
/namespaces/{namespace}/schedules/{scheduleId}/update:
|
|
1004
|
+
/api/v1/namespaces/{namespace}/schedules/{scheduleId}/update:
|
|
833
1005
|
post:
|
|
834
1006
|
tags:
|
|
835
1007
|
- WorkflowService
|
|
@@ -867,7 +1039,7 @@ paths:
|
|
|
867
1039
|
application/json:
|
|
868
1040
|
schema:
|
|
869
1041
|
$ref: '#/components/schemas/Status'
|
|
870
|
-
/namespaces/{namespace}/search-attributes:
|
|
1042
|
+
/api/v1/namespaces/{namespace}/search-attributes:
|
|
871
1043
|
get:
|
|
872
1044
|
tags:
|
|
873
1045
|
- OperatorService
|
|
@@ -892,7 +1064,7 @@ paths:
|
|
|
892
1064
|
application/json:
|
|
893
1065
|
schema:
|
|
894
1066
|
$ref: '#/components/schemas/Status'
|
|
895
|
-
/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility:
|
|
1067
|
+
/api/v1/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility:
|
|
896
1068
|
get:
|
|
897
1069
|
tags:
|
|
898
1070
|
- WorkflowService
|
|
@@ -933,7 +1105,7 @@ paths:
|
|
|
933
1105
|
application/json:
|
|
934
1106
|
schema:
|
|
935
1107
|
$ref: '#/components/schemas/Status'
|
|
936
|
-
/namespaces/{namespace}/task-queues/{taskQueue}/worker-versioning-rules:
|
|
1108
|
+
/api/v1/namespaces/{namespace}/task-queues/{taskQueue}/worker-versioning-rules:
|
|
937
1109
|
get:
|
|
938
1110
|
tags:
|
|
939
1111
|
- WorkflowService
|
|
@@ -965,7 +1137,7 @@ paths:
|
|
|
965
1137
|
application/json:
|
|
966
1138
|
schema:
|
|
967
1139
|
$ref: '#/components/schemas/Status'
|
|
968
|
-
/namespaces/{namespace}/task-queues/{task_queue.name}:
|
|
1140
|
+
/api/v1/namespaces/{namespace}/task-queues/{task_queue.name}:
|
|
969
1141
|
get:
|
|
970
1142
|
tags:
|
|
971
1143
|
- WorkflowService
|
|
@@ -1049,8 +1221,8 @@ paths:
|
|
|
1049
1221
|
- name: versions.allActive
|
|
1050
1222
|
in: query
|
|
1051
1223
|
description: |-
|
|
1052
|
-
Include all active versions. A version is considered active if
|
|
1053
|
-
tasks or polls
|
|
1224
|
+
Include all active versions. A version is considered active if, in the last few minutes,
|
|
1225
|
+
it has had new tasks or polls, or it has been the subject of certain task queue API calls.
|
|
1054
1226
|
schema:
|
|
1055
1227
|
type: boolean
|
|
1056
1228
|
- name: taskQueueTypes
|
|
@@ -1096,7 +1268,7 @@ paths:
|
|
|
1096
1268
|
application/json:
|
|
1097
1269
|
schema:
|
|
1098
1270
|
$ref: '#/components/schemas/Status'
|
|
1099
|
-
/namespaces/{namespace}/update:
|
|
1271
|
+
/api/v1/namespaces/{namespace}/update:
|
|
1100
1272
|
post:
|
|
1101
1273
|
tags:
|
|
1102
1274
|
- WorkflowService
|
|
@@ -1129,7 +1301,7 @@ paths:
|
|
|
1129
1301
|
application/json:
|
|
1130
1302
|
schema:
|
|
1131
1303
|
$ref: '#/components/schemas/Status'
|
|
1132
|
-
/namespaces/{namespace}/worker-task-reachability:
|
|
1304
|
+
/api/v1/namespaces/{namespace}/worker-task-reachability:
|
|
1133
1305
|
get:
|
|
1134
1306
|
tags:
|
|
1135
1307
|
- WorkflowService
|
|
@@ -1209,7 +1381,7 @@ paths:
|
|
|
1209
1381
|
application/json:
|
|
1210
1382
|
schema:
|
|
1211
1383
|
$ref: '#/components/schemas/Status'
|
|
1212
|
-
/namespaces/{namespace}/workflow-count:
|
|
1384
|
+
/api/v1/namespaces/{namespace}/workflow-count:
|
|
1213
1385
|
get:
|
|
1214
1386
|
tags:
|
|
1215
1387
|
- WorkflowService
|
|
@@ -1238,7 +1410,7 @@ paths:
|
|
|
1238
1410
|
application/json:
|
|
1239
1411
|
schema:
|
|
1240
1412
|
$ref: '#/components/schemas/Status'
|
|
1241
|
-
/namespaces/{namespace}/workflows:
|
|
1413
|
+
/api/v1/namespaces/{namespace}/workflows:
|
|
1242
1414
|
get:
|
|
1243
1415
|
tags:
|
|
1244
1416
|
- WorkflowService
|
|
@@ -1277,7 +1449,7 @@ paths:
|
|
|
1277
1449
|
application/json:
|
|
1278
1450
|
schema:
|
|
1279
1451
|
$ref: '#/components/schemas/Status'
|
|
1280
|
-
/namespaces/{namespace}/workflows/execute-multi-operation:
|
|
1452
|
+
/api/v1/namespaces/{namespace}/workflows/execute-multi-operation:
|
|
1281
1453
|
post:
|
|
1282
1454
|
tags:
|
|
1283
1455
|
- WorkflowService
|
|
@@ -1317,7 +1489,7 @@ paths:
|
|
|
1317
1489
|
application/json:
|
|
1318
1490
|
schema:
|
|
1319
1491
|
$ref: '#/components/schemas/Status'
|
|
1320
|
-
/namespaces/{namespace}/workflows/{execution.workflow_id}:
|
|
1492
|
+
/api/v1/namespaces/{namespace}/workflows/{execution.workflow_id}:
|
|
1321
1493
|
get:
|
|
1322
1494
|
tags:
|
|
1323
1495
|
- WorkflowService
|
|
@@ -1355,7 +1527,7 @@ paths:
|
|
|
1355
1527
|
application/json:
|
|
1356
1528
|
schema:
|
|
1357
1529
|
$ref: '#/components/schemas/Status'
|
|
1358
|
-
/namespaces/{namespace}/workflows/{execution.workflow_id}/history:
|
|
1530
|
+
/api/v1/namespaces/{namespace}/workflows/{execution.workflow_id}/history:
|
|
1359
1531
|
get:
|
|
1360
1532
|
tags:
|
|
1361
1533
|
- WorkflowService
|
|
@@ -1431,7 +1603,7 @@ paths:
|
|
|
1431
1603
|
application/json:
|
|
1432
1604
|
schema:
|
|
1433
1605
|
$ref: '#/components/schemas/Status'
|
|
1434
|
-
/namespaces/{namespace}/workflows/{execution.workflow_id}/history-reverse:
|
|
1606
|
+
/api/v1/namespaces/{namespace}/workflows/{execution.workflow_id}/history-reverse:
|
|
1435
1607
|
get:
|
|
1436
1608
|
tags:
|
|
1437
1609
|
- WorkflowService
|
|
@@ -1479,7 +1651,7 @@ paths:
|
|
|
1479
1651
|
application/json:
|
|
1480
1652
|
schema:
|
|
1481
1653
|
$ref: '#/components/schemas/Status'
|
|
1482
|
-
/namespaces/{namespace}/workflows/{execution.workflow_id}/query/{query.query_type}:
|
|
1654
|
+
/api/v1/namespaces/{namespace}/workflows/{execution.workflow_id}/query/{query.query_type}:
|
|
1483
1655
|
post:
|
|
1484
1656
|
tags:
|
|
1485
1657
|
- WorkflowService
|
|
@@ -1520,7 +1692,7 @@ paths:
|
|
|
1520
1692
|
application/json:
|
|
1521
1693
|
schema:
|
|
1522
1694
|
$ref: '#/components/schemas/Status'
|
|
1523
|
-
/namespaces/{namespace}/workflows/{workflowId}:
|
|
1695
|
+
/api/v1/namespaces/{namespace}/workflows/{workflowId}:
|
|
1524
1696
|
post:
|
|
1525
1697
|
tags:
|
|
1526
1698
|
- WorkflowService
|
|
@@ -1561,7 +1733,7 @@ paths:
|
|
|
1561
1733
|
application/json:
|
|
1562
1734
|
schema:
|
|
1563
1735
|
$ref: '#/components/schemas/Status'
|
|
1564
|
-
/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}:
|
|
1736
|
+
/api/v1/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}:
|
|
1565
1737
|
post:
|
|
1566
1738
|
tags:
|
|
1567
1739
|
- WorkflowService
|
|
@@ -1615,7 +1787,7 @@ paths:
|
|
|
1615
1787
|
application/json:
|
|
1616
1788
|
schema:
|
|
1617
1789
|
$ref: '#/components/schemas/Status'
|
|
1618
|
-
/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/cancel:
|
|
1790
|
+
/api/v1/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/cancel:
|
|
1619
1791
|
post:
|
|
1620
1792
|
tags:
|
|
1621
1793
|
- WorkflowService
|
|
@@ -1657,7 +1829,7 @@ paths:
|
|
|
1657
1829
|
application/json:
|
|
1658
1830
|
schema:
|
|
1659
1831
|
$ref: '#/components/schemas/Status'
|
|
1660
|
-
/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/reset:
|
|
1832
|
+
/api/v1/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/reset:
|
|
1661
1833
|
post:
|
|
1662
1834
|
tags:
|
|
1663
1835
|
- WorkflowService
|
|
@@ -1697,7 +1869,7 @@ paths:
|
|
|
1697
1869
|
application/json:
|
|
1698
1870
|
schema:
|
|
1699
1871
|
$ref: '#/components/schemas/Status'
|
|
1700
|
-
/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/signal/{signalName}:
|
|
1872
|
+
/api/v1/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/signal/{signalName}:
|
|
1701
1873
|
post:
|
|
1702
1874
|
tags:
|
|
1703
1875
|
- WorkflowService
|
|
@@ -1743,7 +1915,7 @@ paths:
|
|
|
1743
1915
|
application/json:
|
|
1744
1916
|
schema:
|
|
1745
1917
|
$ref: '#/components/schemas/Status'
|
|
1746
|
-
/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/terminate:
|
|
1918
|
+
/api/v1/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/terminate:
|
|
1747
1919
|
post:
|
|
1748
1920
|
tags:
|
|
1749
1921
|
- WorkflowService
|
|
@@ -1782,16 +1954,16 @@ paths:
|
|
|
1782
1954
|
application/json:
|
|
1783
1955
|
schema:
|
|
1784
1956
|
$ref: '#/components/schemas/Status'
|
|
1785
|
-
/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/update/{request.input.name}:
|
|
1957
|
+
/api/v1/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/update/{request.input.name}:
|
|
1786
1958
|
post:
|
|
1787
1959
|
tags:
|
|
1788
1960
|
- WorkflowService
|
|
1789
|
-
description: Invokes the specified
|
|
1961
|
+
description: Invokes the specified Update function on user Workflow code.
|
|
1790
1962
|
operationId: UpdateWorkflowExecution
|
|
1791
1963
|
parameters:
|
|
1792
1964
|
- name: namespace
|
|
1793
1965
|
in: path
|
|
1794
|
-
description: The namespace name of the target
|
|
1966
|
+
description: The namespace name of the target Workflow.
|
|
1795
1967
|
required: true
|
|
1796
1968
|
schema:
|
|
1797
1969
|
type: string
|
|
@@ -1824,7 +1996,7 @@ paths:
|
|
|
1824
1996
|
application/json:
|
|
1825
1997
|
schema:
|
|
1826
1998
|
$ref: '#/components/schemas/Status'
|
|
1827
|
-
/nexus/endpoints:
|
|
1999
|
+
/api/v1/nexus/endpoints:
|
|
1828
2000
|
get:
|
|
1829
2001
|
tags:
|
|
1830
2002
|
- OperatorService
|
|
@@ -1897,7 +2069,7 @@ paths:
|
|
|
1897
2069
|
application/json:
|
|
1898
2070
|
schema:
|
|
1899
2071
|
$ref: '#/components/schemas/Status'
|
|
1900
|
-
/nexus/endpoints/{id}:
|
|
2072
|
+
/api/v1/nexus/endpoints/{id}:
|
|
1901
2073
|
get:
|
|
1902
2074
|
tags:
|
|
1903
2075
|
- OperatorService
|
|
@@ -1953,7 +2125,7 @@ paths:
|
|
|
1953
2125
|
application/json:
|
|
1954
2126
|
schema:
|
|
1955
2127
|
$ref: '#/components/schemas/Status'
|
|
1956
|
-
/nexus/endpoints/{id}/update:
|
|
2128
|
+
/api/v1/nexus/endpoints/{id}/update:
|
|
1957
2129
|
post:
|
|
1958
2130
|
tags:
|
|
1959
2131
|
- OperatorService
|
|
@@ -1990,7 +2162,7 @@ paths:
|
|
|
1990
2162
|
application/json:
|
|
1991
2163
|
schema:
|
|
1992
2164
|
$ref: '#/components/schemas/Status'
|
|
1993
|
-
/system-info:
|
|
2165
|
+
/api/v1/system-info:
|
|
1994
2166
|
get:
|
|
1995
2167
|
tags:
|
|
1996
2168
|
- WorkflowService
|
|
@@ -2009,33 +2181,2249 @@ paths:
|
|
|
2009
2181
|
application/json:
|
|
2010
2182
|
schema:
|
|
2011
2183
|
$ref: '#/components/schemas/Status'
|
|
2012
|
-
|
|
2013
|
-
|
|
2014
|
-
|
|
2015
|
-
|
|
2016
|
-
|
|
2017
|
-
|
|
2018
|
-
|
|
2019
|
-
|
|
2020
|
-
|
|
2021
|
-
|
|
2022
|
-
|
|
2023
|
-
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
|
|
2027
|
-
|
|
2028
|
-
|
|
2029
|
-
|
|
2030
|
-
|
|
2031
|
-
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
|
|
2035
|
-
|
|
2036
|
-
|
|
2037
|
-
|
|
2038
|
-
|
|
2184
|
+
/cluster:
|
|
2185
|
+
get:
|
|
2186
|
+
tags:
|
|
2187
|
+
- WorkflowService
|
|
2188
|
+
description: GetClusterInfo returns information about temporal cluster
|
|
2189
|
+
operationId: GetClusterInfo
|
|
2190
|
+
responses:
|
|
2191
|
+
"200":
|
|
2192
|
+
description: OK
|
|
2193
|
+
content:
|
|
2194
|
+
application/json:
|
|
2195
|
+
schema:
|
|
2196
|
+
$ref: '#/components/schemas/GetClusterInfoResponse'
|
|
2197
|
+
default:
|
|
2198
|
+
description: Default error response
|
|
2199
|
+
content:
|
|
2200
|
+
application/json:
|
|
2201
|
+
schema:
|
|
2202
|
+
$ref: '#/components/schemas/Status'
|
|
2203
|
+
/cluster/namespaces:
|
|
2204
|
+
get:
|
|
2205
|
+
tags:
|
|
2206
|
+
- WorkflowService
|
|
2207
|
+
description: ListNamespaces returns the information and configuration for all namespaces.
|
|
2208
|
+
operationId: ListNamespaces
|
|
2209
|
+
parameters:
|
|
2210
|
+
- name: pageSize
|
|
2211
|
+
in: query
|
|
2212
|
+
schema:
|
|
2213
|
+
type: integer
|
|
2214
|
+
format: int32
|
|
2215
|
+
- name: nextPageToken
|
|
2216
|
+
in: query
|
|
2217
|
+
schema:
|
|
2218
|
+
type: string
|
|
2219
|
+
format: bytes
|
|
2220
|
+
- name: namespaceFilter.includeDeleted
|
|
2221
|
+
in: query
|
|
2222
|
+
description: |-
|
|
2223
|
+
By default namespaces in NAMESPACE_STATE_DELETED state are not included.
|
|
2224
|
+
Setting include_deleted to true will include deleted namespaces.
|
|
2225
|
+
Note: Namespace is in NAMESPACE_STATE_DELETED state when it was deleted from the system but associated data is not deleted yet.
|
|
2226
|
+
schema:
|
|
2227
|
+
type: boolean
|
|
2228
|
+
responses:
|
|
2229
|
+
"200":
|
|
2230
|
+
description: OK
|
|
2231
|
+
content:
|
|
2232
|
+
application/json:
|
|
2233
|
+
schema:
|
|
2234
|
+
$ref: '#/components/schemas/ListNamespacesResponse'
|
|
2235
|
+
default:
|
|
2236
|
+
description: Default error response
|
|
2237
|
+
content:
|
|
2238
|
+
application/json:
|
|
2239
|
+
schema:
|
|
2240
|
+
$ref: '#/components/schemas/Status'
|
|
2241
|
+
post:
|
|
2242
|
+
tags:
|
|
2243
|
+
- WorkflowService
|
|
2244
|
+
description: |-
|
|
2245
|
+
RegisterNamespace creates a new namespace which can be used as a container for all resources.
|
|
2246
|
+
|
|
2247
|
+
A Namespace is a top level entity within Temporal, and is used as a container for resources
|
|
2248
|
+
like workflow executions, task queues, etc. A Namespace acts as a sandbox and provides
|
|
2249
|
+
isolation for all resources within the namespace. All resources belongs to exactly one
|
|
2250
|
+
namespace.
|
|
2251
|
+
operationId: RegisterNamespace
|
|
2252
|
+
requestBody:
|
|
2253
|
+
content:
|
|
2254
|
+
application/json:
|
|
2255
|
+
schema:
|
|
2256
|
+
$ref: '#/components/schemas/RegisterNamespaceRequest'
|
|
2257
|
+
required: true
|
|
2258
|
+
responses:
|
|
2259
|
+
"200":
|
|
2260
|
+
description: OK
|
|
2261
|
+
content:
|
|
2262
|
+
application/json:
|
|
2263
|
+
schema:
|
|
2264
|
+
$ref: '#/components/schemas/RegisterNamespaceResponse'
|
|
2265
|
+
default:
|
|
2266
|
+
description: Default error response
|
|
2267
|
+
content:
|
|
2268
|
+
application/json:
|
|
2269
|
+
schema:
|
|
2270
|
+
$ref: '#/components/schemas/Status'
|
|
2271
|
+
/cluster/namespaces/{namespace}:
|
|
2272
|
+
get:
|
|
2273
|
+
tags:
|
|
2274
|
+
- WorkflowService
|
|
2275
|
+
description: DescribeNamespace returns the information and configuration for a registered namespace.
|
|
2276
|
+
operationId: DescribeNamespace
|
|
2277
|
+
parameters:
|
|
2278
|
+
- name: namespace
|
|
2279
|
+
in: path
|
|
2280
|
+
required: true
|
|
2281
|
+
schema:
|
|
2282
|
+
type: string
|
|
2283
|
+
- name: id
|
|
2284
|
+
in: query
|
|
2285
|
+
schema:
|
|
2286
|
+
type: string
|
|
2287
|
+
responses:
|
|
2288
|
+
"200":
|
|
2289
|
+
description: OK
|
|
2290
|
+
content:
|
|
2291
|
+
application/json:
|
|
2292
|
+
schema:
|
|
2293
|
+
$ref: '#/components/schemas/DescribeNamespaceResponse'
|
|
2294
|
+
default:
|
|
2295
|
+
description: Default error response
|
|
2296
|
+
content:
|
|
2297
|
+
application/json:
|
|
2298
|
+
schema:
|
|
2299
|
+
$ref: '#/components/schemas/Status'
|
|
2300
|
+
/cluster/namespaces/{namespace}/search-attributes:
|
|
2301
|
+
get:
|
|
2302
|
+
tags:
|
|
2303
|
+
- OperatorService
|
|
2304
|
+
description: ListSearchAttributes returns comprehensive information about search attributes.
|
|
2305
|
+
operationId: ListSearchAttributes
|
|
2306
|
+
parameters:
|
|
2307
|
+
- name: namespace
|
|
2308
|
+
in: path
|
|
2309
|
+
required: true
|
|
2310
|
+
schema:
|
|
2311
|
+
type: string
|
|
2312
|
+
responses:
|
|
2313
|
+
"200":
|
|
2314
|
+
description: OK
|
|
2315
|
+
content:
|
|
2316
|
+
application/json:
|
|
2317
|
+
schema:
|
|
2318
|
+
$ref: '#/components/schemas/ListSearchAttributesResponse'
|
|
2319
|
+
default:
|
|
2320
|
+
description: Default error response
|
|
2321
|
+
content:
|
|
2322
|
+
application/json:
|
|
2323
|
+
schema:
|
|
2324
|
+
$ref: '#/components/schemas/Status'
|
|
2325
|
+
/cluster/namespaces/{namespace}/update:
|
|
2326
|
+
post:
|
|
2327
|
+
tags:
|
|
2328
|
+
- WorkflowService
|
|
2329
|
+
description: |-
|
|
2330
|
+
UpdateNamespace is used to update the information and configuration of a registered
|
|
2331
|
+
namespace.
|
|
2332
|
+
operationId: UpdateNamespace
|
|
2333
|
+
parameters:
|
|
2334
|
+
- name: namespace
|
|
2335
|
+
in: path
|
|
2336
|
+
required: true
|
|
2337
|
+
schema:
|
|
2338
|
+
type: string
|
|
2339
|
+
requestBody:
|
|
2340
|
+
content:
|
|
2341
|
+
application/json:
|
|
2342
|
+
schema:
|
|
2343
|
+
$ref: '#/components/schemas/UpdateNamespaceRequest'
|
|
2344
|
+
required: true
|
|
2345
|
+
responses:
|
|
2346
|
+
"200":
|
|
2347
|
+
description: OK
|
|
2348
|
+
content:
|
|
2349
|
+
application/json:
|
|
2350
|
+
schema:
|
|
2351
|
+
$ref: '#/components/schemas/UpdateNamespaceResponse'
|
|
2352
|
+
default:
|
|
2353
|
+
description: Default error response
|
|
2354
|
+
content:
|
|
2355
|
+
application/json:
|
|
2356
|
+
schema:
|
|
2357
|
+
$ref: '#/components/schemas/Status'
|
|
2358
|
+
/cluster/nexus/endpoints:
|
|
2359
|
+
get:
|
|
2360
|
+
tags:
|
|
2361
|
+
- OperatorService
|
|
2362
|
+
description: |-
|
|
2363
|
+
List all Nexus endpoints for the cluster, sorted by ID in ascending order. Set page_token in the request to the
|
|
2364
|
+
next_page_token field of the previous response to get the next page of results. An empty next_page_token
|
|
2365
|
+
indicates that there are no more results. During pagination, a newly added service with an ID lexicographically
|
|
2366
|
+
earlier than the previous page's last endpoint's ID may be missed.
|
|
2367
|
+
operationId: ListNexusEndpoints
|
|
2368
|
+
parameters:
|
|
2369
|
+
- name: pageSize
|
|
2370
|
+
in: query
|
|
2371
|
+
schema:
|
|
2372
|
+
type: integer
|
|
2373
|
+
format: int32
|
|
2374
|
+
- name: nextPageToken
|
|
2375
|
+
in: query
|
|
2376
|
+
description: |-
|
|
2377
|
+
To get the next page, pass in `ListNexusEndpointsResponse.next_page_token` from the previous page's
|
|
2378
|
+
response, the token will be empty if there's no other page.
|
|
2379
|
+
Note: the last page may be empty if the total number of endpoints registered is a multiple of the page size.
|
|
2380
|
+
schema:
|
|
2381
|
+
type: string
|
|
2382
|
+
format: bytes
|
|
2383
|
+
- name: name
|
|
2384
|
+
in: query
|
|
2385
|
+
description: |-
|
|
2386
|
+
Name of the incoming endpoint to filter on - optional. Specifying this will result in zero or one results.
|
|
2387
|
+
(-- api-linter: core::203::field-behavior-required=disabled
|
|
2388
|
+
aip.dev/not-precedent: Not following linter rules. --)
|
|
2389
|
+
schema:
|
|
2390
|
+
type: string
|
|
2391
|
+
responses:
|
|
2392
|
+
"200":
|
|
2393
|
+
description: OK
|
|
2394
|
+
content:
|
|
2395
|
+
application/json:
|
|
2396
|
+
schema:
|
|
2397
|
+
$ref: '#/components/schemas/ListNexusEndpointsResponse'
|
|
2398
|
+
default:
|
|
2399
|
+
description: Default error response
|
|
2400
|
+
content:
|
|
2401
|
+
application/json:
|
|
2402
|
+
schema:
|
|
2403
|
+
$ref: '#/components/schemas/Status'
|
|
2404
|
+
post:
|
|
2405
|
+
tags:
|
|
2406
|
+
- OperatorService
|
|
2407
|
+
description: |-
|
|
2408
|
+
Create a Nexus endpoint. This will fail if an endpoint with the same name is already registered with a status of
|
|
2409
|
+
ALREADY_EXISTS.
|
|
2410
|
+
Returns the created endpoint with its initial version. You may use this version for subsequent updates.
|
|
2411
|
+
operationId: CreateNexusEndpoint
|
|
2412
|
+
requestBody:
|
|
2413
|
+
content:
|
|
2414
|
+
application/json:
|
|
2415
|
+
schema:
|
|
2416
|
+
$ref: '#/components/schemas/CreateNexusEndpointRequest'
|
|
2417
|
+
required: true
|
|
2418
|
+
responses:
|
|
2419
|
+
"200":
|
|
2420
|
+
description: OK
|
|
2421
|
+
content:
|
|
2422
|
+
application/json:
|
|
2423
|
+
schema:
|
|
2424
|
+
$ref: '#/components/schemas/CreateNexusEndpointResponse'
|
|
2425
|
+
default:
|
|
2426
|
+
description: Default error response
|
|
2427
|
+
content:
|
|
2428
|
+
application/json:
|
|
2429
|
+
schema:
|
|
2430
|
+
$ref: '#/components/schemas/Status'
|
|
2431
|
+
/cluster/nexus/endpoints/{id}:
|
|
2432
|
+
get:
|
|
2433
|
+
tags:
|
|
2434
|
+
- OperatorService
|
|
2435
|
+
description: Get a registered Nexus endpoint by ID. The returned version can be used for optimistic updates.
|
|
2436
|
+
operationId: GetNexusEndpoint
|
|
2437
|
+
parameters:
|
|
2438
|
+
- name: id
|
|
2439
|
+
in: path
|
|
2440
|
+
description: Server-generated unique endpoint ID.
|
|
2441
|
+
required: true
|
|
2442
|
+
schema:
|
|
2443
|
+
type: string
|
|
2444
|
+
responses:
|
|
2445
|
+
"200":
|
|
2446
|
+
description: OK
|
|
2447
|
+
content:
|
|
2448
|
+
application/json:
|
|
2449
|
+
schema:
|
|
2450
|
+
$ref: '#/components/schemas/GetNexusEndpointResponse'
|
|
2451
|
+
default:
|
|
2452
|
+
description: Default error response
|
|
2453
|
+
content:
|
|
2454
|
+
application/json:
|
|
2455
|
+
schema:
|
|
2456
|
+
$ref: '#/components/schemas/Status'
|
|
2457
|
+
delete:
|
|
2458
|
+
tags:
|
|
2459
|
+
- OperatorService
|
|
2460
|
+
description: Delete an incoming Nexus service by ID.
|
|
2461
|
+
operationId: DeleteNexusEndpoint
|
|
2462
|
+
parameters:
|
|
2463
|
+
- name: id
|
|
2464
|
+
in: path
|
|
2465
|
+
description: Server-generated unique endpoint ID.
|
|
2466
|
+
required: true
|
|
2467
|
+
schema:
|
|
2468
|
+
type: string
|
|
2469
|
+
- name: version
|
|
2470
|
+
in: query
|
|
2471
|
+
description: Data version for this endpoint. Must match current version.
|
|
2472
|
+
schema:
|
|
2473
|
+
type: string
|
|
2474
|
+
responses:
|
|
2475
|
+
"200":
|
|
2476
|
+
description: OK
|
|
2477
|
+
content:
|
|
2478
|
+
application/json:
|
|
2479
|
+
schema:
|
|
2480
|
+
$ref: '#/components/schemas/DeleteNexusEndpointResponse'
|
|
2481
|
+
default:
|
|
2482
|
+
description: Default error response
|
|
2483
|
+
content:
|
|
2484
|
+
application/json:
|
|
2485
|
+
schema:
|
|
2486
|
+
$ref: '#/components/schemas/Status'
|
|
2487
|
+
/cluster/nexus/endpoints/{id}/update:
|
|
2488
|
+
post:
|
|
2489
|
+
tags:
|
|
2490
|
+
- OperatorService
|
|
2491
|
+
description: |-
|
|
2492
|
+
Optimistically update a Nexus endpoint based on provided version as obtained via the `GetNexusEndpoint` or
|
|
2493
|
+
`ListNexusEndpointResponse` APIs. This will fail with a status of FAILED_PRECONDITION if the version does not
|
|
2494
|
+
match.
|
|
2495
|
+
Returns the updated endpoint with its updated version. You may use this version for subsequent updates. You don't
|
|
2496
|
+
need to increment the version yourself. The server will increment the version for you after each update.
|
|
2497
|
+
operationId: UpdateNexusEndpoint
|
|
2498
|
+
parameters:
|
|
2499
|
+
- name: id
|
|
2500
|
+
in: path
|
|
2501
|
+
description: Server-generated unique endpoint ID.
|
|
2502
|
+
required: true
|
|
2503
|
+
schema:
|
|
2504
|
+
type: string
|
|
2505
|
+
requestBody:
|
|
2506
|
+
content:
|
|
2507
|
+
application/json:
|
|
2508
|
+
schema:
|
|
2509
|
+
$ref: '#/components/schemas/UpdateNexusEndpointRequest'
|
|
2510
|
+
required: true
|
|
2511
|
+
responses:
|
|
2512
|
+
"200":
|
|
2513
|
+
description: OK
|
|
2514
|
+
content:
|
|
2515
|
+
application/json:
|
|
2516
|
+
schema:
|
|
2517
|
+
$ref: '#/components/schemas/UpdateNexusEndpointResponse'
|
|
2518
|
+
default:
|
|
2519
|
+
description: Default error response
|
|
2520
|
+
content:
|
|
2521
|
+
application/json:
|
|
2522
|
+
schema:
|
|
2523
|
+
$ref: '#/components/schemas/Status'
|
|
2524
|
+
/namespaces/{namespace}/activities/cancel:
|
|
2525
|
+
post:
|
|
2526
|
+
tags:
|
|
2527
|
+
- WorkflowService
|
|
2528
|
+
description: |-
|
|
2529
|
+
RespondActivityTaskFailed is called by workers when processing an activity task fails.
|
|
2530
|
+
|
|
2531
|
+
This results in a new `ACTIVITY_TASK_CANCELED` event being written to the workflow history
|
|
2532
|
+
and a new workflow task created for the workflow. Fails with `NotFound` if the task token is
|
|
2533
|
+
no longer valid due to activity timeout, already being completed, or never having existed.
|
|
2534
|
+
operationId: RespondActivityTaskCanceled
|
|
2535
|
+
parameters:
|
|
2536
|
+
- name: namespace
|
|
2537
|
+
in: path
|
|
2538
|
+
required: true
|
|
2539
|
+
schema:
|
|
2540
|
+
type: string
|
|
2541
|
+
requestBody:
|
|
2542
|
+
content:
|
|
2543
|
+
application/json:
|
|
2544
|
+
schema:
|
|
2545
|
+
$ref: '#/components/schemas/RespondActivityTaskCanceledRequest'
|
|
2546
|
+
required: true
|
|
2547
|
+
responses:
|
|
2548
|
+
"200":
|
|
2549
|
+
description: OK
|
|
2550
|
+
content:
|
|
2551
|
+
application/json:
|
|
2552
|
+
schema:
|
|
2553
|
+
$ref: '#/components/schemas/RespondActivityTaskCanceledResponse'
|
|
2554
|
+
default:
|
|
2555
|
+
description: Default error response
|
|
2556
|
+
content:
|
|
2557
|
+
application/json:
|
|
2558
|
+
schema:
|
|
2559
|
+
$ref: '#/components/schemas/Status'
|
|
2560
|
+
/namespaces/{namespace}/activities/cancel-by-id:
|
|
2561
|
+
post:
|
|
2562
|
+
tags:
|
|
2563
|
+
- WorkflowService
|
|
2564
|
+
description: |-
|
|
2565
|
+
See `RecordActivityTaskCanceled`. This version allows clients to record failures by
|
|
2566
|
+
namespace/workflow id/activity id instead of task token.
|
|
2567
|
+
|
|
2568
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
2569
|
+
aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
2570
|
+
operationId: RespondActivityTaskCanceledById
|
|
2571
|
+
parameters:
|
|
2572
|
+
- name: namespace
|
|
2573
|
+
in: path
|
|
2574
|
+
description: Namespace of the workflow which scheduled this activity
|
|
2575
|
+
required: true
|
|
2576
|
+
schema:
|
|
2577
|
+
type: string
|
|
2578
|
+
requestBody:
|
|
2579
|
+
content:
|
|
2580
|
+
application/json:
|
|
2581
|
+
schema:
|
|
2582
|
+
$ref: '#/components/schemas/RespondActivityTaskCanceledByIdRequest'
|
|
2583
|
+
required: true
|
|
2584
|
+
responses:
|
|
2585
|
+
"200":
|
|
2586
|
+
description: OK
|
|
2587
|
+
content:
|
|
2588
|
+
application/json:
|
|
2589
|
+
schema:
|
|
2590
|
+
$ref: '#/components/schemas/RespondActivityTaskCanceledByIdResponse'
|
|
2591
|
+
default:
|
|
2592
|
+
description: Default error response
|
|
2593
|
+
content:
|
|
2594
|
+
application/json:
|
|
2595
|
+
schema:
|
|
2596
|
+
$ref: '#/components/schemas/Status'
|
|
2597
|
+
/namespaces/{namespace}/activities/complete:
|
|
2598
|
+
post:
|
|
2599
|
+
tags:
|
|
2600
|
+
- WorkflowService
|
|
2601
|
+
description: |-
|
|
2602
|
+
RespondActivityTaskCompleted is called by workers when they successfully complete an activity
|
|
2603
|
+
task.
|
|
2604
|
+
|
|
2605
|
+
This results in a new `ACTIVITY_TASK_COMPLETED` event being written to the workflow history
|
|
2606
|
+
and a new workflow task created for the workflow. Fails with `NotFound` if the task token is
|
|
2607
|
+
no longer valid due to activity timeout, already being completed, or never having existed.
|
|
2608
|
+
operationId: RespondActivityTaskCompleted
|
|
2609
|
+
parameters:
|
|
2610
|
+
- name: namespace
|
|
2611
|
+
in: path
|
|
2612
|
+
required: true
|
|
2613
|
+
schema:
|
|
2614
|
+
type: string
|
|
2615
|
+
requestBody:
|
|
2616
|
+
content:
|
|
2617
|
+
application/json:
|
|
2618
|
+
schema:
|
|
2619
|
+
$ref: '#/components/schemas/RespondActivityTaskCompletedRequest'
|
|
2620
|
+
required: true
|
|
2621
|
+
responses:
|
|
2622
|
+
"200":
|
|
2623
|
+
description: OK
|
|
2624
|
+
content:
|
|
2625
|
+
application/json:
|
|
2626
|
+
schema:
|
|
2627
|
+
$ref: '#/components/schemas/RespondActivityTaskCompletedResponse'
|
|
2628
|
+
default:
|
|
2629
|
+
description: Default error response
|
|
2630
|
+
content:
|
|
2631
|
+
application/json:
|
|
2632
|
+
schema:
|
|
2633
|
+
$ref: '#/components/schemas/Status'
|
|
2634
|
+
/namespaces/{namespace}/activities/complete-by-id:
|
|
2635
|
+
post:
|
|
2636
|
+
tags:
|
|
2637
|
+
- WorkflowService
|
|
2638
|
+
description: |-
|
|
2639
|
+
See `RecordActivityTaskCompleted`. This version allows clients to record completions by
|
|
2640
|
+
namespace/workflow id/activity id instead of task token.
|
|
2641
|
+
|
|
2642
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
2643
|
+
aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
2644
|
+
operationId: RespondActivityTaskCompletedById
|
|
2645
|
+
parameters:
|
|
2646
|
+
- name: namespace
|
|
2647
|
+
in: path
|
|
2648
|
+
description: Namespace of the workflow which scheduled this activity
|
|
2649
|
+
required: true
|
|
2650
|
+
schema:
|
|
2651
|
+
type: string
|
|
2652
|
+
requestBody:
|
|
2653
|
+
content:
|
|
2654
|
+
application/json:
|
|
2655
|
+
schema:
|
|
2656
|
+
$ref: '#/components/schemas/RespondActivityTaskCompletedByIdRequest'
|
|
2657
|
+
required: true
|
|
2658
|
+
responses:
|
|
2659
|
+
"200":
|
|
2660
|
+
description: OK
|
|
2661
|
+
content:
|
|
2662
|
+
application/json:
|
|
2663
|
+
schema:
|
|
2664
|
+
$ref: '#/components/schemas/RespondActivityTaskCompletedByIdResponse'
|
|
2665
|
+
default:
|
|
2666
|
+
description: Default error response
|
|
2667
|
+
content:
|
|
2668
|
+
application/json:
|
|
2669
|
+
schema:
|
|
2670
|
+
$ref: '#/components/schemas/Status'
|
|
2671
|
+
/namespaces/{namespace}/activities/fail:
|
|
2672
|
+
post:
|
|
2673
|
+
tags:
|
|
2674
|
+
- WorkflowService
|
|
2675
|
+
description: |-
|
|
2676
|
+
RespondActivityTaskFailed is called by workers when processing an activity task fails.
|
|
2677
|
+
|
|
2678
|
+
This results in a new `ACTIVITY_TASK_FAILED` event being written to the workflow history and
|
|
2679
|
+
a new workflow task created for the workflow. Fails with `NotFound` if the task token is no
|
|
2680
|
+
longer valid due to activity timeout, already being completed, or never having existed.
|
|
2681
|
+
operationId: RespondActivityTaskFailed
|
|
2682
|
+
parameters:
|
|
2683
|
+
- name: namespace
|
|
2684
|
+
in: path
|
|
2685
|
+
required: true
|
|
2686
|
+
schema:
|
|
2687
|
+
type: string
|
|
2688
|
+
requestBody:
|
|
2689
|
+
content:
|
|
2690
|
+
application/json:
|
|
2691
|
+
schema:
|
|
2692
|
+
$ref: '#/components/schemas/RespondActivityTaskFailedRequest'
|
|
2693
|
+
required: true
|
|
2694
|
+
responses:
|
|
2695
|
+
"200":
|
|
2696
|
+
description: OK
|
|
2697
|
+
content:
|
|
2698
|
+
application/json:
|
|
2699
|
+
schema:
|
|
2700
|
+
$ref: '#/components/schemas/RespondActivityTaskFailedResponse'
|
|
2701
|
+
default:
|
|
2702
|
+
description: Default error response
|
|
2703
|
+
content:
|
|
2704
|
+
application/json:
|
|
2705
|
+
schema:
|
|
2706
|
+
$ref: '#/components/schemas/Status'
|
|
2707
|
+
/namespaces/{namespace}/activities/fail-by-id:
|
|
2708
|
+
post:
|
|
2709
|
+
tags:
|
|
2710
|
+
- WorkflowService
|
|
2711
|
+
description: |-
|
|
2712
|
+
See `RecordActivityTaskFailed`. This version allows clients to record failures by
|
|
2713
|
+
namespace/workflow id/activity id instead of task token.
|
|
2714
|
+
|
|
2715
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
2716
|
+
aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
2717
|
+
operationId: RespondActivityTaskFailedById
|
|
2718
|
+
parameters:
|
|
2719
|
+
- name: namespace
|
|
2720
|
+
in: path
|
|
2721
|
+
description: Namespace of the workflow which scheduled this activity
|
|
2722
|
+
required: true
|
|
2723
|
+
schema:
|
|
2724
|
+
type: string
|
|
2725
|
+
requestBody:
|
|
2726
|
+
content:
|
|
2727
|
+
application/json:
|
|
2728
|
+
schema:
|
|
2729
|
+
$ref: '#/components/schemas/RespondActivityTaskFailedByIdRequest'
|
|
2730
|
+
required: true
|
|
2731
|
+
responses:
|
|
2732
|
+
"200":
|
|
2733
|
+
description: OK
|
|
2734
|
+
content:
|
|
2735
|
+
application/json:
|
|
2736
|
+
schema:
|
|
2737
|
+
$ref: '#/components/schemas/RespondActivityTaskFailedByIdResponse'
|
|
2738
|
+
default:
|
|
2739
|
+
description: Default error response
|
|
2740
|
+
content:
|
|
2741
|
+
application/json:
|
|
2742
|
+
schema:
|
|
2743
|
+
$ref: '#/components/schemas/Status'
|
|
2744
|
+
/namespaces/{namespace}/activities/heartbeat:
|
|
2745
|
+
post:
|
|
2746
|
+
tags:
|
|
2747
|
+
- WorkflowService
|
|
2748
|
+
description: |-
|
|
2749
|
+
RecordActivityTaskHeartbeat is optionally called by workers while they execute activities.
|
|
2750
|
+
|
|
2751
|
+
If worker fails to heartbeat within the `heartbeat_timeout` interval for the activity task,
|
|
2752
|
+
then it will be marked as timed out and an `ACTIVITY_TASK_TIMED_OUT` event will be written to
|
|
2753
|
+
the workflow history. Calling `RecordActivityTaskHeartbeat` will fail with `NotFound` in
|
|
2754
|
+
such situations, in that event, the SDK should request cancellation of the activity.
|
|
2755
|
+
operationId: RecordActivityTaskHeartbeat
|
|
2756
|
+
parameters:
|
|
2757
|
+
- name: namespace
|
|
2758
|
+
in: path
|
|
2759
|
+
required: true
|
|
2760
|
+
schema:
|
|
2761
|
+
type: string
|
|
2762
|
+
requestBody:
|
|
2763
|
+
content:
|
|
2764
|
+
application/json:
|
|
2765
|
+
schema:
|
|
2766
|
+
$ref: '#/components/schemas/RecordActivityTaskHeartbeatRequest'
|
|
2767
|
+
required: true
|
|
2768
|
+
responses:
|
|
2769
|
+
"200":
|
|
2770
|
+
description: OK
|
|
2771
|
+
content:
|
|
2772
|
+
application/json:
|
|
2773
|
+
schema:
|
|
2774
|
+
$ref: '#/components/schemas/RecordActivityTaskHeartbeatResponse'
|
|
2775
|
+
default:
|
|
2776
|
+
description: Default error response
|
|
2777
|
+
content:
|
|
2778
|
+
application/json:
|
|
2779
|
+
schema:
|
|
2780
|
+
$ref: '#/components/schemas/Status'
|
|
2781
|
+
/namespaces/{namespace}/activities/heartbeat-by-id:
|
|
2782
|
+
post:
|
|
2783
|
+
tags:
|
|
2784
|
+
- WorkflowService
|
|
2785
|
+
description: |-
|
|
2786
|
+
See `RecordActivityTaskHeartbeat`. This version allows clients to record heartbeats by
|
|
2787
|
+
namespace/workflow id/activity id instead of task token.
|
|
2788
|
+
|
|
2789
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
2790
|
+
aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
2791
|
+
operationId: RecordActivityTaskHeartbeatById
|
|
2792
|
+
parameters:
|
|
2793
|
+
- name: namespace
|
|
2794
|
+
in: path
|
|
2795
|
+
description: Namespace of the workflow which scheduled this activity
|
|
2796
|
+
required: true
|
|
2797
|
+
schema:
|
|
2798
|
+
type: string
|
|
2799
|
+
requestBody:
|
|
2800
|
+
content:
|
|
2801
|
+
application/json:
|
|
2802
|
+
schema:
|
|
2803
|
+
$ref: '#/components/schemas/RecordActivityTaskHeartbeatByIdRequest'
|
|
2804
|
+
required: true
|
|
2805
|
+
responses:
|
|
2806
|
+
"200":
|
|
2807
|
+
description: OK
|
|
2808
|
+
content:
|
|
2809
|
+
application/json:
|
|
2810
|
+
schema:
|
|
2811
|
+
$ref: '#/components/schemas/RecordActivityTaskHeartbeatByIdResponse'
|
|
2812
|
+
default:
|
|
2813
|
+
description: Default error response
|
|
2814
|
+
content:
|
|
2815
|
+
application/json:
|
|
2816
|
+
schema:
|
|
2817
|
+
$ref: '#/components/schemas/Status'
|
|
2818
|
+
/namespaces/{namespace}/activities/pause-by-id:
|
|
2819
|
+
post:
|
|
2820
|
+
tags:
|
|
2821
|
+
- WorkflowService
|
|
2822
|
+
description: |-
|
|
2823
|
+
PauseActivityById pauses the execution of an activity specified by its ID.
|
|
2824
|
+
Returns a `NotFound` error if there is no pending activity with the provided ID.
|
|
2825
|
+
|
|
2826
|
+
Pausing an activity means:
|
|
2827
|
+
- If the activity is currently waiting for a retry or is running and subsequently fails,
|
|
2828
|
+
it will not be rescheduled until it is unpaused.
|
|
2829
|
+
- If the activity is already paused, calling this method will have no effect.
|
|
2830
|
+
- If the activity is running and finishes successfully, the activity will be completed.
|
|
2831
|
+
- If the activity is running and finishes with failure:
|
|
2832
|
+
* if there is no retry left - the activity will be completed.
|
|
2833
|
+
* if there are more retries left - the activity will be paused.
|
|
2834
|
+
For long-running activities:
|
|
2835
|
+
- activities in paused state will send a cancellation with "activity_paused" set to 'true' in response to 'RecordActivityTaskHeartbeat'.
|
|
2836
|
+
- The activity should respond to the cancellation accordingly.
|
|
2837
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
2838
|
+
aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
2839
|
+
operationId: PauseActivityById
|
|
2840
|
+
parameters:
|
|
2841
|
+
- name: namespace
|
|
2842
|
+
in: path
|
|
2843
|
+
description: Namespace of the workflow which scheduled this activity.
|
|
2844
|
+
required: true
|
|
2845
|
+
schema:
|
|
2846
|
+
type: string
|
|
2847
|
+
requestBody:
|
|
2848
|
+
content:
|
|
2849
|
+
application/json:
|
|
2850
|
+
schema:
|
|
2851
|
+
$ref: '#/components/schemas/PauseActivityByIdRequest'
|
|
2852
|
+
required: true
|
|
2853
|
+
responses:
|
|
2854
|
+
"200":
|
|
2855
|
+
description: OK
|
|
2856
|
+
content:
|
|
2857
|
+
application/json:
|
|
2858
|
+
schema:
|
|
2859
|
+
$ref: '#/components/schemas/PauseActivityByIdResponse'
|
|
2860
|
+
default:
|
|
2861
|
+
description: Default error response
|
|
2862
|
+
content:
|
|
2863
|
+
application/json:
|
|
2864
|
+
schema:
|
|
2865
|
+
$ref: '#/components/schemas/Status'
|
|
2866
|
+
/namespaces/{namespace}/activities/reset-by-id:
|
|
2867
|
+
post:
|
|
2868
|
+
tags:
|
|
2869
|
+
- WorkflowService
|
|
2870
|
+
description: |-
|
|
2871
|
+
ResetActivityById unpauses the execution of an activity specified by its ID.
|
|
2872
|
+
Returns a `NotFound` error if there is no pending activity with the provided ID.
|
|
2873
|
+
Resetting an activity means:
|
|
2874
|
+
* number of attempts will be reset to 0.
|
|
2875
|
+
* activity timeouts will be resetted.
|
|
2876
|
+
If the activity currently running:
|
|
2877
|
+
* if 'no_wait' flag is provided, a new instance of the activity will be scheduled immediately.
|
|
2878
|
+
* if 'no_wait' flag is not provided, a new instance of the activity will be scheduled after current instance completes if needed.
|
|
2879
|
+
If 'reset_heartbeats' flag is set, the activity heartbeat timer and heartbeats will be reset.
|
|
2880
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
2881
|
+
aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
2882
|
+
operationId: ResetActivityById
|
|
2883
|
+
parameters:
|
|
2884
|
+
- name: namespace
|
|
2885
|
+
in: path
|
|
2886
|
+
description: Namespace of the workflow which scheduled this activity.
|
|
2887
|
+
required: true
|
|
2888
|
+
schema:
|
|
2889
|
+
type: string
|
|
2890
|
+
requestBody:
|
|
2891
|
+
content:
|
|
2892
|
+
application/json:
|
|
2893
|
+
schema:
|
|
2894
|
+
$ref: '#/components/schemas/ResetActivityByIdRequest'
|
|
2895
|
+
required: true
|
|
2896
|
+
responses:
|
|
2897
|
+
"200":
|
|
2898
|
+
description: OK
|
|
2899
|
+
content:
|
|
2900
|
+
application/json:
|
|
2901
|
+
schema:
|
|
2902
|
+
$ref: '#/components/schemas/ResetActivityByIdResponse'
|
|
2903
|
+
default:
|
|
2904
|
+
description: Default error response
|
|
2905
|
+
content:
|
|
2906
|
+
application/json:
|
|
2907
|
+
schema:
|
|
2908
|
+
$ref: '#/components/schemas/Status'
|
|
2909
|
+
/namespaces/{namespace}/activities/unpause-by-id:
|
|
2910
|
+
post:
|
|
2911
|
+
tags:
|
|
2912
|
+
- WorkflowService
|
|
2913
|
+
description: |-
|
|
2914
|
+
UnpauseActivityById unpauses the execution of an activity specified by its ID.
|
|
2915
|
+
Returns a `NotFound` error if there is no pending activity with the provided ID.
|
|
2916
|
+
There are two 'modes' of unpausing an activity:
|
|
2917
|
+
'resume' - If the activity is paused, it will be resumed and scheduled for execution.
|
|
2918
|
+
* If the activity is currently running Unpause with 'resume' has no effect.
|
|
2919
|
+
* if 'no_wait' flag is set and the activity is waiting, the activity will be scheduled immediately.
|
|
2920
|
+
'reset' - If the activity is paused, it will be reset to its initial state and (depending on parameters) scheduled for execution.
|
|
2921
|
+
* If the activity is currently running, Unpause with 'reset' will reset the number of attempts.
|
|
2922
|
+
* if 'no_wait' flag is set, the activity will be scheduled immediately.
|
|
2923
|
+
* if 'reset_heartbeats' flag is set, the activity heartbeat timer and heartbeats will be reset.
|
|
2924
|
+
If the activity is in waiting for retry and past it retry timeout, it will be scheduled immediately.
|
|
2925
|
+
Once the activity is unpaused, all timeout timers will be regenerated.
|
|
2926
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
2927
|
+
aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
2928
|
+
operationId: UnpauseActivityById
|
|
2929
|
+
parameters:
|
|
2930
|
+
- name: namespace
|
|
2931
|
+
in: path
|
|
2932
|
+
description: Namespace of the workflow which scheduled this activity.
|
|
2933
|
+
required: true
|
|
2934
|
+
schema:
|
|
2935
|
+
type: string
|
|
2936
|
+
requestBody:
|
|
2937
|
+
content:
|
|
2938
|
+
application/json:
|
|
2939
|
+
schema:
|
|
2940
|
+
$ref: '#/components/schemas/UnpauseActivityByIdRequest'
|
|
2941
|
+
required: true
|
|
2942
|
+
responses:
|
|
2943
|
+
"200":
|
|
2944
|
+
description: OK
|
|
2945
|
+
content:
|
|
2946
|
+
application/json:
|
|
2947
|
+
schema:
|
|
2948
|
+
$ref: '#/components/schemas/UnpauseActivityByIdResponse'
|
|
2949
|
+
default:
|
|
2950
|
+
description: Default error response
|
|
2951
|
+
content:
|
|
2952
|
+
application/json:
|
|
2953
|
+
schema:
|
|
2954
|
+
$ref: '#/components/schemas/Status'
|
|
2955
|
+
/namespaces/{namespace}/activities/update-options-by-id:
|
|
2956
|
+
post:
|
|
2957
|
+
tags:
|
|
2958
|
+
- WorkflowService
|
|
2959
|
+
description: |-
|
|
2960
|
+
UpdateActivityOptionsById is called by the client to update the options of an activity
|
|
2961
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
2962
|
+
aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
2963
|
+
operationId: UpdateActivityOptionsById
|
|
2964
|
+
parameters:
|
|
2965
|
+
- name: namespace
|
|
2966
|
+
in: path
|
|
2967
|
+
description: Namespace of the workflow which scheduled this activity
|
|
2968
|
+
required: true
|
|
2969
|
+
schema:
|
|
2970
|
+
type: string
|
|
2971
|
+
requestBody:
|
|
2972
|
+
content:
|
|
2973
|
+
application/json:
|
|
2974
|
+
schema:
|
|
2975
|
+
$ref: '#/components/schemas/UpdateActivityOptionsByIdRequest'
|
|
2976
|
+
required: true
|
|
2977
|
+
responses:
|
|
2978
|
+
"200":
|
|
2979
|
+
description: OK
|
|
2980
|
+
content:
|
|
2981
|
+
application/json:
|
|
2982
|
+
schema:
|
|
2983
|
+
$ref: '#/components/schemas/UpdateActivityOptionsByIdResponse'
|
|
2984
|
+
default:
|
|
2985
|
+
description: Default error response
|
|
2986
|
+
content:
|
|
2987
|
+
application/json:
|
|
2988
|
+
schema:
|
|
2989
|
+
$ref: '#/components/schemas/Status'
|
|
2990
|
+
/namespaces/{namespace}/archived-workflows:
|
|
2991
|
+
get:
|
|
2992
|
+
tags:
|
|
2993
|
+
- WorkflowService
|
|
2994
|
+
description: ListArchivedWorkflowExecutions is a visibility API to list archived workflow executions in a specific namespace.
|
|
2995
|
+
operationId: ListArchivedWorkflowExecutions
|
|
2996
|
+
parameters:
|
|
2997
|
+
- name: namespace
|
|
2998
|
+
in: path
|
|
2999
|
+
required: true
|
|
3000
|
+
schema:
|
|
3001
|
+
type: string
|
|
3002
|
+
- name: pageSize
|
|
3003
|
+
in: query
|
|
3004
|
+
schema:
|
|
3005
|
+
type: integer
|
|
3006
|
+
format: int32
|
|
3007
|
+
- name: nextPageToken
|
|
3008
|
+
in: query
|
|
3009
|
+
schema:
|
|
3010
|
+
type: string
|
|
3011
|
+
format: bytes
|
|
3012
|
+
- name: query
|
|
3013
|
+
in: query
|
|
3014
|
+
schema:
|
|
3015
|
+
type: string
|
|
3016
|
+
responses:
|
|
3017
|
+
"200":
|
|
3018
|
+
description: OK
|
|
3019
|
+
content:
|
|
3020
|
+
application/json:
|
|
3021
|
+
schema:
|
|
3022
|
+
$ref: '#/components/schemas/ListArchivedWorkflowExecutionsResponse'
|
|
3023
|
+
default:
|
|
3024
|
+
description: Default error response
|
|
3025
|
+
content:
|
|
3026
|
+
application/json:
|
|
3027
|
+
schema:
|
|
3028
|
+
$ref: '#/components/schemas/Status'
|
|
3029
|
+
/namespaces/{namespace}/batch-operations:
|
|
3030
|
+
get:
|
|
3031
|
+
tags:
|
|
3032
|
+
- WorkflowService
|
|
3033
|
+
description: ListBatchOperations returns a list of batch operations
|
|
3034
|
+
operationId: ListBatchOperations
|
|
3035
|
+
parameters:
|
|
3036
|
+
- name: namespace
|
|
3037
|
+
in: path
|
|
3038
|
+
description: Namespace that contains the batch operation
|
|
3039
|
+
required: true
|
|
3040
|
+
schema:
|
|
3041
|
+
type: string
|
|
3042
|
+
- name: pageSize
|
|
3043
|
+
in: query
|
|
3044
|
+
description: List page size
|
|
3045
|
+
schema:
|
|
3046
|
+
type: integer
|
|
3047
|
+
format: int32
|
|
3048
|
+
- name: nextPageToken
|
|
3049
|
+
in: query
|
|
3050
|
+
description: Next page token
|
|
3051
|
+
schema:
|
|
3052
|
+
type: string
|
|
3053
|
+
format: bytes
|
|
3054
|
+
responses:
|
|
3055
|
+
"200":
|
|
3056
|
+
description: OK
|
|
3057
|
+
content:
|
|
3058
|
+
application/json:
|
|
3059
|
+
schema:
|
|
3060
|
+
$ref: '#/components/schemas/ListBatchOperationsResponse'
|
|
3061
|
+
default:
|
|
3062
|
+
description: Default error response
|
|
3063
|
+
content:
|
|
3064
|
+
application/json:
|
|
3065
|
+
schema:
|
|
3066
|
+
$ref: '#/components/schemas/Status'
|
|
3067
|
+
/namespaces/{namespace}/batch-operations/{jobId}:
|
|
3068
|
+
get:
|
|
3069
|
+
tags:
|
|
3070
|
+
- WorkflowService
|
|
3071
|
+
description: DescribeBatchOperation returns the information about a batch operation
|
|
3072
|
+
operationId: DescribeBatchOperation
|
|
3073
|
+
parameters:
|
|
3074
|
+
- name: namespace
|
|
3075
|
+
in: path
|
|
3076
|
+
description: Namespace that contains the batch operation
|
|
3077
|
+
required: true
|
|
3078
|
+
schema:
|
|
3079
|
+
type: string
|
|
3080
|
+
- name: jobId
|
|
3081
|
+
in: path
|
|
3082
|
+
description: Batch job id
|
|
3083
|
+
required: true
|
|
3084
|
+
schema:
|
|
3085
|
+
type: string
|
|
3086
|
+
responses:
|
|
3087
|
+
"200":
|
|
3088
|
+
description: OK
|
|
3089
|
+
content:
|
|
3090
|
+
application/json:
|
|
3091
|
+
schema:
|
|
3092
|
+
$ref: '#/components/schemas/DescribeBatchOperationResponse'
|
|
3093
|
+
default:
|
|
3094
|
+
description: Default error response
|
|
3095
|
+
content:
|
|
3096
|
+
application/json:
|
|
3097
|
+
schema:
|
|
3098
|
+
$ref: '#/components/schemas/Status'
|
|
3099
|
+
post:
|
|
3100
|
+
tags:
|
|
3101
|
+
- WorkflowService
|
|
3102
|
+
description: StartBatchOperation starts a new batch operation
|
|
3103
|
+
operationId: StartBatchOperation
|
|
3104
|
+
parameters:
|
|
3105
|
+
- name: namespace
|
|
3106
|
+
in: path
|
|
3107
|
+
description: Namespace that contains the batch operation
|
|
3108
|
+
required: true
|
|
3109
|
+
schema:
|
|
3110
|
+
type: string
|
|
3111
|
+
- name: jobId
|
|
3112
|
+
in: path
|
|
3113
|
+
description: Job ID defines the unique ID for the batch job
|
|
3114
|
+
required: true
|
|
3115
|
+
schema:
|
|
3116
|
+
type: string
|
|
3117
|
+
requestBody:
|
|
3118
|
+
content:
|
|
3119
|
+
application/json:
|
|
3120
|
+
schema:
|
|
3121
|
+
$ref: '#/components/schemas/StartBatchOperationRequest'
|
|
3122
|
+
required: true
|
|
3123
|
+
responses:
|
|
3124
|
+
"200":
|
|
3125
|
+
description: OK
|
|
3126
|
+
content:
|
|
3127
|
+
application/json:
|
|
3128
|
+
schema:
|
|
3129
|
+
$ref: '#/components/schemas/StartBatchOperationResponse'
|
|
3130
|
+
default:
|
|
3131
|
+
description: Default error response
|
|
3132
|
+
content:
|
|
3133
|
+
application/json:
|
|
3134
|
+
schema:
|
|
3135
|
+
$ref: '#/components/schemas/Status'
|
|
3136
|
+
/namespaces/{namespace}/batch-operations/{jobId}/stop:
|
|
3137
|
+
post:
|
|
3138
|
+
tags:
|
|
3139
|
+
- WorkflowService
|
|
3140
|
+
description: StopBatchOperation stops a batch operation
|
|
3141
|
+
operationId: StopBatchOperation
|
|
3142
|
+
parameters:
|
|
3143
|
+
- name: namespace
|
|
3144
|
+
in: path
|
|
3145
|
+
description: Namespace that contains the batch operation
|
|
3146
|
+
required: true
|
|
3147
|
+
schema:
|
|
3148
|
+
type: string
|
|
3149
|
+
- name: jobId
|
|
3150
|
+
in: path
|
|
3151
|
+
description: Batch job id
|
|
3152
|
+
required: true
|
|
3153
|
+
schema:
|
|
3154
|
+
type: string
|
|
3155
|
+
requestBody:
|
|
3156
|
+
content:
|
|
3157
|
+
application/json:
|
|
3158
|
+
schema:
|
|
3159
|
+
$ref: '#/components/schemas/StopBatchOperationRequest'
|
|
3160
|
+
required: true
|
|
3161
|
+
responses:
|
|
3162
|
+
"200":
|
|
3163
|
+
description: OK
|
|
3164
|
+
content:
|
|
3165
|
+
application/json:
|
|
3166
|
+
schema:
|
|
3167
|
+
$ref: '#/components/schemas/StopBatchOperationResponse'
|
|
3168
|
+
default:
|
|
3169
|
+
description: Default error response
|
|
3170
|
+
content:
|
|
3171
|
+
application/json:
|
|
3172
|
+
schema:
|
|
3173
|
+
$ref: '#/components/schemas/Status'
|
|
3174
|
+
/namespaces/{namespace}/schedules:
|
|
3175
|
+
get:
|
|
3176
|
+
tags:
|
|
3177
|
+
- WorkflowService
|
|
3178
|
+
description: List all schedules in a namespace.
|
|
3179
|
+
operationId: ListSchedules
|
|
3180
|
+
parameters:
|
|
3181
|
+
- name: namespace
|
|
3182
|
+
in: path
|
|
3183
|
+
description: The namespace to list schedules in.
|
|
3184
|
+
required: true
|
|
3185
|
+
schema:
|
|
3186
|
+
type: string
|
|
3187
|
+
- name: maximumPageSize
|
|
3188
|
+
in: query
|
|
3189
|
+
description: How many to return at once.
|
|
3190
|
+
schema:
|
|
3191
|
+
type: integer
|
|
3192
|
+
format: int32
|
|
3193
|
+
- name: nextPageToken
|
|
3194
|
+
in: query
|
|
3195
|
+
description: Token to get the next page of results.
|
|
3196
|
+
schema:
|
|
3197
|
+
type: string
|
|
3198
|
+
format: bytes
|
|
3199
|
+
- name: query
|
|
3200
|
+
in: query
|
|
3201
|
+
description: Query to filter schedules.
|
|
3202
|
+
schema:
|
|
3203
|
+
type: string
|
|
3204
|
+
responses:
|
|
3205
|
+
"200":
|
|
3206
|
+
description: OK
|
|
3207
|
+
content:
|
|
3208
|
+
application/json:
|
|
3209
|
+
schema:
|
|
3210
|
+
$ref: '#/components/schemas/ListSchedulesResponse'
|
|
3211
|
+
default:
|
|
3212
|
+
description: Default error response
|
|
3213
|
+
content:
|
|
3214
|
+
application/json:
|
|
3215
|
+
schema:
|
|
3216
|
+
$ref: '#/components/schemas/Status'
|
|
3217
|
+
/namespaces/{namespace}/schedules/{scheduleId}:
|
|
3218
|
+
get:
|
|
3219
|
+
tags:
|
|
3220
|
+
- WorkflowService
|
|
3221
|
+
description: Returns the schedule description and current state of an existing schedule.
|
|
3222
|
+
operationId: DescribeSchedule
|
|
3223
|
+
parameters:
|
|
3224
|
+
- name: namespace
|
|
3225
|
+
in: path
|
|
3226
|
+
description: The namespace of the schedule to describe.
|
|
3227
|
+
required: true
|
|
3228
|
+
schema:
|
|
3229
|
+
type: string
|
|
3230
|
+
- name: scheduleId
|
|
3231
|
+
in: path
|
|
3232
|
+
description: The id of the schedule to describe.
|
|
3233
|
+
required: true
|
|
3234
|
+
schema:
|
|
3235
|
+
type: string
|
|
3236
|
+
responses:
|
|
3237
|
+
"200":
|
|
3238
|
+
description: OK
|
|
3239
|
+
content:
|
|
3240
|
+
application/json:
|
|
3241
|
+
schema:
|
|
3242
|
+
$ref: '#/components/schemas/DescribeScheduleResponse'
|
|
3243
|
+
default:
|
|
3244
|
+
description: Default error response
|
|
3245
|
+
content:
|
|
3246
|
+
application/json:
|
|
3247
|
+
schema:
|
|
3248
|
+
$ref: '#/components/schemas/Status'
|
|
3249
|
+
post:
|
|
3250
|
+
tags:
|
|
3251
|
+
- WorkflowService
|
|
3252
|
+
description: Creates a new schedule.
|
|
3253
|
+
operationId: CreateSchedule
|
|
3254
|
+
parameters:
|
|
3255
|
+
- name: namespace
|
|
3256
|
+
in: path
|
|
3257
|
+
description: The namespace the schedule should be created in.
|
|
3258
|
+
required: true
|
|
3259
|
+
schema:
|
|
3260
|
+
type: string
|
|
3261
|
+
- name: scheduleId
|
|
3262
|
+
in: path
|
|
3263
|
+
description: The id of the new schedule.
|
|
3264
|
+
required: true
|
|
3265
|
+
schema:
|
|
3266
|
+
type: string
|
|
3267
|
+
requestBody:
|
|
3268
|
+
content:
|
|
3269
|
+
application/json:
|
|
3270
|
+
schema:
|
|
3271
|
+
$ref: '#/components/schemas/CreateScheduleRequest'
|
|
3272
|
+
required: true
|
|
3273
|
+
responses:
|
|
3274
|
+
"200":
|
|
3275
|
+
description: OK
|
|
3276
|
+
content:
|
|
3277
|
+
application/json:
|
|
3278
|
+
schema:
|
|
3279
|
+
$ref: '#/components/schemas/CreateScheduleResponse'
|
|
3280
|
+
default:
|
|
3281
|
+
description: Default error response
|
|
3282
|
+
content:
|
|
3283
|
+
application/json:
|
|
3284
|
+
schema:
|
|
3285
|
+
$ref: '#/components/schemas/Status'
|
|
3286
|
+
delete:
|
|
3287
|
+
tags:
|
|
3288
|
+
- WorkflowService
|
|
3289
|
+
description: Deletes a schedule, removing it from the system.
|
|
3290
|
+
operationId: DeleteSchedule
|
|
3291
|
+
parameters:
|
|
3292
|
+
- name: namespace
|
|
3293
|
+
in: path
|
|
3294
|
+
description: The namespace of the schedule to delete.
|
|
3295
|
+
required: true
|
|
3296
|
+
schema:
|
|
3297
|
+
type: string
|
|
3298
|
+
- name: scheduleId
|
|
3299
|
+
in: path
|
|
3300
|
+
description: The id of the schedule to delete.
|
|
3301
|
+
required: true
|
|
3302
|
+
schema:
|
|
3303
|
+
type: string
|
|
3304
|
+
- name: identity
|
|
3305
|
+
in: query
|
|
3306
|
+
description: The identity of the client who initiated this request.
|
|
3307
|
+
schema:
|
|
3308
|
+
type: string
|
|
3309
|
+
responses:
|
|
3310
|
+
"200":
|
|
3311
|
+
description: OK
|
|
3312
|
+
content:
|
|
3313
|
+
application/json:
|
|
3314
|
+
schema:
|
|
3315
|
+
$ref: '#/components/schemas/DeleteScheduleResponse'
|
|
3316
|
+
default:
|
|
3317
|
+
description: Default error response
|
|
3318
|
+
content:
|
|
3319
|
+
application/json:
|
|
3320
|
+
schema:
|
|
3321
|
+
$ref: '#/components/schemas/Status'
|
|
3322
|
+
/namespaces/{namespace}/schedules/{scheduleId}/matching-times:
|
|
3323
|
+
get:
|
|
3324
|
+
tags:
|
|
3325
|
+
- WorkflowService
|
|
3326
|
+
description: Lists matching times within a range.
|
|
3327
|
+
operationId: ListScheduleMatchingTimes
|
|
3328
|
+
parameters:
|
|
3329
|
+
- name: namespace
|
|
3330
|
+
in: path
|
|
3331
|
+
description: The namespace of the schedule to query.
|
|
3332
|
+
required: true
|
|
3333
|
+
schema:
|
|
3334
|
+
type: string
|
|
3335
|
+
- name: scheduleId
|
|
3336
|
+
in: path
|
|
3337
|
+
description: The id of the schedule to query.
|
|
3338
|
+
required: true
|
|
3339
|
+
schema:
|
|
3340
|
+
type: string
|
|
3341
|
+
- name: startTime
|
|
3342
|
+
in: query
|
|
3343
|
+
description: Time range to query.
|
|
3344
|
+
schema:
|
|
3345
|
+
type: string
|
|
3346
|
+
format: date-time
|
|
3347
|
+
- name: endTime
|
|
3348
|
+
in: query
|
|
3349
|
+
schema:
|
|
3350
|
+
type: string
|
|
3351
|
+
format: date-time
|
|
3352
|
+
responses:
|
|
3353
|
+
"200":
|
|
3354
|
+
description: OK
|
|
3355
|
+
content:
|
|
3356
|
+
application/json:
|
|
3357
|
+
schema:
|
|
3358
|
+
$ref: '#/components/schemas/ListScheduleMatchingTimesResponse'
|
|
3359
|
+
default:
|
|
3360
|
+
description: Default error response
|
|
3361
|
+
content:
|
|
3362
|
+
application/json:
|
|
3363
|
+
schema:
|
|
3364
|
+
$ref: '#/components/schemas/Status'
|
|
3365
|
+
/namespaces/{namespace}/schedules/{scheduleId}/patch:
|
|
3366
|
+
post:
|
|
3367
|
+
tags:
|
|
3368
|
+
- WorkflowService
|
|
3369
|
+
description: Makes a specific change to a schedule or triggers an immediate action.
|
|
3370
|
+
operationId: PatchSchedule
|
|
3371
|
+
parameters:
|
|
3372
|
+
- name: namespace
|
|
3373
|
+
in: path
|
|
3374
|
+
description: The namespace of the schedule to patch.
|
|
3375
|
+
required: true
|
|
3376
|
+
schema:
|
|
3377
|
+
type: string
|
|
3378
|
+
- name: scheduleId
|
|
3379
|
+
in: path
|
|
3380
|
+
description: The id of the schedule to patch.
|
|
3381
|
+
required: true
|
|
3382
|
+
schema:
|
|
3383
|
+
type: string
|
|
3384
|
+
requestBody:
|
|
3385
|
+
content:
|
|
3386
|
+
application/json:
|
|
3387
|
+
schema:
|
|
3388
|
+
$ref: '#/components/schemas/PatchScheduleRequest'
|
|
3389
|
+
required: true
|
|
3390
|
+
responses:
|
|
3391
|
+
"200":
|
|
3392
|
+
description: OK
|
|
3393
|
+
content:
|
|
3394
|
+
application/json:
|
|
3395
|
+
schema:
|
|
3396
|
+
$ref: '#/components/schemas/PatchScheduleResponse'
|
|
3397
|
+
default:
|
|
3398
|
+
description: Default error response
|
|
3399
|
+
content:
|
|
3400
|
+
application/json:
|
|
3401
|
+
schema:
|
|
3402
|
+
$ref: '#/components/schemas/Status'
|
|
3403
|
+
/namespaces/{namespace}/schedules/{scheduleId}/update:
|
|
3404
|
+
post:
|
|
3405
|
+
tags:
|
|
3406
|
+
- WorkflowService
|
|
3407
|
+
description: Changes the configuration or state of an existing schedule.
|
|
3408
|
+
operationId: UpdateSchedule
|
|
3409
|
+
parameters:
|
|
3410
|
+
- name: namespace
|
|
3411
|
+
in: path
|
|
3412
|
+
description: The namespace of the schedule to update.
|
|
3413
|
+
required: true
|
|
3414
|
+
schema:
|
|
3415
|
+
type: string
|
|
3416
|
+
- name: scheduleId
|
|
3417
|
+
in: path
|
|
3418
|
+
description: The id of the schedule to update.
|
|
3419
|
+
required: true
|
|
3420
|
+
schema:
|
|
3421
|
+
type: string
|
|
3422
|
+
requestBody:
|
|
3423
|
+
content:
|
|
3424
|
+
application/json:
|
|
3425
|
+
schema:
|
|
3426
|
+
$ref: '#/components/schemas/UpdateScheduleRequest'
|
|
3427
|
+
required: true
|
|
3428
|
+
responses:
|
|
3429
|
+
"200":
|
|
3430
|
+
description: OK
|
|
3431
|
+
content:
|
|
3432
|
+
application/json:
|
|
3433
|
+
schema:
|
|
3434
|
+
$ref: '#/components/schemas/UpdateScheduleResponse'
|
|
3435
|
+
default:
|
|
3436
|
+
description: Default error response
|
|
3437
|
+
content:
|
|
3438
|
+
application/json:
|
|
3439
|
+
schema:
|
|
3440
|
+
$ref: '#/components/schemas/Status'
|
|
3441
|
+
/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility:
|
|
3442
|
+
get:
|
|
3443
|
+
tags:
|
|
3444
|
+
- WorkflowService
|
|
3445
|
+
description: |-
|
|
3446
|
+
Deprecated. Use `GetWorkerVersioningRules`.
|
|
3447
|
+
Fetches the worker build id versioning sets for a task queue.
|
|
3448
|
+
operationId: GetWorkerBuildIdCompatibility
|
|
3449
|
+
parameters:
|
|
3450
|
+
- name: namespace
|
|
3451
|
+
in: path
|
|
3452
|
+
required: true
|
|
3453
|
+
schema:
|
|
3454
|
+
type: string
|
|
3455
|
+
- name: taskQueue
|
|
3456
|
+
in: path
|
|
3457
|
+
description: Must be set, the task queue to interrogate about worker id compatibility.
|
|
3458
|
+
required: true
|
|
3459
|
+
schema:
|
|
3460
|
+
type: string
|
|
3461
|
+
- name: maxSets
|
|
3462
|
+
in: query
|
|
3463
|
+
description: |-
|
|
3464
|
+
Limits how many compatible sets will be returned. Specify 1 to only return the current
|
|
3465
|
+
default major version set. 0 returns all sets.
|
|
3466
|
+
schema:
|
|
3467
|
+
type: integer
|
|
3468
|
+
format: int32
|
|
3469
|
+
responses:
|
|
3470
|
+
"200":
|
|
3471
|
+
description: OK
|
|
3472
|
+
content:
|
|
3473
|
+
application/json:
|
|
3474
|
+
schema:
|
|
3475
|
+
$ref: '#/components/schemas/GetWorkerBuildIdCompatibilityResponse'
|
|
3476
|
+
default:
|
|
3477
|
+
description: Default error response
|
|
3478
|
+
content:
|
|
3479
|
+
application/json:
|
|
3480
|
+
schema:
|
|
3481
|
+
$ref: '#/components/schemas/Status'
|
|
3482
|
+
/namespaces/{namespace}/task-queues/{taskQueue}/worker-versioning-rules:
|
|
3483
|
+
get:
|
|
3484
|
+
tags:
|
|
3485
|
+
- WorkflowService
|
|
3486
|
+
description: |-
|
|
3487
|
+
Fetches the Build ID assignment and redirect rules for a Task Queue.
|
|
3488
|
+
WARNING: Worker Versioning is not yet stable and the API and behavior may change incompatibly.
|
|
3489
|
+
operationId: GetWorkerVersioningRules
|
|
3490
|
+
parameters:
|
|
3491
|
+
- name: namespace
|
|
3492
|
+
in: path
|
|
3493
|
+
required: true
|
|
3494
|
+
schema:
|
|
3495
|
+
type: string
|
|
3496
|
+
- name: taskQueue
|
|
3497
|
+
in: path
|
|
3498
|
+
required: true
|
|
3499
|
+
schema:
|
|
3500
|
+
type: string
|
|
3501
|
+
responses:
|
|
3502
|
+
"200":
|
|
3503
|
+
description: OK
|
|
3504
|
+
content:
|
|
3505
|
+
application/json:
|
|
3506
|
+
schema:
|
|
3507
|
+
$ref: '#/components/schemas/GetWorkerVersioningRulesResponse'
|
|
3508
|
+
default:
|
|
3509
|
+
description: Default error response
|
|
3510
|
+
content:
|
|
3511
|
+
application/json:
|
|
3512
|
+
schema:
|
|
3513
|
+
$ref: '#/components/schemas/Status'
|
|
3514
|
+
/namespaces/{namespace}/task-queues/{task_queue.name}:
|
|
3515
|
+
get:
|
|
3516
|
+
tags:
|
|
3517
|
+
- WorkflowService
|
|
3518
|
+
description: |-
|
|
3519
|
+
DescribeTaskQueue returns the following information about the target task queue, broken down by Build ID:
|
|
3520
|
+
- List of pollers
|
|
3521
|
+
- Workflow Reachability status
|
|
3522
|
+
- Backlog info for Workflow and/or Activity tasks
|
|
3523
|
+
operationId: DescribeTaskQueue
|
|
3524
|
+
parameters:
|
|
3525
|
+
- name: namespace
|
|
3526
|
+
in: path
|
|
3527
|
+
required: true
|
|
3528
|
+
schema:
|
|
3529
|
+
type: string
|
|
3530
|
+
- name: task_queue.name
|
|
3531
|
+
in: path
|
|
3532
|
+
required: true
|
|
3533
|
+
schema:
|
|
3534
|
+
type: string
|
|
3535
|
+
- name: taskQueue.name
|
|
3536
|
+
in: query
|
|
3537
|
+
schema:
|
|
3538
|
+
type: string
|
|
3539
|
+
- name: taskQueue.kind
|
|
3540
|
+
in: query
|
|
3541
|
+
description: 'Default: TASK_QUEUE_KIND_NORMAL.'
|
|
3542
|
+
schema:
|
|
3543
|
+
enum:
|
|
3544
|
+
- TASK_QUEUE_KIND_UNSPECIFIED
|
|
3545
|
+
- TASK_QUEUE_KIND_NORMAL
|
|
3546
|
+
- TASK_QUEUE_KIND_STICKY
|
|
3547
|
+
type: string
|
|
3548
|
+
format: enum
|
|
3549
|
+
- name: taskQueue.normalName
|
|
3550
|
+
in: query
|
|
3551
|
+
description: |-
|
|
3552
|
+
Iff kind == TASK_QUEUE_KIND_STICKY, then this field contains the name of
|
|
3553
|
+
the normal task queue that the sticky worker is running on.
|
|
3554
|
+
schema:
|
|
3555
|
+
type: string
|
|
3556
|
+
- name: taskQueueType
|
|
3557
|
+
in: query
|
|
3558
|
+
description: |-
|
|
3559
|
+
Deprecated. Use `ENHANCED` mode with `task_queue_types`. Ignored in `ENHANCED` mode.
|
|
3560
|
+
If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.
|
|
3561
|
+
schema:
|
|
3562
|
+
enum:
|
|
3563
|
+
- TASK_QUEUE_TYPE_UNSPECIFIED
|
|
3564
|
+
- TASK_QUEUE_TYPE_WORKFLOW
|
|
3565
|
+
- TASK_QUEUE_TYPE_ACTIVITY
|
|
3566
|
+
- TASK_QUEUE_TYPE_NEXUS
|
|
3567
|
+
type: string
|
|
3568
|
+
format: enum
|
|
3569
|
+
- name: includeTaskQueueStatus
|
|
3570
|
+
in: query
|
|
3571
|
+
description: Deprecated. Ignored in `ENHANCED` mode.
|
|
3572
|
+
schema:
|
|
3573
|
+
type: boolean
|
|
3574
|
+
- name: apiMode
|
|
3575
|
+
in: query
|
|
3576
|
+
description: All options except `task_queue_type` and `include_task_queue_status` are only available in the `ENHANCED` mode.
|
|
3577
|
+
schema:
|
|
3578
|
+
enum:
|
|
3579
|
+
- DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED
|
|
3580
|
+
- DESCRIBE_TASK_QUEUE_MODE_ENHANCED
|
|
3581
|
+
type: string
|
|
3582
|
+
format: enum
|
|
3583
|
+
- name: versions.buildIds
|
|
3584
|
+
in: query
|
|
3585
|
+
description: Include specific Build IDs.
|
|
3586
|
+
schema:
|
|
3587
|
+
type: array
|
|
3588
|
+
items:
|
|
3589
|
+
type: string
|
|
3590
|
+
- name: versions.unversioned
|
|
3591
|
+
in: query
|
|
3592
|
+
description: Include the unversioned queue.
|
|
3593
|
+
schema:
|
|
3594
|
+
type: boolean
|
|
3595
|
+
- name: versions.allActive
|
|
3596
|
+
in: query
|
|
3597
|
+
description: |-
|
|
3598
|
+
Include all active versions. A version is considered active if, in the last few minutes,
|
|
3599
|
+
it has had new tasks or polls, or it has been the subject of certain task queue API calls.
|
|
3600
|
+
schema:
|
|
3601
|
+
type: boolean
|
|
3602
|
+
- name: taskQueueTypes
|
|
3603
|
+
in: query
|
|
3604
|
+
description: Task queue types to report info about. If not specified, all types are considered.
|
|
3605
|
+
schema:
|
|
3606
|
+
type: array
|
|
3607
|
+
items:
|
|
3608
|
+
enum:
|
|
3609
|
+
- TASK_QUEUE_TYPE_UNSPECIFIED
|
|
3610
|
+
- TASK_QUEUE_TYPE_WORKFLOW
|
|
3611
|
+
- TASK_QUEUE_TYPE_ACTIVITY
|
|
3612
|
+
- TASK_QUEUE_TYPE_NEXUS
|
|
3613
|
+
type: string
|
|
3614
|
+
format: enum
|
|
3615
|
+
- name: reportStats
|
|
3616
|
+
in: query
|
|
3617
|
+
description: Report stats for the requested task queue types and versions
|
|
3618
|
+
schema:
|
|
3619
|
+
type: boolean
|
|
3620
|
+
- name: reportPollers
|
|
3621
|
+
in: query
|
|
3622
|
+
description: Report list of pollers for requested task queue types and versions
|
|
3623
|
+
schema:
|
|
3624
|
+
type: boolean
|
|
3625
|
+
- name: reportTaskReachability
|
|
3626
|
+
in: query
|
|
3627
|
+
description: |-
|
|
3628
|
+
Report task reachability for the requested versions and all task types (task reachability is not reported
|
|
3629
|
+
per task type).
|
|
3630
|
+
schema:
|
|
3631
|
+
type: boolean
|
|
3632
|
+
responses:
|
|
3633
|
+
"200":
|
|
3634
|
+
description: OK
|
|
3635
|
+
content:
|
|
3636
|
+
application/json:
|
|
3637
|
+
schema:
|
|
3638
|
+
$ref: '#/components/schemas/DescribeTaskQueueResponse'
|
|
3639
|
+
default:
|
|
3640
|
+
description: Default error response
|
|
3641
|
+
content:
|
|
3642
|
+
application/json:
|
|
3643
|
+
schema:
|
|
3644
|
+
$ref: '#/components/schemas/Status'
|
|
3645
|
+
/namespaces/{namespace}/worker-task-reachability:
|
|
3646
|
+
get:
|
|
3647
|
+
tags:
|
|
3648
|
+
- WorkflowService
|
|
3649
|
+
description: |-
|
|
3650
|
+
Deprecated. Use `DescribeTaskQueue`.
|
|
3651
|
+
|
|
3652
|
+
Fetches task reachability to determine whether a worker may be retired.
|
|
3653
|
+
The request may specify task queues to query for or let the server fetch all task queues mapped to the given
|
|
3654
|
+
build IDs.
|
|
3655
|
+
|
|
3656
|
+
When requesting a large number of task queues or all task queues associated with the given build ids in a
|
|
3657
|
+
namespace, all task queues will be listed in the response but some of them may not contain reachability
|
|
3658
|
+
information due to a server enforced limit. When reaching the limit, task queues that reachability information
|
|
3659
|
+
could not be retrieved for will be marked with a single TASK_REACHABILITY_UNSPECIFIED entry. The caller may issue
|
|
3660
|
+
another call to get the reachability for those task queues.
|
|
3661
|
+
|
|
3662
|
+
Open source users can adjust this limit by setting the server's dynamic config value for
|
|
3663
|
+
`limit.reachabilityTaskQueueScan` with the caveat that this call can strain the visibility store.
|
|
3664
|
+
operationId: GetWorkerTaskReachability
|
|
3665
|
+
parameters:
|
|
3666
|
+
- name: namespace
|
|
3667
|
+
in: path
|
|
3668
|
+
required: true
|
|
3669
|
+
schema:
|
|
3670
|
+
type: string
|
|
3671
|
+
- name: buildIds
|
|
3672
|
+
in: query
|
|
3673
|
+
description: |-
|
|
3674
|
+
Build ids to retrieve reachability for. An empty string will be interpreted as an unversioned worker.
|
|
3675
|
+
The number of build ids that can be queried in a single API call is limited.
|
|
3676
|
+
Open source users can adjust this limit by setting the server's dynamic config value for
|
|
3677
|
+
`limit.reachabilityQueryBuildIds` with the caveat that this call can strain the visibility store.
|
|
3678
|
+
schema:
|
|
3679
|
+
type: array
|
|
3680
|
+
items:
|
|
3681
|
+
type: string
|
|
3682
|
+
- name: taskQueues
|
|
3683
|
+
in: query
|
|
3684
|
+
description: |-
|
|
3685
|
+
Task queues to retrieve reachability for. Leave this empty to query for all task queues associated with given
|
|
3686
|
+
build ids in the namespace.
|
|
3687
|
+
Must specify at least one task queue if querying for an unversioned worker.
|
|
3688
|
+
The number of task queues that the server will fetch reachability information for is limited.
|
|
3689
|
+
See the `GetWorkerTaskReachabilityResponse` documentation for more information.
|
|
3690
|
+
schema:
|
|
3691
|
+
type: array
|
|
3692
|
+
items:
|
|
3693
|
+
type: string
|
|
3694
|
+
- name: reachability
|
|
3695
|
+
in: query
|
|
3696
|
+
description: |-
|
|
3697
|
+
Type of reachability to query for.
|
|
3698
|
+
`TASK_REACHABILITY_NEW_WORKFLOWS` is always returned in the response.
|
|
3699
|
+
Use `TASK_REACHABILITY_EXISTING_WORKFLOWS` if your application needs to respond to queries on closed workflows.
|
|
3700
|
+
Otherwise, use `TASK_REACHABILITY_OPEN_WORKFLOWS`. Default is `TASK_REACHABILITY_EXISTING_WORKFLOWS` if left
|
|
3701
|
+
unspecified.
|
|
3702
|
+
See the TaskReachability docstring for information about each enum variant.
|
|
3703
|
+
schema:
|
|
3704
|
+
enum:
|
|
3705
|
+
- TASK_REACHABILITY_UNSPECIFIED
|
|
3706
|
+
- TASK_REACHABILITY_NEW_WORKFLOWS
|
|
3707
|
+
- TASK_REACHABILITY_EXISTING_WORKFLOWS
|
|
3708
|
+
- TASK_REACHABILITY_OPEN_WORKFLOWS
|
|
3709
|
+
- TASK_REACHABILITY_CLOSED_WORKFLOWS
|
|
3710
|
+
type: string
|
|
3711
|
+
format: enum
|
|
3712
|
+
responses:
|
|
3713
|
+
"200":
|
|
3714
|
+
description: OK
|
|
3715
|
+
content:
|
|
3716
|
+
application/json:
|
|
3717
|
+
schema:
|
|
3718
|
+
$ref: '#/components/schemas/GetWorkerTaskReachabilityResponse'
|
|
3719
|
+
default:
|
|
3720
|
+
description: Default error response
|
|
3721
|
+
content:
|
|
3722
|
+
application/json:
|
|
3723
|
+
schema:
|
|
3724
|
+
$ref: '#/components/schemas/Status'
|
|
3725
|
+
/namespaces/{namespace}/workflow-count:
|
|
3726
|
+
get:
|
|
3727
|
+
tags:
|
|
3728
|
+
- WorkflowService
|
|
3729
|
+
description: CountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.
|
|
3730
|
+
operationId: CountWorkflowExecutions
|
|
3731
|
+
parameters:
|
|
3732
|
+
- name: namespace
|
|
3733
|
+
in: path
|
|
3734
|
+
required: true
|
|
3735
|
+
schema:
|
|
3736
|
+
type: string
|
|
3737
|
+
- name: query
|
|
3738
|
+
in: query
|
|
3739
|
+
schema:
|
|
3740
|
+
type: string
|
|
3741
|
+
responses:
|
|
3742
|
+
"200":
|
|
3743
|
+
description: OK
|
|
3744
|
+
content:
|
|
3745
|
+
application/json:
|
|
3746
|
+
schema:
|
|
3747
|
+
$ref: '#/components/schemas/CountWorkflowExecutionsResponse'
|
|
3748
|
+
default:
|
|
3749
|
+
description: Default error response
|
|
3750
|
+
content:
|
|
3751
|
+
application/json:
|
|
3752
|
+
schema:
|
|
3753
|
+
$ref: '#/components/schemas/Status'
|
|
3754
|
+
/namespaces/{namespace}/workflows:
|
|
3755
|
+
get:
|
|
3756
|
+
tags:
|
|
3757
|
+
- WorkflowService
|
|
3758
|
+
description: ListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.
|
|
3759
|
+
operationId: ListWorkflowExecutions
|
|
3760
|
+
parameters:
|
|
3761
|
+
- name: namespace
|
|
3762
|
+
in: path
|
|
3763
|
+
required: true
|
|
3764
|
+
schema:
|
|
3765
|
+
type: string
|
|
3766
|
+
- name: pageSize
|
|
3767
|
+
in: query
|
|
3768
|
+
schema:
|
|
3769
|
+
type: integer
|
|
3770
|
+
format: int32
|
|
3771
|
+
- name: nextPageToken
|
|
3772
|
+
in: query
|
|
3773
|
+
schema:
|
|
3774
|
+
type: string
|
|
3775
|
+
format: bytes
|
|
3776
|
+
- name: query
|
|
3777
|
+
in: query
|
|
3778
|
+
schema:
|
|
3779
|
+
type: string
|
|
3780
|
+
responses:
|
|
3781
|
+
"200":
|
|
3782
|
+
description: OK
|
|
3783
|
+
content:
|
|
3784
|
+
application/json:
|
|
3785
|
+
schema:
|
|
3786
|
+
$ref: '#/components/schemas/ListWorkflowExecutionsResponse'
|
|
3787
|
+
default:
|
|
3788
|
+
description: Default error response
|
|
3789
|
+
content:
|
|
3790
|
+
application/json:
|
|
3791
|
+
schema:
|
|
3792
|
+
$ref: '#/components/schemas/Status'
|
|
3793
|
+
/namespaces/{namespace}/workflows/execute-multi-operation:
|
|
3794
|
+
post:
|
|
3795
|
+
tags:
|
|
3796
|
+
- WorkflowService
|
|
3797
|
+
description: |-
|
|
3798
|
+
ExecuteMultiOperation executes multiple operations within a single workflow.
|
|
3799
|
+
|
|
3800
|
+
Operations are started atomically, meaning if *any* operation fails to be started, none are,
|
|
3801
|
+
and the request fails. Upon start, the API returns only when *all* operations have a response.
|
|
3802
|
+
|
|
3803
|
+
Upon failure, it returns `MultiOperationExecutionFailure` where the status code
|
|
3804
|
+
equals the status code of the *first* operation that failed to be started.
|
|
3805
|
+
|
|
3806
|
+
NOTE: Experimental API.
|
|
3807
|
+
operationId: ExecuteMultiOperation
|
|
3808
|
+
parameters:
|
|
3809
|
+
- name: namespace
|
|
3810
|
+
in: path
|
|
3811
|
+
required: true
|
|
3812
|
+
schema:
|
|
3813
|
+
type: string
|
|
3814
|
+
requestBody:
|
|
3815
|
+
content:
|
|
3816
|
+
application/json:
|
|
3817
|
+
schema:
|
|
3818
|
+
$ref: '#/components/schemas/ExecuteMultiOperationRequest'
|
|
3819
|
+
required: true
|
|
3820
|
+
responses:
|
|
3821
|
+
"200":
|
|
3822
|
+
description: OK
|
|
3823
|
+
content:
|
|
3824
|
+
application/json:
|
|
3825
|
+
schema:
|
|
3826
|
+
$ref: '#/components/schemas/ExecuteMultiOperationResponse'
|
|
3827
|
+
default:
|
|
3828
|
+
description: Default error response
|
|
3829
|
+
content:
|
|
3830
|
+
application/json:
|
|
3831
|
+
schema:
|
|
3832
|
+
$ref: '#/components/schemas/Status'
|
|
3833
|
+
/namespaces/{namespace}/workflows/{execution.workflow_id}:
|
|
3834
|
+
get:
|
|
3835
|
+
tags:
|
|
3836
|
+
- WorkflowService
|
|
3837
|
+
description: DescribeWorkflowExecution returns information about the specified workflow execution.
|
|
3838
|
+
operationId: DescribeWorkflowExecution
|
|
3839
|
+
parameters:
|
|
3840
|
+
- name: namespace
|
|
3841
|
+
in: path
|
|
3842
|
+
required: true
|
|
3843
|
+
schema:
|
|
3844
|
+
type: string
|
|
3845
|
+
- name: execution.workflow_id
|
|
3846
|
+
in: path
|
|
3847
|
+
required: true
|
|
3848
|
+
schema:
|
|
3849
|
+
type: string
|
|
3850
|
+
- name: execution.workflowId
|
|
3851
|
+
in: query
|
|
3852
|
+
schema:
|
|
3853
|
+
type: string
|
|
3854
|
+
- name: execution.runId
|
|
3855
|
+
in: query
|
|
3856
|
+
schema:
|
|
3857
|
+
type: string
|
|
3858
|
+
responses:
|
|
3859
|
+
"200":
|
|
3860
|
+
description: OK
|
|
3861
|
+
content:
|
|
3862
|
+
application/json:
|
|
3863
|
+
schema:
|
|
3864
|
+
$ref: '#/components/schemas/DescribeWorkflowExecutionResponse'
|
|
3865
|
+
default:
|
|
3866
|
+
description: Default error response
|
|
3867
|
+
content:
|
|
3868
|
+
application/json:
|
|
3869
|
+
schema:
|
|
3870
|
+
$ref: '#/components/schemas/Status'
|
|
3871
|
+
/namespaces/{namespace}/workflows/{execution.workflow_id}/history:
|
|
3872
|
+
get:
|
|
3873
|
+
tags:
|
|
3874
|
+
- WorkflowService
|
|
3875
|
+
description: |-
|
|
3876
|
+
GetWorkflowExecutionHistory returns the history of specified workflow execution. Fails with
|
|
3877
|
+
`NotFound` if the specified workflow execution is unknown to the service.
|
|
3878
|
+
operationId: GetWorkflowExecutionHistory
|
|
3879
|
+
parameters:
|
|
3880
|
+
- name: namespace
|
|
3881
|
+
in: path
|
|
3882
|
+
required: true
|
|
3883
|
+
schema:
|
|
3884
|
+
type: string
|
|
3885
|
+
- name: execution.workflow_id
|
|
3886
|
+
in: path
|
|
3887
|
+
required: true
|
|
3888
|
+
schema:
|
|
3889
|
+
type: string
|
|
3890
|
+
- name: execution.workflowId
|
|
3891
|
+
in: query
|
|
3892
|
+
schema:
|
|
3893
|
+
type: string
|
|
3894
|
+
- name: execution.runId
|
|
3895
|
+
in: query
|
|
3896
|
+
schema:
|
|
3897
|
+
type: string
|
|
3898
|
+
- name: maximumPageSize
|
|
3899
|
+
in: query
|
|
3900
|
+
schema:
|
|
3901
|
+
type: integer
|
|
3902
|
+
format: int32
|
|
3903
|
+
- name: nextPageToken
|
|
3904
|
+
in: query
|
|
3905
|
+
description: |-
|
|
3906
|
+
If a `GetWorkflowExecutionHistoryResponse` or a `PollWorkflowTaskQueueResponse` had one of
|
|
3907
|
+
these, it should be passed here to fetch the next page.
|
|
3908
|
+
schema:
|
|
3909
|
+
type: string
|
|
3910
|
+
format: bytes
|
|
3911
|
+
- name: waitNewEvent
|
|
3912
|
+
in: query
|
|
3913
|
+
description: |-
|
|
3914
|
+
If set to true, the RPC call will not resolve until there is a new event which matches
|
|
3915
|
+
the `history_event_filter_type`, or a timeout is hit.
|
|
3916
|
+
schema:
|
|
3917
|
+
type: boolean
|
|
3918
|
+
- name: historyEventFilterType
|
|
3919
|
+
in: query
|
|
3920
|
+
description: |-
|
|
3921
|
+
Filter returned events such that they match the specified filter type.
|
|
3922
|
+
Default: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT.
|
|
3923
|
+
schema:
|
|
3924
|
+
enum:
|
|
3925
|
+
- HISTORY_EVENT_FILTER_TYPE_UNSPECIFIED
|
|
3926
|
+
- HISTORY_EVENT_FILTER_TYPE_ALL_EVENT
|
|
3927
|
+
- HISTORY_EVENT_FILTER_TYPE_CLOSE_EVENT
|
|
3928
|
+
type: string
|
|
3929
|
+
format: enum
|
|
3930
|
+
- name: skipArchival
|
|
3931
|
+
in: query
|
|
3932
|
+
schema:
|
|
3933
|
+
type: boolean
|
|
3934
|
+
responses:
|
|
3935
|
+
"200":
|
|
3936
|
+
description: OK
|
|
3937
|
+
content:
|
|
3938
|
+
application/json:
|
|
3939
|
+
schema:
|
|
3940
|
+
$ref: '#/components/schemas/GetWorkflowExecutionHistoryResponse'
|
|
3941
|
+
default:
|
|
3942
|
+
description: Default error response
|
|
3943
|
+
content:
|
|
3944
|
+
application/json:
|
|
3945
|
+
schema:
|
|
3946
|
+
$ref: '#/components/schemas/Status'
|
|
3947
|
+
/namespaces/{namespace}/workflows/{execution.workflow_id}/history-reverse:
|
|
3948
|
+
get:
|
|
3949
|
+
tags:
|
|
3950
|
+
- WorkflowService
|
|
3951
|
+
description: "GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse \n order (starting from last event). Fails with`NotFound` if the specified workflow execution is \n unknown to the service."
|
|
3952
|
+
operationId: GetWorkflowExecutionHistoryReverse
|
|
3953
|
+
parameters:
|
|
3954
|
+
- name: namespace
|
|
3955
|
+
in: path
|
|
3956
|
+
required: true
|
|
3957
|
+
schema:
|
|
3958
|
+
type: string
|
|
3959
|
+
- name: execution.workflow_id
|
|
3960
|
+
in: path
|
|
3961
|
+
required: true
|
|
3962
|
+
schema:
|
|
3963
|
+
type: string
|
|
3964
|
+
- name: execution.workflowId
|
|
3965
|
+
in: query
|
|
3966
|
+
schema:
|
|
3967
|
+
type: string
|
|
3968
|
+
- name: execution.runId
|
|
3969
|
+
in: query
|
|
3970
|
+
schema:
|
|
3971
|
+
type: string
|
|
3972
|
+
- name: maximumPageSize
|
|
3973
|
+
in: query
|
|
3974
|
+
schema:
|
|
3975
|
+
type: integer
|
|
3976
|
+
format: int32
|
|
3977
|
+
- name: nextPageToken
|
|
3978
|
+
in: query
|
|
3979
|
+
schema:
|
|
3980
|
+
type: string
|
|
3981
|
+
format: bytes
|
|
3982
|
+
responses:
|
|
3983
|
+
"200":
|
|
3984
|
+
description: OK
|
|
3985
|
+
content:
|
|
3986
|
+
application/json:
|
|
3987
|
+
schema:
|
|
3988
|
+
$ref: '#/components/schemas/GetWorkflowExecutionHistoryReverseResponse'
|
|
3989
|
+
default:
|
|
3990
|
+
description: Default error response
|
|
3991
|
+
content:
|
|
3992
|
+
application/json:
|
|
3993
|
+
schema:
|
|
3994
|
+
$ref: '#/components/schemas/Status'
|
|
3995
|
+
/namespaces/{namespace}/workflows/{execution.workflow_id}/query/{query.query_type}:
|
|
3996
|
+
post:
|
|
3997
|
+
tags:
|
|
3998
|
+
- WorkflowService
|
|
3999
|
+
description: QueryWorkflow requests a query be executed for a specified workflow execution.
|
|
4000
|
+
operationId: QueryWorkflow
|
|
4001
|
+
parameters:
|
|
4002
|
+
- name: namespace
|
|
4003
|
+
in: path
|
|
4004
|
+
required: true
|
|
4005
|
+
schema:
|
|
4006
|
+
type: string
|
|
4007
|
+
- name: execution.workflow_id
|
|
4008
|
+
in: path
|
|
4009
|
+
required: true
|
|
4010
|
+
schema:
|
|
4011
|
+
type: string
|
|
4012
|
+
- name: query.query_type
|
|
4013
|
+
in: path
|
|
4014
|
+
required: true
|
|
4015
|
+
schema:
|
|
4016
|
+
type: string
|
|
4017
|
+
requestBody:
|
|
4018
|
+
content:
|
|
4019
|
+
application/json:
|
|
4020
|
+
schema:
|
|
4021
|
+
$ref: '#/components/schemas/QueryWorkflowRequest'
|
|
4022
|
+
required: true
|
|
4023
|
+
responses:
|
|
4024
|
+
"200":
|
|
4025
|
+
description: OK
|
|
4026
|
+
content:
|
|
4027
|
+
application/json:
|
|
4028
|
+
schema:
|
|
4029
|
+
$ref: '#/components/schemas/QueryWorkflowResponse'
|
|
4030
|
+
default:
|
|
4031
|
+
description: Default error response
|
|
4032
|
+
content:
|
|
4033
|
+
application/json:
|
|
4034
|
+
schema:
|
|
4035
|
+
$ref: '#/components/schemas/Status'
|
|
4036
|
+
/namespaces/{namespace}/workflows/{workflowId}:
|
|
4037
|
+
post:
|
|
4038
|
+
tags:
|
|
4039
|
+
- WorkflowService
|
|
4040
|
+
description: |-
|
|
4041
|
+
StartWorkflowExecution starts a new workflow execution.
|
|
4042
|
+
|
|
4043
|
+
It will create the execution with a `WORKFLOW_EXECUTION_STARTED` event in its history and
|
|
4044
|
+
also schedule the first workflow task. Returns `WorkflowExecutionAlreadyStarted`, if an
|
|
4045
|
+
instance already exists with same workflow id.
|
|
4046
|
+
operationId: StartWorkflowExecution
|
|
4047
|
+
parameters:
|
|
4048
|
+
- name: namespace
|
|
4049
|
+
in: path
|
|
4050
|
+
required: true
|
|
4051
|
+
schema:
|
|
4052
|
+
type: string
|
|
4053
|
+
- name: workflowId
|
|
4054
|
+
in: path
|
|
4055
|
+
required: true
|
|
4056
|
+
schema:
|
|
4057
|
+
type: string
|
|
4058
|
+
requestBody:
|
|
4059
|
+
content:
|
|
4060
|
+
application/json:
|
|
4061
|
+
schema:
|
|
4062
|
+
$ref: '#/components/schemas/StartWorkflowExecutionRequest'
|
|
4063
|
+
required: true
|
|
4064
|
+
responses:
|
|
4065
|
+
"200":
|
|
4066
|
+
description: OK
|
|
4067
|
+
content:
|
|
4068
|
+
application/json:
|
|
4069
|
+
schema:
|
|
4070
|
+
$ref: '#/components/schemas/StartWorkflowExecutionResponse'
|
|
4071
|
+
default:
|
|
4072
|
+
description: Default error response
|
|
4073
|
+
content:
|
|
4074
|
+
application/json:
|
|
4075
|
+
schema:
|
|
4076
|
+
$ref: '#/components/schemas/Status'
|
|
4077
|
+
/namespaces/{namespace}/workflows/{workflowId}/signal-with-start/{signalName}:
|
|
4078
|
+
post:
|
|
4079
|
+
tags:
|
|
4080
|
+
- WorkflowService
|
|
4081
|
+
description: |-
|
|
4082
|
+
SignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if
|
|
4083
|
+
it isn't yet started.
|
|
4084
|
+
|
|
4085
|
+
If the workflow is running, a `WORKFLOW_EXECUTION_SIGNALED` event is recorded in the history
|
|
4086
|
+
and a workflow task is generated.
|
|
4087
|
+
|
|
4088
|
+
If the workflow is not running or not found, then the workflow is created with
|
|
4089
|
+
`WORKFLOW_EXECUTION_STARTED` and `WORKFLOW_EXECUTION_SIGNALED` events in its history, and a
|
|
4090
|
+
workflow task is generated.
|
|
4091
|
+
|
|
4092
|
+
(-- api-linter: core::0136::prepositions=disabled
|
|
4093
|
+
aip.dev/not-precedent: "With" is used to indicate combined operation. --)
|
|
4094
|
+
operationId: SignalWithStartWorkflowExecution
|
|
4095
|
+
parameters:
|
|
4096
|
+
- name: namespace
|
|
4097
|
+
in: path
|
|
4098
|
+
required: true
|
|
4099
|
+
schema:
|
|
4100
|
+
type: string
|
|
4101
|
+
- name: workflowId
|
|
4102
|
+
in: path
|
|
4103
|
+
required: true
|
|
4104
|
+
schema:
|
|
4105
|
+
type: string
|
|
4106
|
+
- name: signalName
|
|
4107
|
+
in: path
|
|
4108
|
+
description: The workflow author-defined name of the signal to send to the workflow
|
|
4109
|
+
required: true
|
|
4110
|
+
schema:
|
|
4111
|
+
type: string
|
|
4112
|
+
requestBody:
|
|
4113
|
+
content:
|
|
4114
|
+
application/json:
|
|
4115
|
+
schema:
|
|
4116
|
+
$ref: '#/components/schemas/SignalWithStartWorkflowExecutionRequest'
|
|
4117
|
+
required: true
|
|
4118
|
+
responses:
|
|
4119
|
+
"200":
|
|
4120
|
+
description: OK
|
|
4121
|
+
content:
|
|
4122
|
+
application/json:
|
|
4123
|
+
schema:
|
|
4124
|
+
$ref: '#/components/schemas/SignalWithStartWorkflowExecutionResponse'
|
|
4125
|
+
default:
|
|
4126
|
+
description: Default error response
|
|
4127
|
+
content:
|
|
4128
|
+
application/json:
|
|
4129
|
+
schema:
|
|
4130
|
+
$ref: '#/components/schemas/Status'
|
|
4131
|
+
/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/cancel:
|
|
4132
|
+
post:
|
|
4133
|
+
tags:
|
|
4134
|
+
- WorkflowService
|
|
4135
|
+
description: |-
|
|
4136
|
+
RequestCancelWorkflowExecution is called by workers when they want to request cancellation of
|
|
4137
|
+
a workflow execution.
|
|
4138
|
+
|
|
4139
|
+
This results in a new `WORKFLOW_EXECUTION_CANCEL_REQUESTED` event being written to the
|
|
4140
|
+
workflow history and a new workflow task created for the workflow. It returns success if the requested
|
|
4141
|
+
workflow is already closed. It fails with 'NotFound' if the requested workflow doesn't exist.
|
|
4142
|
+
operationId: RequestCancelWorkflowExecution
|
|
4143
|
+
parameters:
|
|
4144
|
+
- name: namespace
|
|
4145
|
+
in: path
|
|
4146
|
+
required: true
|
|
4147
|
+
schema:
|
|
4148
|
+
type: string
|
|
4149
|
+
- name: workflow_execution.workflow_id
|
|
4150
|
+
in: path
|
|
4151
|
+
required: true
|
|
4152
|
+
schema:
|
|
4153
|
+
type: string
|
|
4154
|
+
requestBody:
|
|
4155
|
+
content:
|
|
4156
|
+
application/json:
|
|
4157
|
+
schema:
|
|
4158
|
+
$ref: '#/components/schemas/RequestCancelWorkflowExecutionRequest'
|
|
4159
|
+
required: true
|
|
4160
|
+
responses:
|
|
4161
|
+
"200":
|
|
4162
|
+
description: OK
|
|
4163
|
+
content:
|
|
4164
|
+
application/json:
|
|
4165
|
+
schema:
|
|
4166
|
+
$ref: '#/components/schemas/RequestCancelWorkflowExecutionResponse'
|
|
4167
|
+
default:
|
|
4168
|
+
description: Default error response
|
|
4169
|
+
content:
|
|
4170
|
+
application/json:
|
|
4171
|
+
schema:
|
|
4172
|
+
$ref: '#/components/schemas/Status'
|
|
4173
|
+
/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/reset:
|
|
4174
|
+
post:
|
|
4175
|
+
tags:
|
|
4176
|
+
- WorkflowService
|
|
4177
|
+
description: |-
|
|
4178
|
+
ResetWorkflowExecution will reset an existing workflow execution to a specified
|
|
4179
|
+
`WORKFLOW_TASK_COMPLETED` event (exclusive). It will immediately terminate the current
|
|
4180
|
+
execution instance.
|
|
4181
|
+
TODO: Does exclusive here mean *just* the completed event, or also WFT started? Otherwise the task is doomed to time out?
|
|
4182
|
+
operationId: ResetWorkflowExecution
|
|
4183
|
+
parameters:
|
|
4184
|
+
- name: namespace
|
|
4185
|
+
in: path
|
|
4186
|
+
required: true
|
|
4187
|
+
schema:
|
|
4188
|
+
type: string
|
|
4189
|
+
- name: workflow_execution.workflow_id
|
|
4190
|
+
in: path
|
|
4191
|
+
required: true
|
|
4192
|
+
schema:
|
|
4193
|
+
type: string
|
|
4194
|
+
requestBody:
|
|
4195
|
+
content:
|
|
4196
|
+
application/json:
|
|
4197
|
+
schema:
|
|
4198
|
+
$ref: '#/components/schemas/ResetWorkflowExecutionRequest'
|
|
4199
|
+
required: true
|
|
4200
|
+
responses:
|
|
4201
|
+
"200":
|
|
4202
|
+
description: OK
|
|
4203
|
+
content:
|
|
4204
|
+
application/json:
|
|
4205
|
+
schema:
|
|
4206
|
+
$ref: '#/components/schemas/ResetWorkflowExecutionResponse'
|
|
4207
|
+
default:
|
|
4208
|
+
description: Default error response
|
|
4209
|
+
content:
|
|
4210
|
+
application/json:
|
|
4211
|
+
schema:
|
|
4212
|
+
$ref: '#/components/schemas/Status'
|
|
4213
|
+
/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/signal/{signalName}:
|
|
4214
|
+
post:
|
|
4215
|
+
tags:
|
|
4216
|
+
- WorkflowService
|
|
4217
|
+
description: |-
|
|
4218
|
+
SignalWorkflowExecution is used to send a signal to a running workflow execution.
|
|
4219
|
+
|
|
4220
|
+
This results in a `WORKFLOW_EXECUTION_SIGNALED` event recorded in the history and a workflow
|
|
4221
|
+
task being created for the execution.
|
|
4222
|
+
operationId: SignalWorkflowExecution
|
|
4223
|
+
parameters:
|
|
4224
|
+
- name: namespace
|
|
4225
|
+
in: path
|
|
4226
|
+
required: true
|
|
4227
|
+
schema:
|
|
4228
|
+
type: string
|
|
4229
|
+
- name: workflow_execution.workflow_id
|
|
4230
|
+
in: path
|
|
4231
|
+
required: true
|
|
4232
|
+
schema:
|
|
4233
|
+
type: string
|
|
4234
|
+
- name: signalName
|
|
4235
|
+
in: path
|
|
4236
|
+
description: The workflow author-defined name of the signal to send to the workflow
|
|
4237
|
+
required: true
|
|
4238
|
+
schema:
|
|
4239
|
+
type: string
|
|
4240
|
+
requestBody:
|
|
4241
|
+
content:
|
|
4242
|
+
application/json:
|
|
4243
|
+
schema:
|
|
4244
|
+
$ref: '#/components/schemas/SignalWorkflowExecutionRequest'
|
|
4245
|
+
required: true
|
|
4246
|
+
responses:
|
|
4247
|
+
"200":
|
|
4248
|
+
description: OK
|
|
4249
|
+
content:
|
|
4250
|
+
application/json:
|
|
4251
|
+
schema:
|
|
4252
|
+
$ref: '#/components/schemas/SignalWorkflowExecutionResponse'
|
|
4253
|
+
default:
|
|
4254
|
+
description: Default error response
|
|
4255
|
+
content:
|
|
4256
|
+
application/json:
|
|
4257
|
+
schema:
|
|
4258
|
+
$ref: '#/components/schemas/Status'
|
|
4259
|
+
/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/terminate:
|
|
4260
|
+
post:
|
|
4261
|
+
tags:
|
|
4262
|
+
- WorkflowService
|
|
4263
|
+
description: |-
|
|
4264
|
+
TerminateWorkflowExecution terminates an existing workflow execution by recording a
|
|
4265
|
+
`WORKFLOW_EXECUTION_TERMINATED` event in the history and immediately terminating the
|
|
4266
|
+
execution instance.
|
|
4267
|
+
operationId: TerminateWorkflowExecution
|
|
4268
|
+
parameters:
|
|
4269
|
+
- name: namespace
|
|
4270
|
+
in: path
|
|
4271
|
+
required: true
|
|
4272
|
+
schema:
|
|
4273
|
+
type: string
|
|
4274
|
+
- name: workflow_execution.workflow_id
|
|
4275
|
+
in: path
|
|
4276
|
+
required: true
|
|
4277
|
+
schema:
|
|
4278
|
+
type: string
|
|
4279
|
+
requestBody:
|
|
4280
|
+
content:
|
|
4281
|
+
application/json:
|
|
4282
|
+
schema:
|
|
4283
|
+
$ref: '#/components/schemas/TerminateWorkflowExecutionRequest'
|
|
4284
|
+
required: true
|
|
4285
|
+
responses:
|
|
4286
|
+
"200":
|
|
4287
|
+
description: OK
|
|
4288
|
+
content:
|
|
4289
|
+
application/json:
|
|
4290
|
+
schema:
|
|
4291
|
+
$ref: '#/components/schemas/TerminateWorkflowExecutionResponse'
|
|
4292
|
+
default:
|
|
4293
|
+
description: Default error response
|
|
4294
|
+
content:
|
|
4295
|
+
application/json:
|
|
4296
|
+
schema:
|
|
4297
|
+
$ref: '#/components/schemas/Status'
|
|
4298
|
+
/namespaces/{namespace}/workflows/{workflow_execution.workflow_id}/update/{request.input.name}:
|
|
4299
|
+
post:
|
|
4300
|
+
tags:
|
|
4301
|
+
- WorkflowService
|
|
4302
|
+
description: Invokes the specified Update function on user Workflow code.
|
|
4303
|
+
operationId: UpdateWorkflowExecution
|
|
4304
|
+
parameters:
|
|
4305
|
+
- name: namespace
|
|
4306
|
+
in: path
|
|
4307
|
+
description: The namespace name of the target Workflow.
|
|
4308
|
+
required: true
|
|
4309
|
+
schema:
|
|
4310
|
+
type: string
|
|
4311
|
+
- name: workflow_execution.workflow_id
|
|
4312
|
+
in: path
|
|
4313
|
+
required: true
|
|
4314
|
+
schema:
|
|
4315
|
+
type: string
|
|
4316
|
+
- name: request.input.name
|
|
4317
|
+
in: path
|
|
4318
|
+
required: true
|
|
4319
|
+
schema:
|
|
4320
|
+
type: string
|
|
4321
|
+
requestBody:
|
|
4322
|
+
content:
|
|
4323
|
+
application/json:
|
|
4324
|
+
schema:
|
|
4325
|
+
$ref: '#/components/schemas/UpdateWorkflowExecutionRequest'
|
|
4326
|
+
required: true
|
|
4327
|
+
responses:
|
|
4328
|
+
"200":
|
|
4329
|
+
description: OK
|
|
4330
|
+
content:
|
|
4331
|
+
application/json:
|
|
4332
|
+
schema:
|
|
4333
|
+
$ref: '#/components/schemas/UpdateWorkflowExecutionResponse'
|
|
4334
|
+
default:
|
|
4335
|
+
description: Default error response
|
|
4336
|
+
content:
|
|
4337
|
+
application/json:
|
|
4338
|
+
schema:
|
|
4339
|
+
$ref: '#/components/schemas/Status'
|
|
4340
|
+
/system-info:
|
|
4341
|
+
get:
|
|
4342
|
+
tags:
|
|
4343
|
+
- WorkflowService
|
|
4344
|
+
description: GetSystemInfo returns information about the system.
|
|
4345
|
+
operationId: GetSystemInfo
|
|
4346
|
+
responses:
|
|
4347
|
+
"200":
|
|
4348
|
+
description: OK
|
|
4349
|
+
content:
|
|
4350
|
+
application/json:
|
|
4351
|
+
schema:
|
|
4352
|
+
$ref: '#/components/schemas/GetSystemInfoResponse'
|
|
4353
|
+
default:
|
|
4354
|
+
description: Default error response
|
|
4355
|
+
content:
|
|
4356
|
+
application/json:
|
|
4357
|
+
schema:
|
|
4358
|
+
$ref: '#/components/schemas/Status'
|
|
4359
|
+
components:
|
|
4360
|
+
schemas:
|
|
4361
|
+
ActivityFailureInfo:
|
|
4362
|
+
type: object
|
|
4363
|
+
properties:
|
|
4364
|
+
scheduledEventId:
|
|
4365
|
+
type: string
|
|
4366
|
+
startedEventId:
|
|
4367
|
+
type: string
|
|
4368
|
+
identity:
|
|
4369
|
+
type: string
|
|
4370
|
+
activityType:
|
|
4371
|
+
$ref: '#/components/schemas/ActivityType'
|
|
4372
|
+
activityId:
|
|
4373
|
+
type: string
|
|
4374
|
+
retryState:
|
|
4375
|
+
enum:
|
|
4376
|
+
- RETRY_STATE_UNSPECIFIED
|
|
4377
|
+
- RETRY_STATE_IN_PROGRESS
|
|
4378
|
+
- RETRY_STATE_NON_RETRYABLE_FAILURE
|
|
4379
|
+
- RETRY_STATE_TIMEOUT
|
|
4380
|
+
- RETRY_STATE_MAXIMUM_ATTEMPTS_REACHED
|
|
4381
|
+
- RETRY_STATE_RETRY_POLICY_NOT_SET
|
|
4382
|
+
- RETRY_STATE_INTERNAL_SERVER_ERROR
|
|
4383
|
+
- RETRY_STATE_CANCEL_REQUESTED
|
|
4384
|
+
type: string
|
|
4385
|
+
format: enum
|
|
4386
|
+
ActivityOptions:
|
|
4387
|
+
type: object
|
|
4388
|
+
properties:
|
|
4389
|
+
taskQueue:
|
|
4390
|
+
$ref: '#/components/schemas/TaskQueue'
|
|
4391
|
+
scheduleToCloseTimeout:
|
|
4392
|
+
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
|
|
4393
|
+
type: string
|
|
4394
|
+
description: |-
|
|
4395
|
+
Indicates how long the caller is willing to wait for an activity completion. Limits how long
|
|
4396
|
+
retries will be attempted. Either this or `start_to_close_timeout` must be specified.
|
|
4397
|
+
|
|
4398
|
+
(-- api-linter: core::0140::prepositions=disabled
|
|
4399
|
+
aip.dev/not-precedent: "to" is used to indicate interval. --)
|
|
4400
|
+
scheduleToStartTimeout:
|
|
4401
|
+
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
|
|
4402
|
+
type: string
|
|
4403
|
+
description: |-
|
|
4404
|
+
Limits time an activity task can stay in a task queue before a worker picks it up. This
|
|
4405
|
+
timeout is always non retryable, as all a retry would achieve is to put it back into the same
|
|
4406
|
+
queue. Defaults to `schedule_to_close_timeout` or workflow execution timeout if not
|
|
4407
|
+
specified.
|
|
4408
|
+
|
|
4409
|
+
(-- api-linter: core::0140::prepositions=disabled
|
|
4410
|
+
aip.dev/not-precedent: "to" is used to indicate interval. --)
|
|
4411
|
+
startToCloseTimeout:
|
|
4412
|
+
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
|
|
4413
|
+
type: string
|
|
4414
|
+
description: |-
|
|
4415
|
+
Maximum time an activity is allowed to execute after being picked up by a worker. This
|
|
4416
|
+
timeout is always retryable. Either this or `schedule_to_close_timeout` must be
|
|
4417
|
+
specified.
|
|
4418
|
+
|
|
4419
|
+
(-- api-linter: core::0140::prepositions=disabled
|
|
4420
|
+
aip.dev/not-precedent: "to" is used to indicate interval. --)
|
|
4421
|
+
heartbeatTimeout:
|
|
4422
|
+
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
|
|
4423
|
+
type: string
|
|
4424
|
+
description: Maximum permitted time between successful worker heartbeats.
|
|
4425
|
+
retryPolicy:
|
|
4426
|
+
$ref: '#/components/schemas/RetryPolicy'
|
|
2039
4427
|
ActivityPropertiesModifiedExternallyEventAttributes:
|
|
2040
4428
|
type: object
|
|
2041
4429
|
properties:
|
|
@@ -2300,8 +4688,6 @@ components:
|
|
|
2300
4688
|
retry interval calculated by the retry policy. Retry attempts will
|
|
2301
4689
|
still be subject to the maximum retries limit and total time limit
|
|
2302
4690
|
defined by the policy.
|
|
2303
|
-
ATTENTION: this value will be ignored if set for failures produced by
|
|
2304
|
-
the workflow.
|
|
2305
4691
|
BackfillRequest:
|
|
2306
4692
|
type: object
|
|
2307
4693
|
properties:
|
|
@@ -2571,6 +4957,8 @@ components:
|
|
|
2571
4957
|
properties:
|
|
2572
4958
|
nexus:
|
|
2573
4959
|
$ref: '#/components/schemas/Callback_Nexus'
|
|
4960
|
+
internal:
|
|
4961
|
+
$ref: '#/components/schemas/Callback_Internal'
|
|
2574
4962
|
description: Callback to attach to various events in the system, e.g. workflow run completion.
|
|
2575
4963
|
CallbackInfo:
|
|
2576
4964
|
type: object
|
|
@@ -2625,6 +5013,18 @@ components:
|
|
|
2625
5013
|
type: object
|
|
2626
5014
|
properties: {}
|
|
2627
5015
|
description: Trigger for when the workflow is closed.
|
|
5016
|
+
Callback_Internal:
|
|
5017
|
+
type: object
|
|
5018
|
+
properties:
|
|
5019
|
+
data:
|
|
5020
|
+
type: string
|
|
5021
|
+
description: Opaque internal data.
|
|
5022
|
+
format: bytes
|
|
5023
|
+
description: |-
|
|
5024
|
+
Callbacks to be delivered internally within the system.
|
|
5025
|
+
This variant is not settable in the API and will be rejected by the service with an INVALID_ARGUMENT error.
|
|
5026
|
+
The only reason that this is exposed is because callbacks are replicated across clusters via the
|
|
5027
|
+
WorkflowExecutionStarted event, which is defined in the public API.
|
|
2628
5028
|
Callback_Nexus:
|
|
2629
5029
|
type: object
|
|
2630
5030
|
properties:
|
|
@@ -3151,8 +5551,13 @@ components:
|
|
|
3151
5551
|
description: |-
|
|
3152
5552
|
Endpoint name, unique for this cluster. Must match `[a-zA-Z_][a-zA-Z0-9_]*`.
|
|
3153
5553
|
Renaming an endpoint breaks all workflow callers that reference this endpoint, causing operations to fail.
|
|
3154
|
-
|
|
3155
|
-
|
|
5554
|
+
description:
|
|
5555
|
+
allOf:
|
|
5556
|
+
- $ref: '#/components/schemas/Payload'
|
|
5557
|
+
description: |-
|
|
5558
|
+
Markdown description serialized as a single JSON string.
|
|
5559
|
+
If the Payload is encrypted, the UI and CLI may decrypt with the configured codec server endpoint.
|
|
5560
|
+
By default, the server enforces a limit of 20,000 bytes for this entire payload.
|
|
3156
5561
|
target:
|
|
3157
5562
|
allOf:
|
|
3158
5563
|
- $ref: '#/components/schemas/EndpointTarget'
|
|
@@ -3214,8 +5619,14 @@ components:
|
|
|
3214
5619
|
Additional restrictions:
|
|
3215
5620
|
- setting `cron_schedule` is invalid
|
|
3216
5621
|
- setting `request_eager_execution` is invalid
|
|
5622
|
+
- setting `workflow_start_delay` is invalid
|
|
3217
5623
|
updateWorkflow:
|
|
3218
|
-
|
|
5624
|
+
allOf:
|
|
5625
|
+
- $ref: '#/components/schemas/UpdateWorkflowExecutionRequest'
|
|
5626
|
+
description: |-
|
|
5627
|
+
Additional restrictions:
|
|
5628
|
+
- setting `first_execution_run_id` is invalid
|
|
5629
|
+
- setting `workflow_execution.run_id` is invalid
|
|
3219
5630
|
ExecuteMultiOperationResponse:
|
|
3220
5631
|
type: object
|
|
3221
5632
|
properties:
|
|
@@ -3290,7 +5701,21 @@ components:
|
|
|
3290
5701
|
encodedAttributes:
|
|
3291
5702
|
allOf:
|
|
3292
5703
|
- $ref: '#/components/schemas/Payload'
|
|
3293
|
-
description:
|
|
5704
|
+
description: |-
|
|
5705
|
+
Alternative way to supply `message` and `stack_trace` and possibly other attributes, used for encryption of
|
|
5706
|
+
errors originating in user code which might contain sensitive information.
|
|
5707
|
+
The `encoded_attributes` Payload could represent any serializable object, e.g. JSON object or a `Failure` proto
|
|
5708
|
+
message.
|
|
5709
|
+
|
|
5710
|
+
SDK authors:
|
|
5711
|
+
- The SDK should provide a default `encodeFailureAttributes` and `decodeFailureAttributes` implementation that:
|
|
5712
|
+
- Uses a JSON object to represent `{ message, stack_trace }`.
|
|
5713
|
+
- Overwrites the original message with "Encoded failure" to indicate that more information could be extracted.
|
|
5714
|
+
- Overwrites the original stack_trace with an empty string.
|
|
5715
|
+
- The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed
|
|
5716
|
+
by the user-provided PayloadCodec
|
|
5717
|
+
|
|
5718
|
+
- If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes.
|
|
3294
5719
|
cause:
|
|
3295
5720
|
$ref: '#/components/schemas/Failure'
|
|
3296
5721
|
applicationFailureInfo:
|
|
@@ -3395,6 +5820,11 @@ components:
|
|
|
3395
5820
|
countGroupByExecutionStatus:
|
|
3396
5821
|
type: boolean
|
|
3397
5822
|
description: True if the server supports count group by execution status
|
|
5823
|
+
nexus:
|
|
5824
|
+
type: boolean
|
|
5825
|
+
description: |-
|
|
5826
|
+
True if the server supports Nexus operations.
|
|
5827
|
+
This flag is dependent both on server version and for Nexus to be enabled via server configuration.
|
|
3398
5828
|
description: System capability details.
|
|
3399
5829
|
GetWorkerBuildIdCompatibilityResponse:
|
|
3400
5830
|
type: object
|
|
@@ -3549,13 +5979,13 @@ components:
|
|
|
3549
5979
|
- EVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_FAILED
|
|
3550
5980
|
- EVENT_TYPE_EXTERNAL_WORKFLOW_EXECUTION_SIGNALED
|
|
3551
5981
|
- EVENT_TYPE_UPSERT_WORKFLOW_SEARCH_ATTRIBUTES
|
|
5982
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ADMITTED
|
|
3552
5983
|
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ACCEPTED
|
|
3553
5984
|
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_REJECTED
|
|
3554
5985
|
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_COMPLETED
|
|
3555
5986
|
- EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED_EXTERNALLY
|
|
3556
5987
|
- EVENT_TYPE_ACTIVITY_PROPERTIES_MODIFIED_EXTERNALLY
|
|
3557
5988
|
- EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED
|
|
3558
|
-
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ADMITTED
|
|
3559
5989
|
- EVENT_TYPE_NEXUS_OPERATION_SCHEDULED
|
|
3560
5990
|
- EVENT_TYPE_NEXUS_OPERATION_STARTED
|
|
3561
5991
|
- EVENT_TYPE_NEXUS_OPERATION_COMPLETED
|
|
@@ -3590,6 +6020,11 @@ components:
|
|
|
3590
6020
|
* workflow_execution_started_event_attributes - summary and details from start workflow.
|
|
3591
6021
|
* timer_started_event_attributes - summary represents an identifier for the timer for use by
|
|
3592
6022
|
user interfaces.
|
|
6023
|
+
links:
|
|
6024
|
+
type: array
|
|
6025
|
+
items:
|
|
6026
|
+
$ref: '#/components/schemas/Link'
|
|
6027
|
+
description: Links associated with the event.
|
|
3593
6028
|
workflowExecutionStartedEventAttributes:
|
|
3594
6029
|
$ref: '#/components/schemas/WorkflowExecutionStartedEventAttributes'
|
|
3595
6030
|
workflowExecutionCompletedEventAttributes:
|
|
@@ -3708,15 +6143,15 @@ components:
|
|
|
3708
6143
|
allOf:
|
|
3709
6144
|
- $ref: '#/components/schemas/Header'
|
|
3710
6145
|
description: |-
|
|
3711
|
-
Headers that are passed with the
|
|
6146
|
+
Headers that are passed with the Update from the requesting entity.
|
|
3712
6147
|
These can include things like auth or tracing tokens.
|
|
3713
6148
|
name:
|
|
3714
6149
|
type: string
|
|
3715
|
-
description: The name of the
|
|
6150
|
+
description: The name of the Update handler to invoke on the target Workflow.
|
|
3716
6151
|
args:
|
|
3717
6152
|
allOf:
|
|
3718
6153
|
- $ref: '#/components/schemas/Payloads'
|
|
3719
|
-
description: The arguments to pass to the named handler.
|
|
6154
|
+
description: The arguments to pass to the named Update handler.
|
|
3720
6155
|
IntervalSpec:
|
|
3721
6156
|
type: object
|
|
3722
6157
|
properties:
|
|
@@ -3738,6 +6173,38 @@ components:
|
|
|
3738
6173
|
xx:19:00. An interval of 28 days with phase zero would match
|
|
3739
6174
|
2022-02-17T00:00:00Z (among other times). The same interval with a phase of 3
|
|
3740
6175
|
days, 5 hours, and 23 minutes would match 2022-02-20T05:23:00Z instead.
|
|
6176
|
+
Link:
|
|
6177
|
+
type: object
|
|
6178
|
+
properties:
|
|
6179
|
+
workflowEvent:
|
|
6180
|
+
$ref: '#/components/schemas/Link_WorkflowEvent'
|
|
6181
|
+
batchJob:
|
|
6182
|
+
$ref: '#/components/schemas/Link_BatchJob'
|
|
6183
|
+
description: |-
|
|
6184
|
+
Link can be associated with history events. It might contain information about an external entity
|
|
6185
|
+
related to the history event. For example, workflow A makes a Nexus call that starts workflow B:
|
|
6186
|
+
in this case, a history event in workflow A could contain a Link to the workflow started event in
|
|
6187
|
+
workflow B, and vice-versa.
|
|
6188
|
+
Link_BatchJob:
|
|
6189
|
+
type: object
|
|
6190
|
+
properties:
|
|
6191
|
+
jobId:
|
|
6192
|
+
type: string
|
|
6193
|
+
description: |-
|
|
6194
|
+
A link to a built-in batch job.
|
|
6195
|
+
Batch jobs can be used to perform operations on a set of workflows (e.g. terminate, signal, cancel, etc).
|
|
6196
|
+
This link can be put on workflow history events generated by actions taken by a batch job.
|
|
6197
|
+
Link_WorkflowEvent:
|
|
6198
|
+
type: object
|
|
6199
|
+
properties:
|
|
6200
|
+
namespace:
|
|
6201
|
+
type: string
|
|
6202
|
+
workflowId:
|
|
6203
|
+
type: string
|
|
6204
|
+
runId:
|
|
6205
|
+
type: string
|
|
6206
|
+
eventRef:
|
|
6207
|
+
$ref: '#/components/schemas/WorkflowEvent_EventReference'
|
|
3741
6208
|
ListArchivedWorkflowExecutionsResponse:
|
|
3742
6209
|
type: object
|
|
3743
6210
|
properties:
|
|
@@ -3903,11 +6370,11 @@ components:
|
|
|
3903
6370
|
properties:
|
|
3904
6371
|
updateId:
|
|
3905
6372
|
type: string
|
|
3906
|
-
description: An ID with workflow-scoped uniqueness for this
|
|
6373
|
+
description: An ID with workflow-scoped uniqueness for this Update.
|
|
3907
6374
|
identity:
|
|
3908
6375
|
type: string
|
|
3909
|
-
description: A string identifying the agent that requested this
|
|
3910
|
-
description: Metadata about a
|
|
6376
|
+
description: A string identifying the agent that requested this Update.
|
|
6377
|
+
description: Metadata about a Workflow Update.
|
|
3911
6378
|
MeteringMetadata:
|
|
3912
6379
|
type: object
|
|
3913
6380
|
properties:
|
|
@@ -4096,6 +6563,9 @@ components:
|
|
|
4096
6563
|
allOf:
|
|
4097
6564
|
- $ref: '#/components/schemas/Failure'
|
|
4098
6565
|
description: Cancellation details.
|
|
6566
|
+
requestId:
|
|
6567
|
+
type: string
|
|
6568
|
+
description: The request ID allocated at schedule time.
|
|
4099
6569
|
description: Nexus operation completed as canceled. May or may not have been due to a cancellation request by the workflow.
|
|
4100
6570
|
NexusOperationCancellationInfo:
|
|
4101
6571
|
type: object
|
|
@@ -4145,6 +6615,9 @@ components:
|
|
|
4145
6615
|
description: |-
|
|
4146
6616
|
Serialized result of the Nexus operation. The response of the Nexus handler.
|
|
4147
6617
|
Delivered either via a completion callback or as a response to a synchronous operation.
|
|
6618
|
+
requestId:
|
|
6619
|
+
type: string
|
|
6620
|
+
description: The request ID allocated at schedule time.
|
|
4148
6621
|
description: Nexus operation completed successfully.
|
|
4149
6622
|
NexusOperationFailedEventAttributes:
|
|
4150
6623
|
type: object
|
|
@@ -4156,6 +6629,9 @@ components:
|
|
|
4156
6629
|
allOf:
|
|
4157
6630
|
- $ref: '#/components/schemas/Failure'
|
|
4158
6631
|
description: Failure details. A NexusOperationFailureInfo wrapping an ApplicationFailureInfo.
|
|
6632
|
+
requestId:
|
|
6633
|
+
type: string
|
|
6634
|
+
description: The request ID allocated at schedule time.
|
|
4159
6635
|
description: Nexus operation failed.
|
|
4160
6636
|
NexusOperationFailureInfo:
|
|
4161
6637
|
type: object
|
|
@@ -4219,6 +6695,12 @@ components:
|
|
|
4219
6695
|
description: |-
|
|
4220
6696
|
A unique ID generated by the history service upon creation of this event.
|
|
4221
6697
|
The ID will be transmitted with all nexus StartOperation requests and is used as an idempotentency key.
|
|
6698
|
+
endpointId:
|
|
6699
|
+
type: string
|
|
6700
|
+
description: |-
|
|
6701
|
+
Endpoint ID as resolved in the endpoint registry at the time this event was generated.
|
|
6702
|
+
This is stored on the event and used internally by the server in case the endpoint is renamed from the time the
|
|
6703
|
+
event was originally scheduled.
|
|
4222
6704
|
description: Event marking that an operation was scheduled by a workflow via the ScheduleNexusOperation command.
|
|
4223
6705
|
NexusOperationStartedEventAttributes:
|
|
4224
6706
|
type: object
|
|
@@ -4231,6 +6713,9 @@ components:
|
|
|
4231
6713
|
description: |-
|
|
4232
6714
|
The operation ID returned by the Nexus handler in the response to the StartOperation request.
|
|
4233
6715
|
This ID is used when canceling the operation.
|
|
6716
|
+
requestId:
|
|
6717
|
+
type: string
|
|
6718
|
+
description: The request ID allocated at schedule time.
|
|
4234
6719
|
description: |-
|
|
4235
6720
|
Event marking an asynchronous operation was started by the responding Nexus handler.
|
|
4236
6721
|
If the operation completes synchronously, this event is not generated.
|
|
@@ -4246,6 +6731,9 @@ components:
|
|
|
4246
6731
|
allOf:
|
|
4247
6732
|
- $ref: '#/components/schemas/Failure'
|
|
4248
6733
|
description: Failure details. A NexusOperationFailureInfo wrapping a CanceledFailureInfo.
|
|
6734
|
+
requestId:
|
|
6735
|
+
type: string
|
|
6736
|
+
description: The request ID allocated at schedule time.
|
|
4249
6737
|
description: Nexus operation timed out.
|
|
4250
6738
|
Outcome:
|
|
4251
6739
|
type: object
|
|
@@ -4254,7 +6742,7 @@ components:
|
|
|
4254
6742
|
$ref: '#/components/schemas/Payloads'
|
|
4255
6743
|
failure:
|
|
4256
6744
|
$ref: '#/components/schemas/Failure'
|
|
4257
|
-
description: The outcome of a
|
|
6745
|
+
description: 'The outcome of a Workflow Update: success or failure.'
|
|
4258
6746
|
PatchScheduleRequest:
|
|
4259
6747
|
type: object
|
|
4260
6748
|
properties:
|
|
@@ -4275,6 +6763,32 @@ components:
|
|
|
4275
6763
|
PatchScheduleResponse:
|
|
4276
6764
|
type: object
|
|
4277
6765
|
properties: {}
|
|
6766
|
+
PauseActivityByIdRequest:
|
|
6767
|
+
type: object
|
|
6768
|
+
properties:
|
|
6769
|
+
namespace:
|
|
6770
|
+
type: string
|
|
6771
|
+
description: Namespace of the workflow which scheduled this activity.
|
|
6772
|
+
workflowId:
|
|
6773
|
+
type: string
|
|
6774
|
+
description: ID of the workflow which scheduled this activity.
|
|
6775
|
+
runId:
|
|
6776
|
+
type: string
|
|
6777
|
+
description: |-
|
|
6778
|
+
Run ID of the workflow which scheduled this activity.
|
|
6779
|
+
If empty - latest workflow is used.
|
|
6780
|
+
activityId:
|
|
6781
|
+
type: string
|
|
6782
|
+
description: ID of the activity we're updating.
|
|
6783
|
+
identity:
|
|
6784
|
+
type: string
|
|
6785
|
+
description: The identity of the client who initiated this request.
|
|
6786
|
+
requestId:
|
|
6787
|
+
type: string
|
|
6788
|
+
description: Used to de-dupe requests.
|
|
6789
|
+
PauseActivityByIdResponse:
|
|
6790
|
+
type: object
|
|
6791
|
+
properties: {}
|
|
4278
6792
|
Payload:
|
|
4279
6793
|
description: |-
|
|
4280
6794
|
Represents some binary (byte array) data (ex: activity input parameters or workflow result) with
|
|
@@ -4338,6 +6852,27 @@ components:
|
|
|
4338
6852
|
allOf:
|
|
4339
6853
|
- $ref: '#/components/schemas/WorkerVersionStamp'
|
|
4340
6854
|
description: The version stamp of the worker to whom this activity was most recently dispatched
|
|
6855
|
+
currentRetryInterval:
|
|
6856
|
+
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
|
|
6857
|
+
type: string
|
|
6858
|
+
description: |-
|
|
6859
|
+
The time activity will wait until the next retry.
|
|
6860
|
+
If activity is currently running it will be next retry interval if activity failed.
|
|
6861
|
+
If activity is currently waiting it will be current retry interval.
|
|
6862
|
+
If there will be no retry it will be null.
|
|
6863
|
+
lastAttemptCompleteTime:
|
|
6864
|
+
type: string
|
|
6865
|
+
description: The time when the last activity attempt was completed. If activity has not been completed yet then it will be null.
|
|
6866
|
+
format: date-time
|
|
6867
|
+
nextAttemptScheduleTime:
|
|
6868
|
+
type: string
|
|
6869
|
+
description: |-
|
|
6870
|
+
Next time when activity will be scheduled.
|
|
6871
|
+
If activity is currently scheduled or started it will be null.
|
|
6872
|
+
format: date-time
|
|
6873
|
+
paused:
|
|
6874
|
+
type: boolean
|
|
6875
|
+
description: Indicates if activity is paused.
|
|
4341
6876
|
PendingChildExecutionInfo:
|
|
4342
6877
|
type: object
|
|
4343
6878
|
properties:
|
|
@@ -4415,6 +6950,11 @@ components:
|
|
|
4415
6950
|
format: date-time
|
|
4416
6951
|
cancellationInfo:
|
|
4417
6952
|
$ref: '#/components/schemas/NexusOperationCancellationInfo'
|
|
6953
|
+
scheduledEventId:
|
|
6954
|
+
type: string
|
|
6955
|
+
description: |-
|
|
6956
|
+
The event ID of the NexusOperationScheduled event. Can be used to correlate an operation in the
|
|
6957
|
+
DescribeWorkflowExecution response with workflow history.
|
|
4418
6958
|
description: PendingNexusOperationInfo contains the state of a pending Nexus operation.
|
|
4419
6959
|
PendingWorkflowTaskInfo:
|
|
4420
6960
|
type: object
|
|
@@ -4660,6 +7200,9 @@ components:
|
|
|
4660
7200
|
description: |-
|
|
4661
7201
|
Will be set to true if the activity has been asked to cancel itself. The SDK should then
|
|
4662
7202
|
notify the activity of cancellation if it is still running.
|
|
7203
|
+
activityPaused:
|
|
7204
|
+
type: boolean
|
|
7205
|
+
description: Will be set to true if the activity is paused.
|
|
4663
7206
|
RegisterNamespaceRequest:
|
|
4664
7207
|
type: object
|
|
4665
7208
|
properties:
|
|
@@ -4728,7 +7271,7 @@ components:
|
|
|
4728
7271
|
$ref: '#/components/schemas/Meta'
|
|
4729
7272
|
input:
|
|
4730
7273
|
$ref: '#/components/schemas/Input'
|
|
4731
|
-
description: The client request that triggers a
|
|
7274
|
+
description: The client request that triggers a Workflow Update.
|
|
4732
7275
|
RequestCancelExternalWorkflowExecutionFailedEventAttributes:
|
|
4733
7276
|
type: object
|
|
4734
7277
|
properties:
|
|
@@ -4807,9 +7350,50 @@ components:
|
|
|
4807
7350
|
reason:
|
|
4808
7351
|
type: string
|
|
4809
7352
|
description: Reason for requesting the cancellation
|
|
7353
|
+
links:
|
|
7354
|
+
type: array
|
|
7355
|
+
items:
|
|
7356
|
+
$ref: '#/components/schemas/Link'
|
|
7357
|
+
description: Links to be associated with the WorkflowExecutionCanceled event.
|
|
4810
7358
|
RequestCancelWorkflowExecutionResponse:
|
|
4811
7359
|
type: object
|
|
4812
7360
|
properties: {}
|
|
7361
|
+
ResetActivityByIdRequest:
|
|
7362
|
+
type: object
|
|
7363
|
+
properties:
|
|
7364
|
+
namespace:
|
|
7365
|
+
type: string
|
|
7366
|
+
description: Namespace of the workflow which scheduled this activity.
|
|
7367
|
+
workflowId:
|
|
7368
|
+
type: string
|
|
7369
|
+
description: ID of the workflow which scheduled this activity.
|
|
7370
|
+
runId:
|
|
7371
|
+
type: string
|
|
7372
|
+
description: |-
|
|
7373
|
+
Run ID of the workflow which scheduled this activity.
|
|
7374
|
+
If empty - latest workflow is used.
|
|
7375
|
+
activityId:
|
|
7376
|
+
type: string
|
|
7377
|
+
description: ID of the activity we're updating.
|
|
7378
|
+
identity:
|
|
7379
|
+
type: string
|
|
7380
|
+
description: The identity of the client who initiated this request.
|
|
7381
|
+
requestId:
|
|
7382
|
+
type: string
|
|
7383
|
+
description: Used to de-dupe requests.
|
|
7384
|
+
noWait:
|
|
7385
|
+
type: boolean
|
|
7386
|
+
description: |-
|
|
7387
|
+
Indicates that activity should be scheduled immediately.
|
|
7388
|
+
If this flag doesn't set, and activity currently running - temporal will wait until activity is completed.
|
|
7389
|
+
resetHeartbeat:
|
|
7390
|
+
type: boolean
|
|
7391
|
+
description: |-
|
|
7392
|
+
Indicates that activity should reset heartbeat details.
|
|
7393
|
+
This flag will be applied only to the new instance of the activity.
|
|
7394
|
+
ResetActivityByIdResponse:
|
|
7395
|
+
type: object
|
|
7396
|
+
properties: {}
|
|
4813
7397
|
ResetOptions:
|
|
4814
7398
|
type: object
|
|
4815
7399
|
properties:
|
|
@@ -4850,6 +7434,7 @@ components:
|
|
|
4850
7434
|
- RESET_REAPPLY_EXCLUDE_TYPE_UNSPECIFIED
|
|
4851
7435
|
- RESET_REAPPLY_EXCLUDE_TYPE_SIGNAL
|
|
4852
7436
|
- RESET_REAPPLY_EXCLUDE_TYPE_UPDATE
|
|
7437
|
+
- RESET_REAPPLY_EXCLUDE_TYPE_NEXUS
|
|
4853
7438
|
type: string
|
|
4854
7439
|
format: enum
|
|
4855
7440
|
description: Event types not to be reapplied
|
|
@@ -4930,6 +7515,7 @@ components:
|
|
|
4930
7515
|
- RESET_REAPPLY_EXCLUDE_TYPE_UNSPECIFIED
|
|
4931
7516
|
- RESET_REAPPLY_EXCLUDE_TYPE_SIGNAL
|
|
4932
7517
|
- RESET_REAPPLY_EXCLUDE_TYPE_UPDATE
|
|
7518
|
+
- RESET_REAPPLY_EXCLUDE_TYPE_NEXUS
|
|
4933
7519
|
type: string
|
|
4934
7520
|
format: enum
|
|
4935
7521
|
description: Event types not to be reapplied
|
|
@@ -5190,6 +7776,21 @@ components:
|
|
|
5190
7776
|
allOf:
|
|
5191
7777
|
- $ref: '#/components/schemas/WorkflowExecution'
|
|
5192
7778
|
description: 'If action was start_workflow:'
|
|
7779
|
+
startWorkflowStatus:
|
|
7780
|
+
enum:
|
|
7781
|
+
- WORKFLOW_EXECUTION_STATUS_UNSPECIFIED
|
|
7782
|
+
- WORKFLOW_EXECUTION_STATUS_RUNNING
|
|
7783
|
+
- WORKFLOW_EXECUTION_STATUS_COMPLETED
|
|
7784
|
+
- WORKFLOW_EXECUTION_STATUS_FAILED
|
|
7785
|
+
- WORKFLOW_EXECUTION_STATUS_CANCELED
|
|
7786
|
+
- WORKFLOW_EXECUTION_STATUS_TERMINATED
|
|
7787
|
+
- WORKFLOW_EXECUTION_STATUS_CONTINUED_AS_NEW
|
|
7788
|
+
- WORKFLOW_EXECUTION_STATUS_TIMED_OUT
|
|
7789
|
+
type: string
|
|
7790
|
+
description: |-
|
|
7791
|
+
If the action was start_workflow, this field will reflect an
|
|
7792
|
+
eventually-consistent view of the started workflow's status.
|
|
7793
|
+
format: enum
|
|
5193
7794
|
ScheduleInfo:
|
|
5194
7795
|
type: object
|
|
5195
7796
|
properties:
|
|
@@ -5668,6 +8269,11 @@ components:
|
|
|
5668
8269
|
Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo
|
|
5669
8270
|
for use by user interfaces to display the fixed as-of-start summary and details of the
|
|
5670
8271
|
workflow.
|
|
8272
|
+
links:
|
|
8273
|
+
type: array
|
|
8274
|
+
items:
|
|
8275
|
+
$ref: '#/components/schemas/Link'
|
|
8276
|
+
description: Links to be associated with the WorkflowExecutionStarted and WorkflowExecutionSignaled events.
|
|
5671
8277
|
SignalWithStartWorkflowExecutionResponse:
|
|
5672
8278
|
type: object
|
|
5673
8279
|
properties:
|
|
@@ -5709,6 +8315,11 @@ components:
|
|
|
5709
8315
|
skipGenerateWorkflowTask:
|
|
5710
8316
|
type: boolean
|
|
5711
8317
|
description: Indicates that a new workflow task should not be generated when this signal is received.
|
|
8318
|
+
links:
|
|
8319
|
+
type: array
|
|
8320
|
+
items:
|
|
8321
|
+
$ref: '#/components/schemas/Link'
|
|
8322
|
+
description: Links to be associated with the WorkflowExecutionSignaled event.
|
|
5712
8323
|
SignalWorkflowExecutionResponse:
|
|
5713
8324
|
type: object
|
|
5714
8325
|
properties: {}
|
|
@@ -5972,6 +8583,11 @@ components:
|
|
|
5972
8583
|
Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo
|
|
5973
8584
|
for use by user interfaces to display the fixed as-of-start summary and details of the
|
|
5974
8585
|
workflow.
|
|
8586
|
+
links:
|
|
8587
|
+
type: array
|
|
8588
|
+
items:
|
|
8589
|
+
$ref: '#/components/schemas/Link'
|
|
8590
|
+
description: Links to be associated with the workflow.
|
|
5975
8591
|
StartWorkflowExecutionResponse:
|
|
5976
8592
|
type: object
|
|
5977
8593
|
properties:
|
|
@@ -6129,28 +8745,63 @@ components:
|
|
|
6129
8745
|
approximateBacklogCount:
|
|
6130
8746
|
type: string
|
|
6131
8747
|
description: |-
|
|
6132
|
-
The approximate number of tasks backlogged in this task queue. May count expired tasks but eventually
|
|
6133
|
-
to the right value.
|
|
8748
|
+
The approximate number of tasks backlogged in this task queue. May count expired tasks but eventually
|
|
8749
|
+
converges to the right value. Can be relied upon for scaling decisions.
|
|
8750
|
+
|
|
8751
|
+
Special note for workflow task queue type: this metric does not count sticky queue tasks. However, because
|
|
8752
|
+
those tasks only remain valid for a few seconds, the inaccuracy becomes less significant as the backlog size
|
|
8753
|
+
grows.
|
|
6134
8754
|
approximateBacklogAge:
|
|
6135
8755
|
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
|
|
6136
8756
|
type: string
|
|
6137
|
-
description:
|
|
8757
|
+
description: |-
|
|
8758
|
+
Approximate age of the oldest task in the backlog based on the creation time of the task at the head of
|
|
8759
|
+
the queue. Can be relied upon for scaling decisions.
|
|
8760
|
+
|
|
8761
|
+
Special note for workflow task queue type: this metric does not count sticky queue tasks. However, because
|
|
8762
|
+
those tasks only remain valid for a few seconds, they should not affect the result when backlog is older than
|
|
8763
|
+
few seconds.
|
|
6138
8764
|
tasksAddRate:
|
|
6139
8765
|
type: number
|
|
6140
8766
|
description: |-
|
|
6141
|
-
|
|
6142
|
-
|
|
8767
|
+
The approximate tasks per second added to the task queue, averaging the last 30 seconds. These includes tasks
|
|
8768
|
+
whether or not they were added to/dispatched from the backlog or they were dispatched immediately without going
|
|
8769
|
+
to the backlog (sync-matched).
|
|
8770
|
+
|
|
8771
|
+
The difference between `tasks_add_rate` and `tasks_dispatch_rate` is a reliable metric for the rate at which
|
|
8772
|
+
backlog grows/shrinks.
|
|
8773
|
+
|
|
8774
|
+
Note: the actual tasks delivered to the workers may significantly be higher than the numbers reported by
|
|
8775
|
+
tasks_add_rate, because:
|
|
8776
|
+
- Tasks can be sent to workers without going to the task queue. This is called Eager dispatch. Eager dispatch is
|
|
8777
|
+
enable for activities by default in the latest SDKs.
|
|
8778
|
+
- Tasks going to Sticky queue are not accounted for. Note that, typically, only the first workflow task of each
|
|
8779
|
+
workflow goes to a normal queue, and the rest workflow tasks go to the Sticky queue associated with a specific
|
|
8780
|
+
worker instance.
|
|
6143
8781
|
format: float
|
|
6144
8782
|
tasksDispatchRate:
|
|
6145
8783
|
type: number
|
|
6146
8784
|
description: |-
|
|
6147
|
-
|
|
6148
|
-
|
|
8785
|
+
The approximate tasks per second dispatched from the task queue, averaging the last 30 seconds. These includes
|
|
8786
|
+
tasks whether or not they were added to/dispatched from the backlog or they were dispatched immediately without
|
|
8787
|
+
going to the backlog (sync-matched).
|
|
8788
|
+
|
|
8789
|
+
The difference between `tasks_add_rate` and `tasks_dispatch_rate` is a reliable metric for the rate at which
|
|
8790
|
+
backlog grows/shrinks.
|
|
8791
|
+
|
|
8792
|
+
Note: the actual tasks delivered to the workers may significantly be higher than the numbers reported by
|
|
8793
|
+
tasks_dispatch_rate, because:
|
|
8794
|
+
- Tasks can be sent to workers without going to the task queue. This is called Eager dispatch. Eager dispatch is
|
|
8795
|
+
enable for activities by default in the latest SDKs.
|
|
8796
|
+
- Tasks going to Sticky queue are not accounted for. Note that, typically, only the first workflow task of each
|
|
8797
|
+
workflow goes to a normal queue, and the rest workflow tasks go to the Sticky queue associated with a specific
|
|
8798
|
+
worker instance.
|
|
6149
8799
|
format: float
|
|
6150
8800
|
description: |-
|
|
6151
|
-
|
|
6152
|
-
|
|
6153
|
-
|
|
8801
|
+
TaskQueueStats contains statistics about task queue backlog and activity.
|
|
8802
|
+
|
|
8803
|
+
For workflow task queue type, this result is partial because tasks sent to sticky queues are not included. Read
|
|
8804
|
+
comments above each metric to understand the impact of sticky queue exclusion on that metric accuracy.
|
|
6154
8805
|
TaskQueueStatus:
|
|
6155
8806
|
type: object
|
|
6156
8807
|
properties:
|
|
@@ -6224,6 +8875,11 @@ components:
|
|
|
6224
8875
|
If set, this call will error if the most recent (if no run id is set on
|
|
6225
8876
|
`workflow_execution`), or specified (if it is) workflow execution is not part of the same
|
|
6226
8877
|
execution chain as this id.
|
|
8878
|
+
links:
|
|
8879
|
+
type: array
|
|
8880
|
+
items:
|
|
8881
|
+
$ref: '#/components/schemas/Link'
|
|
8882
|
+
description: Links to be associated with the WorkflowExecutionTerminated event.
|
|
6227
8883
|
TerminateWorkflowExecutionResponse:
|
|
6228
8884
|
type: object
|
|
6229
8885
|
properties: {}
|
|
@@ -6316,6 +8972,91 @@ components:
|
|
|
6316
8972
|
type: string
|
|
6317
8973
|
description: If set, override overlap policy for this one request.
|
|
6318
8974
|
format: enum
|
|
8975
|
+
UnpauseActivityByIdRequest:
|
|
8976
|
+
type: object
|
|
8977
|
+
properties:
|
|
8978
|
+
namespace:
|
|
8979
|
+
type: string
|
|
8980
|
+
description: Namespace of the workflow which scheduled this activity.
|
|
8981
|
+
workflowId:
|
|
8982
|
+
type: string
|
|
8983
|
+
description: ID of the workflow which scheduled this activity.
|
|
8984
|
+
runId:
|
|
8985
|
+
type: string
|
|
8986
|
+
description: |-
|
|
8987
|
+
Run ID of the workflow which scheduled this activity.
|
|
8988
|
+
If empty - latest workflow is used.
|
|
8989
|
+
activityId:
|
|
8990
|
+
type: string
|
|
8991
|
+
description: ID of the activity we're updating.
|
|
8992
|
+
identity:
|
|
8993
|
+
type: string
|
|
8994
|
+
description: The identity of the client who initiated this request.
|
|
8995
|
+
requestId:
|
|
8996
|
+
type: string
|
|
8997
|
+
description: Used to de-dupe requests.
|
|
8998
|
+
resume:
|
|
8999
|
+
$ref: '#/components/schemas/UnpauseActivityByIdRequest_ResumeOperation'
|
|
9000
|
+
reset:
|
|
9001
|
+
$ref: '#/components/schemas/UnpauseActivityByIdRequest_ResetOperation'
|
|
9002
|
+
UnpauseActivityByIdRequest_ResetOperation:
|
|
9003
|
+
type: object
|
|
9004
|
+
properties:
|
|
9005
|
+
noWait:
|
|
9006
|
+
type: boolean
|
|
9007
|
+
description: |-
|
|
9008
|
+
Indicates that the activity should be scheduled immediately.
|
|
9009
|
+
Note that this may run simultaneously with any existing executions of the activity.
|
|
9010
|
+
resetHeartbeat:
|
|
9011
|
+
type: boolean
|
|
9012
|
+
description: If set, the Heartbeat Details will be cleared out to make the Activity start over from the beginning
|
|
9013
|
+
UnpauseActivityByIdRequest_ResumeOperation:
|
|
9014
|
+
type: object
|
|
9015
|
+
properties:
|
|
9016
|
+
noWait:
|
|
9017
|
+
type: boolean
|
|
9018
|
+
description: Indicates that if the activity is waiting to retry, it will be scheduled immediately.
|
|
9019
|
+
UnpauseActivityByIdResponse:
|
|
9020
|
+
type: object
|
|
9021
|
+
properties: {}
|
|
9022
|
+
UpdateActivityOptionsByIdRequest:
|
|
9023
|
+
type: object
|
|
9024
|
+
properties:
|
|
9025
|
+
namespace:
|
|
9026
|
+
type: string
|
|
9027
|
+
description: Namespace of the workflow which scheduled this activity
|
|
9028
|
+
workflowId:
|
|
9029
|
+
type: string
|
|
9030
|
+
description: ID of the workflow which scheduled this activity
|
|
9031
|
+
runId:
|
|
9032
|
+
type: string
|
|
9033
|
+
description: |-
|
|
9034
|
+
Run ID of the workflow which scheduled this activity
|
|
9035
|
+
if empty - latest workflow is used
|
|
9036
|
+
activityId:
|
|
9037
|
+
type: string
|
|
9038
|
+
description: ID of the activity we're updating
|
|
9039
|
+
identity:
|
|
9040
|
+
type: string
|
|
9041
|
+
description: The identity of the client who initiated this request
|
|
9042
|
+
activityOptions:
|
|
9043
|
+
allOf:
|
|
9044
|
+
- $ref: '#/components/schemas/ActivityOptions'
|
|
9045
|
+
description: Activity options. Partial updates are accepted and controlled by update_mask
|
|
9046
|
+
updateMask:
|
|
9047
|
+
type: string
|
|
9048
|
+
description: Controls which fields from `activity_options` will be applied
|
|
9049
|
+
format: field-mask
|
|
9050
|
+
requestId:
|
|
9051
|
+
type: string
|
|
9052
|
+
description: Used to de-dupe requests
|
|
9053
|
+
UpdateActivityOptionsByIdResponse:
|
|
9054
|
+
type: object
|
|
9055
|
+
properties:
|
|
9056
|
+
activityOptions:
|
|
9057
|
+
allOf:
|
|
9058
|
+
- $ref: '#/components/schemas/ActivityOptions'
|
|
9059
|
+
description: Activity options after an update
|
|
6319
9060
|
UpdateNamespaceInfo:
|
|
6320
9061
|
type: object
|
|
6321
9062
|
properties:
|
|
@@ -6398,9 +9139,7 @@ components:
|
|
|
6398
9139
|
$ref: '#/components/schemas/WorkflowExecution'
|
|
6399
9140
|
updateId:
|
|
6400
9141
|
type: string
|
|
6401
|
-
description:
|
|
6402
|
-
The data needed by a client to refer to a previously invoked workflow
|
|
6403
|
-
execution update process.
|
|
9142
|
+
description: The data needed by a client to refer to a previously invoked Workflow Update.
|
|
6404
9143
|
UpdateScheduleRequest:
|
|
6405
9144
|
type: object
|
|
6406
9145
|
properties:
|
|
@@ -6447,32 +9186,35 @@ components:
|
|
|
6447
9186
|
properties:
|
|
6448
9187
|
namespace:
|
|
6449
9188
|
type: string
|
|
6450
|
-
description: The namespace name of the target
|
|
9189
|
+
description: The namespace name of the target Workflow.
|
|
6451
9190
|
workflowExecution:
|
|
6452
9191
|
allOf:
|
|
6453
9192
|
- $ref: '#/components/schemas/WorkflowExecution'
|
|
6454
9193
|
description: |-
|
|
6455
|
-
The target
|
|
9194
|
+
The target Workflow Id and (optionally) a specific Run Id thereof.
|
|
6456
9195
|
(-- api-linter: core::0203::optional=disabled
|
|
6457
9196
|
aip.dev/not-precedent: false positive triggered by the word "optional" --)
|
|
6458
9197
|
firstExecutionRunId:
|
|
6459
9198
|
type: string
|
|
6460
9199
|
description: |-
|
|
6461
|
-
If set, this call will error if the most recent (if no
|
|
6462
|
-
`workflow_execution`), or specified (if it is)
|
|
6463
|
-
part of the same execution chain as this
|
|
9200
|
+
If set, this call will error if the most recent (if no Run Id is set on
|
|
9201
|
+
`workflow_execution`), or specified (if it is) Workflow Execution is not
|
|
9202
|
+
part of the same execution chain as this Id.
|
|
6464
9203
|
waitPolicy:
|
|
6465
9204
|
allOf:
|
|
6466
9205
|
- $ref: '#/components/schemas/WaitPolicy'
|
|
6467
9206
|
description: |-
|
|
6468
|
-
|
|
6469
|
-
|
|
9207
|
+
Specifies client's intent to wait for Update results.
|
|
9208
|
+
NOTE: This field works together with API call timeout which is limited by
|
|
9209
|
+
server timeout (maximum wait time). If server timeout is expired before
|
|
9210
|
+
user specified timeout, API call returns even if specified stage is not reached.
|
|
9211
|
+
Actual reached stage will be included in the response.
|
|
6470
9212
|
request:
|
|
6471
9213
|
allOf:
|
|
6472
9214
|
- $ref: '#/components/schemas/Request'
|
|
6473
9215
|
description: |-
|
|
6474
9216
|
The request information that will be delivered all the way down to the
|
|
6475
|
-
|
|
9217
|
+
Workflow Execution.
|
|
6476
9218
|
description: |-
|
|
6477
9219
|
(-- api-linter: core::0134=disabled
|
|
6478
9220
|
aip.dev/not-precedent: Update RPCs don't follow Google API format. --)
|
|
@@ -6487,8 +9229,8 @@ components:
|
|
|
6487
9229
|
allOf:
|
|
6488
9230
|
- $ref: '#/components/schemas/Outcome'
|
|
6489
9231
|
description: |-
|
|
6490
|
-
The outcome of the
|
|
6491
|
-
has completed. If this response is being returned before the
|
|
9232
|
+
The outcome of the Update if and only if the Workflow Update
|
|
9233
|
+
has completed. If this response is being returned before the Update has
|
|
6492
9234
|
completed then this field will not be set.
|
|
6493
9235
|
stage:
|
|
6494
9236
|
enum:
|
|
@@ -6564,12 +9306,13 @@ components:
|
|
|
6564
9306
|
- UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED
|
|
6565
9307
|
type: string
|
|
6566
9308
|
description: |-
|
|
6567
|
-
Indicates the
|
|
6568
|
-
|
|
9309
|
+
Indicates the Update lifecycle stage that the Update must reach before
|
|
9310
|
+
API call is returned.
|
|
9311
|
+
NOTE: This field works together with API call timeout which is limited by
|
|
9312
|
+
server timeout (maximum wait time). If server timeout is expired before
|
|
9313
|
+
user specified timeout, API call returns even if specified stage is not reached.
|
|
6569
9314
|
format: enum
|
|
6570
|
-
description:
|
|
6571
|
-
Specifies to the gRPC server how long the client wants the an update-related
|
|
6572
|
-
RPC call to wait before returning control to the caller.
|
|
9315
|
+
description: Specifies client's intent to wait for Update results.
|
|
6573
9316
|
WorkerVersionCapabilities:
|
|
6574
9317
|
type: object
|
|
6575
9318
|
properties:
|
|
@@ -6599,6 +9342,70 @@ components:
|
|
|
6599
9342
|
If set, the worker is opting in to worker versioning. Otherwise, this is used only as a
|
|
6600
9343
|
marker for workflow reset points and the BuildIDs search attribute.
|
|
6601
9344
|
description: Identifies the version(s) of a worker that processed a task
|
|
9345
|
+
WorkflowEvent_EventReference:
|
|
9346
|
+
type: object
|
|
9347
|
+
properties:
|
|
9348
|
+
eventId:
|
|
9349
|
+
type: string
|
|
9350
|
+
eventType:
|
|
9351
|
+
enum:
|
|
9352
|
+
- EVENT_TYPE_UNSPECIFIED
|
|
9353
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_STARTED
|
|
9354
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_COMPLETED
|
|
9355
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_FAILED
|
|
9356
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_TIMED_OUT
|
|
9357
|
+
- EVENT_TYPE_WORKFLOW_TASK_SCHEDULED
|
|
9358
|
+
- EVENT_TYPE_WORKFLOW_TASK_STARTED
|
|
9359
|
+
- EVENT_TYPE_WORKFLOW_TASK_COMPLETED
|
|
9360
|
+
- EVENT_TYPE_WORKFLOW_TASK_TIMED_OUT
|
|
9361
|
+
- EVENT_TYPE_WORKFLOW_TASK_FAILED
|
|
9362
|
+
- EVENT_TYPE_ACTIVITY_TASK_SCHEDULED
|
|
9363
|
+
- EVENT_TYPE_ACTIVITY_TASK_STARTED
|
|
9364
|
+
- EVENT_TYPE_ACTIVITY_TASK_COMPLETED
|
|
9365
|
+
- EVENT_TYPE_ACTIVITY_TASK_FAILED
|
|
9366
|
+
- EVENT_TYPE_ACTIVITY_TASK_TIMED_OUT
|
|
9367
|
+
- EVENT_TYPE_ACTIVITY_TASK_CANCEL_REQUESTED
|
|
9368
|
+
- EVENT_TYPE_ACTIVITY_TASK_CANCELED
|
|
9369
|
+
- EVENT_TYPE_TIMER_STARTED
|
|
9370
|
+
- EVENT_TYPE_TIMER_FIRED
|
|
9371
|
+
- EVENT_TYPE_TIMER_CANCELED
|
|
9372
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_CANCEL_REQUESTED
|
|
9373
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_CANCELED
|
|
9374
|
+
- EVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED
|
|
9375
|
+
- EVENT_TYPE_REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_FAILED
|
|
9376
|
+
- EVENT_TYPE_EXTERNAL_WORKFLOW_EXECUTION_CANCEL_REQUESTED
|
|
9377
|
+
- EVENT_TYPE_MARKER_RECORDED
|
|
9378
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_SIGNALED
|
|
9379
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_TERMINATED
|
|
9380
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_CONTINUED_AS_NEW
|
|
9381
|
+
- EVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_INITIATED
|
|
9382
|
+
- EVENT_TYPE_START_CHILD_WORKFLOW_EXECUTION_FAILED
|
|
9383
|
+
- EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_STARTED
|
|
9384
|
+
- EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_COMPLETED
|
|
9385
|
+
- EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_FAILED
|
|
9386
|
+
- EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_CANCELED
|
|
9387
|
+
- EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_TIMED_OUT
|
|
9388
|
+
- EVENT_TYPE_CHILD_WORKFLOW_EXECUTION_TERMINATED
|
|
9389
|
+
- EVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED
|
|
9390
|
+
- EVENT_TYPE_SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_FAILED
|
|
9391
|
+
- EVENT_TYPE_EXTERNAL_WORKFLOW_EXECUTION_SIGNALED
|
|
9392
|
+
- EVENT_TYPE_UPSERT_WORKFLOW_SEARCH_ATTRIBUTES
|
|
9393
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ADMITTED
|
|
9394
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_ACCEPTED
|
|
9395
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_REJECTED
|
|
9396
|
+
- EVENT_TYPE_WORKFLOW_EXECUTION_UPDATE_COMPLETED
|
|
9397
|
+
- EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED_EXTERNALLY
|
|
9398
|
+
- EVENT_TYPE_ACTIVITY_PROPERTIES_MODIFIED_EXTERNALLY
|
|
9399
|
+
- EVENT_TYPE_WORKFLOW_PROPERTIES_MODIFIED
|
|
9400
|
+
- EVENT_TYPE_NEXUS_OPERATION_SCHEDULED
|
|
9401
|
+
- EVENT_TYPE_NEXUS_OPERATION_STARTED
|
|
9402
|
+
- EVENT_TYPE_NEXUS_OPERATION_COMPLETED
|
|
9403
|
+
- EVENT_TYPE_NEXUS_OPERATION_FAILED
|
|
9404
|
+
- EVENT_TYPE_NEXUS_OPERATION_CANCELED
|
|
9405
|
+
- EVENT_TYPE_NEXUS_OPERATION_TIMED_OUT
|
|
9406
|
+
- EVENT_TYPE_NEXUS_OPERATION_CANCEL_REQUESTED
|
|
9407
|
+
type: string
|
|
9408
|
+
format: enum
|
|
6602
9409
|
WorkflowExecution:
|
|
6603
9410
|
type: object
|
|
6604
9411
|
properties:
|
|
@@ -6839,6 +9646,15 @@ components:
|
|
|
6839
9646
|
description: |-
|
|
6840
9647
|
Build ID inherited from a previous/parent execution. If present, assigned_build_id will be set to this, instead
|
|
6841
9648
|
of using the assignment rules.
|
|
9649
|
+
firstRunId:
|
|
9650
|
+
type: string
|
|
9651
|
+
description: |-
|
|
9652
|
+
The first run ID in the execution chain.
|
|
9653
|
+
Executions created via the following operations are considered to be in the same chain
|
|
9654
|
+
- ContinueAsNew
|
|
9655
|
+
- Workflow Retry
|
|
9656
|
+
- Workflow Reset
|
|
9657
|
+
- Cron Schedule
|
|
6842
9658
|
WorkflowExecutionSignaledEventAttributes:
|
|
6843
9659
|
type: object
|
|
6844
9660
|
properties:
|