Class: Temporalio::Client::Connection::WorkflowService

Inherits:
Service
  • Object
show all
Defined in:
lib/temporalio/client/connection/workflow_service.rb

Overview

WorkflowService API.

Instance Method Summary collapse

Methods inherited from Service

#invoke_rpc

Instance Method Details

#count_workflow_executions(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::CountWorkflowExecutionsResponse

Calls WorkflowService.CountWorkflowExecutions API call.

Parameters:

Returns:



504
505
506
507
508
509
510
511
512
# File 'lib/temporalio/client/connection/workflow_service.rb', line 504

def count_workflow_executions(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'count_workflow_executions',
    request_class: Temporalio::Api::WorkflowService::V1::CountWorkflowExecutionsRequest,
    response_class: Temporalio::Api::WorkflowService::V1::CountWorkflowExecutionsResponse,
    request:,
    rpc_options:
  )
end

#create_schedule(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::CreateScheduleResponse

Calls WorkflowService.CreateSchedule API call.

Parameters:

Returns:



669
670
671
672
673
674
675
676
677
# File 'lib/temporalio/client/connection/workflow_service.rb', line 669

def create_schedule(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'create_schedule',
    request_class: Temporalio::Api::WorkflowService::V1::CreateScheduleRequest,
    response_class: Temporalio::Api::WorkflowService::V1::CreateScheduleResponse,
    request:,
    rpc_options:
  )
end

#delete_schedule(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::DeleteScheduleResponse

Calls WorkflowService.DeleteSchedule API call.

Parameters:

Returns:



744
745
746
747
748
749
750
751
752
# File 'lib/temporalio/client/connection/workflow_service.rb', line 744

def delete_schedule(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'delete_schedule',
    request_class: Temporalio::Api::WorkflowService::V1::DeleteScheduleRequest,
    response_class: Temporalio::Api::WorkflowService::V1::DeleteScheduleResponse,
    request:,
    rpc_options:
  )
end

#delete_workflow_execution(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::DeleteWorkflowExecutionResponse

Calls WorkflowService.DeleteWorkflowExecution API call.

Parameters:

Returns:



414
415
416
417
418
419
420
421
422
# File 'lib/temporalio/client/connection/workflow_service.rb', line 414

def delete_workflow_execution(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'delete_workflow_execution',
    request_class: Temporalio::Api::WorkflowService::V1::DeleteWorkflowExecutionRequest,
    response_class: Temporalio::Api::WorkflowService::V1::DeleteWorkflowExecutionResponse,
    request:,
    rpc_options:
  )
end

#deprecate_namespace(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::DeprecateNamespaceResponse

Calls WorkflowService.DeprecateNamespace API call.

Parameters:

Returns:



84
85
86
87
88
89
90
91
92
# File 'lib/temporalio/client/connection/workflow_service.rb', line 84

def deprecate_namespace(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'deprecate_namespace',
    request_class: Temporalio::Api::WorkflowService::V1::DeprecateNamespaceRequest,
    response_class: Temporalio::Api::WorkflowService::V1::DeprecateNamespaceResponse,
    request:,
    rpc_options:
  )
end

#describe_batch_operation(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeBatchOperationResponse

Calls WorkflowService.DescribeBatchOperation API call.

Parameters:

Returns:



909
910
911
912
913
914
915
916
917
# File 'lib/temporalio/client/connection/workflow_service.rb', line 909

def describe_batch_operation(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'describe_batch_operation',
    request_class: Temporalio::Api::WorkflowService::V1::DescribeBatchOperationRequest,
    response_class: Temporalio::Api::WorkflowService::V1::DescribeBatchOperationResponse,
    request:,
    rpc_options:
  )
end

#describe_namespace(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeNamespaceResponse

Calls WorkflowService.DescribeNamespace API call.

Parameters:

Returns:



39
40
41
42
43
44
45
46
47
# File 'lib/temporalio/client/connection/workflow_service.rb', line 39

def describe_namespace(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'describe_namespace',
    request_class: Temporalio::Api::WorkflowService::V1::DescribeNamespaceRequest,
    response_class: Temporalio::Api::WorkflowService::V1::DescribeNamespaceResponse,
    request:,
    rpc_options:
  )
end

#describe_schedule(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeScheduleResponse

Calls WorkflowService.DescribeSchedule API call.

Parameters:

Returns:



684
685
686
687
688
689
690
691
692
# File 'lib/temporalio/client/connection/workflow_service.rb', line 684

def describe_schedule(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'describe_schedule',
    request_class: Temporalio::Api::WorkflowService::V1::DescribeScheduleRequest,
    response_class: Temporalio::Api::WorkflowService::V1::DescribeScheduleResponse,
    request:,
    rpc_options:
  )
end

#describe_task_queue(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeTaskQueueResponse

Calls WorkflowService.DescribeTaskQueue API call.

Parameters:

Returns:



609
610
611
612
613
614
615
616
617
# File 'lib/temporalio/client/connection/workflow_service.rb', line 609

def describe_task_queue(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'describe_task_queue',
    request_class: Temporalio::Api::WorkflowService::V1::DescribeTaskQueueRequest,
    response_class: Temporalio::Api::WorkflowService::V1::DescribeTaskQueueResponse,
    request:,
    rpc_options:
  )
end

#describe_workflow_execution(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeWorkflowExecutionResponse

Calls WorkflowService.DescribeWorkflowExecution API call.

Parameters:

Returns:



594
595
596
597
598
599
600
601
602
# File 'lib/temporalio/client/connection/workflow_service.rb', line 594

def describe_workflow_execution(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'describe_workflow_execution',
    request_class: Temporalio::Api::WorkflowService::V1::DescribeWorkflowExecutionRequest,
    response_class: Temporalio::Api::WorkflowService::V1::DescribeWorkflowExecutionResponse,
    request:,
    rpc_options:
  )
end

#execute_multi_operation(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ExecuteMultiOperationResponse

Calls WorkflowService.ExecuteMultiOperation API call.

Parameters:

Returns:



114
115
116
117
118
119
120
121
122
# File 'lib/temporalio/client/connection/workflow_service.rb', line 114

def execute_multi_operation(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'execute_multi_operation',
    request_class: Temporalio::Api::WorkflowService::V1::ExecuteMultiOperationRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ExecuteMultiOperationResponse,
    request:,
    rpc_options:
  )
end

#get_cluster_info(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetClusterInfoResponse

Calls WorkflowService.GetClusterInfo API call.

Parameters:

Returns:



624
625
626
627
628
629
630
631
632
# File 'lib/temporalio/client/connection/workflow_service.rb', line 624

def get_cluster_info(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'get_cluster_info',
    request_class: Temporalio::Api::WorkflowService::V1::GetClusterInfoRequest,
    response_class: Temporalio::Api::WorkflowService::V1::GetClusterInfoResponse,
    request:,
    rpc_options:
  )
end

#get_search_attributes(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetSearchAttributesResponse

Calls WorkflowService.GetSearchAttributes API call.

Parameters:

Returns:



519
520
521
522
523
524
525
526
527
# File 'lib/temporalio/client/connection/workflow_service.rb', line 519

def get_search_attributes(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'get_search_attributes',
    request_class: Temporalio::Api::WorkflowService::V1::GetSearchAttributesRequest,
    response_class: Temporalio::Api::WorkflowService::V1::GetSearchAttributesResponse,
    request:,
    rpc_options:
  )
end

#get_system_info(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetSystemInfoResponse

Calls WorkflowService.GetSystemInfo API call.

Parameters:

Returns:



639
640
641
642
643
644
645
646
647
# File 'lib/temporalio/client/connection/workflow_service.rb', line 639

def get_system_info(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'get_system_info',
    request_class: Temporalio::Api::WorkflowService::V1::GetSystemInfoRequest,
    response_class: Temporalio::Api::WorkflowService::V1::GetSystemInfoResponse,
    request:,
    rpc_options:
  )
end

#get_worker_build_id_compatibility(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkerBuildIdCompatibilityResponse

Calls WorkflowService.GetWorkerBuildIdCompatibility API call.

Parameters:

Returns:



789
790
791
792
793
794
795
796
797
# File 'lib/temporalio/client/connection/workflow_service.rb', line 789

def get_worker_build_id_compatibility(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'get_worker_build_id_compatibility',
    request_class: Temporalio::Api::WorkflowService::V1::GetWorkerBuildIdCompatibilityRequest,
    response_class: Temporalio::Api::WorkflowService::V1::GetWorkerBuildIdCompatibilityResponse,
    request:,
    rpc_options:
  )
end

#get_worker_task_reachability(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkerTaskReachabilityResponse

Calls WorkflowService.GetWorkerTaskReachability API call.

Parameters:

Returns:



834
835
836
837
838
839
840
841
842
# File 'lib/temporalio/client/connection/workflow_service.rb', line 834

def get_worker_task_reachability(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'get_worker_task_reachability',
    request_class: Temporalio::Api::WorkflowService::V1::GetWorkerTaskReachabilityRequest,
    response_class: Temporalio::Api::WorkflowService::V1::GetWorkerTaskReachabilityResponse,
    request:,
    rpc_options:
  )
end

#get_worker_versioning_rules(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkerVersioningRulesResponse

Calls WorkflowService.GetWorkerVersioningRules API call.

Parameters:

Returns:



819
820
821
822
823
824
825
826
827
# File 'lib/temporalio/client/connection/workflow_service.rb', line 819

def get_worker_versioning_rules(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'get_worker_versioning_rules',
    request_class: Temporalio::Api::WorkflowService::V1::GetWorkerVersioningRulesRequest,
    response_class: Temporalio::Api::WorkflowService::V1::GetWorkerVersioningRulesResponse,
    request:,
    rpc_options:
  )
end

#get_workflow_execution_history(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryResponse

Calls WorkflowService.GetWorkflowExecutionHistory API call.

Parameters:

Returns:



129
130
131
132
133
134
135
136
137
# File 'lib/temporalio/client/connection/workflow_service.rb', line 129

def get_workflow_execution_history(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'get_workflow_execution_history',
    request_class: Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryRequest,
    response_class: Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryResponse,
    request:,
    rpc_options:
  )
end

#get_workflow_execution_history_reverse(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryReverseResponse

Calls WorkflowService.GetWorkflowExecutionHistoryReverse API call.

Parameters:

Returns:



144
145
146
147
148
149
150
151
152
# File 'lib/temporalio/client/connection/workflow_service.rb', line 144

def get_workflow_execution_history_reverse(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'get_workflow_execution_history_reverse',
    request_class: Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryReverseRequest,
    response_class: Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryReverseResponse,
    request:,
    rpc_options:
  )
end

#list_archived_workflow_executions(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListArchivedWorkflowExecutionsResponse

Calls WorkflowService.ListArchivedWorkflowExecutions API call.

Parameters:

Returns:



474
475
476
477
478
479
480
481
482
# File 'lib/temporalio/client/connection/workflow_service.rb', line 474

def list_archived_workflow_executions(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'list_archived_workflow_executions',
    request_class: Temporalio::Api::WorkflowService::V1::ListArchivedWorkflowExecutionsRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ListArchivedWorkflowExecutionsResponse,
    request:,
    rpc_options:
  )
end

#list_batch_operations(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListBatchOperationsResponse

Calls WorkflowService.ListBatchOperations API call.

Parameters:

Returns:



924
925
926
927
928
929
930
931
932
# File 'lib/temporalio/client/connection/workflow_service.rb', line 924

def list_batch_operations(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'list_batch_operations',
    request_class: Temporalio::Api::WorkflowService::V1::ListBatchOperationsRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ListBatchOperationsResponse,
    request:,
    rpc_options:
  )
end

#list_closed_workflow_executions(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListClosedWorkflowExecutionsResponse

Calls WorkflowService.ListClosedWorkflowExecutions API call.

Parameters:

Returns:



444
445
446
447
448
449
450
451
452
# File 'lib/temporalio/client/connection/workflow_service.rb', line 444

def list_closed_workflow_executions(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'list_closed_workflow_executions',
    request_class: Temporalio::Api::WorkflowService::V1::ListClosedWorkflowExecutionsRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ListClosedWorkflowExecutionsResponse,
    request:,
    rpc_options:
  )
end

#list_namespaces(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListNamespacesResponse

Calls WorkflowService.ListNamespaces API call.

Parameters:

Returns:



54
55
56
57
58
59
60
61
62
# File 'lib/temporalio/client/connection/workflow_service.rb', line 54

def list_namespaces(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'list_namespaces',
    request_class: Temporalio::Api::WorkflowService::V1::ListNamespacesRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ListNamespacesResponse,
    request:,
    rpc_options:
  )
end

#list_open_workflow_executions(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListOpenWorkflowExecutionsResponse

Calls WorkflowService.ListOpenWorkflowExecutions API call.

Parameters:

Returns:



429
430
431
432
433
434
435
436
437
# File 'lib/temporalio/client/connection/workflow_service.rb', line 429

def list_open_workflow_executions(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'list_open_workflow_executions',
    request_class: Temporalio::Api::WorkflowService::V1::ListOpenWorkflowExecutionsRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ListOpenWorkflowExecutionsResponse,
    request:,
    rpc_options:
  )
end

#list_schedule_matching_times(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListScheduleMatchingTimesResponse

Calls WorkflowService.ListScheduleMatchingTimes API call.

Parameters:

Returns:



729
730
731
732
733
734
735
736
737
# File 'lib/temporalio/client/connection/workflow_service.rb', line 729

def list_schedule_matching_times(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'list_schedule_matching_times',
    request_class: Temporalio::Api::WorkflowService::V1::ListScheduleMatchingTimesRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ListScheduleMatchingTimesResponse,
    request:,
    rpc_options:
  )
end

#list_schedules(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListSchedulesResponse

Calls WorkflowService.ListSchedules API call.

Parameters:

Returns:



759
760
761
762
763
764
765
766
767
# File 'lib/temporalio/client/connection/workflow_service.rb', line 759

def list_schedules(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'list_schedules',
    request_class: Temporalio::Api::WorkflowService::V1::ListSchedulesRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ListSchedulesResponse,
    request:,
    rpc_options:
  )
end

#list_task_queue_partitions(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListTaskQueuePartitionsResponse

Calls WorkflowService.ListTaskQueuePartitions API call.

Parameters:

Returns:



654
655
656
657
658
659
660
661
662
# File 'lib/temporalio/client/connection/workflow_service.rb', line 654

def list_task_queue_partitions(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'list_task_queue_partitions',
    request_class: Temporalio::Api::WorkflowService::V1::ListTaskQueuePartitionsRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ListTaskQueuePartitionsResponse,
    request:,
    rpc_options:
  )
end

#list_workflow_executions(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListWorkflowExecutionsResponse

Calls WorkflowService.ListWorkflowExecutions API call.

Parameters:

Returns:



459
460
461
462
463
464
465
466
467
# File 'lib/temporalio/client/connection/workflow_service.rb', line 459

def list_workflow_executions(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'list_workflow_executions',
    request_class: Temporalio::Api::WorkflowService::V1::ListWorkflowExecutionsRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ListWorkflowExecutionsResponse,
    request:,
    rpc_options:
  )
end

#patch_schedule(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::PatchScheduleResponse

Calls WorkflowService.PatchSchedule API call.

Parameters:

Returns:



714
715
716
717
718
719
720
721
722
# File 'lib/temporalio/client/connection/workflow_service.rb', line 714

def patch_schedule(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'patch_schedule',
    request_class: Temporalio::Api::WorkflowService::V1::PatchScheduleRequest,
    response_class: Temporalio::Api::WorkflowService::V1::PatchScheduleResponse,
    request:,
    rpc_options:
  )
end

#pause_activity_by_id(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::PauseActivityByIdResponse

Calls WorkflowService.PauseActivityById API call.

Parameters:

Returns:



999
1000
1001
1002
1003
1004
1005
1006
1007
# File 'lib/temporalio/client/connection/workflow_service.rb', line 999

def pause_activity_by_id(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'pause_activity_by_id',
    request_class: Temporalio::Api::WorkflowService::V1::PauseActivityByIdRequest,
    response_class: Temporalio::Api::WorkflowService::V1::PauseActivityByIdResponse,
    request:,
    rpc_options:
  )
end

#poll_activity_task_queue(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::PollActivityTaskQueueResponse

Calls WorkflowService.PollActivityTaskQueue API call.

Parameters:

Returns:



204
205
206
207
208
209
210
211
212
# File 'lib/temporalio/client/connection/workflow_service.rb', line 204

def poll_activity_task_queue(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'poll_activity_task_queue',
    request_class: Temporalio::Api::WorkflowService::V1::PollActivityTaskQueueRequest,
    response_class: Temporalio::Api::WorkflowService::V1::PollActivityTaskQueueResponse,
    request:,
    rpc_options:
  )
end

#poll_nexus_task_queue(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::PollNexusTaskQueueResponse

Calls WorkflowService.PollNexusTaskQueue API call.

Parameters:

Returns:



939
940
941
942
943
944
945
946
947
# File 'lib/temporalio/client/connection/workflow_service.rb', line 939

def poll_nexus_task_queue(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'poll_nexus_task_queue',
    request_class: Temporalio::Api::WorkflowService::V1::PollNexusTaskQueueRequest,
    response_class: Temporalio::Api::WorkflowService::V1::PollNexusTaskQueueResponse,
    request:,
    rpc_options:
  )
end

#poll_workflow_execution_update(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::PollWorkflowExecutionUpdateResponse

Calls WorkflowService.PollWorkflowExecutionUpdate API call.

Parameters:

Returns:



864
865
866
867
868
869
870
871
872
# File 'lib/temporalio/client/connection/workflow_service.rb', line 864

def poll_workflow_execution_update(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'poll_workflow_execution_update',
    request_class: Temporalio::Api::WorkflowService::V1::PollWorkflowExecutionUpdateRequest,
    response_class: Temporalio::Api::WorkflowService::V1::PollWorkflowExecutionUpdateResponse,
    request:,
    rpc_options:
  )
end

#poll_workflow_task_queue(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::PollWorkflowTaskQueueResponse

Calls WorkflowService.PollWorkflowTaskQueue API call.

Parameters:

Returns:



159
160
161
162
163
164
165
166
167
# File 'lib/temporalio/client/connection/workflow_service.rb', line 159

def poll_workflow_task_queue(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'poll_workflow_task_queue',
    request_class: Temporalio::Api::WorkflowService::V1::PollWorkflowTaskQueueRequest,
    response_class: Temporalio::Api::WorkflowService::V1::PollWorkflowTaskQueueResponse,
    request:,
    rpc_options:
  )
end

#query_workflow(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::QueryWorkflowResponse

Calls WorkflowService.QueryWorkflow API call.

Parameters:

Returns:



579
580
581
582
583
584
585
586
587
# File 'lib/temporalio/client/connection/workflow_service.rb', line 579

def query_workflow(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'query_workflow',
    request_class: Temporalio::Api::WorkflowService::V1::QueryWorkflowRequest,
    response_class: Temporalio::Api::WorkflowService::V1::QueryWorkflowResponse,
    request:,
    rpc_options:
  )
end

#record_activity_task_heartbeat(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatResponse

Calls WorkflowService.RecordActivityTaskHeartbeat API call.

Parameters:

Returns:



219
220
221
222
223
224
225
226
227
# File 'lib/temporalio/client/connection/workflow_service.rb', line 219

def record_activity_task_heartbeat(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'record_activity_task_heartbeat',
    request_class: Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatResponse,
    request:,
    rpc_options:
  )
end

#record_activity_task_heartbeat_by_id(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatByIdResponse

Calls WorkflowService.RecordActivityTaskHeartbeatById API call.

Parameters:

Returns:



234
235
236
237
238
239
240
241
242
# File 'lib/temporalio/client/connection/workflow_service.rb', line 234

def record_activity_task_heartbeat_by_id(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'record_activity_task_heartbeat_by_id',
    request_class: Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatByIdRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatByIdResponse,
    request:,
    rpc_options:
  )
end

#register_namespace(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RegisterNamespaceResponse

Calls WorkflowService.RegisterNamespace API call.

Parameters:

Returns:



24
25
26
27
28
29
30
31
32
# File 'lib/temporalio/client/connection/workflow_service.rb', line 24

def register_namespace(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'register_namespace',
    request_class: Temporalio::Api::WorkflowService::V1::RegisterNamespaceRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RegisterNamespaceResponse,
    request:,
    rpc_options:
  )
end

#request_cancel_workflow_execution(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RequestCancelWorkflowExecutionResponse

Calls WorkflowService.RequestCancelWorkflowExecution API call.

Parameters:

Returns:



339
340
341
342
343
344
345
346
347
# File 'lib/temporalio/client/connection/workflow_service.rb', line 339

def request_cancel_workflow_execution(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'request_cancel_workflow_execution',
    request_class: Temporalio::Api::WorkflowService::V1::RequestCancelWorkflowExecutionRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RequestCancelWorkflowExecutionResponse,
    request:,
    rpc_options:
  )
end

#reset_activity_by_id(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ResetActivityByIdResponse

Calls WorkflowService.ResetActivityById API call.

Parameters:

Returns:



1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'lib/temporalio/client/connection/workflow_service.rb', line 1029

def reset_activity_by_id(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'reset_activity_by_id',
    request_class: Temporalio::Api::WorkflowService::V1::ResetActivityByIdRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ResetActivityByIdResponse,
    request:,
    rpc_options:
  )
end

#reset_sticky_task_queue(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ResetStickyTaskQueueResponse

Calls WorkflowService.ResetStickyTaskQueue API call.

Parameters:

Returns:



549
550
551
552
553
554
555
556
557
# File 'lib/temporalio/client/connection/workflow_service.rb', line 549

def reset_sticky_task_queue(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'reset_sticky_task_queue',
    request_class: Temporalio::Api::WorkflowService::V1::ResetStickyTaskQueueRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ResetStickyTaskQueueResponse,
    request:,
    rpc_options:
  )
end

#reset_workflow_execution(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ResetWorkflowExecutionResponse

Calls WorkflowService.ResetWorkflowExecution API call.

Parameters:

Returns:



384
385
386
387
388
389
390
391
392
# File 'lib/temporalio/client/connection/workflow_service.rb', line 384

def reset_workflow_execution(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'reset_workflow_execution',
    request_class: Temporalio::Api::WorkflowService::V1::ResetWorkflowExecutionRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ResetWorkflowExecutionResponse,
    request:,
    rpc_options:
  )
end

#respond_activity_task_canceled(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledResponse

Calls WorkflowService.RespondActivityTaskCanceled API call.

Parameters:

Returns:



309
310
311
312
313
314
315
316
317
# File 'lib/temporalio/client/connection/workflow_service.rb', line 309

def respond_activity_task_canceled(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'respond_activity_task_canceled',
    request_class: Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledResponse,
    request:,
    rpc_options:
  )
end

#respond_activity_task_canceled_by_id(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledByIdResponse

Calls WorkflowService.RespondActivityTaskCanceledById API call.

Parameters:

Returns:



324
325
326
327
328
329
330
331
332
# File 'lib/temporalio/client/connection/workflow_service.rb', line 324

def respond_activity_task_canceled_by_id(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'respond_activity_task_canceled_by_id',
    request_class: Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledByIdRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledByIdResponse,
    request:,
    rpc_options:
  )
end

#respond_activity_task_completed(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedResponse

Calls WorkflowService.RespondActivityTaskCompleted API call.

Parameters:

Returns:



249
250
251
252
253
254
255
256
257
# File 'lib/temporalio/client/connection/workflow_service.rb', line 249

def respond_activity_task_completed(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'respond_activity_task_completed',
    request_class: Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedResponse,
    request:,
    rpc_options:
  )
end

#respond_activity_task_completed_by_id(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedByIdResponse

Calls WorkflowService.RespondActivityTaskCompletedById API call.

Parameters:

Returns:



264
265
266
267
268
269
270
271
272
# File 'lib/temporalio/client/connection/workflow_service.rb', line 264

def respond_activity_task_completed_by_id(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'respond_activity_task_completed_by_id',
    request_class: Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedByIdRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedByIdResponse,
    request:,
    rpc_options:
  )
end

#respond_activity_task_failed(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedResponse

Calls WorkflowService.RespondActivityTaskFailed API call.

Parameters:

Returns:



279
280
281
282
283
284
285
286
287
# File 'lib/temporalio/client/connection/workflow_service.rb', line 279

def respond_activity_task_failed(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'respond_activity_task_failed',
    request_class: Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedResponse,
    request:,
    rpc_options:
  )
end

#respond_activity_task_failed_by_id(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedByIdResponse

Calls WorkflowService.RespondActivityTaskFailedById API call.

Parameters:

Returns:



294
295
296
297
298
299
300
301
302
# File 'lib/temporalio/client/connection/workflow_service.rb', line 294

def respond_activity_task_failed_by_id(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'respond_activity_task_failed_by_id',
    request_class: Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedByIdRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedByIdResponse,
    request:,
    rpc_options:
  )
end

#respond_nexus_task_completed(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondNexusTaskCompletedResponse

Calls WorkflowService.RespondNexusTaskCompleted API call.

Parameters:

Returns:



954
955
956
957
958
959
960
961
962
# File 'lib/temporalio/client/connection/workflow_service.rb', line 954

def respond_nexus_task_completed(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'respond_nexus_task_completed',
    request_class: Temporalio::Api::WorkflowService::V1::RespondNexusTaskCompletedRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RespondNexusTaskCompletedResponse,
    request:,
    rpc_options:
  )
end

#respond_nexus_task_failed(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondNexusTaskFailedResponse

Calls WorkflowService.RespondNexusTaskFailed API call.

Parameters:

Returns:



969
970
971
972
973
974
975
976
977
# File 'lib/temporalio/client/connection/workflow_service.rb', line 969

def respond_nexus_task_failed(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'respond_nexus_task_failed',
    request_class: Temporalio::Api::WorkflowService::V1::RespondNexusTaskFailedRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RespondNexusTaskFailedResponse,
    request:,
    rpc_options:
  )
end

#respond_query_task_completed(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondQueryTaskCompletedResponse

Calls WorkflowService.RespondQueryTaskCompleted API call.

Parameters:

Returns:



534
535
536
537
538
539
540
541
542
# File 'lib/temporalio/client/connection/workflow_service.rb', line 534

def respond_query_task_completed(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'respond_query_task_completed',
    request_class: Temporalio::Api::WorkflowService::V1::RespondQueryTaskCompletedRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RespondQueryTaskCompletedResponse,
    request:,
    rpc_options:
  )
end

#respond_workflow_task_completed(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskCompletedResponse

Calls WorkflowService.RespondWorkflowTaskCompleted API call.

Parameters:

Returns:



174
175
176
177
178
179
180
181
182
# File 'lib/temporalio/client/connection/workflow_service.rb', line 174

def respond_workflow_task_completed(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'respond_workflow_task_completed',
    request_class: Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskCompletedRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskCompletedResponse,
    request:,
    rpc_options:
  )
end

#respond_workflow_task_failed(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskFailedResponse

Calls WorkflowService.RespondWorkflowTaskFailed API call.

Parameters:

Returns:



189
190
191
192
193
194
195
196
197
# File 'lib/temporalio/client/connection/workflow_service.rb', line 189

def respond_workflow_task_failed(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'respond_workflow_task_failed',
    request_class: Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskFailedRequest,
    response_class: Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskFailedResponse,
    request:,
    rpc_options:
  )
end

#scan_workflow_executions(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ScanWorkflowExecutionsResponse

Calls WorkflowService.ScanWorkflowExecutions API call.

Parameters:

Returns:



489
490
491
492
493
494
495
496
497
# File 'lib/temporalio/client/connection/workflow_service.rb', line 489

def scan_workflow_executions(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'scan_workflow_executions',
    request_class: Temporalio::Api::WorkflowService::V1::ScanWorkflowExecutionsRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ScanWorkflowExecutionsResponse,
    request:,
    rpc_options:
  )
end

#shutdown_worker(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::ShutdownWorkerResponse

Calls WorkflowService.ShutdownWorker API call.

Parameters:

Returns:



564
565
566
567
568
569
570
571
572
# File 'lib/temporalio/client/connection/workflow_service.rb', line 564

def shutdown_worker(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'shutdown_worker',
    request_class: Temporalio::Api::WorkflowService::V1::ShutdownWorkerRequest,
    response_class: Temporalio::Api::WorkflowService::V1::ShutdownWorkerResponse,
    request:,
    rpc_options:
  )
end

#signal_with_start_workflow_execution(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::SignalWithStartWorkflowExecutionResponse

Calls WorkflowService.SignalWithStartWorkflowExecution API call.

Parameters:

Returns:



369
370
371
372
373
374
375
376
377
# File 'lib/temporalio/client/connection/workflow_service.rb', line 369

def signal_with_start_workflow_execution(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'signal_with_start_workflow_execution',
    request_class: Temporalio::Api::WorkflowService::V1::SignalWithStartWorkflowExecutionRequest,
    response_class: Temporalio::Api::WorkflowService::V1::SignalWithStartWorkflowExecutionResponse,
    request:,
    rpc_options:
  )
end

#signal_workflow_execution(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::SignalWorkflowExecutionResponse

Calls WorkflowService.SignalWorkflowExecution API call.

Parameters:

Returns:



354
355
356
357
358
359
360
361
362
# File 'lib/temporalio/client/connection/workflow_service.rb', line 354

def signal_workflow_execution(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'signal_workflow_execution',
    request_class: Temporalio::Api::WorkflowService::V1::SignalWorkflowExecutionRequest,
    response_class: Temporalio::Api::WorkflowService::V1::SignalWorkflowExecutionResponse,
    request:,
    rpc_options:
  )
end

#start_batch_operation(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::StartBatchOperationResponse

Calls WorkflowService.StartBatchOperation API call.

Parameters:

Returns:



879
880
881
882
883
884
885
886
887
# File 'lib/temporalio/client/connection/workflow_service.rb', line 879

def start_batch_operation(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'start_batch_operation',
    request_class: Temporalio::Api::WorkflowService::V1::StartBatchOperationRequest,
    response_class: Temporalio::Api::WorkflowService::V1::StartBatchOperationResponse,
    request:,
    rpc_options:
  )
end

#start_workflow_execution(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::StartWorkflowExecutionResponse

Calls WorkflowService.StartWorkflowExecution API call.

Parameters:

Returns:



99
100
101
102
103
104
105
106
107
# File 'lib/temporalio/client/connection/workflow_service.rb', line 99

def start_workflow_execution(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'start_workflow_execution',
    request_class: Temporalio::Api::WorkflowService::V1::StartWorkflowExecutionRequest,
    response_class: Temporalio::Api::WorkflowService::V1::StartWorkflowExecutionResponse,
    request:,
    rpc_options:
  )
end

#stop_batch_operation(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::StopBatchOperationResponse

Calls WorkflowService.StopBatchOperation API call.

Parameters:

Returns:



894
895
896
897
898
899
900
901
902
# File 'lib/temporalio/client/connection/workflow_service.rb', line 894

def stop_batch_operation(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'stop_batch_operation',
    request_class: Temporalio::Api::WorkflowService::V1::StopBatchOperationRequest,
    response_class: Temporalio::Api::WorkflowService::V1::StopBatchOperationResponse,
    request:,
    rpc_options:
  )
end

#terminate_workflow_execution(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::TerminateWorkflowExecutionResponse

Calls WorkflowService.TerminateWorkflowExecution API call.

Parameters:

Returns:



399
400
401
402
403
404
405
406
407
# File 'lib/temporalio/client/connection/workflow_service.rb', line 399

def terminate_workflow_execution(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'terminate_workflow_execution',
    request_class: Temporalio::Api::WorkflowService::V1::TerminateWorkflowExecutionRequest,
    response_class: Temporalio::Api::WorkflowService::V1::TerminateWorkflowExecutionResponse,
    request:,
    rpc_options:
  )
end

#unpause_activity_by_id(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::UnpauseActivityByIdResponse

Calls WorkflowService.UnpauseActivityById API call.

Parameters:

Returns:



1014
1015
1016
1017
1018
1019
1020
1021
1022
# File 'lib/temporalio/client/connection/workflow_service.rb', line 1014

def unpause_activity_by_id(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'unpause_activity_by_id',
    request_class: Temporalio::Api::WorkflowService::V1::UnpauseActivityByIdRequest,
    response_class: Temporalio::Api::WorkflowService::V1::UnpauseActivityByIdResponse,
    request:,
    rpc_options:
  )
end

#update_activity_options_by_id(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateActivityOptionsByIdResponse

Calls WorkflowService.UpdateActivityOptionsById API call.

Parameters:

Returns:



984
985
986
987
988
989
990
991
992
# File 'lib/temporalio/client/connection/workflow_service.rb', line 984

def update_activity_options_by_id(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'update_activity_options_by_id',
    request_class: Temporalio::Api::WorkflowService::V1::UpdateActivityOptionsByIdRequest,
    response_class: Temporalio::Api::WorkflowService::V1::UpdateActivityOptionsByIdResponse,
    request:,
    rpc_options:
  )
end

#update_namespace(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateNamespaceResponse

Calls WorkflowService.UpdateNamespace API call.

Parameters:

Returns:



69
70
71
72
73
74
75
76
77
# File 'lib/temporalio/client/connection/workflow_service.rb', line 69

def update_namespace(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'update_namespace',
    request_class: Temporalio::Api::WorkflowService::V1::UpdateNamespaceRequest,
    response_class: Temporalio::Api::WorkflowService::V1::UpdateNamespaceResponse,
    request:,
    rpc_options:
  )
end

#update_schedule(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateScheduleResponse

Calls WorkflowService.UpdateSchedule API call.

Parameters:

Returns:



699
700
701
702
703
704
705
706
707
# File 'lib/temporalio/client/connection/workflow_service.rb', line 699

def update_schedule(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'update_schedule',
    request_class: Temporalio::Api::WorkflowService::V1::UpdateScheduleRequest,
    response_class: Temporalio::Api::WorkflowService::V1::UpdateScheduleResponse,
    request:,
    rpc_options:
  )
end

#update_worker_build_id_compatibility(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateWorkerBuildIdCompatibilityResponse

Calls WorkflowService.UpdateWorkerBuildIdCompatibility API call.

Parameters:

Returns:



774
775
776
777
778
779
780
781
782
# File 'lib/temporalio/client/connection/workflow_service.rb', line 774

def update_worker_build_id_compatibility(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'update_worker_build_id_compatibility',
    request_class: Temporalio::Api::WorkflowService::V1::UpdateWorkerBuildIdCompatibilityRequest,
    response_class: Temporalio::Api::WorkflowService::V1::UpdateWorkerBuildIdCompatibilityResponse,
    request:,
    rpc_options:
  )
end

#update_worker_versioning_rules(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateWorkerVersioningRulesResponse

Calls WorkflowService.UpdateWorkerVersioningRules API call.

Parameters:

Returns:



804
805
806
807
808
809
810
811
812
# File 'lib/temporalio/client/connection/workflow_service.rb', line 804

def update_worker_versioning_rules(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'update_worker_versioning_rules',
    request_class: Temporalio::Api::WorkflowService::V1::UpdateWorkerVersioningRulesRequest,
    response_class: Temporalio::Api::WorkflowService::V1::UpdateWorkerVersioningRulesResponse,
    request:,
    rpc_options:
  )
end

#update_workflow_execution(request, rpc_options: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateWorkflowExecutionResponse

Calls WorkflowService.UpdateWorkflowExecution API call.

Parameters:

Returns:



849
850
851
852
853
854
855
856
857
# File 'lib/temporalio/client/connection/workflow_service.rb', line 849

def update_workflow_execution(request, rpc_options: nil)
  invoke_rpc(
    rpc: 'update_workflow_execution',
    request_class: Temporalio::Api::WorkflowService::V1::UpdateWorkflowExecutionRequest,
    response_class: Temporalio::Api::WorkflowService::V1::UpdateWorkflowExecutionResponse,
    request:,
    rpc_options:
  )
end