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

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

Overview

Schedule action to start a workflow.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#arg_hints ⇒ Array<Object>?

Returns Converter hints for workflow arguments. This is only user-set (e.g. on create) and is not persisted and therefore will not be set when describing a workflow.

Returns:

  • (Array<Object>, nil) —

    Converter hints for workflow arguments. This is only user-set (e.g. on create) and is not persisted and therefore will not be set when describing a workflow.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def arg_hints
  @arg_hints
end

#args ⇒ Array<Object>

Returns Arguments to the workflow.

Returns:

  • (Array<Object>) —

    Arguments to the workflow.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def args
  @args
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.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def execution_timeout
  @execution_timeout
end

#headers ⇒ Hash<String, Object>?

Returns Headers for the workflow.

Returns:

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

    Headers for the workflow.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def headers
  @headers
end

#id ⇒ String

Returns Unique identifier for the workflow execution.

Returns:

  • (String) —

    Unique identifier for the workflow execution.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def id
  @id
end

#memo ⇒ Hash<String, Object>?

Returns Memo for the workflow.

Returns:

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

    Memo for the workflow.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def memo
  @memo
end

#priority ⇒ Priority

Returns Priority of the workflow. This is currently experimental.

Returns:

  • (Priority) —

    Priority of the workflow. This is currently experimental.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def priority
  @priority
end

#retry_policy ⇒ RetryPolicy?

Returns Retry policy for the workflow.

Returns:

  • (RetryPolicy, nil) —

    Retry policy for the workflow.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def retry_policy
  @retry_policy
end

#run_timeout ⇒ Float?

Returns Timeout of a single workflow run in seconds.

Returns:

  • (Float, nil) —

    Timeout of a single workflow run in seconds.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def run_timeout
  @run_timeout
end

#search_attributes ⇒ SearchAttributes?

Returns Search attributes for the workflow.

Returns:



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def search_attributes
  @search_attributes
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.

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.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def static_details
  @static_details
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.

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.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def static_summary
  @static_summary
end

#task_queue ⇒ String

Returns Task queue to run the workflow on.

Returns:

  • (String) —

    Task queue to run the workflow on.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def task_queue
  @task_queue
end

#task_timeout ⇒ Float?

Returns Timeout of a single workflow task in seconds.

Returns:

  • (Float, nil) —

    Timeout of a single workflow task in seconds.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def task_timeout
  @task_timeout
end

#workflow ⇒ String

Returns Workflow.

Returns:

  • (String) —

    Workflow.



220
221
222
 
# File 'lib/temporalio/client/schedule.rb', line 220

def workflow
  @workflow
end

Class Method Details

._original_new ⇒ Object 



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

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, priority: Priority.default, arg_hints: 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.

  • 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.

  • 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.

  • priority (Priority) (defaults to: Priority.default) —

    Priority of the workflow. This is currently experimental.

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

    Headers for the workflow.



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
 
# File 'lib/temporalio/client/schedule.rb', line 247

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,
  priority: Priority.default,
  arg_hints: nil,
  headers: nil
)
  workflow, defn_arg_hints, =
    Workflow::Definition._workflow_type_and_hints_from_workflow_parameter(workflow)
  _original_new( # steep:ignore
    workflow:,
    args:,
    id:,
    task_queue:,
    static_summary:,
    static_details:,
    execution_timeout:,
    run_timeout:,
    task_timeout:,
    retry_policy:,
    memo:,
    search_attributes:,
    priority:,
    arg_hints: arg_hints || defn_arg_hints,
    headers:
  )
end