Class: Temporalio::Client::Schedule::Action::StartWorkflow

Inherits:
Object
  • Object
show all
Includes:
Temporalio::Client::Schedule::Action
Defined in:
lib/temporalio/client/schedule.rb

Overview

Schedule action to start a workflow.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#args ⇒ Array<Object>

Returns Arguments to the workflow.

Returns:

  • (Array<Object>) —

    Arguments to the workflow.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

#execution_timeout ⇒ Float?

Returns Total workflow execution timeout in seconds including retries and continue as new.

Returns:

  • (Float, nil) —

    Total workflow execution timeout in seconds including retries and continue as new.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

#headers ⇒ Hash<String, Object>?

Returns Headers for the workflow.

Returns:

  • (Hash<String, Object>, nil) —

    Headers for the workflow.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

#id ⇒ String

Returns Unique identifier for the workflow execution.

Returns:

  • (String) —

    Unique identifier for the workflow execution.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

#memo ⇒ Hash<String, Object>?

Returns Memo for the workflow.

Returns:

  • (Hash<String, Object>, nil) —

    Memo for the workflow.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

#retry_policy ⇒ RetryPolicy?

Returns Retry policy for the workflow.

Returns:

  • (RetryPolicy, nil) —

    Retry policy for the workflow.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

#run_timeout ⇒ Float?

Returns Timeout of a single workflow run in seconds.

Returns:

  • (Float, nil) —

    Timeout of a single workflow run in seconds.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

#search_attributes ⇒ SearchAttributes?

Returns Search attributes for the workflow.

Returns:



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

#static_details ⇒ String?

Returns Fixed details for this workflow execution that may appear in CLI/UI. This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow that cannot be updated. For details that can be updated, use Workflow.current_details= within the workflow. This is currently experimental.

Returns:

  • (String, nil) —

    Fixed details for this workflow execution that may appear in CLI/UI. This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow that cannot be updated. For details that can be updated, use Workflow.current_details= within the workflow. This is currently experimental.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

#static_summary ⇒ String?

Returns Fixed single-line summary for this workflow execution that may appear in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.

Returns:

  • (String, nil) —

    Fixed single-line summary for this workflow execution that may appear in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

#task_queue ⇒ String

Returns Task queue to run the workflow on.

Returns:

  • (String) —

    Task queue to run the workflow on.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

#task_timeout ⇒ Float?

Returns Timeout of a single workflow task in seconds.

Returns:

  • (Float, nil) —

    Timeout of a single workflow task in seconds.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

#workflow ⇒ String

Returns Workflow.

Returns:

  • (String) —

    Workflow.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/temporalio/client/schedule.rb', line 213

class StartWorkflow
  include Action

  class << self
    alias _original_new new

    # Create start-workflow schedule action.
    #
    # @param workflow [Class<Workflow::Definition>, Symbol, String] Workflow.
    # @param args [Array<Object>] Arguments to the workflow.
    # @param id [String] Unique identifier for the workflow execution.
    # @param task_queue [String] Task queue to run the workflow on.
    # @param static_summary [String, nil] Fixed single-line summary for this workflow execution that may appear
    #   in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.
    # @param static_details [String, nil] Fixed details for this workflow execution that may appear in CLI/UI.
    #   This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow
    #   that cannot be updated. For details that can be updated, use {Workflow.current_details=} within the
    #   workflow. This is currently experimental.
    # @param execution_timeout [Float, nil] Total workflow execution timeout in seconds including retries and
    #   continue as new.
    # @param run_timeout [Float, nil] Timeout of a single workflow run in seconds.
    # @param task_timeout [Float, nil] Timeout of a single workflow task in seconds.
    # @param retry_policy [RetryPolicy, nil] Retry policy for the workflow.
    # @param memo [Hash<String, Object>, nil] Memo for the workflow.
    # @param search_attributes [SearchAttributes, nil] Search attributes for the workflow.
    # @param headers [Hash<String, Object>, nil] Headers for the workflow.
    def new(
      workflow,
      *args,
      id:,
      task_queue:,
      static_summary: nil,
      static_details: nil,
      execution_timeout: nil,
      run_timeout: nil,
      task_timeout: nil,
      retry_policy: nil,
      memo: nil,
      search_attributes: nil,
      headers: nil
    )
      _original_new( # steep:ignore
        workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
        args:,
        id:,
        task_queue:,
        static_summary:,
        static_details:,
        execution_timeout:,
        run_timeout:,
        task_timeout:,
        retry_policy:,
        memo:,
        search_attributes:,
        headers:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_info, data_converter)
    (summary, details) = Internal::ProtoUtils.from_user_metadata(raw_info.user_metadata, data_converter)
    StartWorkflow.new(
      raw_info.workflow_type.name,
      *data_converter.from_payloads(raw_info.input),
      id: raw_info.workflow_id,
      task_queue: raw_info.task_queue.name,
      static_summary: summary,
      static_details: details,
      execution_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_execution_timeout),
      run_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_run_timeout),
      task_timeout: Internal::ProtoUtils.duration_to_seconds(raw_info.workflow_task_timeout),
      retry_policy: raw_info.retry_policy ? RetryPolicy._from_proto(raw_info.retry_policy) : nil,
      memo: Internal::ProtoUtils.memo_from_proto(raw_info.memo, data_converter),
      search_attributes: SearchAttributes._from_proto(raw_info.search_attributes),
      headers: Internal::ProtoUtils.headers_from_proto(raw_info.header, data_converter)
    )
  end

  # @!visibility private
  def _to_proto(data_converter)
    Api::Schedule::V1::ScheduleAction.new(
      start_workflow: Api::Workflow::V1::NewWorkflowExecutionInfo.new(
        workflow_id: id,
        workflow_type: Api::Common::V1::WorkflowType.new(name: workflow),
        task_queue: Api::TaskQueue::V1::TaskQueue.new(name: task_queue),
        input: data_converter.to_payloads(args),
        workflow_execution_timeout: Internal::ProtoUtils.seconds_to_duration(execution_timeout),
        workflow_run_timeout: Internal::ProtoUtils.seconds_to_duration(run_timeout),
        workflow_task_timeout: Internal::ProtoUtils.seconds_to_duration(task_timeout),
        retry_policy: retry_policy&._to_proto,
        memo: Internal::ProtoUtils.memo_to_proto(memo, data_converter),
        search_attributes: search_attributes&._to_proto,
        header: Internal::ProtoUtils.headers_to_proto(headers, data_converter),
        user_metadata: Internal::ProtoUtils.to_user_metadata(static_summary, static_details, data_converter)
      )
    )
  end
end

Class Method Details

._original_new ⇒ Object 



217
 
# File 'lib/temporalio/client/schedule.rb', line 217

alias _original_new new

.new(workflow, *args, id:, task_queue:, static_summary: nil, static_details: nil, execution_timeout: nil, run_timeout: nil, task_timeout: nil, retry_policy: nil, memo: nil, search_attributes: nil, headers: nil) ⇒ Object

Create start-workflow schedule action.

Parameters:

  • workflow (Class<Workflow::Definition>, Symbol, String) —

    Workflow.

  • args (Array<Object>) —

    Arguments to the workflow.

  • id (String) —

    Unique identifier for the workflow execution.

  • task_queue (String) —

    Task queue to run the workflow on.

  • static_summary (String, nil) (defaults to: nil) —

    Fixed single-line summary for this workflow execution that may appear in CLI/UI. This can be in single-line Temporal markdown format. This is currently experimental.

  • static_details (String, nil) (defaults to: nil) —

    Fixed details for this workflow execution that may appear in CLI/UI. This can be in Temporal markdown format and can be multiple lines. This is a fixed value on the workflow that cannot be updated. For details that can be updated, use Workflow.current_details= within the workflow. This is currently experimental.

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

    Total workflow execution timeout in seconds including retries and continue as new.

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

    Timeout of a single workflow run in seconds.

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

    Timeout of a single workflow task in seconds.

  • retry_policy (RetryPolicy, nil) (defaults to: nil) —

    Retry policy for the workflow.

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

    Memo for the workflow.

  • search_attributes (SearchAttributes, nil) (defaults to: nil) —

    Search attributes for the workflow.

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

    Headers for the workflow.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/temporalio/client/schedule.rb', line 239

def new(
  workflow,
  *args,
  id:,
  task_queue:,
  static_summary: nil,
  static_details: nil,
  execution_timeout: nil,
  run_timeout: nil,
  task_timeout: nil,
  retry_policy: nil,
  memo: nil,
  search_attributes: nil,
  headers: nil
)
  _original_new( # steep:ignore
    workflow: Workflow::Definition._workflow_type_from_workflow_parameter(workflow),
    args:,
    id:,
    task_queue:,
    static_summary:,
    static_details:,
    execution_timeout:,
    run_timeout:,
    task_timeout:,
    retry_policy:,
    memo:,
    search_attributes:,
    headers:
  )
end