Class: Temporal::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/temporal/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”`.



16
17
18
19
20
 
# File 'lib/temporal/connection.rb', line 16

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

Instance Attribute Details

#core_connection ⇒ Object (readonly)

Returns the value of attribute core_connection.



12
13
14
 
# File 'lib/temporal/connection.rb', line 12

def core_connection
  @core_connection
end

Instance Method Details

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

Parameters:

Returns:



418
419
420
421
422
423
 
# File 'lib/temporal/connection.rb', line 418

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

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

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

Parameters:

  • request (Temporal::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:



548
549
550
551
552
553
 
# File 'lib/temporal/connection.rb', line 548

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

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

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

Parameters:

  • request (Temporal::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:



613
614
615
616
617
618
 
# File 'lib/temporal/connection.rb', line 613

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

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

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

Parameters:

Returns:



80
81
82
83
84
85
 
# File 'lib/temporal/connection.rb', line 80

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

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

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

Parameters:

Returns:



704
705
706
707
708
709
 
# File 'lib/temporal/connection.rb', line 704

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

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

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

Parameters:

Returns:



41
42
43
44
45
46
 
# File 'lib/temporal/connection.rb', line 41

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

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

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

Parameters:

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



561
562
563
564
565
566
 
# File 'lib/temporal/connection.rb', line 561

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

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

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

Parameters:

Returns:



496
497
498
499
500
501
 
# File 'lib/temporal/connection.rb', line 496

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

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

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

Parameters:

Returns:



483
484
485
486
487
488
 
# File 'lib/temporal/connection.rb', line 483

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

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

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

Parameters:

  • request (Temporal::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:



509
510
511
512
513
514
 
# File 'lib/temporal/connection.rb', line 509

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

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

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

Parameters:

Returns:



431
432
433
434
435
436
 
# File 'lib/temporal/connection.rb', line 431

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

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

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

Parameters:

  • request (Temporal::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:



522
523
524
525
526
527
 
# File 'lib/temporal/connection.rb', line 522

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

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

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

Parameters:

Returns:



652
653
654
655
656
657
 
# File 'lib/temporal/connection.rb', line 652

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

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

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

Parameters:

Returns:



106
107
108
109
110
111
 
# File 'lib/temporal/connection.rb', line 106

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

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

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

Parameters:

Returns:



119
120
121
122
123
124
 
# File 'lib/temporal/connection.rb', line 119

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

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

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

Parameters:

Returns:



392
393
394
395
396
397
 
# File 'lib/temporal/connection.rb', line 392

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

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

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

Parameters:

Returns:



717
718
719
720
721
722
 
# File 'lib/temporal/connection.rb', line 717

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

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

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

Parameters:

Returns:



366
367
368
369
370
371
 
# File 'lib/temporal/connection.rb', line 366

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

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

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

Parameters:

  • request (Temporal::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:



54
55
56
57
58
59
 
# File 'lib/temporal/connection.rb', line 54

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

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

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

Parameters:

Returns:



353
354
355
356
357
358
 
# File 'lib/temporal/connection.rb', line 353

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

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

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

Parameters:

Returns:



600
601
602
603
604
605
 
# File 'lib/temporal/connection.rb', line 600

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

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

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

Parameters:

  • request (Temporal::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:



626
627
628
629
630
631
 
# File 'lib/temporal/connection.rb', line 626

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

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

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

Parameters:

Returns:



535
536
537
538
539
540
 
# File 'lib/temporal/connection.rb', line 535

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

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

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

Parameters:

Returns:



379
380
381
382
383
384
 
# File 'lib/temporal/connection.rb', line 379

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

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

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

Parameters:

  • request (Temporal::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:



587
588
589
590
591
592
 
# File 'lib/temporal/connection.rb', line 587

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

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

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

Parameters:

Returns:



171
172
173
174
175
176
 
# File 'lib/temporal/connection.rb', line 171

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

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

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

Parameters:

Returns:



132
133
134
135
136
137
 
# File 'lib/temporal/connection.rb', line 132

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

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

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

Parameters:

  • request (Temporal::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:



470
471
472
473
474
475
 
# File 'lib/temporal/connection.rb', line 470

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

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

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

Parameters:

Returns:



184
185
186
187
188
189
 
# File 'lib/temporal/connection.rb', line 184

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

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

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

Parameters:

Returns:



197
198
199
200
201
202
 
# File 'lib/temporal/connection.rb', line 197

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

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

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

Parameters:

Returns:



28
29
30
31
32
33
 
# File 'lib/temporal/connection.rb', line 28

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

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

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

Parameters:

Returns:



288
289
290
291
292
293
 
# File 'lib/temporal/connection.rb', line 288

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

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

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

Parameters:

Returns:



457
458
459
460
461
462
 
# File 'lib/temporal/connection.rb', line 457

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

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

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

Parameters:

Returns:



327
328
329
330
331
332
 
# File 'lib/temporal/connection.rb', line 327

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

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

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

Parameters:

Returns:



262
263
264
265
266
267
 
# File 'lib/temporal/connection.rb', line 262

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

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

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

Parameters:

Returns:



275
276
277
278
279
280
 
# File 'lib/temporal/connection.rb', line 275

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

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

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

Parameters:

Returns:



210
211
212
213
214
215
 
# File 'lib/temporal/connection.rb', line 210

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

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

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

Parameters:

Returns:



223
224
225
226
227
228
 
# File 'lib/temporal/connection.rb', line 223

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

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

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

Parameters:

Returns:



236
237
238
239
240
241
 
# File 'lib/temporal/connection.rb', line 236

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

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

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

Parameters:

Returns:



249
250
251
252
253
254
 
# File 'lib/temporal/connection.rb', line 249

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

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

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

Parameters:

Returns:



444
445
446
447
448
449
 
# File 'lib/temporal/connection.rb', line 444

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

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

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

Parameters:

Returns:



145
146
147
148
149
150
 
# File 'lib/temporal/connection.rb', line 145

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

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

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

Parameters:

Returns:



158
159
160
161
162
163
 
# File 'lib/temporal/connection.rb', line 158

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

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

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

Parameters:

Returns:



405
406
407
408
409
410
 
# File 'lib/temporal/connection.rb', line 405

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

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

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

Parameters:

Returns:



314
315
316
317
318
319
 
# File 'lib/temporal/connection.rb', line 314

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

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

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

Parameters:

Returns:



301
302
303
304
305
306
 
# File 'lib/temporal/connection.rb', line 301

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

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

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

Parameters:

Returns:



678
679
680
681
682
683
 
# File 'lib/temporal/connection.rb', line 678

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

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

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

Parameters:

Returns:



93
94
95
96
97
98
 
# File 'lib/temporal/connection.rb', line 93

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

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

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

Parameters:

Returns:



691
692
693
694
695
696
 
# File 'lib/temporal/connection.rb', line 691

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

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

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

Parameters:

Returns:



340
341
342
343
344
345
 
# File 'lib/temporal/connection.rb', line 340

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

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

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

Parameters:

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



67
68
69
70
71
72
 
# File 'lib/temporal/connection.rb', line 67

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

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

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

Parameters:

  • request (Temporal::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:



574
575
576
577
578
579
 
# File 'lib/temporal/connection.rb', line 574

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

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

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

Parameters:

Returns:



639
640
641
642
643
644
 
# File 'lib/temporal/connection.rb', line 639

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

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

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

Parameters:

  • request (Temporal::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:



665
666
667
668
669
670
 
# File 'lib/temporal/connection.rb', line 665

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

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