Class: Temporalio::Connection

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

Overview

A connection to the Temporal server.

This is used to instantiate a Client. But it also can be used for a direct interaction with the API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host) ⇒ Connection

Returns a new instance of Connection.

Parameters:

  • host (String) —

    ‘host:port` for the Temporal server. For local development, this is often `“localhost:7233”`.



18
19
20
21
22
 
# File 'lib/temporalio/connection.rb', line 18

def initialize(host)
  url = parse_url(host)
  runtime = Temporalio::Runtime.instance
  @core_connection = Temporalio::Bridge::Connection.connect(runtime.core_runtime, url)
end

Instance Attribute Details

#core_connection ⇒ Object (readonly)

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. 



14
15
16
 
# File 'lib/temporalio/connection.rb', line 14

def core_connection
  @core_connection
end

Instance Method Details

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

Parameters:

Returns:



433
434
435
436
437
438
 
# File 'lib/temporalio/connection.rb', line 433

def count_workflow_executions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::CountWorkflowExecutionsRequest.encode(request)
  response = core_connection.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:



563
564
565
566
567
568
 
# File 'lib/temporalio/connection.rb', line 563

def create_schedule(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::CreateScheduleRequest.encode(request)
  response = core_connection.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:



628
629
630
631
632
633
 
# File 'lib/temporalio/connection.rb', line 628

def delete_schedule(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DeleteScheduleRequest.encode(request)
  response = core_connection.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:



355
356
357
358
359
360
 
# File 'lib/temporalio/connection.rb', line 355

def delete_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DeleteWorkflowExecutionRequest.encode(request)
  response = core_connection.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:



82
83
84
85
86
87
 
# File 'lib/temporalio/connection.rb', line 82

def deprecate_namespace(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DeprecateNamespaceRequest.encode(request)
  response = core_connection.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:



719
720
721
722
723
724
 
# File 'lib/temporalio/connection.rb', line 719

def describe_batch_operation(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DescribeBatchOperationRequest.encode(request)
  response = core_connection.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:



43
44
45
46
47
48
 
# File 'lib/temporalio/connection.rb', line 43

def describe_namespace(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DescribeNamespaceRequest.encode(request)
  response = core_connection.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:



576
577
578
579
580
581
 
# File 'lib/temporalio/connection.rb', line 576

def describe_schedule(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DescribeScheduleRequest.encode(request)
  response = core_connection.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:



511
512
513
514
515
516
 
# File 'lib/temporalio/connection.rb', line 511

def describe_task_queue(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DescribeTaskQueueRequest.encode(request)
  response = core_connection.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:



498
499
500
501
502
503
 
# File 'lib/temporalio/connection.rb', line 498

def describe_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::DescribeWorkflowExecutionRequest.encode(request)
  response = core_connection.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:



524
525
526
527
528
529
 
# File 'lib/temporalio/connection.rb', line 524

def get_cluster_info(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::GetClusterInfoRequest.encode(request)
  response = core_connection.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:



446
447
448
449
450
451
 
# File 'lib/temporalio/connection.rb', line 446

def get_search_attributes(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::GetSearchAttributesRequest.encode(request)
  response = core_connection.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:



537
538
539
540
541
542
 
# File 'lib/temporalio/connection.rb', line 537

def get_system_info(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::GetSystemInfoRequest.encode(request)
  response = core_connection.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:



667
668
669
670
671
672
 
# File 'lib/temporalio/connection.rb', line 667

def get_worker_build_id_ordering(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::GetWorkerBuildIdOrderingRequest.encode(request)
  response = core_connection.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:



108
109
110
111
112
113
 
# File 'lib/temporalio/connection.rb', line 108

def get_workflow_execution_history(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryRequest.encode(request)
  response = core_connection.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:



121
122
123
124
125
126
 
# File 'lib/temporalio/connection.rb', line 121

def get_workflow_execution_history_reverse(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::GetWorkflowExecutionHistoryReverseRequest.encode(request)
  response = core_connection.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:



407
408
409
410
411
412
 
# File 'lib/temporalio/connection.rb', line 407

def list_archived_workflow_executions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListArchivedWorkflowExecutionsRequest.encode(request)
  response = core_connection.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:



732
733
734
735
736
737
 
# File 'lib/temporalio/connection.rb', line 732

def list_batch_operations(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListBatchOperationsRequest.encode(request)
  response = core_connection.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:



381
382
383
384
385
386
 
# File 'lib/temporalio/connection.rb', line 381

def list_closed_workflow_executions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListClosedWorkflowExecutionsRequest.encode(request)
  response = core_connection.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:



56
57
58
59
60
61
 
# File 'lib/temporalio/connection.rb', line 56

def list_namespaces(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListNamespacesRequest.encode(request)
  response = core_connection.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:



368
369
370
371
372
373
 
# File 'lib/temporalio/connection.rb', line 368

def list_open_workflow_executions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListOpenWorkflowExecutionsRequest.encode(request)
  response = core_connection.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:



615
616
617
618
619
620
 
# File 'lib/temporalio/connection.rb', line 615

def list_schedule_matching_times(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListScheduleMatchingTimesRequest.encode(request)
  response = core_connection.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:



641
642
643
644
645
646
 
# File 'lib/temporalio/connection.rb', line 641

def list_schedules(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListSchedulesRequest.encode(request)
  response = core_connection.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:



550
551
552
553
554
555
 
# File 'lib/temporalio/connection.rb', line 550

def list_task_queue_partitions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListTaskQueuePartitionsRequest.encode(request)
  response = core_connection.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:



394
395
396
397
398
399
 
# File 'lib/temporalio/connection.rb', line 394

def list_workflow_executions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ListWorkflowExecutionsRequest.encode(request)
  response = core_connection.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:



602
603
604
605
606
607
 
# File 'lib/temporalio/connection.rb', line 602

def patch_schedule(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::PatchScheduleRequest.encode(request)
  response = core_connection.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:



173
174
175
176
177
178
 
# File 'lib/temporalio/connection.rb', line 173

def poll_activity_task_queue(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::PollActivityTaskQueueRequest.encode(request)
  response = core_connection.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:



134
135
136
137
138
139
 
# File 'lib/temporalio/connection.rb', line 134

def poll_workflow_task_queue(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::PollWorkflowTaskQueueRequest.encode(request)
  response = core_connection.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:



485
486
487
488
489
490
 
# File 'lib/temporalio/connection.rb', line 485

def query_workflow(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::QueryWorkflowRequest.encode(request)
  response = core_connection.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:



186
187
188
189
190
191
 
# File 'lib/temporalio/connection.rb', line 186

def record_activity_task_heartbeat(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatRequest.encode(request)
  response = core_connection.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:



199
200
201
202
203
204
 
# File 'lib/temporalio/connection.rb', line 199

def record_activity_task_heartbeat_by_id(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RecordActivityTaskHeartbeatByIdRequest.encode(request)
  response = core_connection.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:



30
31
32
33
34
35
 
# File 'lib/temporalio/connection.rb', line 30

def register_namespace(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RegisterNamespaceRequest.encode(request)
  response = core_connection.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:



290
291
292
293
294
295
 
# File 'lib/temporalio/connection.rb', line 290

def request_cancel_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RequestCancelWorkflowExecutionRequest.encode(request)
  response = core_connection.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:



472
473
474
475
476
477
 
# File 'lib/temporalio/connection.rb', line 472

def reset_sticky_task_queue(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ResetStickyTaskQueueRequest.encode(request)
  response = core_connection.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:



329
330
331
332
333
334
 
# File 'lib/temporalio/connection.rb', line 329

def reset_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ResetWorkflowExecutionRequest.encode(request)
  response = core_connection.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:



264
265
266
267
268
269
 
# File 'lib/temporalio/connection.rb', line 264

def respond_activity_task_canceled(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledRequest.encode(request)
  response = core_connection.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:



277
278
279
280
281
282
 
# File 'lib/temporalio/connection.rb', line 277

def respond_activity_task_canceled_by_id(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondActivityTaskCanceledByIdRequest.encode(request)
  response = core_connection.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:



212
213
214
215
216
217
 
# File 'lib/temporalio/connection.rb', line 212

def respond_activity_task_completed(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedRequest.encode(request)
  response = core_connection.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:



225
226
227
228
229
230
 
# File 'lib/temporalio/connection.rb', line 225

def respond_activity_task_completed_by_id(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondActivityTaskCompletedByIdRequest.encode(request)
  response = core_connection.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:



238
239
240
241
242
243
 
# File 'lib/temporalio/connection.rb', line 238

def respond_activity_task_failed(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedRequest.encode(request)
  response = core_connection.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:



251
252
253
254
255
256
 
# File 'lib/temporalio/connection.rb', line 251

def respond_activity_task_failed_by_id(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondActivityTaskFailedByIdRequest.encode(request)
  response = core_connection.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:



459
460
461
462
463
464
 
# File 'lib/temporalio/connection.rb', line 459

def respond_query_task_completed(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondQueryTaskCompletedRequest.encode(request)
  response = core_connection.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:



147
148
149
150
151
152
 
# File 'lib/temporalio/connection.rb', line 147

def respond_workflow_task_completed(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskCompletedRequest.encode(request)
  response = core_connection.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:



160
161
162
163
164
165
 
# File 'lib/temporalio/connection.rb', line 160

def respond_workflow_task_failed(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::RespondWorkflowTaskFailedRequest.encode(request)
  response = core_connection.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:



420
421
422
423
424
425
 
# File 'lib/temporalio/connection.rb', line 420

def scan_workflow_executions(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::ScanWorkflowExecutionsRequest.encode(request)
  response = core_connection.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:



316
317
318
319
320
321
 
# File 'lib/temporalio/connection.rb', line 316

def signal_with_start_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::SignalWithStartWorkflowExecutionRequest.encode(request)
  response = core_connection.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:



303
304
305
306
307
308
 
# File 'lib/temporalio/connection.rb', line 303

def signal_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::SignalWorkflowExecutionRequest.encode(request)
  response = core_connection.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:



693
694
695
696
697
698
 
# File 'lib/temporalio/connection.rb', line 693

def start_batch_operation(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::StartBatchOperationRequest.encode(request)
  response = core_connection.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:



95
96
97
98
99
100
 
# File 'lib/temporalio/connection.rb', line 95

def start_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::StartWorkflowExecutionRequest.encode(request)
  response = core_connection.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:



706
707
708
709
710
711
 
# File 'lib/temporalio/connection.rb', line 706

def stop_batch_operation(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::StopBatchOperationRequest.encode(request)
  response = core_connection.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:



342
343
344
345
346
347
 
# File 'lib/temporalio/connection.rb', line 342

def terminate_workflow_execution(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::TerminateWorkflowExecutionRequest.encode(request)
  response = core_connection.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:



69
70
71
72
73
74
 
# File 'lib/temporalio/connection.rb', line 69

def update_namespace(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::UpdateNamespaceRequest.encode(request)
  response = core_connection.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:



589
590
591
592
593
594
 
# File 'lib/temporalio/connection.rb', line 589

def update_schedule(request, metadata: {}, timeout: nil)
  encoded = Temporalio::Api::WorkflowService::V1::UpdateScheduleRequest.encode(request)
  response = core_connection.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:



654
655
656
657
658
659
 
# File 'lib/temporalio/connection.rb', line 654

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

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

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

Parameters:

  • request (Temporalio::Api::WorkflowService::V1::UpdateWorkflowRequest)
  • 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:



680
681
682
683
684
685
 
# File 'lib/temporalio/connection.rb', line 680

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

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