Class: Temporalio::Worker::DeploymentOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/temporalio/worker/deployment_options.rb

Overview

Options for configuring the Worker Versioning feature.

WARNING: Deployment-based versioning is experimental and APIs may change.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(version:, use_worker_versioning: false, default_versioning_behavior: VersioningBehavior::UNSPECIFIED) ⇒ DeploymentOptions

Returns a new instance of DeploymentOptions.



25
26
27
28
29
30
31
 
# File 'lib/temporalio/worker/deployment_options.rb', line 25

def initialize(
  version:,
  use_worker_versioning: false,
  default_versioning_behavior: VersioningBehavior::UNSPECIFIED
)
  super
end

Instance Attribute Details

#default_versioning_behavior ⇒ VersioningBehavior

Returns The default versioning behavior.

Returns:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/temporalio/worker/deployment_options.rb', line 24

class DeploymentOptions
  def initialize(
    version:,
    use_worker_versioning: false,
    default_versioning_behavior: VersioningBehavior::UNSPECIFIED
  )
    super
  end

  # @!visibility private
  def _to_bridge_options
    Internal::Bridge::Worker::DeploymentOptions.new(
      version: Internal::Bridge::Worker::WorkerDeploymentVersion.new(
        deployment_name: version.deployment_name, build_id: version.build_id
      ),
      use_worker_versioning: use_worker_versioning,
      default_versioning_behavior: default_versioning_behavior
    )
  end
end

#use_worker_versioning ⇒ Boolean

Returns Whether worker versioning is enabled.

Returns:

  • (Boolean) —

    Whether worker versioning is enabled.



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/temporalio/worker/deployment_options.rb', line 24

class DeploymentOptions
  def initialize(
    version:,
    use_worker_versioning: false,
    default_versioning_behavior: VersioningBehavior::UNSPECIFIED
  )
    super
  end

  # @!visibility private
  def _to_bridge_options
    Internal::Bridge::Worker::DeploymentOptions.new(
      version: Internal::Bridge::Worker::WorkerDeploymentVersion.new(
        deployment_name: version.deployment_name, build_id: version.build_id
      ),
      use_worker_versioning: use_worker_versioning,
      default_versioning_behavior: default_versioning_behavior
    )
  end
end

#version ⇒ WorkerDeploymentVersion

Returns The worker deployment version.

Returns:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/temporalio/worker/deployment_options.rb', line 24

class DeploymentOptions
  def initialize(
    version:,
    use_worker_versioning: false,
    default_versioning_behavior: VersioningBehavior::UNSPECIFIED
  )
    super
  end

  # @!visibility private
  def _to_bridge_options
    Internal::Bridge::Worker::DeploymentOptions.new(
      version: Internal::Bridge::Worker::WorkerDeploymentVersion.new(
        deployment_name: version.deployment_name, build_id: version.build_id
      ),
      use_worker_versioning: use_worker_versioning,
      default_versioning_behavior: default_versioning_behavior
    )
  end
end