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.



11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
 
# File 'lib/models/porcelain.rb', line 11060

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.



11040
11041
11042
 
# File 'lib/models/porcelain.rb', line 11040

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



11042
11043
11044
 
# File 'lib/models/porcelain.rb', line 11042

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



11044
11045
11046
 
# File 'lib/models/porcelain.rb', line 11044

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



11046
11047
11048
 
# File 'lib/models/porcelain.rb', line 11046

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.



11052
11053
11054
 
# File 'lib/models/porcelain.rb', line 11052

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



11054
11055
11056
 
# File 'lib/models/porcelain.rb', line 11054

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



11056
11057
11058
 
# File 'lib/models/porcelain.rb', line 11056

def name
  @name
end

#weight ⇒ Object

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



11058
11059
11060
 
# File 'lib/models/porcelain.rb', line 11058

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11080
11081
11082
11083
11084
11085
11086
 
# File 'lib/models/porcelain.rb', line 11080

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