Class: RightScale::OperationContext

Inherits:
Object
  • Object
show all
Defined in:
lib/instance/operation_context.rb

Overview

Context required to run an operation Includes operation input and associated audit

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(payload, audit, options = {}) ⇒ OperationContext

Returns a new instance of OperationContext.

Parameters:

  • payload (Object)

    of any kind (but usually executable bundle)

  • audit (RightScale::AuditProxy)

    for execution

  • options (Hash) (defaults to: {})

    for context

Options Hash (options):

  • :decommission_type (String)

    for decommission bundle



51
52
53
54
55
56
# File 'lib/instance/operation_context.rb', line 51

def initialize(payload, audit, options={})
  @payload = payload
  @audit = audit
  @decommission_type = options[:decommission_type]
  @thread_name = payload.respond_to?(:runlist_policy) && payload.runlist_policy ? payload.runlist_policy.thread_name : ::RightScale::AgentConfig.default_thread_name
end

Instance Attribute Details

#auditRightScale::AuditProxy (readonly)

Returns audit for execution.

Returns:



33
34
35
# File 'lib/instance/operation_context.rb', line 33

def audit
  @audit
end

#decommission_typeString (readonly)

Returns decommission_type or nil.

Returns:

  • (String)

    decommission_type or nil



42
43
44
# File 'lib/instance/operation_context.rb', line 42

def decommission_type
  @decommission_type
end

#payloadObject (readonly)

Returns payload associated with operation.

Returns:

  • (Object)

    payload associated with operation



30
31
32
# File 'lib/instance/operation_context.rb', line 30

def payload
  @payload
end

#succeededTrueClass|FalseClass

Returns true if bundle succeeded.

Returns:



36
37
38
# File 'lib/instance/operation_context.rb', line 36

def succeeded
  @succeeded
end

#thread_nameString (readonly)

Returns thread name for context or default thread name.

Returns:

  • (String)

    thread name for context or default thread name



45
46
47
# File 'lib/instance/operation_context.rb', line 45

def thread_name
  @thread_name
end

Instance Method Details

#decommission?TrueClass|FalseClass

Returns true if a decommission bundle.

Returns:



39
# File 'lib/instance/operation_context.rb', line 39

def decommission?; !!@decommission_type; end