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.



11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
 
# File 'lib/models/porcelain.rb', line 11198

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.



11178
11179
11180
 
# File 'lib/models/porcelain.rb', line 11178

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



11180
11181
11182
 
# File 'lib/models/porcelain.rb', line 11180

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



11182
11183
11184
 
# File 'lib/models/porcelain.rb', line 11182

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



11184
11185
11186
 
# File 'lib/models/porcelain.rb', line 11184

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.



11190
11191
11192
 
# File 'lib/models/porcelain.rb', line 11190

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



11192
11193
11194
 
# File 'lib/models/porcelain.rb', line 11192

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



11194
11195
11196
 
# File 'lib/models/porcelain.rb', line 11194

def name
  @name
end

#weight ⇒ Object

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



11196
11197
11198
 
# File 'lib/models/porcelain.rb', line 11196

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11218
11219
11220
11221
11222
11223
11224
 
# File 'lib/models/porcelain.rb', line 11218

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