temporalio 1.5.0 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Cargo.lock +1461 -621
- data/Cargo.toml +1 -1
- data/Gemfile +6 -5
- data/README.md +42 -1
- data/ext/Cargo.toml +9 -3
- data/lib/temporalio/api/activity/v1/message.rb +1 -1
- data/lib/temporalio/api/cloud/billing/v1/message.rb +2 -1
- data/lib/temporalio/api/cloud/cloudservice/v1/request_response.rb +17 -1
- data/lib/temporalio/api/cloud/cloudservice/v1/service.rb +1 -1
- data/lib/temporalio/api/cloud/connectivityrule/v1/message.rb +1 -1
- data/lib/temporalio/api/cloud/identity/v1/message.rb +8 -1
- data/lib/temporalio/api/cloud/namespace/v1/message.rb +5 -1
- data/lib/temporalio/api/command/v1/message.rb +2 -1
- data/lib/temporalio/api/common/v1/message.rb +5 -1
- data/lib/temporalio/api/deployment/v1/message.rb +3 -1
- data/lib/temporalio/api/history/v1/message.rb +3 -1
- data/lib/temporalio/api/namespace/v1/message.rb +1 -1
- data/lib/temporalio/api/nexus/v1/message.rb +1 -1
- data/lib/temporalio/api/nexusannotations/v1/options.rb +20 -0
- data/lib/temporalio/api/payload_visitor.rb +32 -0
- data/lib/temporalio/api/schedule/v1/message.rb +1 -1
- data/lib/temporalio/api/sdk/v1/event_group_marker.rb +26 -0
- data/lib/temporalio/api/update/v1/message.rb +1 -1
- data/lib/temporalio/api/workflow/v1/message.rb +3 -2
- data/lib/temporalio/api/workflowservice/v1/request_response.rb +11 -1
- data/lib/temporalio/api/workflowservice/v1/service.rb +3 -2
- data/lib/temporalio/client/connection/cloud_service.rb +120 -0
- data/lib/temporalio/client/connection/workflow_service.rb +75 -0
- data/lib/temporalio/client/connection.rb +37 -2
- data/lib/temporalio/client.rb +10 -5
- data/lib/temporalio/internal/bridge/api/workflow_commands/workflow_commands.rb +1 -1
- data/lib/temporalio/internal/bridge/client.rb +6 -1
- data/lib/temporalio/internal/bridge.rb +20 -0
- data/lib/temporalio/internal/google_protobuf.rb +11 -0
- data/lib/temporalio/internal/worker/workflow_instance/context.rb +2 -0
- data/lib/temporalio/internal/worker/workflow_instance/details.rb +3 -1
- data/lib/temporalio/internal/worker/workflow_instance/scheduler.rb +73 -2
- data/lib/temporalio/internal/worker/workflow_instance.rb +36 -6
- data/lib/temporalio/internal/worker/workflow_worker.rb +10 -2
- data/lib/temporalio/internal/workflow_task_failure_error.rb +9 -0
- data/lib/temporalio/version.rb +1 -1
- data/lib/temporalio/worker/activity_executor/fiber.rb +1 -1
- data/lib/temporalio/worker/activity_executor/thread_pool.rb +1 -1
- data/lib/temporalio/worker/illegal_workflow_call_validator.rb +3 -1
- data/lib/temporalio/worker/workflow_executor/thread_pool.rb +5 -1
- data/lib/temporalio/worker/workflow_replayer.rb +17 -4
- data/lib/temporalio/worker.rb +30 -5
- data/lib/temporalio/workflow/future.rb +5 -0
- data/lib/temporalio/workflow/nexus_operation_cancellation_type.rb +4 -2
- data/lib/temporalio/workflow.rb +8 -0
- data/rbi/google/protobuf.rbi +25 -0
- data/rbi/temporalio/activity/cancellation_details.rbi +33 -0
- data/rbi/temporalio/activity/complete_async_error.rbi +3 -0
- data/rbi/temporalio/activity/context.rbi +42 -0
- data/rbi/temporalio/activity/definition.rbi +74 -0
- data/rbi/temporalio/activity/info.rbi +112 -0
- data/rbi/temporalio/activity.rbi +3 -0
- data/rbi/temporalio/api/activity/v1/message.rbi +1453 -0
- data/rbi/temporalio/api/batch/v1/message.rbi +1283 -0
- data/rbi/temporalio/api/callback/v1/message.rbi +188 -0
- data/rbi/temporalio/api/cloud/account/v1/message.rbi +650 -0
- data/rbi/temporalio/api/cloud/auditlog/v1/message.rbi +318 -0
- data/rbi/temporalio/api/cloud/billing/v1/message.rbi +480 -0
- data/rbi/temporalio/api/cloud/cloudservice/v1/request_response.rbi +12454 -0
- data/rbi/temporalio/api/cloud/cloudservice/v1/service.rbi +3 -0
- data/rbi/temporalio/api/cloud/cloudservice/v1/service_services.rbi +709 -0
- data/rbi/temporalio/api/cloud/cloudservice.rbi +5 -0
- data/rbi/temporalio/api/cloud/connectivityrule/v1/message.rbi +403 -0
- data/rbi/temporalio/api/cloud/identity/v1/message.rbi +3072 -0
- data/rbi/temporalio/api/cloud/namespace/v1/message.rbi +3659 -0
- data/rbi/temporalio/api/cloud/nexus/v1/message.rbi +595 -0
- data/rbi/temporalio/api/cloud/operation/v1/message.rbi +244 -0
- data/rbi/temporalio/api/cloud/region/v1/message.rbi +166 -0
- data/rbi/temporalio/api/cloud/resource/v1/message.rbi +29 -0
- data/rbi/temporalio/api/cloud/sink/v1/message.rbi +438 -0
- data/rbi/temporalio/api/cloud/usage/v1/message.rbi +409 -0
- data/rbi/temporalio/api/command/v1/message.rbi +2655 -0
- data/rbi/temporalio/api/common/v1/grpc_status.rbi +92 -0
- data/rbi/temporalio/api/common/v1/message.rbi +2983 -0
- data/rbi/temporalio/api/compute/v1/config.rbi +421 -0
- data/rbi/temporalio/api/compute/v1/provider.rbi +125 -0
- data/rbi/temporalio/api/compute/v1/scaler.rbi +102 -0
- data/rbi/temporalio/api/deployment/v1/message.rbi +2340 -0
- data/rbi/temporalio/api/enums/v1/activity.rbi +62 -0
- data/rbi/temporalio/api/enums/v1/batch_operation.rbi +47 -0
- data/rbi/temporalio/api/enums/v1/command_type.rbi +36 -0
- data/rbi/temporalio/api/enums/v1/common.rbi +181 -0
- data/rbi/temporalio/api/enums/v1/deployment.rbi +80 -0
- data/rbi/temporalio/api/enums/v1/event_type.rbi +79 -0
- data/rbi/temporalio/api/enums/v1/failed_cause.rbi +155 -0
- data/rbi/temporalio/api/enums/v1/namespace.rbi +58 -0
- data/rbi/temporalio/api/enums/v1/nexus.rbi +98 -0
- data/rbi/temporalio/api/enums/v1/query.rbi +40 -0
- data/rbi/temporalio/api/enums/v1/reset.rbi +60 -0
- data/rbi/temporalio/api/enums/v1/schedule.rbi +25 -0
- data/rbi/temporalio/api/enums/v1/task_queue.rbi +134 -0
- data/rbi/temporalio/api/enums/v1/update.rbi +39 -0
- data/rbi/temporalio/api/enums/v1/workflow.rbi +259 -0
- data/rbi/temporalio/api/errordetails/v1/message.rbi +1389 -0
- data/rbi/temporalio/api/export/v1/message.rbi +123 -0
- data/rbi/temporalio/api/failure/v1/message.rbi +1303 -0
- data/rbi/temporalio/api/filter/v1/message.rbi +267 -0
- data/rbi/temporalio/api/history/v1/message.rbi +10737 -0
- data/rbi/temporalio/api/namespace/v1/message.rbi +1044 -0
- data/rbi/temporalio/api/nexus/v1/message.rbi +2780 -0
- data/rbi/temporalio/api/nexusannotations/v1/options.rbi +161 -0
- data/rbi/temporalio/api/nexusservices/workerservice/v1/request_response.rbi +124 -0
- data/rbi/temporalio/api/operatorservice/v1/request_response.rbi +1836 -0
- data/rbi/temporalio/api/operatorservice/v1/service.rbi +3 -0
- data/rbi/temporalio/api/operatorservice/v1/service_services.rbi +143 -0
- data/rbi/temporalio/api/operatorservice.rbi +5 -0
- data/rbi/temporalio/api/payload_visitor.rbi +876 -0
- data/rbi/temporalio/api/protoc_gen_openapiv2/options/annotations.rbi +3 -0
- data/rbi/temporalio/api/protoc_gen_openapiv2/options/openapiv2.rbi +3482 -0
- data/rbi/temporalio/api/protocol/v1/message.rbi +139 -0
- data/rbi/temporalio/api/protometa/v1/annotations.rbi +97 -0
- data/rbi/temporalio/api/query/v1/message.rbi +288 -0
- data/rbi/temporalio/api/replication/v1/message.rbi +226 -0
- data/rbi/temporalio/api/rules/v1/message.rbi +492 -0
- data/rbi/temporalio/api/schedule/v1/message.rbi +2377 -0
- data/rbi/temporalio/api/sdk/v1/enhanced_stack_trace.rbi +478 -0
- data/rbi/temporalio/api/sdk/v1/event_group_marker.rbi +337 -0
- data/rbi/temporalio/api/sdk/v1/external_storage.rbi +85 -0
- data/rbi/temporalio/api/sdk/v1/task_complete_metadata.rbi +206 -0
- data/rbi/temporalio/api/sdk/v1/user_metadata.rbi +98 -0
- data/rbi/temporalio/api/sdk/v1/worker_config.rbi +255 -0
- data/rbi/temporalio/api/sdk/v1/workflow_metadata.rbi +297 -0
- data/rbi/temporalio/api/taskqueue/v1/message.rbi +2460 -0
- data/rbi/temporalio/api/testservice/v1/request_response.rbi +380 -0
- data/rbi/temporalio/api/testservice/v1/service.rbi +3 -0
- data/rbi/temporalio/api/testservice/v1/service_services.rbi +100 -0
- data/rbi/temporalio/api/update/v1/message.rbi +800 -0
- data/rbi/temporalio/api/version/v1/message.rbi +281 -0
- data/rbi/temporalio/api/worker/v1/message.rbi +1565 -0
- data/rbi/temporalio/api/workflow/v1/message.rbi +5011 -0
- data/rbi/temporalio/api/workflowservice/v1/request_response.rbi +30477 -0
- data/rbi/temporalio/api/workflowservice/v1/service.rbi +3 -0
- data/rbi/temporalio/api/workflowservice/v1/service_services.rbi +1571 -0
- data/rbi/temporalio/api/workflowservice.rbi +5 -0
- data/rbi/temporalio/api.rbi +7 -0
- data/rbi/temporalio/cancellation.rbi +40 -0
- data/rbi/temporalio/client/activity_execution.rbi +134 -0
- data/rbi/temporalio/client/activity_execution_count.rbi +23 -0
- data/rbi/temporalio/client/activity_execution_status.rbi +11 -0
- data/rbi/temporalio/client/activity_handle.rbi +49 -0
- data/rbi/temporalio/client/activity_id_reference.rbi +24 -0
- data/rbi/temporalio/client/async_activity_handle.rbi +49 -0
- data/rbi/temporalio/client/connection/cloud_service.rbi +239 -0
- data/rbi/temporalio/client/connection/operator_service.rbi +47 -0
- data/rbi/temporalio/client/connection/service.rbi +19 -0
- data/rbi/temporalio/client/connection/test_service.rbi +29 -0
- data/rbi/temporalio/client/connection/workflow_service.rbi +377 -0
- data/rbi/temporalio/client/connection.rbi +284 -0
- data/rbi/temporalio/client/interceptor.rbi +1067 -0
- data/rbi/temporalio/client/pending_activity_state.rbi +9 -0
- data/rbi/temporalio/client/plugin.rbi +17 -0
- data/rbi/temporalio/client/schedule.rbi +677 -0
- data/rbi/temporalio/client/schedule_handle.rbi +40 -0
- data/rbi/temporalio/client/with_start_workflow_operation.rbi +126 -0
- data/rbi/temporalio/client/workflow_execution.rbi +62 -0
- data/rbi/temporalio/client/workflow_execution_count.rbi +23 -0
- data/rbi/temporalio/client/workflow_execution_status.rbi +11 -0
- data/rbi/temporalio/client/workflow_handle.rbi +148 -0
- data/rbi/temporalio/client/workflow_query_reject_condition.rbi +7 -0
- data/rbi/temporalio/client/workflow_update_handle.rbi +38 -0
- data/rbi/temporalio/client/workflow_update_wait_stage.rbi +7 -0
- data/rbi/temporalio/client.rbi +534 -0
- data/rbi/temporalio/common_enums.rbi +45 -0
- data/rbi/temporalio/contrib/open_telemetry.rbi +73 -0
- data/rbi/temporalio/converters/data_converter.rbi +44 -0
- data/rbi/temporalio/converters/failure_converter.rbi +20 -0
- data/rbi/temporalio/converters/payload_codec.rbi +11 -0
- data/rbi/temporalio/converters/payload_converter/binary_null.rbi +5 -0
- data/rbi/temporalio/converters/payload_converter/binary_plain.rbi +5 -0
- data/rbi/temporalio/converters/payload_converter/binary_protobuf.rbi +5 -0
- data/rbi/temporalio/converters/payload_converter/composite.rbi +20 -0
- data/rbi/temporalio/converters/payload_converter/encoding.rbi +14 -0
- data/rbi/temporalio/converters/payload_converter/json_plain.rbi +10 -0
- data/rbi/temporalio/converters/payload_converter/json_protobuf.rbi +5 -0
- data/rbi/temporalio/converters/payload_converter.rbi +28 -0
- data/rbi/temporalio/converters/raw_value.rbi +11 -0
- data/rbi/temporalio/converters.rbi +3 -0
- data/rbi/temporalio/env_config.rbi +156 -0
- data/rbi/temporalio/error/failure.rbi +3 -0
- data/rbi/temporalio/error.rbi +313 -0
- data/rbi/temporalio/internal/bridge/api/activity_result/activity_result.rbi +547 -0
- data/rbi/temporalio/internal/bridge/api/activity_task/activity_task.rbi +705 -0
- data/rbi/temporalio/internal/bridge/api/child_workflow/child_workflow.rbi +332 -0
- data/rbi/temporalio/internal/bridge/api/common/common.rbi +191 -0
- data/rbi/temporalio/internal/bridge/api/core_interface.rbi +567 -0
- data/rbi/temporalio/internal/bridge/api/external_data/external_data.rbi +255 -0
- data/rbi/temporalio/internal/bridge/api/nexus/nexus.rbi +527 -0
- data/rbi/temporalio/internal/bridge/api/workflow_activation/workflow_activation.rbi +2808 -0
- data/rbi/temporalio/internal/bridge/api/workflow_commands/workflow_commands.rbi +3309 -0
- data/rbi/temporalio/internal/bridge/api/workflow_completion/workflow_completion.rbi +272 -0
- data/rbi/temporalio/internal/bridge/api.rbi +3 -0
- data/rbi/temporalio/internal/bridge/client.rbi +346 -0
- data/rbi/temporalio/internal/bridge/runtime.rbi +231 -0
- data/rbi/temporalio/internal/bridge/testing.rbi +109 -0
- data/rbi/temporalio/internal/bridge/worker.rbi +250 -0
- data/rbi/temporalio/internal/bridge.rbi +47 -0
- data/rbi/temporalio/internal/client/implementation.rbi +53 -0
- data/rbi/temporalio/internal/google_protobuf.rbi +8 -0
- data/rbi/temporalio/internal/metric.rbi +55 -0
- data/rbi/temporalio/internal/proto_utils.rbi +148 -0
- data/rbi/temporalio/internal/worker/activity_worker.rbi +108 -0
- data/rbi/temporalio/internal/worker/multi_runner.rbi +175 -0
- data/rbi/temporalio/internal/worker/workflow_instance/child_workflow_handle.rbi +20 -0
- data/rbi/temporalio/internal/worker/workflow_instance/context.rbi +290 -0
- data/rbi/temporalio/internal/worker/workflow_instance/details.rbi +87 -0
- data/rbi/temporalio/internal/worker/workflow_instance/external_workflow_handle.rbi +14 -0
- data/rbi/temporalio/internal/worker/workflow_instance/externally_immutable_hash.rbi +17 -0
- data/rbi/temporalio/internal/worker/workflow_instance/handler_execution.rbi +17 -0
- data/rbi/temporalio/internal/worker/workflow_instance/handler_hash.rbi +24 -0
- data/rbi/temporalio/internal/worker/workflow_instance/illegal_call_tracer.rbi +17 -0
- data/rbi/temporalio/internal/worker/workflow_instance/inbound_implementation.rbi +21 -0
- data/rbi/temporalio/internal/worker/workflow_instance/nexus_client.rbi +47 -0
- data/rbi/temporalio/internal/worker/workflow_instance/nexus_operation_handle.rbi +19 -0
- data/rbi/temporalio/internal/worker/workflow_instance/outbound_implementation.rbi +43 -0
- data/rbi/temporalio/internal/worker/workflow_instance/replay_safe_logger.rbi +11 -0
- data/rbi/temporalio/internal/worker/workflow_instance/replay_safe_metric.rbi +15 -0
- data/rbi/temporalio/internal/worker/workflow_instance/scheduler.rbi +36 -0
- data/rbi/temporalio/internal/worker/workflow_instance.rbi +231 -0
- data/rbi/temporalio/internal/worker/workflow_worker.rbi +199 -0
- data/rbi/temporalio/internal/workflow_task_failure_error.rbi +3 -0
- data/rbi/temporalio/internal.rbi +3 -0
- data/rbi/temporalio/metric.rbi +56 -0
- data/rbi/temporalio/priority.rbi +38 -0
- data/rbi/temporalio/retry_policy.rbi +40 -0
- data/rbi/temporalio/runtime/metric_buffer.rbi +45 -0
- data/rbi/temporalio/runtime.rbi +185 -0
- data/rbi/temporalio/scoped_logger.rbi +50 -0
- data/rbi/temporalio/search_attributes.rbi +94 -0
- data/rbi/temporalio/simple_plugin.rbi +41 -0
- data/rbi/temporalio/testing/activity_environment.rbi +43 -0
- data/rbi/temporalio/testing/workflow_environment.rbi +116 -0
- data/rbi/temporalio/testing.rbi +3 -0
- data/rbi/temporalio/version.rbi +5 -0
- data/rbi/temporalio/versioning_override.rbi +13 -0
- data/rbi/temporalio/worker/activity_executor/fiber.rbi +20 -0
- data/rbi/temporalio/worker/activity_executor/thread_pool.rbi +20 -0
- data/rbi/temporalio/worker/activity_executor.rbi +20 -0
- data/rbi/temporalio/worker/deployment_options.rbi +23 -0
- data/rbi/temporalio/worker/illegal_workflow_call_validator.rbi +33 -0
- data/rbi/temporalio/worker/interceptor.rbi +489 -0
- data/rbi/temporalio/worker/plugin.rbi +49 -0
- data/rbi/temporalio/worker/poller_behavior.rbi +29 -0
- data/rbi/temporalio/worker/thread_pool.rbi +38 -0
- data/rbi/temporalio/worker/tuner.rbi +221 -0
- data/rbi/temporalio/worker/workflow_executor/thread_pool.rbi +15 -0
- data/rbi/temporalio/worker/workflow_executor.rbi +8 -0
- data/rbi/temporalio/worker/workflow_replayer.rbi +152 -0
- data/rbi/temporalio/worker.rbi +258 -0
- data/rbi/temporalio/worker_deployment_version.rbi +29 -0
- data/rbi/temporalio/workflow/activity_cancellation_type.rbi +7 -0
- data/rbi/temporalio/workflow/child_workflow_cancellation_type.rbi +8 -0
- data/rbi/temporalio/workflow/child_workflow_handle.rbi +27 -0
- data/rbi/temporalio/workflow/definition.rbi +305 -0
- data/rbi/temporalio/workflow/external_workflow_handle.rbi +24 -0
- data/rbi/temporalio/workflow/future.rbi +62 -0
- data/rbi/temporalio/workflow/handler_unfinished_policy.rbi +6 -0
- data/rbi/temporalio/workflow/info.rbi +100 -0
- data/rbi/temporalio/workflow/nexus_client.rbi +65 -0
- data/rbi/temporalio/workflow/nexus_operation_cancellation_type.rbi +8 -0
- data/rbi/temporalio/workflow/nexus_operation_handle.rbi +14 -0
- data/rbi/temporalio/workflow/parent_close_policy.rbi +8 -0
- data/rbi/temporalio/workflow/update_info.rbi +14 -0
- data/rbi/temporalio/workflow.rbi +393 -0
- data/rbi/temporalio/workflow_history.rbi +21 -0
- data/rbi/temporalio.rbi +5 -0
- data/sig/common.rbs +1 -0
- data/sig/google/protobuf_compat.rbs +17 -0
- data/sig/open_telemetry.rbs +47 -0
- data/sig/temporalio/activity/cancellation_details.rbs +21 -0
- data/sig/temporalio/activity/complete_async_error.rbs +6 -0
- data/sig/temporalio/activity/context.rbs +26 -0
- data/sig/temporalio/activity/definition.rbs +60 -0
- data/sig/temporalio/activity/info.rbs +57 -0
- data/sig/temporalio/activity.rbs +4 -0
- data/sig/temporalio/api/activity/v1/message.rbs +708 -0
- data/sig/temporalio/api/batch/v1/message.rbs +594 -0
- data/sig/temporalio/api/callback/v1/message.rbs +112 -0
- data/sig/temporalio/api/cloud/account/v1/message.rbs +314 -0
- data/sig/temporalio/api/cloud/auditlog/v1/message.rbs +168 -0
- data/sig/temporalio/api/cloud/billing/v1/message.rbs +279 -0
- data/sig/temporalio/api/cloud/cloudservice/v1/request_response.rbs +4726 -0
- data/sig/temporalio/api/cloud/cloudservice/v1/service.rbs +25 -0
- data/sig/temporalio/api/cloud/cloudservice.rbs +8 -0
- data/sig/temporalio/api/cloud/connectivityrule/v1/message.rbs +191 -0
- data/sig/temporalio/api/cloud/identity/v1/message.rbs +1372 -0
- data/sig/temporalio/api/cloud/namespace/v1/message.rbs +1571 -0
- data/sig/temporalio/api/cloud/nexus/v1/message.rbs +269 -0
- data/sig/temporalio/api/cloud/operation/v1/message.rbs +156 -0
- data/sig/temporalio/api/cloud/region/v1/message.rbs +109 -0
- data/sig/temporalio/api/cloud/resource/v1/message.rbs +61 -0
- data/sig/temporalio/api/cloud/sink/v1/message.rbs +207 -0
- data/sig/temporalio/api/cloud/usage/v1/message.rbs +230 -0
- data/sig/temporalio/api/command/v1/message.rbs +1211 -0
- data/sig/temporalio/api/common/v1/grpc_status.rbs +59 -0
- data/sig/temporalio/api/common/v1/message.rbs +1238 -0
- data/sig/temporalio/api/compute/v1/config.rbs +176 -0
- data/sig/temporalio/api/compute/v1/provider.rbs +73 -0
- data/sig/temporalio/api/compute/v1/scaler.rbs +60 -0
- data/sig/temporalio/api/deployment/v1/message.rbs +1063 -0
- data/sig/temporalio/api/enums/v1/activity.rbs +134 -0
- data/sig/temporalio/api/enums/v1/batch_operation.rbs +80 -0
- data/sig/temporalio/api/enums/v1/command_type.rbs +74 -0
- data/sig/temporalio/api/enums/v1/common.rbs +271 -0
- data/sig/temporalio/api/enums/v1/deployment.rbs +177 -0
- data/sig/temporalio/api/enums/v1/event_type.rbs +263 -0
- data/sig/temporalio/api/enums/v1/failed_cause.rbs +281 -0
- data/sig/temporalio/api/enums/v1/namespace.rbs +87 -0
- data/sig/temporalio/api/enums/v1/nexus.rbs +172 -0
- data/sig/temporalio/api/enums/v1/query.rbs +69 -0
- data/sig/temporalio/api/enums/v1/reset.rbs +106 -0
- data/sig/temporalio/api/enums/v1/schedule.rbs +68 -0
- data/sig/temporalio/api/enums/v1/task_queue.rbs +238 -0
- data/sig/temporalio/api/enums/v1/update.rbs +87 -0
- data/sig/temporalio/api/enums/v1/workflow.rbs +435 -0
- data/sig/temporalio/api/errordetails/v1/message.rbs +532 -0
- data/sig/temporalio/api/export/v1/message.rbs +63 -0
- data/sig/temporalio/api/failure/v1/message.rbs +579 -0
- data/sig/temporalio/api/filter/v1/message.rbs +121 -0
- data/sig/temporalio/api/history/v1/message.rbs +4928 -0
- data/sig/temporalio/api/namespace/v1/message.rbs +465 -0
- data/sig/temporalio/api/nexus/v1/message.rbs +1268 -0
- data/sig/temporalio/api/nexusannotations/v1/options.rbs +76 -0
- data/sig/temporalio/api/nexusservices/workerservice/v1/request_response.rbs +65 -0
- data/sig/temporalio/api/operatorservice/v1/request_response.rbs +679 -0
- data/sig/temporalio/api/operatorservice/v1/service.rbs +23 -0
- data/sig/temporalio/api/operatorservice.rbs +6 -0
- data/sig/temporalio/api/payload_visitor.rbs +298 -0
- data/sig/temporalio/api/protoc_gen_openapiv2/options/annotations.rbs +23 -0
- data/sig/temporalio/api/protoc_gen_openapiv2/options/openapiv2.rbs +1691 -0
- data/sig/temporalio/api/protocol/v1/message.rbs +90 -0
- data/sig/temporalio/api/protometa/v1/annotations.rbs +62 -0
- data/sig/temporalio/api/query/v1/message.rbs +138 -0
- data/sig/temporalio/api/replication/v1/message.rbs +109 -0
- data/sig/temporalio/api/rules/v1/message.rbs +213 -0
- data/sig/temporalio/api/schedule/v1/message.rbs +1066 -0
- data/sig/temporalio/api/sdk/v1/enhanced_stack_trace.rbs +210 -0
- data/sig/temporalio/api/sdk/v1/event_group_marker.rbs +154 -0
- data/sig/temporalio/api/sdk/v1/external_storage.rbs +54 -0
- data/sig/temporalio/api/sdk/v1/task_complete_metadata.rbs +92 -0
- data/sig/temporalio/api/sdk/v1/user_metadata.rbs +58 -0
- data/sig/temporalio/api/sdk/v1/worker_config.rbs +122 -0
- data/sig/temporalio/api/sdk/v1/workflow_metadata.rbs +138 -0
- data/sig/temporalio/api/taskqueue/v1/message.rbs +1013 -0
- data/sig/temporalio/api/testservice/v1/request_response.rbs +125 -0
- data/sig/temporalio/api/testservice/v1/service.rbs +23 -0
- data/sig/temporalio/api/update/v1/message.rbs +349 -0
- data/sig/temporalio/api/version/v1/message.rbs +143 -0
- data/sig/temporalio/api/worker/v1/message.rbs +716 -0
- data/sig/temporalio/api/workflow/v1/message.rbs +2322 -0
- data/sig/temporalio/api/workflowservice/v1/request_response.rbs +12735 -0
- data/sig/temporalio/api/workflowservice/v1/service.rbs +23 -0
- data/sig/temporalio/api/workflowservice.rbs +6 -0
- data/sig/temporalio/api.rbs +4 -0
- data/sig/temporalio/cancellation.rbs +20 -0
- data/sig/temporalio/client/activity_execution.rbs +50 -0
- data/sig/temporalio/client/activity_execution_count.rbs +17 -0
- data/sig/temporalio/client/activity_execution_status.rbs +15 -0
- data/sig/temporalio/client/activity_handle.rbs +26 -0
- data/sig/temporalio/client/activity_id_reference.rbs +16 -0
- data/sig/temporalio/client/async_activity_handle.rbs +41 -0
- data/sig/temporalio/client/connection/cloud_service.rbs +315 -0
- data/sig/temporalio/client/connection/operator_service.rbs +59 -0
- data/sig/temporalio/client/connection/service.rbs +17 -0
- data/sig/temporalio/client/connection/test_service.rbs +35 -0
- data/sig/temporalio/client/connection/workflow_service.rbs +499 -0
- data/sig/temporalio/client/connection.rbs +143 -0
- data/sig/temporalio/client/interceptor.rbs +622 -0
- data/sig/temporalio/client/pending_activity_state.rbs +14 -0
- data/sig/temporalio/client/plugin.rbs +14 -0
- data/sig/temporalio/client/schedule.rbs +337 -0
- data/sig/temporalio/client/schedule_handle.rbs +44 -0
- data/sig/temporalio/client/with_start_workflow_operation.rbs +82 -0
- data/sig/temporalio/client/workflow_execution.rbs +37 -0
- data/sig/temporalio/client/workflow_execution_count.rbs +17 -0
- data/sig/temporalio/client/workflow_execution_status.rbs +16 -0
- data/sig/temporalio/client/workflow_handle.rbs +95 -0
- data/sig/temporalio/client/workflow_query_reject_condition.rbs +12 -0
- data/sig/temporalio/client/workflow_update_handle.rbs +26 -0
- data/sig/temporalio/client/workflow_update_wait_stage.rbs +12 -0
- data/sig/temporalio/client.rbs +271 -0
- data/sig/temporalio/common_enums.rbs +60 -0
- data/sig/temporalio/contrib/open_telemetry.rbs +74 -0
- data/sig/temporalio/converters/data_converter.rbs +32 -0
- data/sig/temporalio/converters/failure_converter.rbs +12 -0
- data/sig/temporalio/converters/payload_codec.rbs +8 -0
- data/sig/temporalio/converters/payload_converter/binary_null.rbs +9 -0
- data/sig/temporalio/converters/payload_converter/binary_plain.rbs +9 -0
- data/sig/temporalio/converters/payload_converter/binary_protobuf.rbs +9 -0
- data/sig/temporalio/converters/payload_converter/composite.rbs +16 -0
- data/sig/temporalio/converters/payload_converter/encoding.rbs +13 -0
- data/sig/temporalio/converters/payload_converter/json_plain.rbs +14 -0
- data/sig/temporalio/converters/payload_converter/json_protobuf.rbs +9 -0
- data/sig/temporalio/converters/payload_converter.rbs +24 -0
- data/sig/temporalio/converters/raw_value.rbs +9 -0
- data/sig/temporalio/converters.rbs +4 -0
- data/sig/temporalio/env_config.rbs +86 -0
- data/sig/temporalio/error/failure.rbs +170 -0
- data/sig/temporalio/error.rbs +88 -0
- data/sig/temporalio/internal/bridge/api/activity_result/activity_result.rbs +247 -0
- data/sig/temporalio/internal/bridge/api/activity_task/activity_task.rbs +372 -0
- data/sig/temporalio/internal/bridge/api/child_workflow/child_workflow.rbs +207 -0
- data/sig/temporalio/internal/bridge/api/common/common.rbs +123 -0
- data/sig/temporalio/internal/bridge/api/core_interface.rbs +231 -0
- data/sig/temporalio/internal/bridge/api/external_data/external_data.rbs +134 -0
- data/sig/temporalio/internal/bridge/api/nexus/nexus.rbs +285 -0
- data/sig/temporalio/internal/bridge/api/workflow_activation/workflow_activation.rbs +1304 -0
- data/sig/temporalio/internal/bridge/api/workflow_commands/workflow_commands.rbs +1526 -0
- data/sig/temporalio/internal/bridge/api/workflow_completion/workflow_completion.rbs +136 -0
- data/sig/temporalio/internal/bridge/api.rbs +8 -0
- data/sig/temporalio/internal/bridge/client.rbs +144 -0
- data/sig/temporalio/internal/bridge/metric.rbs +28 -0
- data/sig/temporalio/internal/bridge/runtime.rbs +97 -0
- data/sig/temporalio/internal/bridge/testing.rbs +91 -0
- data/sig/temporalio/internal/bridge/worker.rbs +199 -0
- data/sig/temporalio/internal/bridge.rbs +36 -0
- data/sig/temporalio/internal/client/implementation.rbs +33 -0
- data/sig/temporalio/internal/google_protobuf.rbs +7 -0
- data/sig/temporalio/internal/metric.rbs +35 -0
- data/sig/temporalio/internal/proto_utils.rbs +94 -0
- data/sig/temporalio/internal/worker/activity_worker.rbs +64 -0
- data/sig/temporalio/internal/worker/multi_runner.rbs +132 -0
- data/sig/temporalio/internal/worker/workflow_instance/child_workflow_handle.rbs +22 -0
- data/sig/temporalio/internal/worker/workflow_instance/context.rbs +172 -0
- data/sig/temporalio/internal/worker/workflow_instance/details.rbs +43 -0
- data/sig/temporalio/internal/worker/workflow_instance/external_workflow_handle.rbs +15 -0
- data/sig/temporalio/internal/worker/workflow_instance/externally_immutable_hash.rbs +16 -0
- data/sig/temporalio/internal/worker/workflow_instance/handler_execution.rbs +19 -0
- data/sig/temporalio/internal/worker/workflow_instance/handler_hash.rbs +14 -0
- data/sig/temporalio/internal/worker/workflow_instance/illegal_call_tracer.rbs +20 -0
- data/sig/temporalio/internal/worker/workflow_instance/inbound_implementation.rbs +19 -0
- data/sig/temporalio/internal/worker/workflow_instance/nexus_client.rbs +25 -0
- data/sig/temporalio/internal/worker/workflow_instance/nexus_operation_handle.rbs +19 -0
- data/sig/temporalio/internal/worker/workflow_instance/outbound_implementation.rbs +35 -0
- data/sig/temporalio/internal/worker/workflow_instance/replay_safe_logger.rbs +16 -0
- data/sig/temporalio/internal/worker/workflow_instance/replay_safe_metric.rbs +15 -0
- data/sig/temporalio/internal/worker/workflow_instance/scheduler.rbs +52 -0
- data/sig/temporalio/internal/worker/workflow_instance.rbs +111 -0
- data/sig/temporalio/internal/worker/workflow_worker.rbs +99 -0
- data/sig/temporalio/internal/workflow_task_failure_error.rbs +6 -0
- data/sig/temporalio/internal.rbs +4 -0
- data/sig/temporalio/metric.rbs +55 -0
- data/sig/temporalio/priority.rbs +17 -0
- data/sig/temporalio/retry_policy.rbs +21 -0
- data/sig/temporalio/runtime/metric_buffer.rbs +49 -0
- data/sig/temporalio/runtime.rbs +118 -0
- data/sig/temporalio/scoped_logger.rbs +15 -0
- data/sig/temporalio/search_attributes.rbs +82 -0
- data/sig/temporalio/simple_plugin.rbs +65 -0
- data/sig/temporalio/testing/activity_environment.rbs +52 -0
- data/sig/temporalio/testing/workflow_environment.rbs +141 -0
- data/sig/temporalio/testing.rbs +4 -0
- data/sig/temporalio/version.rbs +3 -0
- data/sig/temporalio/versioning_override.rbs +17 -0
- data/sig/temporalio/worker/activity_executor/fiber.rbs +9 -0
- data/sig/temporalio/worker/activity_executor/thread_pool.rbs +11 -0
- data/sig/temporalio/worker/activity_executor.rbs +12 -0
- data/sig/temporalio/worker/deployment_options.rbs +17 -0
- data/sig/temporalio/worker/illegal_workflow_call_validator.rbs +25 -0
- data/sig/temporalio/worker/interceptor.rbs +373 -0
- data/sig/temporalio/worker/plugin.rbs +47 -0
- data/sig/temporalio/worker/poller_behavior.rbs +23 -0
- data/sig/temporalio/worker/thread_pool.rbs +44 -0
- data/sig/temporalio/worker/tuner.rbs +121 -0
- data/sig/temporalio/worker/workflow_executor/thread_pool.rbs +58 -0
- data/sig/temporalio/worker/workflow_executor.rbs +15 -0
- data/sig/temporalio/worker/workflow_replayer.rbs +105 -0
- data/sig/temporalio/worker.rbs +168 -0
- data/sig/temporalio/worker_deployment_version.rbs +17 -0
- data/sig/temporalio/workflow/activity_cancellation_type.rbs +11 -0
- data/sig/temporalio/workflow/child_workflow_cancellation_type.rbs +12 -0
- data/sig/temporalio/workflow/child_workflow_handle.rbs +18 -0
- data/sig/temporalio/workflow/definition.rbs +181 -0
- data/sig/temporalio/workflow/external_workflow_handle.rbs +17 -0
- data/sig/temporalio/workflow/future.rbs +24 -0
- data/sig/temporalio/workflow/handler_unfinished_policy.rbs +10 -0
- data/sig/temporalio/workflow/info.rbs +79 -0
- data/sig/temporalio/workflow/nexus_client.rbs +34 -0
- data/sig/temporalio/workflow/nexus_operation_cancellation_type.rbs +12 -0
- data/sig/temporalio/workflow/nexus_operation_handle.rbs +10 -0
- data/sig/temporalio/workflow/parent_close_policy.rbs +12 -0
- data/sig/temporalio/workflow/update_info.rbs +15 -0
- data/sig/temporalio/workflow.rbs +215 -0
- data/sig/temporalio/workflow_history.rbs +13 -0
- data/sig/temporalio.rbs +3 -0
- data/temporalio.gemspec +1 -1
- metadata +445 -2
|
@@ -0,0 +1,1571 @@
|
|
|
1
|
+
# Code generated by protoc-gen-rbi. DO NOT EDIT.
|
|
2
|
+
# source: temporal/api/workflowservice/v1/service.proto
|
|
3
|
+
# typed: strict
|
|
4
|
+
|
|
5
|
+
module Temporalio::Api::WorkflowService::V1::WorkflowService
|
|
6
|
+
class Service
|
|
7
|
+
include ::GRPC::GenericService
|
|
8
|
+
end
|
|
9
|
+
|
|
10
|
+
class Stub < ::GRPC::ClientStub
|
|
11
|
+
sig do
|
|
12
|
+
params(
|
|
13
|
+
host: String,
|
|
14
|
+
creds: T.any(::GRPC::Core::ChannelCredentials, Symbol),
|
|
15
|
+
kw: T.untyped,
|
|
16
|
+
).void
|
|
17
|
+
end
|
|
18
|
+
def initialize(host, creds, **kw)
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# RegisterNamespace creates a new namespace which can be used as a container for all resources.
|
|
22
|
+
#
|
|
23
|
+
# A Namespace is a top level entity within Temporal, and is used as a container for resources
|
|
24
|
+
# like workflow executions, task queues, etc. A Namespace acts as a sandbox and provides
|
|
25
|
+
# isolation for all resources within the namespace. All resources belongs to exactly one
|
|
26
|
+
# namespace.
|
|
27
|
+
sig do
|
|
28
|
+
params(
|
|
29
|
+
request: Temporalio::Api::WorkflowService::V1::RegisterNamespaceRequest
|
|
30
|
+
).returns(Temporalio::Api::WorkflowService::V1::RegisterNamespaceResponse)
|
|
31
|
+
end
|
|
32
|
+
def register_namespace(request)
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# DescribeNamespace returns the information and configuration for a registered namespace.
|
|
36
|
+
sig do
|
|
37
|
+
params(
|
|
38
|
+
request: Temporalio::Api::WorkflowService::V1::DescribeNamespaceRequest
|
|
39
|
+
).returns(Temporalio::Api::WorkflowService::V1::DescribeNamespaceResponse)
|
|
40
|
+
end
|
|
41
|
+
def describe_namespace(request)
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# ListNamespaces returns the information and configuration for all namespaces.
|
|
45
|
+
sig do
|
|
46
|
+
params(
|
|
47
|
+
request: Temporalio::Api::WorkflowService::V1::ListNamespacesRequest
|
|
48
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListNamespacesResponse)
|
|
49
|
+
end
|
|
50
|
+
def list_namespaces(request)
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
# UpdateNamespace is used to update the information and configuration of a registered
|
|
54
|
+
# namespace.
|
|
55
|
+
sig do
|
|
56
|
+
params(
|
|
57
|
+
request: Temporalio::Api::WorkflowService::V1::UpdateNamespaceRequest
|
|
58
|
+
).returns(Temporalio::Api::WorkflowService::V1::UpdateNamespaceResponse)
|
|
59
|
+
end
|
|
60
|
+
def update_namespace(request)
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# DeprecateNamespace is used to update the state of a registered namespace to DEPRECATED.
|
|
64
|
+
#
|
|
65
|
+
# Once the namespace is deprecated it cannot be used to start new workflow executions. Existing
|
|
66
|
+
# workflow executions will continue to run on deprecated namespaces.
|
|
67
|
+
# Deprecated.
|
|
68
|
+
#
|
|
69
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
70
|
+
# aip.dev/not-precedent: Deprecated --)
|
|
71
|
+
sig do
|
|
72
|
+
params(
|
|
73
|
+
request: Temporalio::Api::WorkflowService::V1::DeprecateNamespaceRequest
|
|
74
|
+
).returns(Temporalio::Api::WorkflowService::V1::DeprecateNamespaceResponse)
|
|
75
|
+
end
|
|
76
|
+
def deprecate_namespace(request)
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# StartWorkflowExecution starts a new workflow execution.
|
|
80
|
+
#
|
|
81
|
+
# It will create the execution with a `WORKFLOW_EXECUTION_STARTED` event in its history and
|
|
82
|
+
# also schedule the first workflow task. Returns `WorkflowExecutionAlreadyStarted`, if an
|
|
83
|
+
# instance already exists with same workflow id.
|
|
84
|
+
sig do
|
|
85
|
+
params(
|
|
86
|
+
request: Temporalio::Api::WorkflowService::V1::StartWorkflowExecutionRequest
|
|
87
|
+
).returns(Temporalio::Api::WorkflowService::V1::StartWorkflowExecutionResponse)
|
|
88
|
+
end
|
|
89
|
+
def start_workflow_execution(request)
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# ExecuteMultiOperation executes multiple operations within a single workflow.
|
|
93
|
+
#
|
|
94
|
+
# Operations are started atomically, meaning if *any* operation fails to be started, none are,
|
|
95
|
+
# and the request fails. Upon start, the API returns only when *all* operations have a response.
|
|
96
|
+
#
|
|
97
|
+
# Upon failure, it returns `MultiOperationExecutionFailure` where the status code
|
|
98
|
+
# equals the status code of the *first* operation that failed to be started.
|
|
99
|
+
#
|
|
100
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
101
|
+
# aip.dev/not-precedent: To be exposed over HTTP in the future. --)
|
|
102
|
+
sig do
|
|
103
|
+
params(
|
|
104
|
+
request: Temporalio::Api::WorkflowService::V1::ExecuteMultiOperationRequest
|
|
105
|
+
).returns(Temporalio::Api::WorkflowService::V1::ExecuteMultiOperationResponse)
|
|
106
|
+
end
|
|
107
|
+
def execute_multi_operation(request)
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# GetWorkflowExecutionHistory returns the history of specified workflow execution. Fails with
|
|
111
|
+
# `NotFound` if the specified workflow execution is unknown to the service.
|
|
112
|
+
sig do
|
|
113
|
+
params(
|
|
114
|
+
request: Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryRequest
|
|
115
|
+
).returns(Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryResponse)
|
|
116
|
+
end
|
|
117
|
+
def get_workflow_execution_history(request)
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# GetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse
|
|
121
|
+
# order (starting from last event). Fails with`NotFound` if the specified workflow execution is
|
|
122
|
+
# unknown to the service.
|
|
123
|
+
sig do
|
|
124
|
+
params(
|
|
125
|
+
request: Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryReverseRequest
|
|
126
|
+
).returns(Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryReverseResponse)
|
|
127
|
+
end
|
|
128
|
+
def get_workflow_execution_history_reverse(request)
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
# PollWorkflowTaskQueue is called by workers to make progress on workflows.
|
|
132
|
+
#
|
|
133
|
+
# A WorkflowTask is dispatched to callers for active workflow executions with pending workflow
|
|
134
|
+
# tasks. The worker is expected to call `RespondWorkflowTaskCompleted` when it is done
|
|
135
|
+
# processing the task. The service will create a `WorkflowTaskStarted` event in the history for
|
|
136
|
+
# this task before handing it to the worker.
|
|
137
|
+
#
|
|
138
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
139
|
+
# aip.dev/not-precedent: We do not expose worker API to HTTP. --)
|
|
140
|
+
sig do
|
|
141
|
+
params(
|
|
142
|
+
request: Temporalio::Api::WorkflowService::V1::PollWorkflowTaskQueueRequest
|
|
143
|
+
).returns(Temporalio::Api::WorkflowService::V1::PollWorkflowTaskQueueResponse)
|
|
144
|
+
end
|
|
145
|
+
def poll_workflow_task_queue(request)
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# RespondWorkflowTaskCompleted is called by workers to successfully complete workflow tasks
|
|
149
|
+
# they received from `PollWorkflowTaskQueue`.
|
|
150
|
+
#
|
|
151
|
+
# Completing a WorkflowTask will write a `WORKFLOW_TASK_COMPLETED` event to the workflow's
|
|
152
|
+
# history, along with events corresponding to whatever commands the SDK generated while
|
|
153
|
+
# executing the task (ex timer started, activity task scheduled, etc).
|
|
154
|
+
#
|
|
155
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
156
|
+
# aip.dev/not-precedent: We do not expose worker API to HTTP. --)
|
|
157
|
+
sig do
|
|
158
|
+
params(
|
|
159
|
+
request: Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskCompletedRequest
|
|
160
|
+
).returns(Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskCompletedResponse)
|
|
161
|
+
end
|
|
162
|
+
def respond_workflow_task_completed(request)
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# RespondWorkflowTaskFailed is called by workers to indicate the processing of a workflow task
|
|
166
|
+
# failed.
|
|
167
|
+
#
|
|
168
|
+
# This results in a `WORKFLOW_TASK_FAILED` event written to the history, and a new workflow
|
|
169
|
+
# task will be scheduled. This API can be used to report unhandled failures resulting from
|
|
170
|
+
# applying the workflow task.
|
|
171
|
+
#
|
|
172
|
+
# Temporal will only append first WorkflowTaskFailed event to the history of workflow execution
|
|
173
|
+
# for consecutive failures.
|
|
174
|
+
#
|
|
175
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
176
|
+
# aip.dev/not-precedent: We do not expose worker API to HTTP. --)
|
|
177
|
+
sig do
|
|
178
|
+
params(
|
|
179
|
+
request: Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskFailedRequest
|
|
180
|
+
).returns(Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskFailedResponse)
|
|
181
|
+
end
|
|
182
|
+
def respond_workflow_task_failed(request)
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
# PollActivityTaskQueue is called by workers to process activity tasks from a specific task
|
|
186
|
+
# queue.
|
|
187
|
+
#
|
|
188
|
+
# The worker is expected to call one of the `RespondActivityTaskXXX` methods when it is done
|
|
189
|
+
# processing the task.
|
|
190
|
+
#
|
|
191
|
+
# An activity task is dispatched whenever a `SCHEDULE_ACTIVITY_TASK` command is produced during
|
|
192
|
+
# workflow execution. An in memory `ACTIVITY_TASK_STARTED` event is written to mutable state
|
|
193
|
+
# before the task is dispatched to the worker. The started event, and the final event
|
|
194
|
+
# (`ACTIVITY_TASK_COMPLETED` / `ACTIVITY_TASK_FAILED` / `ACTIVITY_TASK_TIMED_OUT`) will both be
|
|
195
|
+
# written permanently to Workflow execution history when Activity is finished. This is done to
|
|
196
|
+
# avoid writing many events in the case of a failure/retry loop.
|
|
197
|
+
#
|
|
198
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
199
|
+
# aip.dev/not-precedent: We do not expose worker API to HTTP. --)
|
|
200
|
+
sig do
|
|
201
|
+
params(
|
|
202
|
+
request: Temporalio::Api::WorkflowService::V1::PollActivityTaskQueueRequest
|
|
203
|
+
).returns(Temporalio::Api::WorkflowService::V1::PollActivityTaskQueueResponse)
|
|
204
|
+
end
|
|
205
|
+
def poll_activity_task_queue(request)
|
|
206
|
+
end
|
|
207
|
+
|
|
208
|
+
# RecordActivityTaskHeartbeat is optionally called by workers while they execute activities.
|
|
209
|
+
#
|
|
210
|
+
# If a worker fails to heartbeat within the `heartbeat_timeout` interval for the activity task,
|
|
211
|
+
# then the current attempt times out. Depending on RetryPolicy, this may trigger a retry or
|
|
212
|
+
# time out the activity.
|
|
213
|
+
#
|
|
214
|
+
# For workflow activities, an `ACTIVITY_TASK_TIMED_OUT` event will be written to the workflow
|
|
215
|
+
# history. Calling `RecordActivityTaskHeartbeat` will fail with `NotFound` in such situations,
|
|
216
|
+
# in that event, the SDK should request cancellation of the activity.
|
|
217
|
+
#
|
|
218
|
+
# The request may contain response `details` which will be persisted by the server and may be
|
|
219
|
+
# used by the activity to checkpoint progress. The `cancel_requested` field in the response
|
|
220
|
+
# indicates whether cancellation has been requested for the activity.
|
|
221
|
+
sig do
|
|
222
|
+
params(
|
|
223
|
+
request: Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatRequest
|
|
224
|
+
).returns(Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatResponse)
|
|
225
|
+
end
|
|
226
|
+
def record_activity_task_heartbeat(request)
|
|
227
|
+
end
|
|
228
|
+
|
|
229
|
+
# See `RecordActivityTaskHeartbeat`. This version allows clients to record heartbeats by
|
|
230
|
+
# namespace/workflow id/activity id instead of task token.
|
|
231
|
+
#
|
|
232
|
+
# (-- api-linter: core::0136::prepositions=disabled
|
|
233
|
+
# aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
234
|
+
sig do
|
|
235
|
+
params(
|
|
236
|
+
request: Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatByIdRequest
|
|
237
|
+
).returns(Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatByIdResponse)
|
|
238
|
+
end
|
|
239
|
+
def record_activity_task_heartbeat_by_id(request)
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
# RespondActivityTaskCompleted is called by workers when they successfully complete an activity
|
|
243
|
+
# task.
|
|
244
|
+
#
|
|
245
|
+
# For workflow activities, this results in a new `ACTIVITY_TASK_COMPLETED` event being written to the workflow history
|
|
246
|
+
# and a new workflow task created for the workflow. Fails with `NotFound` if the task token is
|
|
247
|
+
# no longer valid due to activity timeout, already being completed, or never having existed.
|
|
248
|
+
sig do
|
|
249
|
+
params(
|
|
250
|
+
request: Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedRequest
|
|
251
|
+
).returns(Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedResponse)
|
|
252
|
+
end
|
|
253
|
+
def respond_activity_task_completed(request)
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
# See `RespondActivityTaskCompleted`. This version allows clients to record completions by
|
|
257
|
+
# namespace/workflow id/activity id instead of task token.
|
|
258
|
+
#
|
|
259
|
+
# (-- api-linter: core::0136::prepositions=disabled
|
|
260
|
+
# aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
261
|
+
sig do
|
|
262
|
+
params(
|
|
263
|
+
request: Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedByIdRequest
|
|
264
|
+
).returns(Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedByIdResponse)
|
|
265
|
+
end
|
|
266
|
+
def respond_activity_task_completed_by_id(request)
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
# RespondActivityTaskFailed is called by workers when processing an activity task fails.
|
|
270
|
+
#
|
|
271
|
+
# This results in a new `ACTIVITY_TASK_FAILED` event being written to the workflow history and
|
|
272
|
+
# a new workflow task created for the workflow. Fails with `NotFound` if the task token is no
|
|
273
|
+
# longer valid due to activity timeout, already being completed, or never having existed.
|
|
274
|
+
sig do
|
|
275
|
+
params(
|
|
276
|
+
request: Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedRequest
|
|
277
|
+
).returns(Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedResponse)
|
|
278
|
+
end
|
|
279
|
+
def respond_activity_task_failed(request)
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
# See `RecordActivityTaskFailed`. This version allows clients to record failures by
|
|
283
|
+
# namespace/workflow id/activity id instead of task token.
|
|
284
|
+
#
|
|
285
|
+
# (-- api-linter: core::0136::prepositions=disabled
|
|
286
|
+
# aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
287
|
+
sig do
|
|
288
|
+
params(
|
|
289
|
+
request: Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedByIdRequest
|
|
290
|
+
).returns(Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedByIdResponse)
|
|
291
|
+
end
|
|
292
|
+
def respond_activity_task_failed_by_id(request)
|
|
293
|
+
end
|
|
294
|
+
|
|
295
|
+
# RespondActivityTaskFailed is called by workers when processing an activity task fails.
|
|
296
|
+
#
|
|
297
|
+
# For workflow activities, this results in a new `ACTIVITY_TASK_CANCELED` event being written to the workflow history
|
|
298
|
+
# and a new workflow task created for the workflow. Fails with `NotFound` if the task token is
|
|
299
|
+
# no longer valid due to activity timeout, already being completed, or never having existed.
|
|
300
|
+
sig do
|
|
301
|
+
params(
|
|
302
|
+
request: Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledRequest
|
|
303
|
+
).returns(Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledResponse)
|
|
304
|
+
end
|
|
305
|
+
def respond_activity_task_canceled(request)
|
|
306
|
+
end
|
|
307
|
+
|
|
308
|
+
# See `RespondActivityTaskCanceled`. This version allows clients to record failures by
|
|
309
|
+
# namespace/workflow id/activity id instead of task token.
|
|
310
|
+
#
|
|
311
|
+
# (-- api-linter: core::0136::prepositions=disabled
|
|
312
|
+
# aip.dev/not-precedent: "By" is used to indicate request type. --)
|
|
313
|
+
sig do
|
|
314
|
+
params(
|
|
315
|
+
request: Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledByIdRequest
|
|
316
|
+
).returns(Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledByIdResponse)
|
|
317
|
+
end
|
|
318
|
+
def respond_activity_task_canceled_by_id(request)
|
|
319
|
+
end
|
|
320
|
+
|
|
321
|
+
# RequestCancelWorkflowExecution is called by workers when they want to request cancellation of
|
|
322
|
+
# a workflow execution.
|
|
323
|
+
#
|
|
324
|
+
# This results in a new `WORKFLOW_EXECUTION_CANCEL_REQUESTED` event being written to the
|
|
325
|
+
# workflow history and a new workflow task created for the workflow. It returns success if the requested
|
|
326
|
+
# workflow is already closed. It fails with 'NotFound' if the requested workflow doesn't exist.
|
|
327
|
+
sig do
|
|
328
|
+
params(
|
|
329
|
+
request: Temporalio::Api::WorkflowService::V1::RequestCancelWorkflowExecutionRequest
|
|
330
|
+
).returns(Temporalio::Api::WorkflowService::V1::RequestCancelWorkflowExecutionResponse)
|
|
331
|
+
end
|
|
332
|
+
def request_cancel_workflow_execution(request)
|
|
333
|
+
end
|
|
334
|
+
|
|
335
|
+
# SignalWorkflowExecution is used to send a signal to a running workflow execution.
|
|
336
|
+
#
|
|
337
|
+
# This results in a `WORKFLOW_EXECUTION_SIGNALED` event recorded in the history and a workflow
|
|
338
|
+
# task being created for the execution.
|
|
339
|
+
sig do
|
|
340
|
+
params(
|
|
341
|
+
request: Temporalio::Api::WorkflowService::V1::SignalWorkflowExecutionRequest
|
|
342
|
+
).returns(Temporalio::Api::WorkflowService::V1::SignalWorkflowExecutionResponse)
|
|
343
|
+
end
|
|
344
|
+
def signal_workflow_execution(request)
|
|
345
|
+
end
|
|
346
|
+
|
|
347
|
+
# SignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if
|
|
348
|
+
# it isn't yet started.
|
|
349
|
+
#
|
|
350
|
+
# If the workflow is running, a `WORKFLOW_EXECUTION_SIGNALED` event is recorded in the history
|
|
351
|
+
# and a workflow task is generated.
|
|
352
|
+
#
|
|
353
|
+
# If the workflow is not running or not found, then the workflow is created with
|
|
354
|
+
# `WORKFLOW_EXECUTION_STARTED` and `WORKFLOW_EXECUTION_SIGNALED` events in its history, and a
|
|
355
|
+
# workflow task is generated.
|
|
356
|
+
#
|
|
357
|
+
# (-- api-linter: core::0136::prepositions=disabled
|
|
358
|
+
# aip.dev/not-precedent: "With" is used to indicate combined operation. --)
|
|
359
|
+
sig do
|
|
360
|
+
params(
|
|
361
|
+
request: Temporalio::Api::WorkflowService::V1::SignalWithStartWorkflowExecutionRequest
|
|
362
|
+
).returns(Temporalio::Api::WorkflowService::V1::SignalWithStartWorkflowExecutionResponse)
|
|
363
|
+
end
|
|
364
|
+
def signal_with_start_workflow_execution(request)
|
|
365
|
+
end
|
|
366
|
+
|
|
367
|
+
# ResetWorkflowExecution will reset an existing workflow execution to a specified
|
|
368
|
+
# `WORKFLOW_TASK_COMPLETED` event (exclusive). It will immediately terminate the current
|
|
369
|
+
# execution instance. "Exclusive" means the identified completed event itself is not replayed
|
|
370
|
+
# in the reset history; the preceding `WORKFLOW_TASK_STARTED` event remains and will be marked as failed
|
|
371
|
+
# immediately, and a new workflow task will be scheduled to retry it.
|
|
372
|
+
sig do
|
|
373
|
+
params(
|
|
374
|
+
request: Temporalio::Api::WorkflowService::V1::ResetWorkflowExecutionRequest
|
|
375
|
+
).returns(Temporalio::Api::WorkflowService::V1::ResetWorkflowExecutionResponse)
|
|
376
|
+
end
|
|
377
|
+
def reset_workflow_execution(request)
|
|
378
|
+
end
|
|
379
|
+
|
|
380
|
+
# TerminateWorkflowExecution terminates an existing workflow execution by recording a
|
|
381
|
+
# `WORKFLOW_EXECUTION_TERMINATED` event in the history and immediately terminating the
|
|
382
|
+
# execution instance.
|
|
383
|
+
sig do
|
|
384
|
+
params(
|
|
385
|
+
request: Temporalio::Api::WorkflowService::V1::TerminateWorkflowExecutionRequest
|
|
386
|
+
).returns(Temporalio::Api::WorkflowService::V1::TerminateWorkflowExecutionResponse)
|
|
387
|
+
end
|
|
388
|
+
def terminate_workflow_execution(request)
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
# DeleteWorkflowExecution asynchronously deletes a specific Workflow Execution (when
|
|
392
|
+
# WorkflowExecution.run_id is provided) or the latest Workflow Execution (when
|
|
393
|
+
# WorkflowExecution.run_id is not provided). If the Workflow Execution is Running, it will be
|
|
394
|
+
# terminated before deletion.
|
|
395
|
+
#
|
|
396
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
397
|
+
# aip.dev/not-precedent: Workflow deletion not exposed to HTTP, users should use cancel or terminate. --)
|
|
398
|
+
sig do
|
|
399
|
+
params(
|
|
400
|
+
request: Temporalio::Api::WorkflowService::V1::DeleteWorkflowExecutionRequest
|
|
401
|
+
).returns(Temporalio::Api::WorkflowService::V1::DeleteWorkflowExecutionResponse)
|
|
402
|
+
end
|
|
403
|
+
def delete_workflow_execution(request)
|
|
404
|
+
end
|
|
405
|
+
|
|
406
|
+
# ListOpenWorkflowExecutions is a visibility API to list the open executions in a specific namespace.
|
|
407
|
+
#
|
|
408
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
409
|
+
# aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)
|
|
410
|
+
sig do
|
|
411
|
+
params(
|
|
412
|
+
request: Temporalio::Api::WorkflowService::V1::ListOpenWorkflowExecutionsRequest
|
|
413
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListOpenWorkflowExecutionsResponse)
|
|
414
|
+
end
|
|
415
|
+
def list_open_workflow_executions(request)
|
|
416
|
+
end
|
|
417
|
+
|
|
418
|
+
# ListClosedWorkflowExecutions is a visibility API to list the closed executions in a specific namespace.
|
|
419
|
+
#
|
|
420
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
421
|
+
# aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)
|
|
422
|
+
sig do
|
|
423
|
+
params(
|
|
424
|
+
request: Temporalio::Api::WorkflowService::V1::ListClosedWorkflowExecutionsRequest
|
|
425
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListClosedWorkflowExecutionsResponse)
|
|
426
|
+
end
|
|
427
|
+
def list_closed_workflow_executions(request)
|
|
428
|
+
end
|
|
429
|
+
|
|
430
|
+
# ListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.
|
|
431
|
+
sig do
|
|
432
|
+
params(
|
|
433
|
+
request: Temporalio::Api::WorkflowService::V1::ListWorkflowExecutionsRequest
|
|
434
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListWorkflowExecutionsResponse)
|
|
435
|
+
end
|
|
436
|
+
def list_workflow_executions(request)
|
|
437
|
+
end
|
|
438
|
+
|
|
439
|
+
# ListArchivedWorkflowExecutions is a visibility API to list archived workflow executions in a specific namespace.
|
|
440
|
+
sig do
|
|
441
|
+
params(
|
|
442
|
+
request: Temporalio::Api::WorkflowService::V1::ListArchivedWorkflowExecutionsRequest
|
|
443
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListArchivedWorkflowExecutionsResponse)
|
|
444
|
+
end
|
|
445
|
+
def list_archived_workflow_executions(request)
|
|
446
|
+
end
|
|
447
|
+
|
|
448
|
+
# ScanWorkflowExecutions _was_ a visibility API to list large amount of workflow executions in a specific namespace without order.
|
|
449
|
+
# It has since been deprecated in favor of `ListWorkflowExecutions` and rewritten to use `ListWorkflowExecutions` internally.
|
|
450
|
+
#
|
|
451
|
+
# Deprecated: Replaced with `ListWorkflowExecutions`.
|
|
452
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
453
|
+
# aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)
|
|
454
|
+
sig do
|
|
455
|
+
params(
|
|
456
|
+
request: Temporalio::Api::WorkflowService::V1::ScanWorkflowExecutionsRequest
|
|
457
|
+
).returns(Temporalio::Api::WorkflowService::V1::ScanWorkflowExecutionsResponse)
|
|
458
|
+
end
|
|
459
|
+
def scan_workflow_executions(request)
|
|
460
|
+
end
|
|
461
|
+
|
|
462
|
+
# CountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.
|
|
463
|
+
sig do
|
|
464
|
+
params(
|
|
465
|
+
request: Temporalio::Api::WorkflowService::V1::CountWorkflowExecutionsRequest
|
|
466
|
+
).returns(Temporalio::Api::WorkflowService::V1::CountWorkflowExecutionsResponse)
|
|
467
|
+
end
|
|
468
|
+
def count_workflow_executions(request)
|
|
469
|
+
end
|
|
470
|
+
|
|
471
|
+
# GetSearchAttributes is a visibility API to get all legal keys that could be used in list APIs
|
|
472
|
+
#
|
|
473
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
474
|
+
# aip.dev/not-precedent: We do not expose this search attribute API to HTTP (but may expose on OperatorService). --)
|
|
475
|
+
sig do
|
|
476
|
+
params(
|
|
477
|
+
request: Temporalio::Api::WorkflowService::V1::GetSearchAttributesRequest
|
|
478
|
+
).returns(Temporalio::Api::WorkflowService::V1::GetSearchAttributesResponse)
|
|
479
|
+
end
|
|
480
|
+
def get_search_attributes(request)
|
|
481
|
+
end
|
|
482
|
+
|
|
483
|
+
# RespondQueryTaskCompleted is called by workers to complete queries which were delivered on
|
|
484
|
+
# the `query` (not `queries`) field of a `PollWorkflowTaskQueueResponse`.
|
|
485
|
+
#
|
|
486
|
+
# Completing the query will unblock the corresponding client call to `QueryWorkflow` and return
|
|
487
|
+
# the query result a response.
|
|
488
|
+
#
|
|
489
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
490
|
+
# aip.dev/not-precedent: We do not expose worker API to HTTP. --)
|
|
491
|
+
sig do
|
|
492
|
+
params(
|
|
493
|
+
request: Temporalio::Api::WorkflowService::V1::RespondQueryTaskCompletedRequest
|
|
494
|
+
).returns(Temporalio::Api::WorkflowService::V1::RespondQueryTaskCompletedResponse)
|
|
495
|
+
end
|
|
496
|
+
def respond_query_task_completed(request)
|
|
497
|
+
end
|
|
498
|
+
|
|
499
|
+
# ResetStickyTaskQueue resets the sticky task queue related information in the mutable state of
|
|
500
|
+
# a given workflow. This is prudent for workers to perform if a workflow has been paged out of
|
|
501
|
+
# their cache.
|
|
502
|
+
#
|
|
503
|
+
# Things cleared are:
|
|
504
|
+
# 1. StickyTaskQueue
|
|
505
|
+
# 2. StickyScheduleToStartTimeout
|
|
506
|
+
#
|
|
507
|
+
# When possible, ShutdownWorker should be preferred over
|
|
508
|
+
# ResetStickyTaskQueue (particularly when a worker is shutting down or
|
|
509
|
+
# cycling).
|
|
510
|
+
#
|
|
511
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
512
|
+
# aip.dev/not-precedent: We do not expose worker API to HTTP. --)
|
|
513
|
+
sig do
|
|
514
|
+
params(
|
|
515
|
+
request: Temporalio::Api::WorkflowService::V1::ResetStickyTaskQueueRequest
|
|
516
|
+
).returns(Temporalio::Api::WorkflowService::V1::ResetStickyTaskQueueResponse)
|
|
517
|
+
end
|
|
518
|
+
def reset_sticky_task_queue(request)
|
|
519
|
+
end
|
|
520
|
+
|
|
521
|
+
# ShutdownWorker is used to indicate that the given sticky task
|
|
522
|
+
# queue is no longer being polled by its worker. Following the completion of
|
|
523
|
+
# ShutdownWorker, newly-added workflow tasks will instead be placed
|
|
524
|
+
# in the normal task queue, eligible for any worker to pick up.
|
|
525
|
+
#
|
|
526
|
+
# ShutdownWorker should be called by workers while shutting down,
|
|
527
|
+
# after they've shut down their pollers. If another sticky poll
|
|
528
|
+
# request is issued, the sticky task queue will be revived.
|
|
529
|
+
#
|
|
530
|
+
# As of Temporal Server v1.25.0, ShutdownWorker hasn't yet been implemented.
|
|
531
|
+
#
|
|
532
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
533
|
+
# aip.dev/not-precedent: We do not expose worker API to HTTP. --)
|
|
534
|
+
sig do
|
|
535
|
+
params(
|
|
536
|
+
request: Temporalio::Api::WorkflowService::V1::ShutdownWorkerRequest
|
|
537
|
+
).returns(Temporalio::Api::WorkflowService::V1::ShutdownWorkerResponse)
|
|
538
|
+
end
|
|
539
|
+
def shutdown_worker(request)
|
|
540
|
+
end
|
|
541
|
+
|
|
542
|
+
# QueryWorkflow requests a query be executed for a specified workflow execution.
|
|
543
|
+
sig do
|
|
544
|
+
params(
|
|
545
|
+
request: Temporalio::Api::WorkflowService::V1::QueryWorkflowRequest
|
|
546
|
+
).returns(Temporalio::Api::WorkflowService::V1::QueryWorkflowResponse)
|
|
547
|
+
end
|
|
548
|
+
def query_workflow(request)
|
|
549
|
+
end
|
|
550
|
+
|
|
551
|
+
# DescribeWorkflowExecution returns information about the specified workflow execution.
|
|
552
|
+
sig do
|
|
553
|
+
params(
|
|
554
|
+
request: Temporalio::Api::WorkflowService::V1::DescribeWorkflowExecutionRequest
|
|
555
|
+
).returns(Temporalio::Api::WorkflowService::V1::DescribeWorkflowExecutionResponse)
|
|
556
|
+
end
|
|
557
|
+
def describe_workflow_execution(request)
|
|
558
|
+
end
|
|
559
|
+
|
|
560
|
+
# DescribeTaskQueue returns the following information about the target task queue, broken down by Build ID:
|
|
561
|
+
# - List of pollers
|
|
562
|
+
# - Workflow Reachability status
|
|
563
|
+
# - Backlog info for Workflow and/or Activity tasks
|
|
564
|
+
sig do
|
|
565
|
+
params(
|
|
566
|
+
request: Temporalio::Api::WorkflowService::V1::DescribeTaskQueueRequest
|
|
567
|
+
).returns(Temporalio::Api::WorkflowService::V1::DescribeTaskQueueResponse)
|
|
568
|
+
end
|
|
569
|
+
def describe_task_queue(request)
|
|
570
|
+
end
|
|
571
|
+
|
|
572
|
+
# GetClusterInfo returns information about temporal cluster
|
|
573
|
+
sig do
|
|
574
|
+
params(
|
|
575
|
+
request: Temporalio::Api::WorkflowService::V1::GetClusterInfoRequest
|
|
576
|
+
).returns(Temporalio::Api::WorkflowService::V1::GetClusterInfoResponse)
|
|
577
|
+
end
|
|
578
|
+
def get_cluster_info(request)
|
|
579
|
+
end
|
|
580
|
+
|
|
581
|
+
# GetSystemInfo returns information about the system.
|
|
582
|
+
sig do
|
|
583
|
+
params(
|
|
584
|
+
request: Temporalio::Api::WorkflowService::V1::GetSystemInfoRequest
|
|
585
|
+
).returns(Temporalio::Api::WorkflowService::V1::GetSystemInfoResponse)
|
|
586
|
+
end
|
|
587
|
+
def get_system_info(request)
|
|
588
|
+
end
|
|
589
|
+
|
|
590
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
591
|
+
# aip.dev/not-precedent: We do not expose this low-level API to HTTP. --)
|
|
592
|
+
sig do
|
|
593
|
+
params(
|
|
594
|
+
request: Temporalio::Api::WorkflowService::V1::ListTaskQueuePartitionsRequest
|
|
595
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListTaskQueuePartitionsResponse)
|
|
596
|
+
end
|
|
597
|
+
def list_task_queue_partitions(request)
|
|
598
|
+
end
|
|
599
|
+
|
|
600
|
+
# Creates a new schedule.
|
|
601
|
+
sig do
|
|
602
|
+
params(
|
|
603
|
+
request: Temporalio::Api::WorkflowService::V1::CreateScheduleRequest
|
|
604
|
+
).returns(Temporalio::Api::WorkflowService::V1::CreateScheduleResponse)
|
|
605
|
+
end
|
|
606
|
+
def create_schedule(request)
|
|
607
|
+
end
|
|
608
|
+
|
|
609
|
+
# Returns the schedule description and current state of an existing schedule.
|
|
610
|
+
sig do
|
|
611
|
+
params(
|
|
612
|
+
request: Temporalio::Api::WorkflowService::V1::DescribeScheduleRequest
|
|
613
|
+
).returns(Temporalio::Api::WorkflowService::V1::DescribeScheduleResponse)
|
|
614
|
+
end
|
|
615
|
+
def describe_schedule(request)
|
|
616
|
+
end
|
|
617
|
+
|
|
618
|
+
# Changes the configuration or state of an existing schedule.
|
|
619
|
+
sig do
|
|
620
|
+
params(
|
|
621
|
+
request: Temporalio::Api::WorkflowService::V1::UpdateScheduleRequest
|
|
622
|
+
).returns(Temporalio::Api::WorkflowService::V1::UpdateScheduleResponse)
|
|
623
|
+
end
|
|
624
|
+
def update_schedule(request)
|
|
625
|
+
end
|
|
626
|
+
|
|
627
|
+
# Makes a specific change to a schedule or triggers an immediate action.
|
|
628
|
+
sig do
|
|
629
|
+
params(
|
|
630
|
+
request: Temporalio::Api::WorkflowService::V1::PatchScheduleRequest
|
|
631
|
+
).returns(Temporalio::Api::WorkflowService::V1::PatchScheduleResponse)
|
|
632
|
+
end
|
|
633
|
+
def patch_schedule(request)
|
|
634
|
+
end
|
|
635
|
+
|
|
636
|
+
# Lists matching times within a range.
|
|
637
|
+
sig do
|
|
638
|
+
params(
|
|
639
|
+
request: Temporalio::Api::WorkflowService::V1::ListScheduleMatchingTimesRequest
|
|
640
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListScheduleMatchingTimesResponse)
|
|
641
|
+
end
|
|
642
|
+
def list_schedule_matching_times(request)
|
|
643
|
+
end
|
|
644
|
+
|
|
645
|
+
# Deletes a schedule, removing it from the system.
|
|
646
|
+
sig do
|
|
647
|
+
params(
|
|
648
|
+
request: Temporalio::Api::WorkflowService::V1::DeleteScheduleRequest
|
|
649
|
+
).returns(Temporalio::Api::WorkflowService::V1::DeleteScheduleResponse)
|
|
650
|
+
end
|
|
651
|
+
def delete_schedule(request)
|
|
652
|
+
end
|
|
653
|
+
|
|
654
|
+
# List all schedules in a namespace.
|
|
655
|
+
sig do
|
|
656
|
+
params(
|
|
657
|
+
request: Temporalio::Api::WorkflowService::V1::ListSchedulesRequest
|
|
658
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListSchedulesResponse)
|
|
659
|
+
end
|
|
660
|
+
def list_schedules(request)
|
|
661
|
+
end
|
|
662
|
+
|
|
663
|
+
# CountSchedules is a visibility API to count schedules in a specific namespace.
|
|
664
|
+
sig do
|
|
665
|
+
params(
|
|
666
|
+
request: Temporalio::Api::WorkflowService::V1::CountSchedulesRequest
|
|
667
|
+
).returns(Temporalio::Api::WorkflowService::V1::CountSchedulesResponse)
|
|
668
|
+
end
|
|
669
|
+
def count_schedules(request)
|
|
670
|
+
end
|
|
671
|
+
|
|
672
|
+
# Deprecated. Use `UpdateWorkerVersioningRules`.
|
|
673
|
+
# Will be removed in server version v1.32.0.
|
|
674
|
+
#
|
|
675
|
+
# Allows users to specify sets of worker build id versions on a per task queue basis. Versions
|
|
676
|
+
# are ordered, and may be either compatible with some extant version, or a new incompatible
|
|
677
|
+
# version, forming sets of ids which are incompatible with each other, but whose contained
|
|
678
|
+
# members are compatible with one another.
|
|
679
|
+
#
|
|
680
|
+
# A single build id may be mapped to multiple task queues using this API for cases where a single process hosts
|
|
681
|
+
# multiple workers.
|
|
682
|
+
#
|
|
683
|
+
# To query which workers can be retired, use the `GetWorkerTaskReachability` API.
|
|
684
|
+
#
|
|
685
|
+
# NOTE: The number of task queues mapped to a single build id is limited by the `limit.taskQueuesPerBuildId`
|
|
686
|
+
# (default is 20), if this limit is exceeded this API will error with a FailedPrecondition.
|
|
687
|
+
#
|
|
688
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
689
|
+
# aip.dev/not-precedent: We do yet expose versioning API to HTTP. --)
|
|
690
|
+
sig do
|
|
691
|
+
params(
|
|
692
|
+
request: Temporalio::Api::WorkflowService::V1::UpdateWorkerBuildIdCompatibilityRequest
|
|
693
|
+
).returns(Temporalio::Api::WorkflowService::V1::UpdateWorkerBuildIdCompatibilityResponse)
|
|
694
|
+
end
|
|
695
|
+
def update_worker_build_id_compatibility(request)
|
|
696
|
+
end
|
|
697
|
+
|
|
698
|
+
# Deprecated. Use `GetWorkerVersioningRules`.
|
|
699
|
+
# Will be removed in server version v1.32.0.
|
|
700
|
+
# Fetches the worker build id versioning sets for a task queue.
|
|
701
|
+
sig do
|
|
702
|
+
params(
|
|
703
|
+
request: Temporalio::Api::WorkflowService::V1::GetWorkerBuildIdCompatibilityRequest
|
|
704
|
+
).returns(Temporalio::Api::WorkflowService::V1::GetWorkerBuildIdCompatibilityResponse)
|
|
705
|
+
end
|
|
706
|
+
def get_worker_build_id_compatibility(request)
|
|
707
|
+
end
|
|
708
|
+
|
|
709
|
+
# Use this API to manage Worker Versioning Rules for a given Task Queue. There are two types of
|
|
710
|
+
# rules: Build ID Assignment rules and Compatible Build ID Redirect rules.
|
|
711
|
+
#
|
|
712
|
+
# Assignment rules determine how to assign new executions to a Build IDs. Their primary
|
|
713
|
+
# use case is to specify the latest Build ID but they have powerful features for gradual rollout
|
|
714
|
+
# of a new Build ID.
|
|
715
|
+
#
|
|
716
|
+
# Once a workflow execution is assigned to a Build ID and it completes its first Workflow Task,
|
|
717
|
+
# the workflow stays on the assigned Build ID regardless of changes in assignment rules. This
|
|
718
|
+
# eliminates the need for compatibility between versions when you only care about using the new
|
|
719
|
+
# version for new workflows and let existing workflows finish in their own version.
|
|
720
|
+
#
|
|
721
|
+
# Activities, Child Workflows and Continue-as-New executions have the option to inherit the
|
|
722
|
+
# Build ID of their parent/previous workflow or use the latest assignment rules to independently
|
|
723
|
+
# select a Build ID.
|
|
724
|
+
#
|
|
725
|
+
# Redirect rules should only be used when you want to move workflows and activities assigned to
|
|
726
|
+
# one Build ID (source) to another compatible Build ID (target). You are responsible to make sure
|
|
727
|
+
# the target Build ID of a redirect rule is able to process event histories made by the source
|
|
728
|
+
# Build ID by using [Patching](https://docs.temporal.io/workflows#patching) or other means.
|
|
729
|
+
#
|
|
730
|
+
# Will be removed in server version v1.32.0.
|
|
731
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
732
|
+
# aip.dev/not-precedent: We do yet expose versioning API to HTTP. --)
|
|
733
|
+
sig do
|
|
734
|
+
params(
|
|
735
|
+
request: Temporalio::Api::WorkflowService::V1::UpdateWorkerVersioningRulesRequest
|
|
736
|
+
).returns(Temporalio::Api::WorkflowService::V1::UpdateWorkerVersioningRulesResponse)
|
|
737
|
+
end
|
|
738
|
+
def update_worker_versioning_rules(request)
|
|
739
|
+
end
|
|
740
|
+
|
|
741
|
+
# Fetches the Build ID assignment and redirect rules for a Task Queue.
|
|
742
|
+
# Will be removed in server version v1.32.0.
|
|
743
|
+
sig do
|
|
744
|
+
params(
|
|
745
|
+
request: Temporalio::Api::WorkflowService::V1::GetWorkerVersioningRulesRequest
|
|
746
|
+
).returns(Temporalio::Api::WorkflowService::V1::GetWorkerVersioningRulesResponse)
|
|
747
|
+
end
|
|
748
|
+
def get_worker_versioning_rules(request)
|
|
749
|
+
end
|
|
750
|
+
|
|
751
|
+
# Deprecated. Use `DescribeTaskQueue`.
|
|
752
|
+
# Will be removed in server version v1.32.0.
|
|
753
|
+
#
|
|
754
|
+
# Fetches task reachability to determine whether a worker may be retired.
|
|
755
|
+
# The request may specify task queues to query for or let the server fetch all task queues mapped to the given
|
|
756
|
+
# build IDs.
|
|
757
|
+
#
|
|
758
|
+
# When requesting a large number of task queues or all task queues associated with the given build ids in a
|
|
759
|
+
# namespace, all task queues will be listed in the response but some of them may not contain reachability
|
|
760
|
+
# information due to a server enforced limit. When reaching the limit, task queues that reachability information
|
|
761
|
+
# could not be retrieved for will be marked with a single TASK_REACHABILITY_UNSPECIFIED entry. The caller may issue
|
|
762
|
+
# another call to get the reachability for those task queues.
|
|
763
|
+
#
|
|
764
|
+
# Open source users can adjust this limit by setting the server's dynamic config value for
|
|
765
|
+
# `limit.reachabilityTaskQueueScan` with the caveat that this call can strain the visibility store.
|
|
766
|
+
sig do
|
|
767
|
+
params(
|
|
768
|
+
request: Temporalio::Api::WorkflowService::V1::GetWorkerTaskReachabilityRequest
|
|
769
|
+
).returns(Temporalio::Api::WorkflowService::V1::GetWorkerTaskReachabilityResponse)
|
|
770
|
+
end
|
|
771
|
+
def get_worker_task_reachability(request)
|
|
772
|
+
end
|
|
773
|
+
|
|
774
|
+
# Describes a worker deployment.
|
|
775
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
776
|
+
# Deprecated. Replaced with `DescribeWorkerDeploymentVersion`.
|
|
777
|
+
sig do
|
|
778
|
+
params(
|
|
779
|
+
request: Temporalio::Api::WorkflowService::V1::DescribeDeploymentRequest
|
|
780
|
+
).returns(Temporalio::Api::WorkflowService::V1::DescribeDeploymentResponse)
|
|
781
|
+
end
|
|
782
|
+
def describe_deployment(request)
|
|
783
|
+
end
|
|
784
|
+
|
|
785
|
+
# Describes a worker deployment version.
|
|
786
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
787
|
+
sig do
|
|
788
|
+
params(
|
|
789
|
+
request: Temporalio::Api::WorkflowService::V1::DescribeWorkerDeploymentVersionRequest
|
|
790
|
+
).returns(Temporalio::Api::WorkflowService::V1::DescribeWorkerDeploymentVersionResponse)
|
|
791
|
+
end
|
|
792
|
+
def describe_worker_deployment_version(request)
|
|
793
|
+
end
|
|
794
|
+
|
|
795
|
+
# Lists worker deployments in the namespace. Optionally can filter based on deployment series
|
|
796
|
+
# name.
|
|
797
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
798
|
+
# Deprecated. Replaced with `ListWorkerDeployments`.
|
|
799
|
+
sig do
|
|
800
|
+
params(
|
|
801
|
+
request: Temporalio::Api::WorkflowService::V1::ListDeploymentsRequest
|
|
802
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListDeploymentsResponse)
|
|
803
|
+
end
|
|
804
|
+
def list_deployments(request)
|
|
805
|
+
end
|
|
806
|
+
|
|
807
|
+
# Returns the reachability level of a worker deployment to help users decide when it is time
|
|
808
|
+
# to decommission a deployment. Reachability level is calculated based on the deployment's
|
|
809
|
+
# `status` and existing workflows that depend on the given deployment for their execution.
|
|
810
|
+
# Calculating reachability is relatively expensive. Therefore, server might return a recently
|
|
811
|
+
# cached value. In such a case, the `last_update_time` will inform you about the actual
|
|
812
|
+
# reachability calculation time.
|
|
813
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
814
|
+
# Deprecated. Replaced with `DrainageInfo` returned by `DescribeWorkerDeploymentVersion`.
|
|
815
|
+
sig do
|
|
816
|
+
params(
|
|
817
|
+
request: Temporalio::Api::WorkflowService::V1::GetDeploymentReachabilityRequest
|
|
818
|
+
).returns(Temporalio::Api::WorkflowService::V1::GetDeploymentReachabilityResponse)
|
|
819
|
+
end
|
|
820
|
+
def get_deployment_reachability(request)
|
|
821
|
+
end
|
|
822
|
+
|
|
823
|
+
# Returns the current deployment (and its info) for a given deployment series.
|
|
824
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
825
|
+
# Deprecated. Replaced by `current_version` returned by `DescribeWorkerDeployment`.
|
|
826
|
+
sig do
|
|
827
|
+
params(
|
|
828
|
+
request: Temporalio::Api::WorkflowService::V1::GetCurrentDeploymentRequest
|
|
829
|
+
).returns(Temporalio::Api::WorkflowService::V1::GetCurrentDeploymentResponse)
|
|
830
|
+
end
|
|
831
|
+
def get_current_deployment(request)
|
|
832
|
+
end
|
|
833
|
+
|
|
834
|
+
# Sets a deployment as the current deployment for its deployment series. Can optionally update
|
|
835
|
+
# the metadata of the deployment as well.
|
|
836
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
837
|
+
# Deprecated. Replaced by `SetWorkerDeploymentCurrentVersion`.
|
|
838
|
+
sig do
|
|
839
|
+
params(
|
|
840
|
+
request: Temporalio::Api::WorkflowService::V1::SetCurrentDeploymentRequest
|
|
841
|
+
).returns(Temporalio::Api::WorkflowService::V1::SetCurrentDeploymentResponse)
|
|
842
|
+
end
|
|
843
|
+
def set_current_deployment(request)
|
|
844
|
+
end
|
|
845
|
+
|
|
846
|
+
# Set/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping
|
|
847
|
+
# Version if it is the Version being set as Current.
|
|
848
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
849
|
+
sig do
|
|
850
|
+
params(
|
|
851
|
+
request: Temporalio::Api::WorkflowService::V1::SetWorkerDeploymentCurrentVersionRequest
|
|
852
|
+
).returns(Temporalio::Api::WorkflowService::V1::SetWorkerDeploymentCurrentVersionResponse)
|
|
853
|
+
end
|
|
854
|
+
def set_worker_deployment_current_version(request)
|
|
855
|
+
end
|
|
856
|
+
|
|
857
|
+
# Describes a Worker Deployment.
|
|
858
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
859
|
+
sig do
|
|
860
|
+
params(
|
|
861
|
+
request: Temporalio::Api::WorkflowService::V1::DescribeWorkerDeploymentRequest
|
|
862
|
+
).returns(Temporalio::Api::WorkflowService::V1::DescribeWorkerDeploymentResponse)
|
|
863
|
+
end
|
|
864
|
+
def describe_worker_deployment(request)
|
|
865
|
+
end
|
|
866
|
+
|
|
867
|
+
# Deletes records of (an old) Deployment. A deployment can only be deleted if
|
|
868
|
+
# it has no Version in it.
|
|
869
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
870
|
+
sig do
|
|
871
|
+
params(
|
|
872
|
+
request: Temporalio::Api::WorkflowService::V1::DeleteWorkerDeploymentRequest
|
|
873
|
+
).returns(Temporalio::Api::WorkflowService::V1::DeleteWorkerDeploymentResponse)
|
|
874
|
+
end
|
|
875
|
+
def delete_worker_deployment(request)
|
|
876
|
+
end
|
|
877
|
+
|
|
878
|
+
# Used for manual deletion of Versions. User can delete a Version only when all the
|
|
879
|
+
# following conditions are met:
|
|
880
|
+
# - It is not the Current or Ramping Version of its Deployment.
|
|
881
|
+
# - It has no active pollers (none of the task queues in the Version have pollers)
|
|
882
|
+
# - It is not draining (see WorkerDeploymentVersionInfo.drainage_info). This condition
|
|
883
|
+
# can be skipped by passing `skip-drainage=true`.
|
|
884
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
885
|
+
sig do
|
|
886
|
+
params(
|
|
887
|
+
request: Temporalio::Api::WorkflowService::V1::DeleteWorkerDeploymentVersionRequest
|
|
888
|
+
).returns(Temporalio::Api::WorkflowService::V1::DeleteWorkerDeploymentVersionResponse)
|
|
889
|
+
end
|
|
890
|
+
def delete_worker_deployment_version(request)
|
|
891
|
+
end
|
|
892
|
+
|
|
893
|
+
# Set/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for
|
|
894
|
+
# gradual ramp to unversioned workers too.
|
|
895
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
896
|
+
sig do
|
|
897
|
+
params(
|
|
898
|
+
request: Temporalio::Api::WorkflowService::V1::SetWorkerDeploymentRampingVersionRequest
|
|
899
|
+
).returns(Temporalio::Api::WorkflowService::V1::SetWorkerDeploymentRampingVersionResponse)
|
|
900
|
+
end
|
|
901
|
+
def set_worker_deployment_ramping_version(request)
|
|
902
|
+
end
|
|
903
|
+
|
|
904
|
+
# Lists all Worker Deployments that are tracked in the Namespace.
|
|
905
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
906
|
+
sig do
|
|
907
|
+
params(
|
|
908
|
+
request: Temporalio::Api::WorkflowService::V1::ListWorkerDeploymentsRequest
|
|
909
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListWorkerDeploymentsResponse)
|
|
910
|
+
end
|
|
911
|
+
def list_worker_deployments(request)
|
|
912
|
+
end
|
|
913
|
+
|
|
914
|
+
# Creates a new Worker Deployment.
|
|
915
|
+
#
|
|
916
|
+
# Experimental. This API might significantly change or be removed in a
|
|
917
|
+
# future release.
|
|
918
|
+
sig do
|
|
919
|
+
params(
|
|
920
|
+
request: Temporalio::Api::WorkflowService::V1::CreateWorkerDeploymentRequest
|
|
921
|
+
).returns(Temporalio::Api::WorkflowService::V1::CreateWorkerDeploymentResponse)
|
|
922
|
+
end
|
|
923
|
+
def create_worker_deployment(request)
|
|
924
|
+
end
|
|
925
|
+
|
|
926
|
+
# Creates a new Worker Deployment Version.
|
|
927
|
+
#
|
|
928
|
+
# Experimental. This API might significantly change or be removed in a
|
|
929
|
+
# future release.
|
|
930
|
+
sig do
|
|
931
|
+
params(
|
|
932
|
+
request: Temporalio::Api::WorkflowService::V1::CreateWorkerDeploymentVersionRequest
|
|
933
|
+
).returns(Temporalio::Api::WorkflowService::V1::CreateWorkerDeploymentVersionResponse)
|
|
934
|
+
end
|
|
935
|
+
def create_worker_deployment_version(request)
|
|
936
|
+
end
|
|
937
|
+
|
|
938
|
+
# Updates the compute config attached to a Worker Deployment Version.
|
|
939
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
940
|
+
sig do
|
|
941
|
+
params(
|
|
942
|
+
request: Temporalio::Api::WorkflowService::V1::UpdateWorkerDeploymentVersionComputeConfigRequest
|
|
943
|
+
).returns(Temporalio::Api::WorkflowService::V1::UpdateWorkerDeploymentVersionComputeConfigResponse)
|
|
944
|
+
end
|
|
945
|
+
def update_worker_deployment_version_compute_config(request)
|
|
946
|
+
end
|
|
947
|
+
|
|
948
|
+
# Validates the compute config without attaching it to a Worker Deployment Version.
|
|
949
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
950
|
+
sig do
|
|
951
|
+
params(
|
|
952
|
+
request: Temporalio::Api::WorkflowService::V1::ValidateWorkerDeploymentVersionComputeConfigRequest
|
|
953
|
+
).returns(Temporalio::Api::WorkflowService::V1::ValidateWorkerDeploymentVersionComputeConfigResponse)
|
|
954
|
+
end
|
|
955
|
+
def validate_worker_deployment_version_compute_config(request)
|
|
956
|
+
end
|
|
957
|
+
|
|
958
|
+
# Updates the user-given metadata attached to a Worker Deployment Version.
|
|
959
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
960
|
+
sig do
|
|
961
|
+
params(
|
|
962
|
+
request: Temporalio::Api::WorkflowService::V1::UpdateWorkerDeploymentVersionMetadataRequest
|
|
963
|
+
).returns(Temporalio::Api::WorkflowService::V1::UpdateWorkerDeploymentVersionMetadataResponse)
|
|
964
|
+
end
|
|
965
|
+
def update_worker_deployment_version_metadata(request)
|
|
966
|
+
end
|
|
967
|
+
|
|
968
|
+
# Set/unset the ManagerIdentity of a Worker Deployment.
|
|
969
|
+
# Experimental. This API might significantly change or be removed in a future release.
|
|
970
|
+
sig do
|
|
971
|
+
params(
|
|
972
|
+
request: Temporalio::Api::WorkflowService::V1::SetWorkerDeploymentManagerRequest
|
|
973
|
+
).returns(Temporalio::Api::WorkflowService::V1::SetWorkerDeploymentManagerResponse)
|
|
974
|
+
end
|
|
975
|
+
def set_worker_deployment_manager(request)
|
|
976
|
+
end
|
|
977
|
+
|
|
978
|
+
# Invokes the specified Update function on user Workflow code.
|
|
979
|
+
sig do
|
|
980
|
+
params(
|
|
981
|
+
request: Temporalio::Api::WorkflowService::V1::UpdateWorkflowExecutionRequest
|
|
982
|
+
).returns(Temporalio::Api::WorkflowService::V1::UpdateWorkflowExecutionResponse)
|
|
983
|
+
end
|
|
984
|
+
def update_workflow_execution(request)
|
|
985
|
+
end
|
|
986
|
+
|
|
987
|
+
# Polls a Workflow Execution for the outcome of a Workflow Update
|
|
988
|
+
# previously issued through the UpdateWorkflowExecution RPC. The effective
|
|
989
|
+
# timeout on this call will be shorter of the the caller-supplied gRPC
|
|
990
|
+
# timeout and the server's configured long-poll timeout.
|
|
991
|
+
#
|
|
992
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
993
|
+
# aip.dev/not-precedent: We don't expose update polling API to HTTP in favor of a potential future non-blocking form. --)
|
|
994
|
+
sig do
|
|
995
|
+
params(
|
|
996
|
+
request: Temporalio::Api::WorkflowService::V1::PollWorkflowExecutionUpdateRequest
|
|
997
|
+
).returns(Temporalio::Api::WorkflowService::V1::PollWorkflowExecutionUpdateResponse)
|
|
998
|
+
end
|
|
999
|
+
def poll_workflow_execution_update(request)
|
|
1000
|
+
end
|
|
1001
|
+
|
|
1002
|
+
# StartBatchOperation starts a new batch operation
|
|
1003
|
+
sig do
|
|
1004
|
+
params(
|
|
1005
|
+
request: Temporalio::Api::WorkflowService::V1::StartBatchOperationRequest
|
|
1006
|
+
).returns(Temporalio::Api::WorkflowService::V1::StartBatchOperationResponse)
|
|
1007
|
+
end
|
|
1008
|
+
def start_batch_operation(request)
|
|
1009
|
+
end
|
|
1010
|
+
|
|
1011
|
+
# StopBatchOperation stops a batch operation
|
|
1012
|
+
sig do
|
|
1013
|
+
params(
|
|
1014
|
+
request: Temporalio::Api::WorkflowService::V1::StopBatchOperationRequest
|
|
1015
|
+
).returns(Temporalio::Api::WorkflowService::V1::StopBatchOperationResponse)
|
|
1016
|
+
end
|
|
1017
|
+
def stop_batch_operation(request)
|
|
1018
|
+
end
|
|
1019
|
+
|
|
1020
|
+
# DescribeBatchOperation returns the information about a batch operation
|
|
1021
|
+
sig do
|
|
1022
|
+
params(
|
|
1023
|
+
request: Temporalio::Api::WorkflowService::V1::DescribeBatchOperationRequest
|
|
1024
|
+
).returns(Temporalio::Api::WorkflowService::V1::DescribeBatchOperationResponse)
|
|
1025
|
+
end
|
|
1026
|
+
def describe_batch_operation(request)
|
|
1027
|
+
end
|
|
1028
|
+
|
|
1029
|
+
# ListBatchOperations returns a list of batch operations
|
|
1030
|
+
sig do
|
|
1031
|
+
params(
|
|
1032
|
+
request: Temporalio::Api::WorkflowService::V1::ListBatchOperationsRequest
|
|
1033
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListBatchOperationsResponse)
|
|
1034
|
+
end
|
|
1035
|
+
def list_batch_operations(request)
|
|
1036
|
+
end
|
|
1037
|
+
|
|
1038
|
+
# PollNexusTaskQueue is a long poll call used by workers to receive Nexus tasks.
|
|
1039
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
1040
|
+
# aip.dev/not-precedent: We do not expose worker API to HTTP. --)
|
|
1041
|
+
sig do
|
|
1042
|
+
params(
|
|
1043
|
+
request: Temporalio::Api::WorkflowService::V1::PollNexusTaskQueueRequest
|
|
1044
|
+
).returns(Temporalio::Api::WorkflowService::V1::PollNexusTaskQueueResponse)
|
|
1045
|
+
end
|
|
1046
|
+
def poll_nexus_task_queue(request)
|
|
1047
|
+
end
|
|
1048
|
+
|
|
1049
|
+
# RespondNexusTaskCompleted is called by workers to respond to Nexus tasks received via PollNexusTaskQueue.
|
|
1050
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
1051
|
+
# aip.dev/not-precedent: We do not expose worker API to HTTP. --)
|
|
1052
|
+
sig do
|
|
1053
|
+
params(
|
|
1054
|
+
request: Temporalio::Api::WorkflowService::V1::RespondNexusTaskCompletedRequest
|
|
1055
|
+
).returns(Temporalio::Api::WorkflowService::V1::RespondNexusTaskCompletedResponse)
|
|
1056
|
+
end
|
|
1057
|
+
def respond_nexus_task_completed(request)
|
|
1058
|
+
end
|
|
1059
|
+
|
|
1060
|
+
# RespondNexusTaskFailed is called by workers to fail Nexus tasks received via PollNexusTaskQueue.
|
|
1061
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
1062
|
+
# aip.dev/not-precedent: We do not expose worker API to HTTP. --)
|
|
1063
|
+
sig do
|
|
1064
|
+
params(
|
|
1065
|
+
request: Temporalio::Api::WorkflowService::V1::RespondNexusTaskFailedRequest
|
|
1066
|
+
).returns(Temporalio::Api::WorkflowService::V1::RespondNexusTaskFailedResponse)
|
|
1067
|
+
end
|
|
1068
|
+
def respond_nexus_task_failed(request)
|
|
1069
|
+
end
|
|
1070
|
+
|
|
1071
|
+
# UpdateActivityOptions is called by the client to update the options of an activity by its ID or type.
|
|
1072
|
+
# If there are multiple pending activities of the provided type - all of them will be updated.
|
|
1073
|
+
# This API will be deprecated soon and replaced with a newer UpdateActivityExecutionOptions that is better named and
|
|
1074
|
+
# structured to work well for standalone activities.
|
|
1075
|
+
sig do
|
|
1076
|
+
params(
|
|
1077
|
+
request: Temporalio::Api::WorkflowService::V1::UpdateActivityOptionsRequest
|
|
1078
|
+
).returns(Temporalio::Api::WorkflowService::V1::UpdateActivityOptionsResponse)
|
|
1079
|
+
end
|
|
1080
|
+
def update_activity_options(request)
|
|
1081
|
+
end
|
|
1082
|
+
|
|
1083
|
+
# UpdateWorkflowExecutionOptions partially updates the WorkflowExecutionOptions of an existing workflow execution.
|
|
1084
|
+
sig do
|
|
1085
|
+
params(
|
|
1086
|
+
request: Temporalio::Api::WorkflowService::V1::UpdateWorkflowExecutionOptionsRequest
|
|
1087
|
+
).returns(Temporalio::Api::WorkflowService::V1::UpdateWorkflowExecutionOptionsResponse)
|
|
1088
|
+
end
|
|
1089
|
+
def update_workflow_execution_options(request)
|
|
1090
|
+
end
|
|
1091
|
+
|
|
1092
|
+
# PauseActivity pauses the execution of an activity specified by its ID or type.
|
|
1093
|
+
# If there are multiple pending activities of the provided type - all of them will be paused
|
|
1094
|
+
#
|
|
1095
|
+
# Pausing an activity means:
|
|
1096
|
+
# - If the activity is currently waiting for a retry or is running and subsequently fails,
|
|
1097
|
+
# it will not be rescheduled until it is unpaused.
|
|
1098
|
+
# - If the activity is already paused, calling this method will have no effect.
|
|
1099
|
+
# - If the activity is running and finishes successfully, the activity will be completed.
|
|
1100
|
+
# - If the activity is running and finishes with failure:
|
|
1101
|
+
# * if there is no retry left - the activity will be completed.
|
|
1102
|
+
# * if there are more retries left - the activity will be paused.
|
|
1103
|
+
# For long-running activities:
|
|
1104
|
+
# - activities in paused state will send a cancellation with "activity_paused" set to 'true' in response to 'RecordActivityTaskHeartbeat'.
|
|
1105
|
+
# - The activity should respond to the cancellation accordingly.
|
|
1106
|
+
#
|
|
1107
|
+
# Returns a `NotFound` error if there is no pending activity with the provided ID or type
|
|
1108
|
+
# This API will be deprecated soon and replaced with a newer PauseActivityExecution that is better named and
|
|
1109
|
+
# structured to work well for standalone activities.
|
|
1110
|
+
sig do
|
|
1111
|
+
params(
|
|
1112
|
+
request: Temporalio::Api::WorkflowService::V1::PauseActivityRequest
|
|
1113
|
+
).returns(Temporalio::Api::WorkflowService::V1::PauseActivityResponse)
|
|
1114
|
+
end
|
|
1115
|
+
def pause_activity(request)
|
|
1116
|
+
end
|
|
1117
|
+
|
|
1118
|
+
# UnpauseActivity unpauses the execution of an activity specified by its ID or type.
|
|
1119
|
+
# If there are multiple pending activities of the provided type - all of them will be unpaused.
|
|
1120
|
+
#
|
|
1121
|
+
# If activity is not paused, this call will have no effect.
|
|
1122
|
+
# If the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag).
|
|
1123
|
+
# Once the activity is unpaused, all timeout timers will be regenerated.
|
|
1124
|
+
#
|
|
1125
|
+
# Flags:
|
|
1126
|
+
# 'jitter': the activity will be scheduled at a random time within the jitter duration.
|
|
1127
|
+
# 'reset_attempts': the number of attempts will be reset.
|
|
1128
|
+
# 'reset_heartbeat': the activity heartbeat timer and heartbeats will be reset.
|
|
1129
|
+
#
|
|
1130
|
+
# Returns a `NotFound` error if there is no pending activity with the provided ID or type
|
|
1131
|
+
# This API will be deprecated soon and replaced with a newer UnpauseActivityExecution that is better named and
|
|
1132
|
+
# structured to work well for standalone activities.
|
|
1133
|
+
sig do
|
|
1134
|
+
params(
|
|
1135
|
+
request: Temporalio::Api::WorkflowService::V1::UnpauseActivityRequest
|
|
1136
|
+
).returns(Temporalio::Api::WorkflowService::V1::UnpauseActivityResponse)
|
|
1137
|
+
end
|
|
1138
|
+
def unpause_activity(request)
|
|
1139
|
+
end
|
|
1140
|
+
|
|
1141
|
+
# ResetActivity resets the execution of an activity specified by its ID or type.
|
|
1142
|
+
# If there are multiple pending activities of the provided type - all of them will be reset.
|
|
1143
|
+
#
|
|
1144
|
+
# Resetting an activity means:
|
|
1145
|
+
# * number of attempts will be reset to 0.
|
|
1146
|
+
# * activity timeouts will be reset.
|
|
1147
|
+
# * if the activity is waiting for retry, and it is not paused or 'keep_paused' is not provided:
|
|
1148
|
+
# it will be scheduled immediately (* see 'jitter' flag),
|
|
1149
|
+
#
|
|
1150
|
+
# Flags:
|
|
1151
|
+
#
|
|
1152
|
+
# 'jitter': the activity will be scheduled at a random time within the jitter duration.
|
|
1153
|
+
# If the activity currently paused it will be unpaused, unless 'keep_paused' flag is provided.
|
|
1154
|
+
# 'reset_heartbeats': the activity heartbeat timer and heartbeats will be reset.
|
|
1155
|
+
# 'keep_paused': if the activity is paused, it will remain paused.
|
|
1156
|
+
#
|
|
1157
|
+
# Returns a `NotFound` error if there is no pending activity with the provided ID or type.
|
|
1158
|
+
# This API will be deprecated soon and replaced with a newer ResetActivityExecution that is better named and
|
|
1159
|
+
# structured to work well for standalone activities.
|
|
1160
|
+
sig do
|
|
1161
|
+
params(
|
|
1162
|
+
request: Temporalio::Api::WorkflowService::V1::ResetActivityRequest
|
|
1163
|
+
).returns(Temporalio::Api::WorkflowService::V1::ResetActivityResponse)
|
|
1164
|
+
end
|
|
1165
|
+
def reset_activity(request)
|
|
1166
|
+
end
|
|
1167
|
+
|
|
1168
|
+
# Create a new workflow rule. The rules are used to control the workflow execution.
|
|
1169
|
+
# The rule will be applied to all running and new workflows in the namespace.
|
|
1170
|
+
# If the rule with such ID already exist this call will fail
|
|
1171
|
+
# Note: the rules are part of namespace configuration and will be stored in the namespace config.
|
|
1172
|
+
# Namespace config is eventually consistent.
|
|
1173
|
+
sig do
|
|
1174
|
+
params(
|
|
1175
|
+
request: Temporalio::Api::WorkflowService::V1::CreateWorkflowRuleRequest
|
|
1176
|
+
).returns(Temporalio::Api::WorkflowService::V1::CreateWorkflowRuleResponse)
|
|
1177
|
+
end
|
|
1178
|
+
def create_workflow_rule(request)
|
|
1179
|
+
end
|
|
1180
|
+
|
|
1181
|
+
# DescribeWorkflowRule return the rule specification for existing rule id.
|
|
1182
|
+
# If there is no rule with such id - NOT FOUND error will be returned.
|
|
1183
|
+
sig do
|
|
1184
|
+
params(
|
|
1185
|
+
request: Temporalio::Api::WorkflowService::V1::DescribeWorkflowRuleRequest
|
|
1186
|
+
).returns(Temporalio::Api::WorkflowService::V1::DescribeWorkflowRuleResponse)
|
|
1187
|
+
end
|
|
1188
|
+
def describe_workflow_rule(request)
|
|
1189
|
+
end
|
|
1190
|
+
|
|
1191
|
+
# Delete rule by rule id
|
|
1192
|
+
sig do
|
|
1193
|
+
params(
|
|
1194
|
+
request: Temporalio::Api::WorkflowService::V1::DeleteWorkflowRuleRequest
|
|
1195
|
+
).returns(Temporalio::Api::WorkflowService::V1::DeleteWorkflowRuleResponse)
|
|
1196
|
+
end
|
|
1197
|
+
def delete_workflow_rule(request)
|
|
1198
|
+
end
|
|
1199
|
+
|
|
1200
|
+
# Return all namespace workflow rules
|
|
1201
|
+
sig do
|
|
1202
|
+
params(
|
|
1203
|
+
request: Temporalio::Api::WorkflowService::V1::ListWorkflowRulesRequest
|
|
1204
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListWorkflowRulesResponse)
|
|
1205
|
+
end
|
|
1206
|
+
def list_workflow_rules(request)
|
|
1207
|
+
end
|
|
1208
|
+
|
|
1209
|
+
# TriggerWorkflowRule allows to:
|
|
1210
|
+
# * trigger existing rule for a specific workflow execution;
|
|
1211
|
+
# * trigger rule for a specific workflow execution without creating a rule;
|
|
1212
|
+
# This is useful for one-off operations.
|
|
1213
|
+
sig do
|
|
1214
|
+
params(
|
|
1215
|
+
request: Temporalio::Api::WorkflowService::V1::TriggerWorkflowRuleRequest
|
|
1216
|
+
).returns(Temporalio::Api::WorkflowService::V1::TriggerWorkflowRuleResponse)
|
|
1217
|
+
end
|
|
1218
|
+
def trigger_workflow_rule(request)
|
|
1219
|
+
end
|
|
1220
|
+
|
|
1221
|
+
# WorkerHeartbeat receive heartbeat request from the worker.
|
|
1222
|
+
sig do
|
|
1223
|
+
params(
|
|
1224
|
+
request: Temporalio::Api::WorkflowService::V1::RecordWorkerHeartbeatRequest
|
|
1225
|
+
).returns(Temporalio::Api::WorkflowService::V1::RecordWorkerHeartbeatResponse)
|
|
1226
|
+
end
|
|
1227
|
+
def record_worker_heartbeat(request)
|
|
1228
|
+
end
|
|
1229
|
+
|
|
1230
|
+
# ListWorkers is a visibility API to list worker status information in a specific namespace.
|
|
1231
|
+
sig do
|
|
1232
|
+
params(
|
|
1233
|
+
request: Temporalio::Api::WorkflowService::V1::ListWorkersRequest
|
|
1234
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListWorkersResponse)
|
|
1235
|
+
end
|
|
1236
|
+
def list_workers(request)
|
|
1237
|
+
end
|
|
1238
|
+
|
|
1239
|
+
# CountWorkers counts the number of workers in a specific namespace.
|
|
1240
|
+
sig do
|
|
1241
|
+
params(
|
|
1242
|
+
request: Temporalio::Api::WorkflowService::V1::CountWorkersRequest
|
|
1243
|
+
).returns(Temporalio::Api::WorkflowService::V1::CountWorkersResponse)
|
|
1244
|
+
end
|
|
1245
|
+
def count_workers(request)
|
|
1246
|
+
end
|
|
1247
|
+
|
|
1248
|
+
# Updates task queue configuration.
|
|
1249
|
+
# For the overall queue rate limit: the rate limit set by this api overrides the worker-set rate limit,
|
|
1250
|
+
# which uncouples the rate limit from the worker lifecycle.
|
|
1251
|
+
# If the overall queue rate limit is unset, the worker-set rate limit takes effect.
|
|
1252
|
+
sig do
|
|
1253
|
+
params(
|
|
1254
|
+
request: Temporalio::Api::WorkflowService::V1::UpdateTaskQueueConfigRequest
|
|
1255
|
+
).returns(Temporalio::Api::WorkflowService::V1::UpdateTaskQueueConfigResponse)
|
|
1256
|
+
end
|
|
1257
|
+
def update_task_queue_config(request)
|
|
1258
|
+
end
|
|
1259
|
+
|
|
1260
|
+
# FetchWorkerConfig returns the worker configuration for a specific worker.
|
|
1261
|
+
sig do
|
|
1262
|
+
params(
|
|
1263
|
+
request: Temporalio::Api::WorkflowService::V1::FetchWorkerConfigRequest
|
|
1264
|
+
).returns(Temporalio::Api::WorkflowService::V1::FetchWorkerConfigResponse)
|
|
1265
|
+
end
|
|
1266
|
+
def fetch_worker_config(request)
|
|
1267
|
+
end
|
|
1268
|
+
|
|
1269
|
+
# UpdateWorkerConfig updates the worker configuration of one or more workers.
|
|
1270
|
+
# Can be used to partially update the worker configuration.
|
|
1271
|
+
# Can be used to update the configuration of multiple workers.
|
|
1272
|
+
sig do
|
|
1273
|
+
params(
|
|
1274
|
+
request: Temporalio::Api::WorkflowService::V1::UpdateWorkerConfigRequest
|
|
1275
|
+
).returns(Temporalio::Api::WorkflowService::V1::UpdateWorkerConfigResponse)
|
|
1276
|
+
end
|
|
1277
|
+
def update_worker_config(request)
|
|
1278
|
+
end
|
|
1279
|
+
|
|
1280
|
+
# DescribeWorker returns information about the specified worker.
|
|
1281
|
+
sig do
|
|
1282
|
+
params(
|
|
1283
|
+
request: Temporalio::Api::WorkflowService::V1::DescribeWorkerRequest
|
|
1284
|
+
).returns(Temporalio::Api::WorkflowService::V1::DescribeWorkerResponse)
|
|
1285
|
+
end
|
|
1286
|
+
def describe_worker(request)
|
|
1287
|
+
end
|
|
1288
|
+
|
|
1289
|
+
# Note: This is an experimental API and the behavior may change in a future release.
|
|
1290
|
+
# PauseWorkflowExecution pauses the workflow execution specified in the request. Pausing a workflow execution results in
|
|
1291
|
+
# - The workflow execution status changes to `PAUSED` and a new WORKFLOW_EXECUTION_PAUSED event is added to the history
|
|
1292
|
+
# - No new workflow tasks or activity tasks are dispatched.
|
|
1293
|
+
# - Any workflow task currently executing on the worker will be allowed to complete.
|
|
1294
|
+
# - Any activity task currently executing will be paused.
|
|
1295
|
+
# - All server-side events will continue to be processed by the server.
|
|
1296
|
+
# - Queries & Updates on a paused workflow will be rejected.
|
|
1297
|
+
sig do
|
|
1298
|
+
params(
|
|
1299
|
+
request: Temporalio::Api::WorkflowService::V1::PauseWorkflowExecutionRequest
|
|
1300
|
+
).returns(Temporalio::Api::WorkflowService::V1::PauseWorkflowExecutionResponse)
|
|
1301
|
+
end
|
|
1302
|
+
def pause_workflow_execution(request)
|
|
1303
|
+
end
|
|
1304
|
+
|
|
1305
|
+
# Note: This is an experimental API and the behavior may change in a future release.
|
|
1306
|
+
# UnpauseWorkflowExecution unpauses a previously paused workflow execution specified in the request.
|
|
1307
|
+
# Unpausing a workflow execution results in
|
|
1308
|
+
# - The workflow execution status changes to `RUNNING` and a new WORKFLOW_EXECUTION_UNPAUSED event is added to the history
|
|
1309
|
+
# - Workflow tasks and activity tasks are resumed.
|
|
1310
|
+
sig do
|
|
1311
|
+
params(
|
|
1312
|
+
request: Temporalio::Api::WorkflowService::V1::UnpauseWorkflowExecutionRequest
|
|
1313
|
+
).returns(Temporalio::Api::WorkflowService::V1::UnpauseWorkflowExecutionResponse)
|
|
1314
|
+
end
|
|
1315
|
+
def unpause_workflow_execution(request)
|
|
1316
|
+
end
|
|
1317
|
+
|
|
1318
|
+
# StartActivityExecution starts a new activity execution.
|
|
1319
|
+
#
|
|
1320
|
+
# Returns an `ActivityExecutionAlreadyStarted` error if an instance already exists with same activity ID in this namespace
|
|
1321
|
+
# unless permitted by the specified ID conflict policy.
|
|
1322
|
+
sig do
|
|
1323
|
+
params(
|
|
1324
|
+
request: Temporalio::Api::WorkflowService::V1::StartActivityExecutionRequest
|
|
1325
|
+
).returns(Temporalio::Api::WorkflowService::V1::StartActivityExecutionResponse)
|
|
1326
|
+
end
|
|
1327
|
+
def start_activity_execution(request)
|
|
1328
|
+
end
|
|
1329
|
+
|
|
1330
|
+
# StartNexusOperationExecution starts a new Nexus operation.
|
|
1331
|
+
#
|
|
1332
|
+
# Returns a `NexusOperationExecutionAlreadyStarted` error if an instance already exists with same operation ID in this
|
|
1333
|
+
# namespace unless permitted by the specified ID conflict policy.
|
|
1334
|
+
sig do
|
|
1335
|
+
params(
|
|
1336
|
+
request: Temporalio::Api::WorkflowService::V1::StartNexusOperationExecutionRequest
|
|
1337
|
+
).returns(Temporalio::Api::WorkflowService::V1::StartNexusOperationExecutionResponse)
|
|
1338
|
+
end
|
|
1339
|
+
def start_nexus_operation_execution(request)
|
|
1340
|
+
end
|
|
1341
|
+
|
|
1342
|
+
# DescribeActivityExecution returns information about an activity execution.
|
|
1343
|
+
# It can be used to:
|
|
1344
|
+
# - Get current activity info without waiting
|
|
1345
|
+
# - Long-poll for next state change and return new activity info
|
|
1346
|
+
# Response can optionally include activity input or outcome (if the activity has completed).
|
|
1347
|
+
sig do
|
|
1348
|
+
params(
|
|
1349
|
+
request: Temporalio::Api::WorkflowService::V1::DescribeActivityExecutionRequest
|
|
1350
|
+
).returns(Temporalio::Api::WorkflowService::V1::DescribeActivityExecutionResponse)
|
|
1351
|
+
end
|
|
1352
|
+
def describe_activity_execution(request)
|
|
1353
|
+
end
|
|
1354
|
+
|
|
1355
|
+
# DescribeNexusOperationExecution returns information about a Nexus operation.
|
|
1356
|
+
# Supported use cases include:
|
|
1357
|
+
# - Get current operation info without waiting
|
|
1358
|
+
# - Long-poll for next state change and return new operation info
|
|
1359
|
+
# Response can optionally include operation input or outcome (if the operation has completed).
|
|
1360
|
+
sig do
|
|
1361
|
+
params(
|
|
1362
|
+
request: Temporalio::Api::WorkflowService::V1::DescribeNexusOperationExecutionRequest
|
|
1363
|
+
).returns(Temporalio::Api::WorkflowService::V1::DescribeNexusOperationExecutionResponse)
|
|
1364
|
+
end
|
|
1365
|
+
def describe_nexus_operation_execution(request)
|
|
1366
|
+
end
|
|
1367
|
+
|
|
1368
|
+
# PollActivityExecution long-polls for an activity execution to complete and returns the
|
|
1369
|
+
# outcome (result or failure).
|
|
1370
|
+
sig do
|
|
1371
|
+
params(
|
|
1372
|
+
request: Temporalio::Api::WorkflowService::V1::PollActivityExecutionRequest
|
|
1373
|
+
).returns(Temporalio::Api::WorkflowService::V1::PollActivityExecutionResponse)
|
|
1374
|
+
end
|
|
1375
|
+
def poll_activity_execution(request)
|
|
1376
|
+
end
|
|
1377
|
+
|
|
1378
|
+
# PollNexusOperationExecution long-polls for a Nexus operation for a given wait stage to complete and returns
|
|
1379
|
+
# the outcome (result or failure).
|
|
1380
|
+
sig do
|
|
1381
|
+
params(
|
|
1382
|
+
request: Temporalio::Api::WorkflowService::V1::PollNexusOperationExecutionRequest
|
|
1383
|
+
).returns(Temporalio::Api::WorkflowService::V1::PollNexusOperationExecutionResponse)
|
|
1384
|
+
end
|
|
1385
|
+
def poll_nexus_operation_execution(request)
|
|
1386
|
+
end
|
|
1387
|
+
|
|
1388
|
+
# ListActivityExecutions is a visibility API to list activity executions in a specific namespace.
|
|
1389
|
+
sig do
|
|
1390
|
+
params(
|
|
1391
|
+
request: Temporalio::Api::WorkflowService::V1::ListActivityExecutionsRequest
|
|
1392
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListActivityExecutionsResponse)
|
|
1393
|
+
end
|
|
1394
|
+
def list_activity_executions(request)
|
|
1395
|
+
end
|
|
1396
|
+
|
|
1397
|
+
# ListNexusOperationExecutions is a visibility API to list Nexus operations in a specific namespace.
|
|
1398
|
+
sig do
|
|
1399
|
+
params(
|
|
1400
|
+
request: Temporalio::Api::WorkflowService::V1::ListNexusOperationExecutionsRequest
|
|
1401
|
+
).returns(Temporalio::Api::WorkflowService::V1::ListNexusOperationExecutionsResponse)
|
|
1402
|
+
end
|
|
1403
|
+
def list_nexus_operation_executions(request)
|
|
1404
|
+
end
|
|
1405
|
+
|
|
1406
|
+
# CountActivityExecutions is a visibility API to count activity executions in a specific namespace.
|
|
1407
|
+
sig do
|
|
1408
|
+
params(
|
|
1409
|
+
request: Temporalio::Api::WorkflowService::V1::CountActivityExecutionsRequest
|
|
1410
|
+
).returns(Temporalio::Api::WorkflowService::V1::CountActivityExecutionsResponse)
|
|
1411
|
+
end
|
|
1412
|
+
def count_activity_executions(request)
|
|
1413
|
+
end
|
|
1414
|
+
|
|
1415
|
+
# CountNexusOperationExecutions is a visibility API to count Nexus operations in a specific namespace.
|
|
1416
|
+
sig do
|
|
1417
|
+
params(
|
|
1418
|
+
request: Temporalio::Api::WorkflowService::V1::CountNexusOperationExecutionsRequest
|
|
1419
|
+
).returns(Temporalio::Api::WorkflowService::V1::CountNexusOperationExecutionsResponse)
|
|
1420
|
+
end
|
|
1421
|
+
def count_nexus_operation_executions(request)
|
|
1422
|
+
end
|
|
1423
|
+
|
|
1424
|
+
# RequestCancelActivityExecution requests cancellation of an activity execution.
|
|
1425
|
+
#
|
|
1426
|
+
# Cancellation is cooperative: this call records the request, but the activity must detect and
|
|
1427
|
+
# acknowledge it for the activity to reach CANCELED status. The cancellation signal is
|
|
1428
|
+
# delivered via `cancel_requested` in the heartbeat response; SDKs surface this via
|
|
1429
|
+
# language-idiomatic mechanisms (context cancellation, exceptions, abort signals).
|
|
1430
|
+
sig do
|
|
1431
|
+
params(
|
|
1432
|
+
request: Temporalio::Api::WorkflowService::V1::RequestCancelActivityExecutionRequest
|
|
1433
|
+
).returns(Temporalio::Api::WorkflowService::V1::RequestCancelActivityExecutionResponse)
|
|
1434
|
+
end
|
|
1435
|
+
def request_cancel_activity_execution(request)
|
|
1436
|
+
end
|
|
1437
|
+
|
|
1438
|
+
# RequestCancelNexusOperationExecution requests cancellation of a Nexus operation.
|
|
1439
|
+
#
|
|
1440
|
+
# Requesting to cancel an operation does not automatically transition the operation to canceled status.
|
|
1441
|
+
# The operation will only transition to canceled status if it supports cancellation and the handler
|
|
1442
|
+
# processes the cancellation request.
|
|
1443
|
+
sig do
|
|
1444
|
+
params(
|
|
1445
|
+
request: Temporalio::Api::WorkflowService::V1::RequestCancelNexusOperationExecutionRequest
|
|
1446
|
+
).returns(Temporalio::Api::WorkflowService::V1::RequestCancelNexusOperationExecutionResponse)
|
|
1447
|
+
end
|
|
1448
|
+
def request_cancel_nexus_operation_execution(request)
|
|
1449
|
+
end
|
|
1450
|
+
|
|
1451
|
+
# TerminateActivityExecution terminates an existing activity execution immediately.
|
|
1452
|
+
#
|
|
1453
|
+
# Termination does not reach the worker and the activity code cannot react to it. A terminated activity may have a
|
|
1454
|
+
# running attempt.
|
|
1455
|
+
sig do
|
|
1456
|
+
params(
|
|
1457
|
+
request: Temporalio::Api::WorkflowService::V1::TerminateActivityExecutionRequest
|
|
1458
|
+
).returns(Temporalio::Api::WorkflowService::V1::TerminateActivityExecutionResponse)
|
|
1459
|
+
end
|
|
1460
|
+
def terminate_activity_execution(request)
|
|
1461
|
+
end
|
|
1462
|
+
|
|
1463
|
+
# DeleteActivityExecution asynchronously deletes a specific activity execution (when
|
|
1464
|
+
# ActivityExecution.run_id is provided) or the latest activity execution (when
|
|
1465
|
+
# ActivityExecution.run_id is not provided). If the activity Execution is running, it will be
|
|
1466
|
+
# terminated before deletion.
|
|
1467
|
+
#
|
|
1468
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
1469
|
+
# aip.dev/not-precedent: Activity deletion not exposed to HTTP, users should use cancel or terminate. --)
|
|
1470
|
+
sig do
|
|
1471
|
+
params(
|
|
1472
|
+
request: Temporalio::Api::WorkflowService::V1::DeleteActivityExecutionRequest
|
|
1473
|
+
).returns(Temporalio::Api::WorkflowService::V1::DeleteActivityExecutionResponse)
|
|
1474
|
+
end
|
|
1475
|
+
def delete_activity_execution(request)
|
|
1476
|
+
end
|
|
1477
|
+
|
|
1478
|
+
# PauseActivityExecution pauses the execution of an activity specified by its ID.
|
|
1479
|
+
# This API can be used to target a workflow activity or a standalone activity
|
|
1480
|
+
#
|
|
1481
|
+
# Pausing an activity means:
|
|
1482
|
+
# - If the activity is currently waiting for a retry or is running and subsequently fails,
|
|
1483
|
+
# it will not be rescheduled until it is unpaused.
|
|
1484
|
+
# - If the activity is already paused, calling this method will have no effect.
|
|
1485
|
+
# - If the activity is running and finishes successfully, the activity will be completed.
|
|
1486
|
+
# - If the activity is running and finishes with failure:
|
|
1487
|
+
# * if there is no retry left - the activity will be completed.
|
|
1488
|
+
# * if there are more retries left - the activity will be paused.
|
|
1489
|
+
# For long-running activities:
|
|
1490
|
+
# - activities in paused state will send a cancellation with "activity_paused" set to 'true' in response to 'RecordActivityTaskHeartbeat'.
|
|
1491
|
+
#
|
|
1492
|
+
# Returns a `NotFound` error if there is no pending activity with the provided ID
|
|
1493
|
+
sig do
|
|
1494
|
+
params(
|
|
1495
|
+
request: Temporalio::Api::WorkflowService::V1::PauseActivityExecutionRequest
|
|
1496
|
+
).returns(Temporalio::Api::WorkflowService::V1::PauseActivityExecutionResponse)
|
|
1497
|
+
end
|
|
1498
|
+
def pause_activity_execution(request)
|
|
1499
|
+
end
|
|
1500
|
+
|
|
1501
|
+
# ResetActivityExecution resets the execution of an activity specified by its ID.
|
|
1502
|
+
# This API can be used to target a workflow activity or a standalone activity.
|
|
1503
|
+
#
|
|
1504
|
+
# Resetting an activity means:
|
|
1505
|
+
# * number of attempts will be reset to 0.
|
|
1506
|
+
# * activity timeouts will be reset.
|
|
1507
|
+
# * if the activity is waiting for retry, and it is not paused or 'keep_paused' is not provided:
|
|
1508
|
+
# it will be scheduled immediately (* see 'jitter' flag)
|
|
1509
|
+
#
|
|
1510
|
+
# Returns a `NotFound` error if there is no pending activity with the provided ID or type.
|
|
1511
|
+
sig do
|
|
1512
|
+
params(
|
|
1513
|
+
request: Temporalio::Api::WorkflowService::V1::ResetActivityExecutionRequest
|
|
1514
|
+
).returns(Temporalio::Api::WorkflowService::V1::ResetActivityExecutionResponse)
|
|
1515
|
+
end
|
|
1516
|
+
def reset_activity_execution(request)
|
|
1517
|
+
end
|
|
1518
|
+
|
|
1519
|
+
# UnpauseActivityExecution unpauses the execution of an activity specified by its ID.
|
|
1520
|
+
# This API can be used to target a workflow activity or a standalone activity.
|
|
1521
|
+
#
|
|
1522
|
+
# If activity is not paused, this call will have no effect.
|
|
1523
|
+
# If the activity was paused while waiting for retry, it will be scheduled immediately (* see 'jitter' flag).
|
|
1524
|
+
# Once the activity is unpaused, all timeout timers will be regenerated.
|
|
1525
|
+
#
|
|
1526
|
+
# Returns a `NotFound` error if there is no pending activity with the provided ID
|
|
1527
|
+
sig do
|
|
1528
|
+
params(
|
|
1529
|
+
request: Temporalio::Api::WorkflowService::V1::UnpauseActivityExecutionRequest
|
|
1530
|
+
).returns(Temporalio::Api::WorkflowService::V1::UnpauseActivityExecutionResponse)
|
|
1531
|
+
end
|
|
1532
|
+
def unpause_activity_execution(request)
|
|
1533
|
+
end
|
|
1534
|
+
|
|
1535
|
+
# UpdateActivityExecutionOptions is called by the client to update the options of an activity by its ID.
|
|
1536
|
+
# This API can be used to target a workflow activity or a standalone activity.
|
|
1537
|
+
sig do
|
|
1538
|
+
params(
|
|
1539
|
+
request: Temporalio::Api::WorkflowService::V1::UpdateActivityExecutionOptionsRequest
|
|
1540
|
+
).returns(Temporalio::Api::WorkflowService::V1::UpdateActivityExecutionOptionsResponse)
|
|
1541
|
+
end
|
|
1542
|
+
def update_activity_execution_options(request)
|
|
1543
|
+
end
|
|
1544
|
+
|
|
1545
|
+
# TerminateNexusOperationExecution terminates an existing Nexus operation immediately.
|
|
1546
|
+
#
|
|
1547
|
+
# Termination happens immediately and the operation handler cannot react to it. A terminated operation will have
|
|
1548
|
+
# its outcome set to a failure with a termination reason.
|
|
1549
|
+
sig do
|
|
1550
|
+
params(
|
|
1551
|
+
request: Temporalio::Api::WorkflowService::V1::TerminateNexusOperationExecutionRequest
|
|
1552
|
+
).returns(Temporalio::Api::WorkflowService::V1::TerminateNexusOperationExecutionResponse)
|
|
1553
|
+
end
|
|
1554
|
+
def terminate_nexus_operation_execution(request)
|
|
1555
|
+
end
|
|
1556
|
+
|
|
1557
|
+
# DeleteNexusOperationExecution asynchronously deletes a specific Nexus operation run (when
|
|
1558
|
+
# run_id is provided) or the latest run (when run_id is not provided). If the operation
|
|
1559
|
+
# is running, it will be terminated before deletion.
|
|
1560
|
+
#
|
|
1561
|
+
# (-- api-linter: core::0127::http-annotation=disabled
|
|
1562
|
+
# aip.dev/not-precedent: Nexus operation deletion not exposed to HTTP, users should use cancel or terminate. --)
|
|
1563
|
+
sig do
|
|
1564
|
+
params(
|
|
1565
|
+
request: Temporalio::Api::WorkflowService::V1::DeleteNexusOperationExecutionRequest
|
|
1566
|
+
).returns(Temporalio::Api::WorkflowService::V1::DeleteNexusOperationExecutionResponse)
|
|
1567
|
+
end
|
|
1568
|
+
def delete_nexus_operation_execution(request)
|
|
1569
|
+
end
|
|
1570
|
+
end
|
|
1571
|
+
end
|