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.



12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
 
# File 'lib/models/porcelain.rb', line 12143

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.



12123
12124
12125
 
# File 'lib/models/porcelain.rb', line 12123

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



12125
12126
12127
 
# File 'lib/models/porcelain.rb', line 12125

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



12127
12128
12129
 
# File 'lib/models/porcelain.rb', line 12127

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



12129
12130
12131
 
# File 'lib/models/porcelain.rb', line 12129

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.



12135
12136
12137
 
# File 'lib/models/porcelain.rb', line 12135

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



12137
12138
12139
 
# File 'lib/models/porcelain.rb', line 12137

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



12139
12140
12141
 
# File 'lib/models/porcelain.rb', line 12139

def name
  @name
end

#weight ⇒ Object

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



12141
12142
12143
 
# File 'lib/models/porcelain.rb', line 12141

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12163
12164
12165
12166
12167
12168
12169
 
# File 'lib/models/porcelain.rb', line 12163

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