Class: MicrosoftGraph::Models::IdentityGovernanceWorkflowBase

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/identity_governance_workflow_base.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new identityGovernanceWorkflowBase and sets the default values.



83
84
85
 
# File 'lib/models/identity_governance_workflow_base.rb', line 83

def initialize()
    @additional_data = Hash.new
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a identity_governance_workflow_base

Raises:

  • (StandardError) 


121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/models/identity_governance_workflow_base.rb', line 121

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    mapping_value_node = parse_node.get_child_node("@odata.type")
    unless mapping_value_node.nil? then
        mapping_value = mapping_value_node.get_string_value
        case mapping_value
            when "#microsoft.graph.identityGovernance.workflow"
                return IdentityGovernanceWorkflow.new
            when "#microsoft.graph.identityGovernance.workflowVersion"
                return IdentityGovernanceWorkflowVersion.new
        end
    end
    return IdentityGovernanceWorkflowBase.new
end

Instance Method Details

#additional_data ⇒ Object

Gets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Returns:

  • a i_dictionary



53
54
55
 
# File 'lib/models/identity_governance_workflow_base.rb', line 53

def additional_data
    return @additional_data
end

#additional_data=(value) ⇒ Object

Sets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Parameters:

  • value —

    Value to set for the additionalData property.

Returns:

  • a void



61
62
63
 
# File 'lib/models/identity_governance_workflow_base.rb', line 61

def additional_data=(value)
    @additional_data = value
end

#category ⇒ Object

Gets the category property value. The category property

Returns:

  • a identity_governance_lifecycle_workflow_category



68
69
70
 
# File 'lib/models/identity_governance_workflow_base.rb', line 68

def category
    return @category
end

#category=(value) ⇒ Object

Sets the category property value. The category property

Parameters:

  • value —

    Value to set for the category property.

Returns:

  • a void



76
77
78
 
# File 'lib/models/identity_governance_workflow_base.rb', line 76

def category=(value)
    @category = value
end

#created_by ⇒ Object

Gets the createdBy property value. The user who created the workflow.

Returns:

  • a user



90
91
92
 
# File 'lib/models/identity_governance_workflow_base.rb', line 90

def created_by
    return @created_by
end

#created_by=(value) ⇒ Object

Sets the createdBy property value. The user who created the workflow.

Parameters:

  • value —

    Value to set for the createdBy property.

Returns:

  • a void



98
99
100
 
# File 'lib/models/identity_governance_workflow_base.rb', line 98

def created_by=(value)
    @created_by = value
end

#created_date_time ⇒ Object

Gets the createdDateTime property value. When a workflow was created.

Returns:

  • a date_time



105
106
107
 
# File 'lib/models/identity_governance_workflow_base.rb', line 105

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. When a workflow was created.

Parameters:

  • value —

    Value to set for the createdDateTime property.

Returns:

  • a void



113
114
115
 
# File 'lib/models/identity_governance_workflow_base.rb', line 113

def created_date_time=(value)
    @created_date_time = value
end

#description ⇒ Object

Gets the description property value. A string that describes the purpose of the workflow.

Returns:

  • a string



139
140
141
 
# File 'lib/models/identity_governance_workflow_base.rb', line 139

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. A string that describes the purpose of the workflow.

Parameters:

  • value —

    Value to set for the description property.

Returns:

  • a void



147
148
149
 
# File 'lib/models/identity_governance_workflow_base.rb', line 147

def description=(value)
    @description = value
end

#display_name ⇒ Object

Gets the displayName property value. A string to identify the workflow.

Returns:

  • a string



154
155
156
 
# File 'lib/models/identity_governance_workflow_base.rb', line 154

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. A string to identify the workflow.

Parameters:

  • value —

    Value to set for the displayName property.

Returns:

  • a void



162
163
164
 
# File 'lib/models/identity_governance_workflow_base.rb', line 162

def display_name=(value)
    @display_name = value
end

#execution_conditions ⇒ Object

Gets the executionConditions property value. Defines when and for who the workflow will run.

Returns:

  • a identity_governance_workflow_execution_conditions



169
170
171
 
# File 'lib/models/identity_governance_workflow_base.rb', line 169

def execution_conditions
    return @execution_conditions
end

#execution_conditions=(value) ⇒ Object

Sets the executionConditions property value. Defines when and for who the workflow will run.

Parameters:

  • value —

    Value to set for the executionConditions property.

Returns:

  • a void



177
178
179
 
# File 'lib/models/identity_governance_workflow_base.rb', line 177

def execution_conditions=(value)
    @execution_conditions = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/models/identity_governance_workflow_base.rb', line 184

def get_field_deserializers()
    return {
        "category" => lambda {|n| @category = n.get_enum_value(MicrosoftGraph::Models::IdentityGovernanceLifecycleWorkflowCategory) },
        "createdBy" => lambda {|n| @created_by = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::User.create_from_discriminator_value(pn) }) },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "description" => lambda {|n| @description = n.get_string_value() },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "executionConditions" => lambda {|n| @execution_conditions = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::IdentityGovernanceWorkflowExecutionConditions.create_from_discriminator_value(pn) }) },
        "isEnabled" => lambda {|n| @is_enabled = n.get_boolean_value() },
        "isSchedulingEnabled" => lambda {|n| @is_scheduling_enabled = n.get_boolean_value() },
        "lastModifiedBy" => lambda {|n| @last_modified_by = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::User.create_from_discriminator_value(pn) }) },
        "lastModifiedDateTime" => lambda {|n| @last_modified_date_time = n.get_date_time_value() },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "tasks" => lambda {|n| @tasks = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::IdentityGovernanceTask.create_from_discriminator_value(pn) }) },
    }
end

#is_enabled ⇒ Object

Gets the isEnabled property value. Whether the workflow is enabled or disabled. If this setting is true, the workflow can be run on demand or on schedule when isSchedulingEnabled is true.

Returns:

  • a boolean



204
205
206
 
# File 'lib/models/identity_governance_workflow_base.rb', line 204

def is_enabled
    return @is_enabled
end

#is_enabled=(value) ⇒ Object

Sets the isEnabled property value. Whether the workflow is enabled or disabled. If this setting is true, the workflow can be run on demand or on schedule when isSchedulingEnabled is true.

Parameters:

  • value —

    Value to set for the isEnabled property.

Returns:

  • a void



212
213
214
 
# File 'lib/models/identity_governance_workflow_base.rb', line 212

def is_enabled=(value)
    @is_enabled = value
end

#is_scheduling_enabled ⇒ Object

Gets the isSchedulingEnabled property value. If true, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Cannot be true for a disabled workflow (where isEnabled is false).

Returns:

  • a boolean



219
220
221
 
# File 'lib/models/identity_governance_workflow_base.rb', line 219

def is_scheduling_enabled
    return @is_scheduling_enabled
end

#is_scheduling_enabled=(value) ⇒ Object

Sets the isSchedulingEnabled property value. If true, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Cannot be true for a disabled workflow (where isEnabled is false).

Parameters:

  • value —

    Value to set for the isSchedulingEnabled property.

Returns:

  • a void



227
228
229
 
# File 'lib/models/identity_governance_workflow_base.rb', line 227

def is_scheduling_enabled=(value)
    @is_scheduling_enabled = value
end

#last_modified_by ⇒ Object

Gets the lastModifiedBy property value. The unique identifier of the AAD identity that last modified the workflow.

Returns:

  • a user



234
235
236
 
# File 'lib/models/identity_governance_workflow_base.rb', line 234

def last_modified_by
    return @last_modified_by
end

#last_modified_by=(value) ⇒ Object

Sets the lastModifiedBy property value. The unique identifier of the AAD identity that last modified the workflow.

Parameters:

  • value —

    Value to set for the lastModifiedBy property.

Returns:

  • a void



242
243
244
 
# File 'lib/models/identity_governance_workflow_base.rb', line 242

def last_modified_by=(value)
    @last_modified_by = value
end

#last_modified_date_time ⇒ Object

Gets the lastModifiedDateTime property value. When the workflow was last modified.

Returns:

  • a date_time



249
250
251
 
# File 'lib/models/identity_governance_workflow_base.rb', line 249

def last_modified_date_time
    return @last_modified_date_time
end

#last_modified_date_time=(value) ⇒ Object

Sets the lastModifiedDateTime property value. When the workflow was last modified.

Parameters:

  • value —

    Value to set for the lastModifiedDateTime property.

Returns:

  • a void



257
258
259
 
# File 'lib/models/identity_governance_workflow_base.rb', line 257

def last_modified_date_time=(value)
    @last_modified_date_time = value
end

#odata_type ⇒ Object

Gets the @odata.type property value. The OdataType property

Returns:

  • a string



264
265
266
 
# File 'lib/models/identity_governance_workflow_base.rb', line 264

def odata_type
    return @odata_type
end

#odata_type=(value) ⇒ Object

Sets the @odata.type property value. The OdataType property

Parameters:

  • value —

    Value to set for the @odata.type property.

Returns:

  • a void



272
273
274
 
# File 'lib/models/identity_governance_workflow_base.rb', line 272

def odata_type=(value)
    @odata_type = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/models/identity_governance_workflow_base.rb', line 280

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_enum_value("category", @category)
    writer.write_object_value("createdBy", @created_by)
    writer.write_date_time_value("createdDateTime", @created_date_time)
    writer.write_string_value("description", @description)
    writer.write_string_value("displayName", @display_name)
    writer.write_object_value("executionConditions", @execution_conditions)
    writer.write_boolean_value("isEnabled", @is_enabled)
    writer.write_boolean_value("isSchedulingEnabled", @is_scheduling_enabled)
    writer.write_object_value("lastModifiedBy", @last_modified_by)
    writer.write_date_time_value("lastModifiedDateTime", @last_modified_date_time)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_collection_of_object_values("tasks", @tasks)
    writer.write_additional_data(@additional_data)
end

#tasks ⇒ Object

Gets the tasks property value. The tasks in the workflow.

Returns:

  • a identity_governance_task



300
301
302
 
# File 'lib/models/identity_governance_workflow_base.rb', line 300

def tasks
    return @tasks
end

#tasks=(value) ⇒ Object

Sets the tasks property value. The tasks in the workflow.

Parameters:

  • value —

    Value to set for the tasks property.

Returns:

  • a void



308
309
310
 
# File 'lib/models/identity_governance_workflow_base.rb', line 308

def tasks=(value)
    @tasks = value
end