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

Instance Method Details

#count_workflow_executions(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::CountWorkflowExecutionsResponse

Calls WorkflowService.CountWorkflowExecutions API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::CountWorkflowExecutionsRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 634

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

#create_schedule(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::CreateScheduleResponse

Calls WorkflowService.CreateSchedule API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::CreateScheduleRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



824
825
826
827
828
829
830
831
832
833
834
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 824

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

#delete_schedule(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DeleteScheduleResponse

Calls WorkflowService.DeleteSchedule API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::DeleteScheduleRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



919
920
921
922
923
924
925
926
927
928
929
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 919

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

#delete_workflow_execution(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DeleteWorkflowExecutionResponse

Calls WorkflowService.DeleteWorkflowExecution API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::DeleteWorkflowExecutionRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#deprecate_namespace(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DeprecateNamespaceResponse

Calls WorkflowService.DeprecateNamespace API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::DeprecateNamespaceRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 102

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

#describe_batch_operation(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeBatchOperationResponse

Calls WorkflowService.DescribeBatchOperation API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::DescribeBatchOperationRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 1128

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

#describe_namespace(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeNamespaceResponse

Calls WorkflowService.DescribeNamespace API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::DescribeNamespaceRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 45

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

#describe_schedule(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeScheduleResponse

Calls WorkflowService.DescribeSchedule API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::DescribeScheduleRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 843

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

#describe_task_queue(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeTaskQueueResponse

Calls WorkflowService.DescribeTaskQueue API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::DescribeTaskQueueRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



748
749
750
751
752
753
754
755
756
757
758
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 748

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

#describe_workflow_execution(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeWorkflowExecutionResponse

Calls WorkflowService.DescribeWorkflowExecution API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::DescribeWorkflowExecutionRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#execute_multi_operation(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ExecuteMultiOperationResponse

Calls WorkflowService.ExecuteMultiOperation API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ExecuteMultiOperationRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 140

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

#get_cluster_info(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetClusterInfoResponse

Calls WorkflowService.GetClusterInfo API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::GetClusterInfoRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 767

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

#get_search_attributes(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetSearchAttributesResponse

Calls WorkflowService.GetSearchAttributes API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::GetSearchAttributesRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#get_system_info(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetSystemInfoResponse

Calls WorkflowService.GetSystemInfo API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::GetSystemInfoRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#get_worker_build_id_compatibility(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkerBuildIdCompatibilityResponse

Calls WorkflowService.GetWorkerBuildIdCompatibility API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::GetWorkerBuildIdCompatibilityRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 976

def get_worker_build_id_compatibility(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: 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_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#get_worker_task_reachability(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkerTaskReachabilityResponse

Calls WorkflowService.GetWorkerTaskReachability API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::GetWorkerTaskReachabilityRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 1033

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

#get_worker_versioning_rules(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkerVersioningRulesResponse

Calls WorkflowService.GetWorkerVersioningRules API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::GetWorkerVersioningRulesRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#get_workflow_execution_history(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryResponse

Calls WorkflowService.GetWorkflowExecutionHistory API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#get_workflow_execution_history_reverse(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryReverseResponse

Calls WorkflowService.GetWorkflowExecutionHistoryReverse API call.

Parameters:

Returns:



178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 178

def get_workflow_execution_history_reverse(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: 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_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#list_archived_workflow_executions(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListArchivedWorkflowExecutionsResponse

Calls WorkflowService.ListArchivedWorkflowExecutions API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ListArchivedWorkflowExecutionsRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 596

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

#list_batch_operations(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListBatchOperationsResponse

Calls WorkflowService.ListBatchOperations API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ListBatchOperationsRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 1147

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

#list_closed_workflow_executions(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListClosedWorkflowExecutionsResponse

Calls WorkflowService.ListClosedWorkflowExecutions API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ListClosedWorkflowExecutionsRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 558

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

#list_namespaces(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListNamespacesResponse

Calls WorkflowService.ListNamespaces API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ListNamespacesRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 64

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

#list_open_workflow_executions(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListOpenWorkflowExecutionsResponse

Calls WorkflowService.ListOpenWorkflowExecutions API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ListOpenWorkflowExecutionsRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 539

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

#list_schedule_matching_times(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListScheduleMatchingTimesResponse

Calls WorkflowService.ListScheduleMatchingTimes API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ListScheduleMatchingTimesRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



900
901
902
903
904
905
906
907
908
909
910
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 900

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

#list_schedules(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListSchedulesResponse

Calls WorkflowService.ListSchedules API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ListSchedulesRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#list_task_queue_partitions(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListTaskQueuePartitionsResponse

Calls WorkflowService.ListTaskQueuePartitions API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ListTaskQueuePartitionsRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#list_workflow_executions(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListWorkflowExecutionsResponse

Calls WorkflowService.ListWorkflowExecutions API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ListWorkflowExecutionsRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#patch_schedule(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::PatchScheduleResponse

Calls WorkflowService.PatchSchedule API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::PatchScheduleRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 881

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

#poll_activity_task_queue(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::PollActivityTaskQueueResponse

Calls WorkflowService.PollActivityTaskQueue API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::PollActivityTaskQueueRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 254

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

#poll_nexus_task_queue(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::PollNexusTaskQueueResponse

Calls WorkflowService.PollNexusTaskQueue API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::PollNexusTaskQueueRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 1166

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

#poll_workflow_execution_update(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::PollWorkflowExecutionUpdateResponse

Calls WorkflowService.PollWorkflowExecutionUpdate API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::PollWorkflowExecutionUpdateRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 1071

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

#poll_workflow_task_queue(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::PollWorkflowTaskQueueResponse

Calls WorkflowService.PollWorkflowTaskQueue API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::PollWorkflowTaskQueueRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 197

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

#query_workflow(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::QueryWorkflowResponse

Calls WorkflowService.QueryWorkflow API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::QueryWorkflowRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



710
711
712
713
714
715
716
717
718
719
720
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 710

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

#record_activity_task_heartbeat(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatResponse

Calls WorkflowService.RecordActivityTaskHeartbeat API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 273

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

#record_activity_task_heartbeat_by_id(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatByIdResponse

Calls WorkflowService.RecordActivityTaskHeartbeatById API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatByIdRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

def record_activity_task_heartbeat_by_id(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: 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_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#register_namespace(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RegisterNamespaceResponse

Calls WorkflowService.RegisterNamespace API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RegisterNamespaceRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 26

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

#request_cancel_workflow_execution(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RequestCancelWorkflowExecutionResponse

Calls WorkflowService.RequestCancelWorkflowExecution API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RequestCancelWorkflowExecutionRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 425

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

#reset_sticky_task_queue(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ResetStickyTaskQueueResponse

Calls WorkflowService.ResetStickyTaskQueue API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ResetStickyTaskQueueRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 691

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

#reset_workflow_execution(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ResetWorkflowExecutionResponse

Calls WorkflowService.ResetWorkflowExecution API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ResetWorkflowExecutionRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 482

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

#respond_activity_task_canceled(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledResponse

Calls WorkflowService.RespondActivityTaskCanceled API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 387

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

#respond_activity_task_canceled_by_id(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledByIdResponse

Calls WorkflowService.RespondActivityTaskCanceledById API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledByIdRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 406

def respond_activity_task_canceled_by_id(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: 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_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#respond_activity_task_completed(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedResponse

Calls WorkflowService.RespondActivityTaskCompleted API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 311

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

#respond_activity_task_completed_by_id(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedByIdResponse

Calls WorkflowService.RespondActivityTaskCompletedById API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedByIdRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 330

def respond_activity_task_completed_by_id(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: 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_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#respond_activity_task_failed(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedResponse

Calls WorkflowService.RespondActivityTaskFailed API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 349

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

#respond_activity_task_failed_by_id(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedByIdResponse

Calls WorkflowService.RespondActivityTaskFailedById API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedByIdRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

def respond_activity_task_failed_by_id(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: 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_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#respond_nexus_task_completed(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondNexusTaskCompletedResponse

Calls WorkflowService.RespondNexusTaskCompleted API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RespondNexusTaskCompletedRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 1185

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

#respond_nexus_task_failed(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondNexusTaskFailedResponse

Calls WorkflowService.RespondNexusTaskFailed API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RespondNexusTaskFailedRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 1204

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

#respond_query_task_completed(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondQueryTaskCompletedResponse

Calls WorkflowService.RespondQueryTaskCompleted API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RespondQueryTaskCompletedRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 672

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

#respond_workflow_task_completed(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskCompletedResponse

Calls WorkflowService.RespondWorkflowTaskCompleted API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskCompletedRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#respond_workflow_task_failed(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskFailedResponse

Calls WorkflowService.RespondWorkflowTaskFailed API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskFailedRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#scan_workflow_executions(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ScanWorkflowExecutionsResponse

Calls WorkflowService.ScanWorkflowExecutions API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ScanWorkflowExecutionsRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 615

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

#signal_with_start_workflow_execution(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::SignalWithStartWorkflowExecutionResponse

Calls WorkflowService.SignalWithStartWorkflowExecution API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::SignalWithStartWorkflowExecutionRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 463

def signal_with_start_workflow_execution(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: 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_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#signal_workflow_execution(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::SignalWorkflowExecutionResponse

Calls WorkflowService.SignalWorkflowExecution API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::SignalWorkflowExecutionRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#start_batch_operation(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::StartBatchOperationResponse

Calls WorkflowService.StartBatchOperation API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::StartBatchOperationRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 1090

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

#start_workflow_execution(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::StartWorkflowExecutionResponse

Calls WorkflowService.StartWorkflowExecution API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::StartWorkflowExecutionRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 121

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

#stop_batch_operation(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::StopBatchOperationResponse

Calls WorkflowService.StopBatchOperation API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::StopBatchOperationRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 1109

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

#terminate_workflow_execution(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::TerminateWorkflowExecutionResponse

Calls WorkflowService.TerminateWorkflowExecution API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::TerminateWorkflowExecutionRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#update_namespace(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateNamespaceResponse

Calls WorkflowService.UpdateNamespace API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::UpdateNamespaceRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#update_schedule(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateScheduleResponse

Calls WorkflowService.UpdateSchedule API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::UpdateScheduleRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



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

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

#update_worker_build_id_compatibility(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateWorkerBuildIdCompatibilityResponse

Calls WorkflowService.UpdateWorkerBuildIdCompatibility API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::UpdateWorkerBuildIdCompatibilityRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



957
958
959
960
961
962
963
964
965
966
967
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 957

def update_worker_build_id_compatibility(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: 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_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#update_worker_versioning_rules(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateWorkerVersioningRulesResponse

Calls WorkflowService.UpdateWorkerVersioningRules API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::UpdateWorkerVersioningRulesRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



995
996
997
998
999
1000
1001
1002
1003
1004
1005
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 995

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

#update_workflow_execution(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateWorkflowExecutionResponse

Calls WorkflowService.UpdateWorkflowExecution API call.

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::UpdateWorkflowExecutionRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'lib/temporalio/client/connection/workflow_service.rb', line 1052

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