Class: Temporalio::Workflow::Definition::Query

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

Overview

A query definition. This is usually built as a result of a workflow_query method, but can be manually created to set at runtime on Temporalio::Workflow.query_handlers.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, to_invoke:, description: nil, raw_args: false) ⇒ Query

Create a query definition manually. See Temporalio::Workflow::Definition.workflow_query for more details on some of the parameters.

Parameters:

  • name (String, nil) —

    Name or nil if dynamic.

  • to_invoke (Symbol, Proc) —

    Method name or proc to invoke.

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

    Description for this handler that may appear in CLI/UI. This is currently experimental.

  • raw_args (Boolean) (defaults to: false) —

    Whether the parameters should be raw values.



525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/temporalio/workflow/definition.rb', line 525

def initialize(
  name:,
  to_invoke:,
  description: nil,
  raw_args: false
)
  @name = name
  @to_invoke = to_invoke
  @description = description
  @raw_args = raw_args
  Internal::ProtoUtils.assert_non_reserved_name(name)
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



503
504
505
 
# File 'lib/temporalio/workflow/definition.rb', line 503

def description
  @description
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



503
504
505
 
# File 'lib/temporalio/workflow/definition.rb', line 503

def name
  @name
end

#raw_args ⇒ Object (readonly)

Returns the value of attribute raw_args.



503
504
505
 
# File 'lib/temporalio/workflow/definition.rb', line 503

def raw_args
  @raw_args
end

#to_invoke ⇒ Object (readonly)

Returns the value of attribute to_invoke.



503
504
505
 
# File 'lib/temporalio/workflow/definition.rb', line 503

def to_invoke
  @to_invoke
end