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.



11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
 
# File 'lib/models/porcelain.rb', line 11612

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.



11592
11593
11594
 
# File 'lib/models/porcelain.rb', line 11592

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



11594
11595
11596
 
# File 'lib/models/porcelain.rb', line 11594

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



11596
11597
11598
 
# File 'lib/models/porcelain.rb', line 11596

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



11598
11599
11600
 
# File 'lib/models/porcelain.rb', line 11598

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.



11604
11605
11606
 
# File 'lib/models/porcelain.rb', line 11604

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



11606
11607
11608
 
# File 'lib/models/porcelain.rb', line 11606

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



11608
11609
11610
 
# File 'lib/models/porcelain.rb', line 11608

def name
  @name
end

#weight ⇒ Object

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



11610
11611
11612
 
# File 'lib/models/porcelain.rb', line 11610

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11632
11633
11634
11635
11636
11637
11638
 
# File 'lib/models/porcelain.rb', line 11632

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