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.



11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
 
# File 'lib/models/porcelain.rb', line 11133

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.



11113
11114
11115
 
# File 'lib/models/porcelain.rb', line 11113

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



11115
11116
11117
 
# File 'lib/models/porcelain.rb', line 11115

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



11117
11118
11119
 
# File 'lib/models/porcelain.rb', line 11117

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



11119
11120
11121
 
# File 'lib/models/porcelain.rb', line 11119

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.



11125
11126
11127
 
# File 'lib/models/porcelain.rb', line 11125

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



11127
11128
11129
 
# File 'lib/models/porcelain.rb', line 11127

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



11129
11130
11131
 
# File 'lib/models/porcelain.rb', line 11129

def name
  @name
end

#weight ⇒ Object

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



11131
11132
11133
 
# File 'lib/models/porcelain.rb', line 11131

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11153
11154
11155
11156
11157
11158
11159
 
# File 'lib/models/porcelain.rb', line 11153

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