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.



10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
 
# File 'lib/models/porcelain.rb', line 10429

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.



10409
10410
10411
 
# File 'lib/models/porcelain.rb', line 10409

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



10411
10412
10413
 
# File 'lib/models/porcelain.rb', line 10411

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



10413
10414
10415
 
# File 'lib/models/porcelain.rb', line 10413

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



10415
10416
10417
 
# File 'lib/models/porcelain.rb', line 10415

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.



10421
10422
10423
 
# File 'lib/models/porcelain.rb', line 10421

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



10423
10424
10425
 
# File 'lib/models/porcelain.rb', line 10423

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



10425
10426
10427
 
# File 'lib/models/porcelain.rb', line 10425

def name
  @name
end

#weight ⇒ Object

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



10427
10428
10429
 
# File 'lib/models/porcelain.rb', line 10427

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



10449
10450
10451
10452
10453
10454
10455
 
# File 'lib/models/porcelain.rb', line 10449

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