Class: Temporalio::Activity::CancellationDetails

Inherits:

Object

• Object
• Temporalio::Activity::CancellationDetails

Defined in:

lib/temporalio/activity/cancellation_details.rb

Overview

Details that are set when an activity is cancelled. This is only valid at the time the cancel was received, the state may change on the server after it is received.

Instance Method Summary

• #cancel_requested? ⇒ Boolean

  Whether the activity was explicitly cancelled.

• #gone_from_server? ⇒ Boolean

  Whether the activity no longer exists on the server (may already be completed or its workflow may be completed).

• #initialize(gone_from_server: false, cancel_requested: true, timed_out: false, worker_shutdown: false, paused: false, reset: false) ⇒ CancellationDetails constructor

  A new instance of CancellationDetails.

• #paused? ⇒ Boolean

  Whether the activity was explicitly paused.

• #reset? ⇒ Boolean

  Whether the activity was explicitly reset.

• #timed_out? ⇒ Boolean

  Whether the activity timeout caused activity to be marked cancelled.

• #worker_shutdown? ⇒ Boolean

  Whether the worker the activity is running on is shutting down.

Constructor Details

#initialize(gone_from_server: false, cancel_requested: true, timed_out: false, worker_shutdown: false, paused: false, reset: false) ⇒ CancellationDetails

# File 'lib/temporalio/activity/cancellation_details.rb', line 10

def initialize(
  gone_from_server: false,
  cancel_requested: true,
  timed_out: false,
  worker_shutdown: false,
  paused: false,
  reset: false
)
  @gone_from_server = gone_from_server
  @cancel_requested = cancel_requested
  @timed_out = timed_out
  @worker_shutdown = worker_shutdown
  @paused = paused
  @reset = reset
end

Instance Method Details

#cancel_requested? ⇒ Boolean

# File 'lib/temporalio/activity/cancellation_details.rb', line 33

def cancel_requested?
  @cancel_requested
end

#gone_from_server? ⇒ Boolean

# File 'lib/temporalio/activity/cancellation_details.rb', line 28

def gone_from_server?
  @gone_from_server
end

#paused? ⇒ Boolean

# File 'lib/temporalio/activity/cancellation_details.rb', line 48

def paused?
  @paused
end

#reset? ⇒ Boolean

# File 'lib/temporalio/activity/cancellation_details.rb', line 53

def reset?
  @reset
end

#timed_out? ⇒ Boolean

# File 'lib/temporalio/activity/cancellation_details.rb', line 38

def timed_out?
  @timed_out
end

#worker_shutdown? ⇒ Boolean

# File 'lib/temporalio/activity/cancellation_details.rb', line 43

def worker_shutdown?
  @worker_shutdown
end