Class: Temporalio::Connection::WorkflowService

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

Overview

A class for making WorkflowService RPCs

This is normally accessed via Temoralio::Connection#workflow_service.

Instance Method Summary collapse

Constructor Details

#initialize(core_connection) ⇒ WorkflowService

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of WorkflowService.



11
12
13
 
# File 'lib/temporalio/connection/workflow_service.rb', line 11

def initialize(core_connection)
  super(core_connection, :workflow_service)
end

Instance Method Details

#count_workflow_executions(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::CountWorkflowExecutionsResponse

Parameters:

Returns:



424
425
426
427
428
429
 
# File 'lib/temporalio/connection/workflow_service.rb', line 424

def count_workflow_executions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::CountWorkflowExecutionsRequest.encode(request)
  response = call(:count_workflow_executions, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::CountWorkflowExecutionsResponse.decode(response)
end

#create_schedule(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::CreateScheduleResponse

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::CreateScheduleRequest)
  • metadata (Hash<String, String>) (defaults to: {}) —

    Headers used on the RPC call. Keys here override client-level RPC metadata keys.

  • timeout (Integer) (defaults to: nil) —

    Optional RPC deadline to set for each RPC call.

Returns:



554
555
556
557
558
559
 
# File 'lib/temporalio/connection/workflow_service.rb', line 554

def create_schedule(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::CreateScheduleRequest.encode(request)
  response = call(:create_schedule, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::CreateScheduleResponse.decode(response)
end

#delete_schedule(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DeleteScheduleResponse

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::DeleteScheduleRequest)
  • metadata (Hash<String, String>) (defaults to: {}) —

    Headers used on the RPC call. Keys here override client-level RPC metadata keys.

  • timeout (Integer) (defaults to: nil) —

    Optional RPC deadline to set for each RPC call.

Returns:



619
620
621
622
623
624
 
# File 'lib/temporalio/connection/workflow_service.rb', line 619

def delete_schedule(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DeleteScheduleRequest.encode(request)
  response = call(:delete_schedule, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::DeleteScheduleResponse.decode(response)
end

#delete_workflow_execution(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DeleteWorkflowExecutionResponse

Parameters:

Returns:



346
347
348
349
350
351
 
# File 'lib/temporalio/connection/workflow_service.rb', line 346

def delete_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DeleteWorkflowExecutionRequest.encode(request)
  response = call(:delete_workflow_execution, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::DeleteWorkflowExecutionResponse.decode(response)
end

#deprecate_namespace(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DeprecateNamespaceResponse

Parameters:

Returns:



73
74
75
76
77
78
 
# File 'lib/temporalio/connection/workflow_service.rb', line 73

def deprecate_namespace(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DeprecateNamespaceRequest.encode(request)
  response = call(:deprecate_namespace, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::DeprecateNamespaceResponse.decode(response)
end

#describe_batch_operation(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeBatchOperationResponse

Parameters:

Returns:



710
711
712
713
714
715
 
# File 'lib/temporalio/connection/workflow_service.rb', line 710

def describe_batch_operation(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DescribeBatchOperationRequest.encode(request)
  response = call(:describe_batch_operation, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::DescribeBatchOperationResponse.decode(response)
end

#describe_namespace(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeNamespaceResponse

Parameters:

Returns:



34
35
36
37
38
39
 
# File 'lib/temporalio/connection/workflow_service.rb', line 34

def describe_namespace(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DescribeNamespaceRequest.encode(request)
  response = call(:describe_namespace, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::DescribeNamespaceResponse.decode(response)
end

#describe_schedule(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeScheduleResponse

Parameters:

Returns:



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

def describe_schedule(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DescribeScheduleRequest.encode(request)
  response = call(:describe_schedule, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::DescribeScheduleResponse.decode(response)
end

#describe_task_queue(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeTaskQueueResponse

Parameters:

Returns:



502
503
504
505
506
507
 
# File 'lib/temporalio/connection/workflow_service.rb', line 502

def describe_task_queue(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DescribeTaskQueueRequest.encode(request)
  response = call(:describe_task_queue, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::DescribeTaskQueueResponse.decode(response)
end

#describe_workflow_execution(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::DescribeWorkflowExecutionResponse

Parameters:

Returns:



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

def describe_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DescribeWorkflowExecutionRequest.encode(request)
  response = call(:describe_workflow_execution, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::DescribeWorkflowExecutionResponse.decode(response)
end

#get_cluster_info(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetClusterInfoResponse

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::GetClusterInfoRequest)
  • metadata (Hash<String, String>) (defaults to: {}) —

    Headers used on the RPC call. Keys here override client-level RPC metadata keys.

  • timeout (Integer) (defaults to: nil) —

    Optional RPC deadline to set for each RPC call.

Returns:



515
516
517
518
519
520
 
# File 'lib/temporalio/connection/workflow_service.rb', line 515

def get_cluster_info(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::GetClusterInfoRequest.encode(request)
  response = call(:get_cluster_info, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::GetClusterInfoResponse.decode(response)
end

#get_search_attributes(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetSearchAttributesResponse

Parameters:

Returns:



437
438
439
440
441
442
 
# File 'lib/temporalio/connection/workflow_service.rb', line 437

def get_search_attributes(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::GetSearchAttributesRequest.encode(request)
  response = call(:get_search_attributes, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::GetSearchAttributesResponse.decode(response)
end

#get_system_info(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetSystemInfoResponse

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::GetSystemInfoRequest)
  • metadata (Hash<String, String>) (defaults to: {}) —

    Headers used on the RPC call. Keys here override client-level RPC metadata keys.

  • timeout (Integer) (defaults to: nil) —

    Optional RPC deadline to set for each RPC call.

Returns:



528
529
530
531
532
533
 
# File 'lib/temporalio/connection/workflow_service.rb', line 528

def get_system_info(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::GetSystemInfoRequest.encode(request)
  response = call(:get_system_info, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::GetSystemInfoResponse.decode(response)
end

#get_worker_build_id_ordering(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkerBuildIdOrderingResponse

Parameters:

Returns:



658
659
660
661
662
663
 
# File 'lib/temporalio/connection/workflow_service.rb', line 658

def get_worker_build_id_ordering(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::GetWorkerBuildIdOrderingRequest.encode(request)
  response = call(:get_worker_build_id_ordering, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::GetWorkerBuildIdOrderingResponse.decode(response)
end

#get_workflow_execution_history(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryResponse

Parameters:

Returns:



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

def get_workflow_execution_history(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryRequest.encode(request)
  response = call(:get_workflow_execution_history, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryResponse.decode(response)
end

#get_workflow_execution_history_reverse(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryReverseResponse

Parameters:

Returns:



112
113
114
115
116
117
 
# File 'lib/temporalio/connection/workflow_service.rb', line 112

def get_workflow_execution_history_reverse(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryReverseRequest.encode(request)
  response = call(:get_workflow_execution_history_reverse, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryReverseResponse.decode(response)
end

#list_archived_workflow_executions(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListArchivedWorkflowExecutionsResponse

Parameters:

Returns:



398
399
400
401
402
403
 
# File 'lib/temporalio/connection/workflow_service.rb', line 398

def list_archived_workflow_executions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListArchivedWorkflowExecutionsRequest.encode(request)
  response = call(:list_archived_workflow_executions, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::ListArchivedWorkflowExecutionsResponse.decode(response)
end

#list_batch_operations(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListBatchOperationsResponse

Parameters:

Returns:



723
724
725
726
727
728
 
# File 'lib/temporalio/connection/workflow_service.rb', line 723

def list_batch_operations(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListBatchOperationsRequest.encode(request)
  response = call(:list_batch_operations, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::ListBatchOperationsResponse.decode(response)
end

#list_closed_workflow_executions(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListClosedWorkflowExecutionsResponse

Parameters:

Returns:



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

def list_closed_workflow_executions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListClosedWorkflowExecutionsRequest.encode(request)
  response = call(:list_closed_workflow_executions, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::ListClosedWorkflowExecutionsResponse.decode(response)
end

#list_namespaces(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListNamespacesResponse

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ListNamespacesRequest)
  • metadata (Hash<String, String>) (defaults to: {}) —

    Headers used on the RPC call. Keys here override client-level RPC metadata keys.

  • timeout (Integer) (defaults to: nil) —

    Optional RPC deadline to set for each RPC call.

Returns:



47
48
49
50
51
52
 
# File 'lib/temporalio/connection/workflow_service.rb', line 47

def list_namespaces(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListNamespacesRequest.encode(request)
  response = call(:list_namespaces, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::ListNamespacesResponse.decode(response)
end

#list_open_workflow_executions(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListOpenWorkflowExecutionsResponse

Parameters:

Returns:



359
360
361
362
363
364
 
# File 'lib/temporalio/connection/workflow_service.rb', line 359

def list_open_workflow_executions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListOpenWorkflowExecutionsRequest.encode(request)
  response = call(:list_open_workflow_executions, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::ListOpenWorkflowExecutionsResponse.decode(response)
end

#list_schedule_matching_times(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListScheduleMatchingTimesResponse

Parameters:

Returns:



606
607
608
609
610
611
 
# File 'lib/temporalio/connection/workflow_service.rb', line 606

def list_schedule_matching_times(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListScheduleMatchingTimesRequest.encode(request)
  response = call(:list_schedule_matching_times, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::ListScheduleMatchingTimesResponse.decode(response)
end

#list_schedules(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListSchedulesResponse

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::ListSchedulesRequest)
  • metadata (Hash<String, String>) (defaults to: {}) —

    Headers used on the RPC call. Keys here override client-level RPC metadata keys.

  • timeout (Integer) (defaults to: nil) —

    Optional RPC deadline to set for each RPC call.

Returns:



632
633
634
635
636
637
 
# File 'lib/temporalio/connection/workflow_service.rb', line 632

def list_schedules(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListSchedulesRequest.encode(request)
  response = call(:list_schedules, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::ListSchedulesResponse.decode(response)
end

#list_task_queue_partitions(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListTaskQueuePartitionsResponse

Parameters:

Returns:



541
542
543
544
545
546
 
# File 'lib/temporalio/connection/workflow_service.rb', line 541

def list_task_queue_partitions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListTaskQueuePartitionsRequest.encode(request)
  response = call(:list_task_queue_partitions, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::ListTaskQueuePartitionsResponse.decode(response)
end

#list_workflow_executions(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ListWorkflowExecutionsResponse

Parameters:

Returns:



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

def list_workflow_executions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListWorkflowExecutionsRequest.encode(request)
  response = call(:list_workflow_executions, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::ListWorkflowExecutionsResponse.decode(response)
end

#patch_schedule(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::PatchScheduleResponse

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::PatchScheduleRequest)
  • metadata (Hash<String, String>) (defaults to: {}) —

    Headers used on the RPC call. Keys here override client-level RPC metadata keys.

  • timeout (Integer) (defaults to: nil) —

    Optional RPC deadline to set for each RPC call.

Returns:



593
594
595
596
597
598
 
# File 'lib/temporalio/connection/workflow_service.rb', line 593

def patch_schedule(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::PatchScheduleRequest.encode(request)
  response = call(:patch_schedule, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::PatchScheduleResponse.decode(response)
end

#poll_activity_task_queue(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::PollActivityTaskQueueResponse

Parameters:

Returns:



164
165
166
167
168
169
 
# File 'lib/temporalio/connection/workflow_service.rb', line 164

def poll_activity_task_queue(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::PollActivityTaskQueueRequest.encode(request)
  response = call(:poll_activity_task_queue, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::PollActivityTaskQueueResponse.decode(response)
end

#poll_workflow_task_queue(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::PollWorkflowTaskQueueResponse

Parameters:

Returns:



125
126
127
128
129
130
 
# File 'lib/temporalio/connection/workflow_service.rb', line 125

def poll_workflow_task_queue(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::PollWorkflowTaskQueueRequest.encode(request)
  response = call(:poll_workflow_task_queue, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::PollWorkflowTaskQueueResponse.decode(response)
end

#query_workflow(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::QueryWorkflowResponse

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::QueryWorkflowRequest)
  • metadata (Hash<String, String>) (defaults to: {}) —

    Headers used on the RPC call. Keys here override client-level RPC metadata keys.

  • timeout (Integer) (defaults to: nil) —

    Optional RPC deadline to set for each RPC call.

Returns:



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

def query_workflow(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::QueryWorkflowRequest.encode(request)
  response = call(:query_workflow, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::QueryWorkflowResponse.decode(response)
end

#record_activity_task_heartbeat(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatResponse

Parameters:

Returns:



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

def record_activity_task_heartbeat(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatRequest.encode(request)
  response = call(:record_activity_task_heartbeat, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatResponse.decode(response)
end

#record_activity_task_heartbeat_by_id(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatByIdResponse

Parameters:

Returns:



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

def record_activity_task_heartbeat_by_id(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatByIdRequest.encode(request)
  response = call(:record_activity_task_heartbeat_by_id, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatByIdResponse.decode(response)
end

#register_namespace(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RegisterNamespaceResponse

Parameters:

Returns:



21
22
23
24
25
26
 
# File 'lib/temporalio/connection/workflow_service.rb', line 21

def register_namespace(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RegisterNamespaceRequest.encode(request)
  response = call(:register_namespace, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RegisterNamespaceResponse.decode(response)
end

#request_cancel_workflow_execution(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RequestCancelWorkflowExecutionResponse

Parameters:

Returns:



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

def request_cancel_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RequestCancelWorkflowExecutionRequest.encode(request)
  response = call(:request_cancel_workflow_execution, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RequestCancelWorkflowExecutionResponse.decode(response)
end

#reset_sticky_task_queue(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ResetStickyTaskQueueResponse

Parameters:

Returns:



463
464
465
466
467
468
 
# File 'lib/temporalio/connection/workflow_service.rb', line 463

def reset_sticky_task_queue(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ResetStickyTaskQueueRequest.encode(request)
  response = call(:reset_sticky_task_queue, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::ResetStickyTaskQueueResponse.decode(response)
end

#reset_workflow_execution(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ResetWorkflowExecutionResponse

Parameters:

Returns:



320
321
322
323
324
325
 
# File 'lib/temporalio/connection/workflow_service.rb', line 320

def reset_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ResetWorkflowExecutionRequest.encode(request)
  response = call(:reset_workflow_execution, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::ResetWorkflowExecutionResponse.decode(response)
end

#respond_activity_task_canceled(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledResponse

Parameters:

Returns:



255
256
257
258
259
260
 
# File 'lib/temporalio/connection/workflow_service.rb', line 255

def respond_activity_task_canceled(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledRequest.encode(request)
  response = call(:respond_activity_task_canceled, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledResponse.decode(response)
end

#respond_activity_task_canceled_by_id(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledByIdResponse

Parameters:

Returns:



268
269
270
271
272
273
 
# File 'lib/temporalio/connection/workflow_service.rb', line 268

def respond_activity_task_canceled_by_id(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledByIdRequest.encode(request)
  response = call(:respond_activity_task_canceled_by_id, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledByIdResponse.decode(response)
end

#respond_activity_task_completed(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedResponse

Parameters:

Returns:



203
204
205
206
207
208
 
# File 'lib/temporalio/connection/workflow_service.rb', line 203

def respond_activity_task_completed(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedRequest.encode(request)
  response = call(:respond_activity_task_completed, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedResponse.decode(response)
end

#respond_activity_task_completed_by_id(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedByIdResponse

Parameters:

Returns:



216
217
218
219
220
221
 
# File 'lib/temporalio/connection/workflow_service.rb', line 216

def respond_activity_task_completed_by_id(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedByIdRequest.encode(request)
  response = call(:respond_activity_task_completed_by_id, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedByIdResponse.decode(response)
end

#respond_activity_task_failed(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedResponse

Parameters:

Returns:



229
230
231
232
233
234
 
# File 'lib/temporalio/connection/workflow_service.rb', line 229

def respond_activity_task_failed(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedRequest.encode(request)
  response = call(:respond_activity_task_failed, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedResponse.decode(response)
end

#respond_activity_task_failed_by_id(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedByIdResponse

Parameters:

Returns:



242
243
244
245
246
247
 
# File 'lib/temporalio/connection/workflow_service.rb', line 242

def respond_activity_task_failed_by_id(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedByIdRequest.encode(request)
  response = call(:respond_activity_task_failed_by_id, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedByIdResponse.decode(response)
end

#respond_query_task_completed(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondQueryTaskCompletedResponse

Parameters:

Returns:



450
451
452
453
454
455
 
# File 'lib/temporalio/connection/workflow_service.rb', line 450

def respond_query_task_completed(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondQueryTaskCompletedRequest.encode(request)
  response = call(:respond_query_task_completed, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RespondQueryTaskCompletedResponse.decode(response)
end

#respond_workflow_task_completed(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskCompletedResponse

Parameters:

Returns:



138
139
140
141
142
143
 
# File 'lib/temporalio/connection/workflow_service.rb', line 138

def respond_workflow_task_completed(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskCompletedRequest.encode(request)
  response = call(:respond_workflow_task_completed, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskCompletedResponse.decode(response)
end

#respond_workflow_task_failed(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskFailedResponse

Parameters:

Returns:



151
152
153
154
155
156
 
# File 'lib/temporalio/connection/workflow_service.rb', line 151

def respond_workflow_task_failed(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskFailedRequest.encode(request)
  response = call(:respond_workflow_task_failed, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskFailedResponse.decode(response)
end

#scan_workflow_executions(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::ScanWorkflowExecutionsResponse

Parameters:

Returns:



411
412
413
414
415
416
 
# File 'lib/temporalio/connection/workflow_service.rb', line 411

def scan_workflow_executions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ScanWorkflowExecutionsRequest.encode(request)
  response = call(:scan_workflow_executions, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::ScanWorkflowExecutionsResponse.decode(response)
end

#signal_with_start_workflow_execution(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::SignalWithStartWorkflowExecutionResponse

Parameters:

Returns:



307
308
309
310
311
312
 
# File 'lib/temporalio/connection/workflow_service.rb', line 307

def signal_with_start_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::SignalWithStartWorkflowExecutionRequest.encode(request)
  response = call(:signal_with_start_workflow_execution, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::SignalWithStartWorkflowExecutionResponse.decode(response)
end

#signal_workflow_execution(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::SignalWorkflowExecutionResponse

Parameters:

Returns:



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

def signal_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::SignalWorkflowExecutionRequest.encode(request)
  response = call(:signal_workflow_execution, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::SignalWorkflowExecutionResponse.decode(response)
end

#start_batch_operation(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::StartBatchOperationResponse

Parameters:

Returns:



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

def start_batch_operation(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::StartBatchOperationRequest.encode(request)
  response = call(:start_batch_operation, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::StartBatchOperationResponse.decode(response)
end

#start_workflow_execution(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::StartWorkflowExecutionResponse

Parameters:

Returns:



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

def start_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::StartWorkflowExecutionRequest.encode(request)
  response = call(:start_workflow_execution, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::StartWorkflowExecutionResponse.decode(response)
end

#stop_batch_operation(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::StopBatchOperationResponse

Parameters:

Returns:



697
698
699
700
701
702
 
# File 'lib/temporalio/connection/workflow_service.rb', line 697

def stop_batch_operation(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::StopBatchOperationRequest.encode(request)
  response = call(:stop_batch_operation, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::StopBatchOperationResponse.decode(response)
end

#terminate_workflow_execution(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::TerminateWorkflowExecutionResponse

Parameters:

Returns:



333
334
335
336
337
338
 
# File 'lib/temporalio/connection/workflow_service.rb', line 333

def terminate_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::TerminateWorkflowExecutionRequest.encode(request)
  response = call(:terminate_workflow_execution, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::TerminateWorkflowExecutionResponse.decode(response)
end

#update_namespace(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateNamespaceResponse

Parameters:

Returns:



60
61
62
63
64
65
 
# File 'lib/temporalio/connection/workflow_service.rb', line 60

def update_namespace(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::UpdateNamespaceRequest.encode(request)
  response = call(:update_namespace, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::UpdateNamespaceResponse.decode(response)
end

#update_schedule(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateScheduleResponse

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::UpdateScheduleRequest)
  • metadata (Hash<String, String>) (defaults to: {}) —

    Headers used on the RPC call. Keys here override client-level RPC metadata keys.

  • timeout (Integer) (defaults to: nil) —

    Optional RPC deadline to set for each RPC call.

Returns:



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

def update_schedule(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::UpdateScheduleRequest.encode(request)
  response = call(:update_schedule, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::UpdateScheduleResponse.decode(response)
end

#update_worker_build_id_ordering(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateWorkerBuildIdOrderingResponse

Parameters:

Returns:



645
646
647
648
649
650
 
# File 'lib/temporalio/connection/workflow_service.rb', line 645

def update_worker_build_id_ordering(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::UpdateWorkerBuildIdOrderingRequest.encode(request)
  response = call(:update_worker_build_id_ordering, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::UpdateWorkerBuildIdOrderingResponse.decode(response)
end

#update_workflow_execution(request, metadata: {}, timeout: nil) ⇒ Temporalio::Api::WorkflowService::V1::UpdateWorkflowExecutionResponse

Parameters:

Returns:



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

def update_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::UpdateWorkflowExecutionRequest.encode(request)
  response = call(:update_workflow_execution, encoded, metadata, timeout)

  Temporalio::Api::WorkflowService::V1::UpdateWorkflowExecutionResponse.decode(response)
end