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.



10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
# File 'lib/models/porcelain.rb', line 10999

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_rulesObject

AccessRules is a list of access rules defining the resources this Workflow provides access to.



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

def access_rules
  @access_rules
end

#approval_flow_idObject

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



10981
10982
10983
# File 'lib/models/porcelain.rb', line 10981

def approval_flow_id
  @approval_flow_id
end

#auto_grantObject

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



10983
10984
10985
# File 'lib/models/porcelain.rb', line 10983

def auto_grant
  @auto_grant
end

#descriptionObject

Optional description of the Workflow.



10985
10986
10987
# File 'lib/models/porcelain.rb', line 10985

def description
  @description
end

#enabledObject

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.



10991
10992
10993
# File 'lib/models/porcelain.rb', line 10991

def enabled
  @enabled
end

#idObject

Unique identifier of the Workflow.



10993
10994
10995
# File 'lib/models/porcelain.rb', line 10993

def id
  @id
end

#nameObject

Unique human-readable name of the Workflow.



10995
10996
10997
# File 'lib/models/porcelain.rb', line 10995

def name
  @name
end

#weightObject

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



10997
10998
10999
# File 'lib/models/porcelain.rb', line 10997

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object



11019
11020
11021
11022
11023
11024
11025
# File 'lib/models/porcelain.rb', line 11019

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