Class: MicrosoftGraph::Models::IdentityGovernanceTask

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/identity_governance_task.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new identityGovernanceTask and sets the default values.



70
71
72
 
# File 'lib/models/identity_governance_task.rb', line 70

def initialize()
    super
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_task

Raises:

  • (StandardError) 


93
94
95
96
 
# File 'lib/models/identity_governance_task.rb', line 93

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return IdentityGovernanceTask.new
end

Instance Method Details

#arguments ⇒ Object

Gets the arguments property value. Arguments included within the task. For guidance to configure this property, see Configure the arguments for built-in Lifecycle Workflow tasks. Required.

Returns:

  • a key_value_pair



40
41
42
 
# File 'lib/models/identity_governance_task.rb', line 40

def arguments
    return @arguments
end

#arguments=(value) ⇒ Object

Sets the arguments property value. Arguments included within the task. For guidance to configure this property, see Configure the arguments for built-in Lifecycle Workflow tasks. Required.

Parameters:

  • value —

    Value to set for the arguments property.

Returns:

  • a void



48
49
50
 
# File 'lib/models/identity_governance_task.rb', line 48

def arguments=(value)
    @arguments = value
end

#category ⇒ Object

Gets the category property value. The category property

Returns:

  • a identity_governance_lifecycle_task_category



55
56
57
 
# File 'lib/models/identity_governance_task.rb', line 55

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



63
64
65
 
# File 'lib/models/identity_governance_task.rb', line 63

def category=(value)
    @category = value
end

#continue_on_error ⇒ Object

Gets the continueOnError property value. A boolean value that specifies whether, if this task fails, the workflow will stop, and subsequent tasks will not run. Optional.

Returns:

  • a boolean



77
78
79
 
# File 'lib/models/identity_governance_task.rb', line 77

def continue_on_error
    return @continue_on_error
end

#continue_on_error=(value) ⇒ Object

Sets the continueOnError property value. A boolean value that specifies whether, if this task fails, the workflow will stop, and subsequent tasks will not run. Optional.

Parameters:

  • value —

    Value to set for the continueOnError property.

Returns:

  • a void



85
86
87
 
# File 'lib/models/identity_governance_task.rb', line 85

def continue_on_error=(value)
    @continue_on_error = value
end

#description ⇒ Object

Gets the description property value. A string that describes the purpose of the task for administrative use. Optional.

Returns:

  • a string



101
102
103
 
# File 'lib/models/identity_governance_task.rb', line 101

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. A string that describes the purpose of the task for administrative use. Optional.

Parameters:

  • value —

    Value to set for the description property.

Returns:

  • a void



109
110
111
 
# File 'lib/models/identity_governance_task.rb', line 109

def description=(value)
    @description = value
end

#display_name ⇒ Object

Gets the displayName property value. A unique string that identifies the task. Required.Supports $filter(eq, ne) and orderBy.

Returns:

  • a string



116
117
118
 
# File 'lib/models/identity_governance_task.rb', line 116

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. A unique string that identifies the task. Required.Supports $filter(eq, ne) and orderBy.

Parameters:

  • value —

    Value to set for the displayName property.

Returns:

  • a void



124
125
126
 
# File 'lib/models/identity_governance_task.rb', line 124

def display_name=(value)
    @display_name = value
end

#execution_sequence ⇒ Object

Gets the executionSequence property value. An integer that states in what order the task will run in a workflow.Supports $orderby.

Returns:

  • a integer



131
132
133
 
# File 'lib/models/identity_governance_task.rb', line 131

def execution_sequence
    return @execution_sequence
end

#execution_sequence=(value) ⇒ Object

Sets the executionSequence property value. An integer that states in what order the task will run in a workflow.Supports $orderby.

Parameters:

  • value —

    Value to set for the executionSequence property.

Returns:

  • a void



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

def execution_sequence=(value)
    @execution_sequence = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/models/identity_governance_task.rb', line 146

def get_field_deserializers()
    return super.merge({
        "arguments" => lambda {|n| @arguments = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::KeyValuePair.create_from_discriminator_value(pn) }) },
        "category" => lambda {|n| @category = n.get_enum_value(MicrosoftGraph::Models::IdentityGovernanceLifecycleTaskCategory) },
        "continueOnError" => lambda {|n| @continue_on_error = n.get_boolean_value() },
        "description" => lambda {|n| @description = n.get_string_value() },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "executionSequence" => lambda {|n| @execution_sequence = n.get_number_value() },
        "isEnabled" => lambda {|n| @is_enabled = n.get_boolean_value() },
        "taskDefinitionId" => lambda {|n| @task_definition_id = n.get_string_value() },
        "taskProcessingResults" => lambda {|n| @task_processing_results = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::IdentityGovernanceTaskProcessingResult.create_from_discriminator_value(pn) }) },
    })
end

#is_enabled ⇒ Object

Gets the isEnabled property value. A boolean value that denotes whether the task is set to run or not. Optional.Supports $filter(eq, ne) and orderBy.

Returns:

  • a boolean



163
164
165
 
# File 'lib/models/identity_governance_task.rb', line 163

def is_enabled
    return @is_enabled
end

#is_enabled=(value) ⇒ Object

Sets the isEnabled property value. A boolean value that denotes whether the task is set to run or not. Optional.Supports $filter(eq, ne) and orderBy.

Parameters:

  • value —

    Value to set for the isEnabled property.

Returns:

  • a void



171
172
173
 
# File 'lib/models/identity_governance_task.rb', line 171

def is_enabled=(value)
    @is_enabled = 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) 


179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/models/identity_governance_task.rb', line 179

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_collection_of_object_values("arguments", @arguments)
    writer.write_enum_value("category", @category)
    writer.write_boolean_value("continueOnError", @continue_on_error)
    writer.write_string_value("description", @description)
    writer.write_string_value("displayName", @display_name)
    writer.write_number_value("executionSequence", @execution_sequence)
    writer.write_boolean_value("isEnabled", @is_enabled)
    writer.write_string_value("taskDefinitionId", @task_definition_id)
    writer.write_collection_of_object_values("taskProcessingResults", @task_processing_results)
end

#task_definition_id ⇒ Object

Gets the taskDefinitionId property value. A unique template identifier for the task. For more information about the tasks that Lifecycle Workflows currently supports and their unique identifiers, see supported tasks. Required.Supports $filter(eq, ne).

Returns:

  • a string



196
197
198
 
# File 'lib/models/identity_governance_task.rb', line 196

def task_definition_id
    return @task_definition_id
end

#task_definition_id=(value) ⇒ Object

Sets the taskDefinitionId property value. A unique template identifier for the task. For more information about the tasks that Lifecycle Workflows currently supports and their unique identifiers, see supported tasks. Required.Supports $filter(eq, ne).

Parameters:

  • value —

    Value to set for the taskDefinitionId property.

Returns:

  • a void



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

def task_definition_id=(value)
    @task_definition_id = value
end

#task_processing_results ⇒ Object

Gets the taskProcessingResults property value. The result of processing the task.

Returns:

  • a identity_governance_task_processing_result



211
212
213
 
# File 'lib/models/identity_governance_task.rb', line 211

def task_processing_results
    return @task_processing_results
end

#task_processing_results=(value) ⇒ Object

Sets the taskProcessingResults property value. The result of processing the task.

Parameters:

  • value —

    Value to set for the taskProcessingResults property.

Returns:

  • a void



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

def task_processing_results=(value)
    @task_processing_results = value
end