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

Inherits:

Data

• Object
• Data
• Temporalio::Client::Schedule::Action::StartWorkflow

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

• #arg_hints ⇒ Array<Object>^?

  Converter hints for workflow arguments.

• #args ⇒ Array<Object>

  Arguments to the workflow.

• #execution_timeout ⇒ Float^?

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

• #headers ⇒ Hash<String, Object>^?

  Headers for the workflow.

• #id ⇒ String

  Unique identifier for the workflow execution.

• #memo ⇒ Hash<String, Object>^?

  Memo for the workflow.

• #priority ⇒ Priority

  Priority of the workflow.

• #retry_policy ⇒ RetryPolicy^?

  Retry policy for the workflow.

• #run_timeout ⇒ Float^?

  Timeout of a single workflow run in seconds.

• #search_attributes ⇒ SearchAttributes^?

  Search attributes for the workflow.

• #static_details ⇒ String^?

  Fixed details for this workflow execution that may appear in CLI/UI.

• #static_summary ⇒ String^?

  Fixed single-line summary for this workflow execution that may appear in CLI/UI.

• #task_queue ⇒ String

  Task queue to run the workflow on.

• #task_timeout ⇒ Float^?

  Timeout of a single workflow task in seconds.

• #workflow ⇒ String

  Workflow.

Class Method Summary

• ._original_new ⇒ Object
• .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.

Instance Attribute Details

#arg_hints ⇒ Array<Object>^?

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

def arg_hints
  @arg_hints
end

#args ⇒ Array<Object>

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

def args
  @args
end

#execution_timeout ⇒ Float^?

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

def execution_timeout
  @execution_timeout
end

#headers ⇒ Hash<String, Object>^?

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

def headers
  @headers
end

#id ⇒ String

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

def id
  @id
end

#memo ⇒ Hash<String, Object>^?

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

def memo
  @memo
end

#priority ⇒ Priority

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

def priority
  @priority
end

#retry_policy ⇒ RetryPolicy^?

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

def retry_policy
  @retry_policy
end

#run_timeout ⇒ Float^?

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

def run_timeout
  @run_timeout
end

#search_attributes ⇒ SearchAttributes^?

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

def search_attributes
  @search_attributes
end

#static_details ⇒ String^?

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

def static_details
  @static_details
end

#static_summary ⇒ String^?

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

def static_summary
  @static_summary
end

#task_queue ⇒ String

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

def task_queue
  @task_queue
end

#task_timeout ⇒ Float^?

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

def task_timeout
  @task_timeout
end

#workflow ⇒ String

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

def workflow
  @workflow
end

Class Method Details

._original_new ⇒ Object

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

# 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