Class: SDM::Workflow

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

Workflows are the collection of rules that define the resources to which access can be requested, the users that can request that access, and the mechanism for approving those requests which can either but automatic approval or a set of users authorized to approve the requests.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_rules: nil, approval_flow_id: nil, auto_grant: nil, description: nil, enabled: nil, id: nil, name: nil, weight: nil) ⇒ Workflow

Returns a new instance of Workflow.



11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
 
# File 'lib/models/porcelain.rb', line 11680

def initialize(
  access_rules: nil,
  approval_flow_id: nil,
  auto_grant: nil,
  description: nil,
  enabled: nil,
  id: nil,
  name: nil,
  weight: nil
)
  @access_rules = access_rules == nil ? SDM::_porcelain_zero_value_access_rules() : access_rules
  @approval_flow_id = approval_flow_id == nil ? "" : approval_flow_id
  @auto_grant = auto_grant == nil ? false : auto_grant
  @description = description == nil ? "" : description
  @enabled = enabled == nil ? false : enabled
  @id = id == nil ? "" : id
  @name = name == nil ? "" : name
  @weight = weight == nil ? 0 : weight
end

Instance Attribute Details

#access_rules ⇒ Object

AccessRules is a list of access rules defining the resources this Workflow provides access to.



11660
11661
11662
 
# File 'lib/models/porcelain.rb', line 11660

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

Optional approval flow ID identifies an approval flow that linked to the workflow



11662
11663
11664
 
# File 'lib/models/porcelain.rb', line 11662

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

Optional auto grant setting to automatically approve requests or not, defaults to false.



11664
11665
11666
 
# File 'lib/models/porcelain.rb', line 11664

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



11666
11667
11668
 
# File 'lib/models/porcelain.rb', line 11666

def description
  @description
end

#enabled ⇒ Object

Optional enabled state for workflow. This setting may be overridden by the system if the workflow doesn't meet the requirements to be enabled or if other conditions prevent enabling the workflow. The requirements to enable a workflow are that the workflow must be either set up for with auto grant enabled or have one or more WorkflowApprovers created for the workflow.



11672
11673
11674
 
# File 'lib/models/porcelain.rb', line 11672

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



11674
11675
11676
 
# File 'lib/models/porcelain.rb', line 11674

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



11676
11677
11678
 
# File 'lib/models/porcelain.rb', line 11676

def name
  @name
end

#weight ⇒ Object

Optional weight for workflow to specify it's priority in matching a request.



11678
11679
11680
 
# File 'lib/models/porcelain.rb', line 11678

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11700
11701
11702
11703
11704
11705
11706
 
# File 'lib/models/porcelain.rb', line 11700

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end