Class: MicrosoftGraph::Models::IdentityGovernanceTaskReport

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/identity_governance_task_report.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

#initializeObject

Instantiates a new identityGovernanceTaskReport and sets the default values.



65
66
67
# File 'lib/models/identity_governance_task_report.rb', line 65

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_report

Raises:

  • (StandardError)


73
74
75
76
# File 'lib/models/identity_governance_task_report.rb', line 73

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

Instance Method Details

#completed_date_timeObject

Gets the completedDateTime property value. The date time that the associated run completed. Value is null if the run has not completed.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

Returns:

  • a date_time



50
51
52
# File 'lib/models/identity_governance_task_report.rb', line 50

def completed_date_time
    return @completed_date_time
end

#completed_date_time=(value) ⇒ Object

Sets the completedDateTime property value. The date time that the associated run completed. Value is null if the run has not completed.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

Parameters:

  • value

    Value to set for the completedDateTime property.

Returns:

  • a void



58
59
60
# File 'lib/models/identity_governance_task_report.rb', line 58

def completed_date_time=(value)
    @completed_date_time = value
end

#failed_users_countObject

Gets the failedUsersCount property value. The number of users in the run execution for which the associated task failed.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

Returns:

  • a integer



81
82
83
# File 'lib/models/identity_governance_task_report.rb', line 81

def failed_users_count
    return @failed_users_count
end

#failed_users_count=(value) ⇒ Object

Sets the failedUsersCount property value. The number of users in the run execution for which the associated task failed.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

Parameters:

  • value

    Value to set for the failedUsersCount property.

Returns:

  • a void



89
90
91
# File 'lib/models/identity_governance_task_report.rb', line 89

def failed_users_count=(value)
    @failed_users_count = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/models/identity_governance_task_report.rb', line 96

def get_field_deserializers()
    return super.merge({
        "completedDateTime" => lambda {|n| @completed_date_time = n.get_date_time_value() },
        "failedUsersCount" => lambda {|n| @failed_users_count = n.get_number_value() },
        "lastUpdatedDateTime" => lambda {|n| @last_updated_date_time = n.get_date_time_value() },
        "processingStatus" => lambda {|n| @processing_status = n.get_enum_value(MicrosoftGraph::Models::IdentityGovernanceLifecycleWorkflowProcessingStatus) },
        "runId" => lambda {|n| @run_id = n.get_string_value() },
        "startedDateTime" => lambda {|n| @started_date_time = n.get_date_time_value() },
        "successfulUsersCount" => lambda {|n| @successful_users_count = n.get_number_value() },
        "task" => lambda {|n| @task = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::IdentityGovernanceTask.create_from_discriminator_value(pn) }) },
        "taskDefinition" => lambda {|n| @task_definition = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::IdentityGovernanceTaskDefinition.create_from_discriminator_value(pn) }) },
        "taskProcessingResults" => lambda {|n| @task_processing_results = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::IdentityGovernanceTaskProcessingResult.create_from_discriminator_value(pn) }) },
        "totalUsersCount" => lambda {|n| @total_users_count = n.get_number_value() },
        "unprocessedUsersCount" => lambda {|n| @unprocessed_users_count = n.get_number_value() },
    })
end

#last_updated_date_timeObject

Gets the lastUpdatedDateTime property value. The date and time that the task report was last updated.

Returns:

  • a date_time



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

def last_updated_date_time
    return @last_updated_date_time
end

#last_updated_date_time=(value) ⇒ Object

Sets the lastUpdatedDateTime property value. The date and time that the task report was last updated.

Parameters:

  • value

    Value to set for the lastUpdatedDateTime property.

Returns:

  • a void



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

def last_updated_date_time=(value)
    @last_updated_date_time = value
end

#processing_statusObject

Gets the processingStatus property value. The processingStatus property

Returns:

  • a identity_governance_lifecycle_workflow_processing_status



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

def processing_status
    return @processing_status
end

#processing_status=(value) ⇒ Object

Sets the processingStatus property value. The processingStatus property

Parameters:

  • value

    Value to set for the processingStatus property.

Returns:

  • a void



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

def processing_status=(value)
    @processing_status = value
end

#run_idObject

Gets the runId property value. The unique identifier of the associated run.

Returns:

  • a string



146
147
148
# File 'lib/models/identity_governance_task_report.rb', line 146

def run_id
    return @run_id
end

#run_id=(value) ⇒ Object

Sets the runId property value. The unique identifier of the associated run.

Parameters:

  • value

    Value to set for the runId property.

Returns:

  • a void



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

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


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/models/identity_governance_task_report.rb', line 162

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_date_time_value("completedDateTime", @completed_date_time)
    writer.write_number_value("failedUsersCount", @failed_users_count)
    writer.write_date_time_value("lastUpdatedDateTime", @last_updated_date_time)
    writer.write_enum_value("processingStatus", @processing_status)
    writer.write_string_value("runId", @run_id)
    writer.write_date_time_value("startedDateTime", @started_date_time)
    writer.write_number_value("successfulUsersCount", @successful_users_count)
    writer.write_object_value("task", @task)
    writer.write_object_value("taskDefinition", @task_definition)
    writer.write_collection_of_object_values("taskProcessingResults", @task_processing_results)
    writer.write_number_value("totalUsersCount", @total_users_count)
    writer.write_number_value("unprocessedUsersCount", @unprocessed_users_count)
end

#started_date_timeObject

Gets the startedDateTime property value. The date time that the associated run started. Value is null if the run has not started.

Returns:

  • a date_time



182
183
184
# File 'lib/models/identity_governance_task_report.rb', line 182

def started_date_time
    return @started_date_time
end

#started_date_time=(value) ⇒ Object

Sets the startedDateTime property value. The date time that the associated run started. Value is null if the run has not started.

Parameters:

  • value

    Value to set for the startedDateTime property.

Returns:

  • a void



190
191
192
# File 'lib/models/identity_governance_task_report.rb', line 190

def started_date_time=(value)
    @started_date_time = value
end

#successful_users_countObject

Gets the successfulUsersCount property value. The number of users in the run execution for which the associated task succeeded.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

Returns:

  • a integer



197
198
199
# File 'lib/models/identity_governance_task_report.rb', line 197

def successful_users_count
    return @successful_users_count
end

#successful_users_count=(value) ⇒ Object

Sets the successfulUsersCount property value. The number of users in the run execution for which the associated task succeeded.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

Parameters:

  • value

    Value to set for the successfulUsersCount property.

Returns:

  • a void



205
206
207
# File 'lib/models/identity_governance_task_report.rb', line 205

def successful_users_count=(value)
    @successful_users_count = value
end

#taskObject

Gets the task property value. The task property

Returns:

  • a identity_governance_task



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

def task
    return @task
end

#task=(value) ⇒ Object

Sets the task property value. The task property

Parameters:

  • value

    Value to set for the task property.

Returns:

  • a void



220
221
222
# File 'lib/models/identity_governance_task_report.rb', line 220

def task=(value)
    @task = value
end

#task_definitionObject

Gets the taskDefinition property value. The taskDefinition property

Returns:

  • a identity_governance_task_definition



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

def task_definition
    return @task_definition
end

#task_definition=(value) ⇒ Object

Sets the taskDefinition property value. The taskDefinition property

Parameters:

  • value

    Value to set for the taskDefinition property.

Returns:

  • a void



235
236
237
# File 'lib/models/identity_governance_task_report.rb', line 235

def task_definition=(value)
    @task_definition = value
end

#task_processing_resultsObject

Gets the taskProcessingResults property value. The related lifecycle workflow taskProcessingResults.

Returns:

  • a identity_governance_task_processing_result



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

def task_processing_results
    return @task_processing_results
end

#task_processing_results=(value) ⇒ Object

Sets the taskProcessingResults property value. The related lifecycle workflow taskProcessingResults.

Parameters:

  • value

    Value to set for the taskProcessingResults property.

Returns:

  • a void



250
251
252
# File 'lib/models/identity_governance_task_report.rb', line 250

def task_processing_results=(value)
    @task_processing_results = value
end

#total_users_countObject

Gets the totalUsersCount property value. The total number of users in the run execution for which the associated task was scheduled to execute.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

Returns:

  • a integer



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

def total_users_count
    return @total_users_count
end

#total_users_count=(value) ⇒ Object

Sets the totalUsersCount property value. The total number of users in the run execution for which the associated task was scheduled to execute.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

Parameters:

  • value

    Value to set for the totalUsersCount property.

Returns:

  • a void



265
266
267
# File 'lib/models/identity_governance_task_report.rb', line 265

def total_users_count=(value)
    @total_users_count = value
end

#unprocessed_users_countObject

Gets the unprocessedUsersCount property value. The number of users in the run execution for which the associated task is queued, in progress, or canceled.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

Returns:

  • a integer



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

def unprocessed_users_count
    return @unprocessed_users_count
end

#unprocessed_users_count=(value) ⇒ Object

Sets the unprocessedUsersCount property value. The number of users in the run execution for which the associated task is queued, in progress, or canceled.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

Parameters:

  • value

    Value to set for the unprocessedUsersCount property.

Returns:

  • a void



280
281
282
# File 'lib/models/identity_governance_task_report.rb', line 280

def unprocessed_users_count=(value)
    @unprocessed_users_count = value
end