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.



10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
 
# File 'lib/models/porcelain.rb', line 10980

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.



10960
10961
10962
 
# File 'lib/models/porcelain.rb', line 10960

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



10962
10963
10964
 
# File 'lib/models/porcelain.rb', line 10962

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



10964
10965
10966
 
# File 'lib/models/porcelain.rb', line 10964

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



10966
10967
10968
 
# File 'lib/models/porcelain.rb', line 10966

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.



10972
10973
10974
 
# File 'lib/models/porcelain.rb', line 10972

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



10974
10975
10976
 
# File 'lib/models/porcelain.rb', line 10974

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



10976
10977
10978
 
# File 'lib/models/porcelain.rb', line 10976

def name
  @name
end

#weight ⇒ Object

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



10978
10979
10980
 
# File 'lib/models/porcelain.rb', line 10978

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11000
11001
11002
11003
11004
11005
11006
 
# File 'lib/models/porcelain.rb', line 11000

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