temporalio.bridge.services_generated.WorkflowService

class documentation

class WorkflowService: (source)

Known subclasses: temporalio.service.WorkflowService

Constructor: WorkflowService(client)

RPC calls for the WorkflowService.

Method	`__init__`	Initialize service with the provided ServiceClient.
Async Method	`count_workflow_executions`	Invokes the WorkflowService.count_workflow_executions rpc method.
Async Method	`create_schedule`	Invokes the WorkflowService.create_schedule rpc method.
Async Method	`create_workflow_rule`	Invokes the WorkflowService.create_workflow_rule rpc method.
Async Method	`delete_schedule`	Invokes the WorkflowService.delete_schedule rpc method.
Async Method	`delete_worker_deployment`	Invokes the WorkflowService.delete_worker_deployment rpc method.
Async Method	`delete_worker_deployment_version`	Invokes the WorkflowService.delete_worker_deployment_version rpc method.
Async Method	`delete_workflow_execution`	Invokes the WorkflowService.delete_workflow_execution rpc method.
Async Method	`delete_workflow_rule`	Invokes the WorkflowService.delete_workflow_rule rpc method.
Async Method	`deprecate_namespace`	Invokes the WorkflowService.deprecate_namespace rpc method.
Async Method	`describe_batch_operation`	Invokes the WorkflowService.describe_batch_operation rpc method.
Async Method	`describe_deployment`	Invokes the WorkflowService.describe_deployment rpc method.
Async Method	`describe_namespace`	Invokes the WorkflowService.describe_namespace rpc method.
Async Method	`describe_schedule`	Invokes the WorkflowService.describe_schedule rpc method.
Async Method	`describe_task_queue`	Invokes the WorkflowService.describe_task_queue rpc method.
Async Method	`describe_worker_deployment`	Invokes the WorkflowService.describe_worker_deployment rpc method.
Async Method	`describe_worker_deployment_version`	Invokes the WorkflowService.describe_worker_deployment_version rpc method.
Async Method	`describe_workflow_execution`	Invokes the WorkflowService.describe_workflow_execution rpc method.
Async Method	`describe_workflow_rule`	Invokes the WorkflowService.describe_workflow_rule rpc method.
Async Method	`execute_multi_operation`	Invokes the WorkflowService.execute_multi_operation rpc method.
Async Method	`fetch_worker_config`	Invokes the WorkflowService.fetch_worker_config rpc method.
Async Method	`get_cluster_info`	Invokes the WorkflowService.get_cluster_info rpc method.
Async Method	`get_current_deployment`	Invokes the WorkflowService.get_current_deployment rpc method.
Async Method	`get_deployment_reachability`	Invokes the WorkflowService.get_deployment_reachability rpc method.
Async Method	`get_search_attributes`	Invokes the WorkflowService.get_search_attributes rpc method.
Async Method	`get_system_info`	Invokes the WorkflowService.get_system_info rpc method.
Async Method	`get_worker_build_id_compatibility`	Invokes the WorkflowService.get_worker_build_id_compatibility rpc method.
Async Method	`get_worker_task_reachability`	Invokes the WorkflowService.get_worker_task_reachability rpc method.
Async Method	`get_worker_versioning_rules`	Invokes the WorkflowService.get_worker_versioning_rules rpc method.
Async Method	`get_workflow_execution_history`	Invokes the WorkflowService.get_workflow_execution_history rpc method.
Async Method	`get_workflow_execution_history_reverse`	Invokes the WorkflowService.get_workflow_execution_history_reverse rpc method.
Async Method	`list_archived_workflow_executions`	Invokes the WorkflowService.list_archived_workflow_executions rpc method.
Async Method	`list_batch_operations`	Invokes the WorkflowService.list_batch_operations rpc method.
Async Method	`list_closed_workflow_executions`	Invokes the WorkflowService.list_closed_workflow_executions rpc method.
Async Method	`list_deployments`	Invokes the WorkflowService.list_deployments rpc method.
Async Method	`list_namespaces`	Invokes the WorkflowService.list_namespaces rpc method.
Async Method	`list_open_workflow_executions`	Invokes the WorkflowService.list_open_workflow_executions rpc method.
Async Method	`list_schedule_matching_times`	Invokes the WorkflowService.list_schedule_matching_times rpc method.
Async Method	`list_schedules`	Invokes the WorkflowService.list_schedules rpc method.
Async Method	`list_task_queue_partitions`	Invokes the WorkflowService.list_task_queue_partitions rpc method.
Async Method	`list_worker_deployments`	Invokes the WorkflowService.list_worker_deployments rpc method.
Async Method	`list_workers`	Invokes the WorkflowService.list_workers rpc method.
Async Method	`list_workflow_executions`	Invokes the WorkflowService.list_workflow_executions rpc method.
Async Method	`list_workflow_rules`	Invokes the WorkflowService.list_workflow_rules rpc method.
Async Method	`patch_schedule`	Invokes the WorkflowService.patch_schedule rpc method.
Async Method	`pause_activity`	Invokes the WorkflowService.pause_activity rpc method.
Async Method	`poll_activity_task_queue`	Invokes the WorkflowService.poll_activity_task_queue rpc method.
Async Method	`poll_nexus_task_queue`	Invokes the WorkflowService.poll_nexus_task_queue rpc method.
Async Method	`poll_workflow_execution_update`	Invokes the WorkflowService.poll_workflow_execution_update rpc method.
Async Method	`poll_workflow_task_queue`	Invokes the WorkflowService.poll_workflow_task_queue rpc method.
Async Method	`query_workflow`	Invokes the WorkflowService.query_workflow rpc method.
Async Method	`record_activity_task_heartbeat`	Invokes the WorkflowService.record_activity_task_heartbeat rpc method.
Async Method	`record_activity_task_heartbeat_by_id`	Invokes the WorkflowService.record_activity_task_heartbeat_by_id rpc method.
Async Method	`record_worker_heartbeat`	Invokes the WorkflowService.record_worker_heartbeat rpc method.
Async Method	`register_namespace`	Invokes the WorkflowService.register_namespace rpc method.
Async Method	`request_cancel_workflow_execution`	Invokes the WorkflowService.request_cancel_workflow_execution rpc method.
Async Method	`reset_activity`	Invokes the WorkflowService.reset_activity rpc method.
Async Method	`reset_sticky_task_queue`	Invokes the WorkflowService.reset_sticky_task_queue rpc method.
Async Method	`reset_workflow_execution`	Invokes the WorkflowService.reset_workflow_execution rpc method.
Async Method	`respond_activity_task_canceled`	Invokes the WorkflowService.respond_activity_task_canceled rpc method.
Async Method	`respond_activity_task_canceled_by_id`	Invokes the WorkflowService.respond_activity_task_canceled_by_id rpc method.
Async Method	`respond_activity_task_completed`	Invokes the WorkflowService.respond_activity_task_completed rpc method.
Async Method	`respond_activity_task_completed_by_id`	Invokes the WorkflowService.respond_activity_task_completed_by_id rpc method.
Async Method	`respond_activity_task_failed`	Invokes the WorkflowService.respond_activity_task_failed rpc method.
Async Method	`respond_activity_task_failed_by_id`	Invokes the WorkflowService.respond_activity_task_failed_by_id rpc method.
Async Method	`respond_nexus_task_completed`	Invokes the WorkflowService.respond_nexus_task_completed rpc method.
Async Method	`respond_nexus_task_failed`	Invokes the WorkflowService.respond_nexus_task_failed rpc method.
Async Method	`respond_query_task_completed`	Invokes the WorkflowService.respond_query_task_completed rpc method.
Async Method	`respond_workflow_task_completed`	Invokes the WorkflowService.respond_workflow_task_completed rpc method.
Async Method	`respond_workflow_task_failed`	Invokes the WorkflowService.respond_workflow_task_failed rpc method.
Async Method	`scan_workflow_executions`	Invokes the WorkflowService.scan_workflow_executions rpc method.
Async Method	`set_current_deployment`	Invokes the WorkflowService.set_current_deployment rpc method.
Async Method	`set_worker_deployment_current_version`	Invokes the WorkflowService.set_worker_deployment_current_version rpc method.
Async Method	`set_worker_deployment_ramping_version`	Invokes the WorkflowService.set_worker_deployment_ramping_version rpc method.
Async Method	`shutdown_worker`	Invokes the WorkflowService.shutdown_worker rpc method.
Async Method	`signal_with_start_workflow_execution`	Invokes the WorkflowService.signal_with_start_workflow_execution rpc method.
Async Method	`signal_workflow_execution`	Invokes the WorkflowService.signal_workflow_execution rpc method.
Async Method	`start_batch_operation`	Invokes the WorkflowService.start_batch_operation rpc method.
Async Method	`start_workflow_execution`	Invokes the WorkflowService.start_workflow_execution rpc method.
Async Method	`stop_batch_operation`	Invokes the WorkflowService.stop_batch_operation rpc method.
Async Method	`terminate_workflow_execution`	Invokes the WorkflowService.terminate_workflow_execution rpc method.
Async Method	`trigger_workflow_rule`	Invokes the WorkflowService.trigger_workflow_rule rpc method.
Async Method	`unpause_activity`	Invokes the WorkflowService.unpause_activity rpc method.
Async Method	`update_activity_options`	Invokes the WorkflowService.update_activity_options rpc method.
Async Method	`update_namespace`	Invokes the WorkflowService.update_namespace rpc method.
Async Method	`update_schedule`	Invokes the WorkflowService.update_schedule rpc method.
Async Method	`update_task_queue_config`	Invokes the WorkflowService.update_task_queue_config rpc method.
Async Method	`update_worker_build_id_compatibility`	Invokes the WorkflowService.update_worker_build_id_compatibility rpc method.
Async Method	`update_worker_config`	Invokes the WorkflowService.update_worker_config rpc method.
Async Method	`update_worker_deployment_version_metadata`	Invokes the WorkflowService.update_worker_deployment_version_metadata rpc method.
Async Method	`update_worker_versioning_rules`	Invokes the WorkflowService.update_worker_versioning_rules rpc method.
Async Method	`update_workflow_execution`	Invokes the WorkflowService.update_workflow_execution rpc method.
Async Method	`update_workflow_execution_options`	Invokes the WorkflowService.update_workflow_execution_options rpc method.
Instance Variable	`_client`	Undocumented
Instance Variable	`_service`	Undocumented

def __init__(self, client: ServiceClient): (source) ¶

Initialize service with the provided ServiceClient.

async def count_workflow_executions(self, req: temporalio.api.workflowservice.v1.CountWorkflowExecutionsRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.CountWorkflowExecutionsResponse: (source) ¶

Invokes the WorkflowService.count_workflow_executions rpc method.

async def create_schedule(self, req: temporalio.api.workflowservice.v1.CreateScheduleRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.CreateScheduleResponse: (source) ¶

Invokes the WorkflowService.create_schedule rpc method.

async def create_workflow_rule(self, req: temporalio.api.workflowservice.v1.CreateWorkflowRuleRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.CreateWorkflowRuleResponse: (source) ¶

Invokes the WorkflowService.create_workflow_rule rpc method.

async def delete_schedule(self, req: temporalio.api.workflowservice.v1.DeleteScheduleRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DeleteScheduleResponse: (source) ¶

Invokes the WorkflowService.delete_schedule rpc method.

async def delete_worker_deployment(self, req: temporalio.api.workflowservice.v1.DeleteWorkerDeploymentRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DeleteWorkerDeploymentResponse: (source) ¶

Invokes the WorkflowService.delete_worker_deployment rpc method.

async def delete_worker_deployment_version(self, req: temporalio.api.workflowservice.v1.DeleteWorkerDeploymentVersionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DeleteWorkerDeploymentVersionResponse: (source) ¶

Invokes the WorkflowService.delete_worker_deployment_version rpc method.

async def delete_workflow_execution(self, req: temporalio.api.workflowservice.v1.DeleteWorkflowExecutionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DeleteWorkflowExecutionResponse: (source) ¶

Invokes the WorkflowService.delete_workflow_execution rpc method.

async def delete_workflow_rule(self, req: temporalio.api.workflowservice.v1.DeleteWorkflowRuleRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DeleteWorkflowRuleResponse: (source) ¶

Invokes the WorkflowService.delete_workflow_rule rpc method.

async def deprecate_namespace(self, req: temporalio.api.workflowservice.v1.DeprecateNamespaceRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DeprecateNamespaceResponse: (source) ¶

Invokes the WorkflowService.deprecate_namespace rpc method.

async def describe_batch_operation(self, req: temporalio.api.workflowservice.v1.DescribeBatchOperationRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DescribeBatchOperationResponse: (source) ¶

Invokes the WorkflowService.describe_batch_operation rpc method.

async def describe_deployment(self, req: temporalio.api.workflowservice.v1.DescribeDeploymentRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DescribeDeploymentResponse: (source) ¶

Invokes the WorkflowService.describe_deployment rpc method.

async def describe_namespace(self, req: temporalio.api.workflowservice.v1.DescribeNamespaceRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DescribeNamespaceResponse: (source) ¶

Invokes the WorkflowService.describe_namespace rpc method.

async def describe_schedule(self, req: temporalio.api.workflowservice.v1.DescribeScheduleRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DescribeScheduleResponse: (source) ¶

Invokes the WorkflowService.describe_schedule rpc method.

async def describe_task_queue(self, req: temporalio.api.workflowservice.v1.DescribeTaskQueueRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DescribeTaskQueueResponse: (source) ¶

Invokes the WorkflowService.describe_task_queue rpc method.

async def describe_worker_deployment(self, req: temporalio.api.workflowservice.v1.DescribeWorkerDeploymentRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DescribeWorkerDeploymentResponse: (source) ¶

Invokes the WorkflowService.describe_worker_deployment rpc method.

async def describe_worker_deployment_version(self, req: temporalio.api.workflowservice.v1.DescribeWorkerDeploymentVersionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DescribeWorkerDeploymentVersionResponse: (source) ¶

Invokes the WorkflowService.describe_worker_deployment_version rpc method.

async def describe_workflow_execution(self, req: temporalio.api.workflowservice.v1.DescribeWorkflowExecutionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DescribeWorkflowExecutionResponse: (source) ¶

Invokes the WorkflowService.describe_workflow_execution rpc method.

async def describe_workflow_rule(self, req: temporalio.api.workflowservice.v1.DescribeWorkflowRuleRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.DescribeWorkflowRuleResponse: (source) ¶

Invokes the WorkflowService.describe_workflow_rule rpc method.

async def execute_multi_operation(self, req: temporalio.api.workflowservice.v1.ExecuteMultiOperationRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ExecuteMultiOperationResponse: (source) ¶

Invokes the WorkflowService.execute_multi_operation rpc method.

async def fetch_worker_config(self, req: temporalio.api.workflowservice.v1.FetchWorkerConfigRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.FetchWorkerConfigResponse: (source) ¶

Invokes the WorkflowService.fetch_worker_config rpc method.

async def get_cluster_info(self, req: temporalio.api.workflowservice.v1.GetClusterInfoRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.GetClusterInfoResponse: (source) ¶

Invokes the WorkflowService.get_cluster_info rpc method.

async def get_current_deployment(self, req: temporalio.api.workflowservice.v1.GetCurrentDeploymentRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.GetCurrentDeploymentResponse: (source) ¶

Invokes the WorkflowService.get_current_deployment rpc method.

async def get_deployment_reachability(self, req: temporalio.api.workflowservice.v1.GetDeploymentReachabilityRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.GetDeploymentReachabilityResponse: (source) ¶

Invokes the WorkflowService.get_deployment_reachability rpc method.

async def get_search_attributes(self, req: temporalio.api.workflowservice.v1.GetSearchAttributesRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.GetSearchAttributesResponse: (source) ¶

Invokes the WorkflowService.get_search_attributes rpc method.

async def get_system_info(self, req: temporalio.api.workflowservice.v1.GetSystemInfoRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.GetSystemInfoResponse: (source) ¶

Invokes the WorkflowService.get_system_info rpc method.

async def get_worker_build_id_compatibility(self, req: temporalio.api.workflowservice.v1.GetWorkerBuildIdCompatibilityRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.GetWorkerBuildIdCompatibilityResponse: (source) ¶

Invokes the WorkflowService.get_worker_build_id_compatibility rpc method.

async def get_worker_task_reachability(self, req: temporalio.api.workflowservice.v1.GetWorkerTaskReachabilityRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.GetWorkerTaskReachabilityResponse: (source) ¶

Invokes the WorkflowService.get_worker_task_reachability rpc method.

async def get_worker_versioning_rules(self, req: temporalio.api.workflowservice.v1.GetWorkerVersioningRulesRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.GetWorkerVersioningRulesResponse: (source) ¶

Invokes the WorkflowService.get_worker_versioning_rules rpc method.

async def get_workflow_execution_history(self, req: temporalio.api.workflowservice.v1.GetWorkflowExecutionHistoryRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.GetWorkflowExecutionHistoryResponse: (source) ¶

Invokes the WorkflowService.get_workflow_execution_history rpc method.

async def get_workflow_execution_history_reverse(self, req: temporalio.api.workflowservice.v1.GetWorkflowExecutionHistoryReverseRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.GetWorkflowExecutionHistoryReverseResponse: (source) ¶

Invokes the WorkflowService.get_workflow_execution_history_reverse rpc method.

async def list_archived_workflow_executions(self, req: temporalio.api.workflowservice.v1.ListArchivedWorkflowExecutionsRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListArchivedWorkflowExecutionsResponse: (source) ¶

Invokes the WorkflowService.list_archived_workflow_executions rpc method.

async def list_batch_operations(self, req: temporalio.api.workflowservice.v1.ListBatchOperationsRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListBatchOperationsResponse: (source) ¶

Invokes the WorkflowService.list_batch_operations rpc method.

async def list_closed_workflow_executions(self, req: temporalio.api.workflowservice.v1.ListClosedWorkflowExecutionsRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListClosedWorkflowExecutionsResponse: (source) ¶

Invokes the WorkflowService.list_closed_workflow_executions rpc method.

async def list_deployments(self, req: temporalio.api.workflowservice.v1.ListDeploymentsRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListDeploymentsResponse: (source) ¶

Invokes the WorkflowService.list_deployments rpc method.

async def list_namespaces(self, req: temporalio.api.workflowservice.v1.ListNamespacesRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListNamespacesResponse: (source) ¶

Invokes the WorkflowService.list_namespaces rpc method.

async def list_open_workflow_executions(self, req: temporalio.api.workflowservice.v1.ListOpenWorkflowExecutionsRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListOpenWorkflowExecutionsResponse: (source) ¶

Invokes the WorkflowService.list_open_workflow_executions rpc method.

async def list_schedule_matching_times(self, req: temporalio.api.workflowservice.v1.ListScheduleMatchingTimesRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListScheduleMatchingTimesResponse: (source) ¶

Invokes the WorkflowService.list_schedule_matching_times rpc method.

async def list_schedules(self, req: temporalio.api.workflowservice.v1.ListSchedulesRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListSchedulesResponse: (source) ¶

Invokes the WorkflowService.list_schedules rpc method.

async def list_task_queue_partitions(self, req: temporalio.api.workflowservice.v1.ListTaskQueuePartitionsRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListTaskQueuePartitionsResponse: (source) ¶

Invokes the WorkflowService.list_task_queue_partitions rpc method.

async def list_worker_deployments(self, req: temporalio.api.workflowservice.v1.ListWorkerDeploymentsRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListWorkerDeploymentsResponse: (source) ¶

Invokes the WorkflowService.list_worker_deployments rpc method.

async def list_workers(self, req: temporalio.api.workflowservice.v1.ListWorkersRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListWorkersResponse: (source) ¶

Invokes the WorkflowService.list_workers rpc method.

async def list_workflow_executions(self, req: temporalio.api.workflowservice.v1.ListWorkflowExecutionsRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListWorkflowExecutionsResponse: (source) ¶

Invokes the WorkflowService.list_workflow_executions rpc method.

async def list_workflow_rules(self, req: temporalio.api.workflowservice.v1.ListWorkflowRulesRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ListWorkflowRulesResponse: (source) ¶

Invokes the WorkflowService.list_workflow_rules rpc method.

async def patch_schedule(self, req: temporalio.api.workflowservice.v1.PatchScheduleRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.PatchScheduleResponse: (source) ¶

Invokes the WorkflowService.patch_schedule rpc method.

async def pause_activity(self, req: temporalio.api.workflowservice.v1.PauseActivityRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.PauseActivityResponse: (source) ¶

Invokes the WorkflowService.pause_activity rpc method.

async def poll_activity_task_queue(self, req: temporalio.api.workflowservice.v1.PollActivityTaskQueueRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.PollActivityTaskQueueResponse: (source) ¶

Invokes the WorkflowService.poll_activity_task_queue rpc method.

async def poll_nexus_task_queue(self, req: temporalio.api.workflowservice.v1.PollNexusTaskQueueRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.PollNexusTaskQueueResponse: (source) ¶

Invokes the WorkflowService.poll_nexus_task_queue rpc method.

async def poll_workflow_execution_update(self, req: temporalio.api.workflowservice.v1.PollWorkflowExecutionUpdateRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.PollWorkflowExecutionUpdateResponse: (source) ¶

Invokes the WorkflowService.poll_workflow_execution_update rpc method.

async def poll_workflow_task_queue(self, req: temporalio.api.workflowservice.v1.PollWorkflowTaskQueueRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.PollWorkflowTaskQueueResponse: (source) ¶

Invokes the WorkflowService.poll_workflow_task_queue rpc method.

async def query_workflow(self, req: temporalio.api.workflowservice.v1.QueryWorkflowRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.QueryWorkflowResponse: (source) ¶

Invokes the WorkflowService.query_workflow rpc method.

async def record_activity_task_heartbeat(self, req: temporalio.api.workflowservice.v1.RecordActivityTaskHeartbeatRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RecordActivityTaskHeartbeatResponse: (source) ¶

Invokes the WorkflowService.record_activity_task_heartbeat rpc method.

async def record_activity_task_heartbeat_by_id(self, req: temporalio.api.workflowservice.v1.RecordActivityTaskHeartbeatByIdRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RecordActivityTaskHeartbeatByIdResponse: (source) ¶

Invokes the WorkflowService.record_activity_task_heartbeat_by_id rpc method.

async def record_worker_heartbeat(self, req: temporalio.api.workflowservice.v1.RecordWorkerHeartbeatRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RecordWorkerHeartbeatResponse: (source) ¶

Invokes the WorkflowService.record_worker_heartbeat rpc method.

async def register_namespace(self, req: temporalio.api.workflowservice.v1.RegisterNamespaceRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RegisterNamespaceResponse: (source) ¶

Invokes the WorkflowService.register_namespace rpc method.

async def request_cancel_workflow_execution(self, req: temporalio.api.workflowservice.v1.RequestCancelWorkflowExecutionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RequestCancelWorkflowExecutionResponse: (source) ¶

Invokes the WorkflowService.request_cancel_workflow_execution rpc method.

async def reset_activity(self, req: temporalio.api.workflowservice.v1.ResetActivityRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ResetActivityResponse: (source) ¶

Invokes the WorkflowService.reset_activity rpc method.

async def reset_sticky_task_queue(self, req: temporalio.api.workflowservice.v1.ResetStickyTaskQueueRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ResetStickyTaskQueueResponse: (source) ¶

Invokes the WorkflowService.reset_sticky_task_queue rpc method.

async def reset_workflow_execution(self, req: temporalio.api.workflowservice.v1.ResetWorkflowExecutionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ResetWorkflowExecutionResponse: (source) ¶

Invokes the WorkflowService.reset_workflow_execution rpc method.

async def respond_activity_task_canceled(self, req: temporalio.api.workflowservice.v1.RespondActivityTaskCanceledRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RespondActivityTaskCanceledResponse: (source) ¶

Invokes the WorkflowService.respond_activity_task_canceled rpc method.

async def respond_activity_task_canceled_by_id(self, req: temporalio.api.workflowservice.v1.RespondActivityTaskCanceledByIdRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RespondActivityTaskCanceledByIdResponse: (source) ¶

Invokes the WorkflowService.respond_activity_task_canceled_by_id rpc method.

async def respond_activity_task_completed(self, req: temporalio.api.workflowservice.v1.RespondActivityTaskCompletedRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RespondActivityTaskCompletedResponse: (source) ¶

Invokes the WorkflowService.respond_activity_task_completed rpc method.

async def respond_activity_task_completed_by_id(self, req: temporalio.api.workflowservice.v1.RespondActivityTaskCompletedByIdRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RespondActivityTaskCompletedByIdResponse: (source) ¶

Invokes the WorkflowService.respond_activity_task_completed_by_id rpc method.

async def respond_activity_task_failed(self, req: temporalio.api.workflowservice.v1.RespondActivityTaskFailedRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RespondActivityTaskFailedResponse: (source) ¶

Invokes the WorkflowService.respond_activity_task_failed rpc method.

async def respond_activity_task_failed_by_id(self, req: temporalio.api.workflowservice.v1.RespondActivityTaskFailedByIdRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RespondActivityTaskFailedByIdResponse: (source) ¶

Invokes the WorkflowService.respond_activity_task_failed_by_id rpc method.

async def respond_nexus_task_completed(self, req: temporalio.api.workflowservice.v1.RespondNexusTaskCompletedRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RespondNexusTaskCompletedResponse: (source) ¶

Invokes the WorkflowService.respond_nexus_task_completed rpc method.

async def respond_nexus_task_failed(self, req: temporalio.api.workflowservice.v1.RespondNexusTaskFailedRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RespondNexusTaskFailedResponse: (source) ¶

Invokes the WorkflowService.respond_nexus_task_failed rpc method.

async def respond_query_task_completed(self, req: temporalio.api.workflowservice.v1.RespondQueryTaskCompletedRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RespondQueryTaskCompletedResponse: (source) ¶

Invokes the WorkflowService.respond_query_task_completed rpc method.

async def respond_workflow_task_completed(self, req: temporalio.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RespondWorkflowTaskCompletedResponse: (source) ¶

Invokes the WorkflowService.respond_workflow_task_completed rpc method.

async def respond_workflow_task_failed(self, req: temporalio.api.workflowservice.v1.RespondWorkflowTaskFailedRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.RespondWorkflowTaskFailedResponse: (source) ¶

Invokes the WorkflowService.respond_workflow_task_failed rpc method.

async def scan_workflow_executions(self, req: temporalio.api.workflowservice.v1.ScanWorkflowExecutionsRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ScanWorkflowExecutionsResponse: (source) ¶

Invokes the WorkflowService.scan_workflow_executions rpc method.

async def set_current_deployment(self, req: temporalio.api.workflowservice.v1.SetCurrentDeploymentRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.SetCurrentDeploymentResponse: (source) ¶

Invokes the WorkflowService.set_current_deployment rpc method.

async def set_worker_deployment_current_version(self, req: temporalio.api.workflowservice.v1.SetWorkerDeploymentCurrentVersionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.SetWorkerDeploymentCurrentVersionResponse: (source) ¶

Invokes the WorkflowService.set_worker_deployment_current_version rpc method.

async def set_worker_deployment_ramping_version(self, req: temporalio.api.workflowservice.v1.SetWorkerDeploymentRampingVersionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.SetWorkerDeploymentRampingVersionResponse: (source) ¶

Invokes the WorkflowService.set_worker_deployment_ramping_version rpc method.

async def shutdown_worker(self, req: temporalio.api.workflowservice.v1.ShutdownWorkerRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.ShutdownWorkerResponse: (source) ¶

Invokes the WorkflowService.shutdown_worker rpc method.

async def signal_with_start_workflow_execution(self, req: temporalio.api.workflowservice.v1.SignalWithStartWorkflowExecutionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.SignalWithStartWorkflowExecutionResponse: (source) ¶

Invokes the WorkflowService.signal_with_start_workflow_execution rpc method.

async def signal_workflow_execution(self, req: temporalio.api.workflowservice.v1.SignalWorkflowExecutionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.SignalWorkflowExecutionResponse: (source) ¶

Invokes the WorkflowService.signal_workflow_execution rpc method.

async def start_batch_operation(self, req: temporalio.api.workflowservice.v1.StartBatchOperationRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.StartBatchOperationResponse: (source) ¶

Invokes the WorkflowService.start_batch_operation rpc method.

async def start_workflow_execution(self, req: temporalio.api.workflowservice.v1.StartWorkflowExecutionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.StartWorkflowExecutionResponse: (source) ¶

Invokes the WorkflowService.start_workflow_execution rpc method.

async def stop_batch_operation(self, req: temporalio.api.workflowservice.v1.StopBatchOperationRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.StopBatchOperationResponse: (source) ¶

Invokes the WorkflowService.stop_batch_operation rpc method.

async def terminate_workflow_execution(self, req: temporalio.api.workflowservice.v1.TerminateWorkflowExecutionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.TerminateWorkflowExecutionResponse: (source) ¶

Invokes the WorkflowService.terminate_workflow_execution rpc method.

async def trigger_workflow_rule(self, req: temporalio.api.workflowservice.v1.TriggerWorkflowRuleRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.TriggerWorkflowRuleResponse: (source) ¶

Invokes the WorkflowService.trigger_workflow_rule rpc method.

async def unpause_activity(self, req: temporalio.api.workflowservice.v1.UnpauseActivityRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.UnpauseActivityResponse: (source) ¶

Invokes the WorkflowService.unpause_activity rpc method.

async def update_activity_options(self, req: temporalio.api.workflowservice.v1.UpdateActivityOptionsRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.UpdateActivityOptionsResponse: (source) ¶

Invokes the WorkflowService.update_activity_options rpc method.

async def update_namespace(self, req: temporalio.api.workflowservice.v1.UpdateNamespaceRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.UpdateNamespaceResponse: (source) ¶

Invokes the WorkflowService.update_namespace rpc method.

async def update_schedule(self, req: temporalio.api.workflowservice.v1.UpdateScheduleRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.UpdateScheduleResponse: (source) ¶

Invokes the WorkflowService.update_schedule rpc method.

async def update_task_queue_config(self, req: temporalio.api.workflowservice.v1.UpdateTaskQueueConfigRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.UpdateTaskQueueConfigResponse: (source) ¶

Invokes the WorkflowService.update_task_queue_config rpc method.

async def update_worker_build_id_compatibility(self, req: temporalio.api.workflowservice.v1.UpdateWorkerBuildIdCompatibilityRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.UpdateWorkerBuildIdCompatibilityResponse: (source) ¶

Invokes the WorkflowService.update_worker_build_id_compatibility rpc method.

async def update_worker_config(self, req: temporalio.api.workflowservice.v1.UpdateWorkerConfigRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.UpdateWorkerConfigResponse: (source) ¶

Invokes the WorkflowService.update_worker_config rpc method.

async def update_worker_deployment_version_metadata(self, req: temporalio.api.workflowservice.v1.UpdateWorkerDeploymentVersionMetadataRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.UpdateWorkerDeploymentVersionMetadataResponse: (source) ¶

Invokes the WorkflowService.update_worker_deployment_version_metadata rpc method.

async def update_worker_versioning_rules(self, req: temporalio.api.workflowservice.v1.UpdateWorkerVersioningRulesRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.UpdateWorkerVersioningRulesResponse: (source) ¶

Invokes the WorkflowService.update_worker_versioning_rules rpc method.

async def update_workflow_execution(self, req: temporalio.api.workflowservice.v1.UpdateWorkflowExecutionRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.UpdateWorkflowExecutionResponse: (source) ¶

Invokes the WorkflowService.update_workflow_execution rpc method.

async def update_workflow_execution_options(self, req: temporalio.api.workflowservice.v1.UpdateWorkflowExecutionOptionsRequest, retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> temporalio.api.workflowservice.v1.UpdateWorkflowExecutionOptionsResponse: (source) ¶

Invokes the WorkflowService.update_workflow_execution_options rpc method.

_client = (source) ¶

Undocumented

_service: str = (source) ¶

Undocumented