Class: MicrosoftGraph::Models::WindowsProtectionState

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

Overview

Device protection status entity.

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 windowsProtectionState and sets the default values.



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

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 windows_protection_state

Raises:

  • (StandardError)


102
103
104
105
# File 'lib/models/windows_protection_state.rb', line 102

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

Instance Method Details

#anti_malware_versionObject

Gets the antiMalwareVersion property value. Current anti malware version

Returns:

  • a string



79
80
81
# File 'lib/models/windows_protection_state.rb', line 79

def anti_malware_version
    return @anti_malware_version
end

#anti_malware_version=(value) ⇒ Object

Sets the antiMalwareVersion property value. Current anti malware version

Parameters:

  • value

    Value to set for the antiMalwareVersion property.

Returns:

  • a void



87
88
89
# File 'lib/models/windows_protection_state.rb', line 87

def anti_malware_version=(value)
    @anti_malware_version = value
end

#detected_malware_stateObject

Gets the detectedMalwareState property value. Device malware list

Returns:

  • a windows_device_malware_state



110
111
112
# File 'lib/models/windows_protection_state.rb', line 110

def detected_malware_state
    return @detected_malware_state
end

#detected_malware_state=(value) ⇒ Object

Sets the detectedMalwareState property value. Device malware list

Parameters:

  • value

    Value to set for the detectedMalwareState property.

Returns:

  • a void



118
119
120
# File 'lib/models/windows_protection_state.rb', line 118

def detected_malware_state=(value)
    @detected_malware_state = value
end

#device_stateObject

Gets the deviceState property value. Indicates device’s health state. Possible values are: clean, fullScanPending, rebootPending, manualStepsPending, offlineScanPending, critical. Possible values are: clean, fullScanPending, rebootPending, manualStepsPending, offlineScanPending, critical.

Returns:

  • a windows_device_health_state



125
126
127
# File 'lib/models/windows_protection_state.rb', line 125

def device_state
    return @device_state
end

#device_state=(value) ⇒ Object

Sets the deviceState property value. Indicates device’s health state. Possible values are: clean, fullScanPending, rebootPending, manualStepsPending, offlineScanPending, critical. Possible values are: clean, fullScanPending, rebootPending, manualStepsPending, offlineScanPending, critical.

Parameters:

  • value

    Value to set for the deviceState property.

Returns:

  • a void



133
134
135
# File 'lib/models/windows_protection_state.rb', line 133

def device_state=(value)
    @device_state = value
end

#engine_versionObject

Gets the engineVersion property value. Current endpoint protection engine’s version

Returns:

  • a string



140
141
142
# File 'lib/models/windows_protection_state.rb', line 140

def engine_version
    return @engine_version
end

#engine_version=(value) ⇒ Object

Sets the engineVersion property value. Current endpoint protection engine’s version

Parameters:

  • value

    Value to set for the engineVersion property.

Returns:

  • a void



148
149
150
# File 'lib/models/windows_protection_state.rb', line 148

def engine_version=(value)
    @engine_version = value
end

#full_scan_overdueObject

Gets the fullScanOverdue property value. When TRUE indicates full scan is overdue, when FALSE indicates full scan is not overdue. Defaults to setting on client device.

Returns:

  • a boolean



155
156
157
# File 'lib/models/windows_protection_state.rb', line 155

def full_scan_overdue
    return @full_scan_overdue
end

#full_scan_overdue=(value) ⇒ Object

Sets the fullScanOverdue property value. When TRUE indicates full scan is overdue, when FALSE indicates full scan is not overdue. Defaults to setting on client device.

Parameters:

  • value

    Value to set for the fullScanOverdue property.

Returns:

  • a void



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

def full_scan_overdue=(value)
    @full_scan_overdue = value
end

#full_scan_requiredObject

Gets the fullScanRequired property value. When TRUE indicates full scan is required, when FALSE indicates full scan is not required. Defaults to setting on client device.

Returns:

  • a boolean



170
171
172
# File 'lib/models/windows_protection_state.rb', line 170

def full_scan_required
    return @full_scan_required
end

#full_scan_required=(value) ⇒ Object

Sets the fullScanRequired property value. When TRUE indicates full scan is required, when FALSE indicates full scan is not required. Defaults to setting on client device.

Parameters:

  • value

    Value to set for the fullScanRequired property.

Returns:

  • a void



178
179
180
# File 'lib/models/windows_protection_state.rb', line 178

def full_scan_required=(value)
    @full_scan_required = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/models/windows_protection_state.rb', line 185

def get_field_deserializers()
    return super.merge({
        "antiMalwareVersion" => lambda {|n| @anti_malware_version = n.get_string_value() },
        "detectedMalwareState" => lambda {|n| @detected_malware_state = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::WindowsDeviceMalwareState.create_from_discriminator_value(pn) }) },
        "deviceState" => lambda {|n| @device_state = n.get_enum_value(MicrosoftGraph::Models::WindowsDeviceHealthState) },
        "engineVersion" => lambda {|n| @engine_version = n.get_string_value() },
        "fullScanOverdue" => lambda {|n| @full_scan_overdue = n.get_boolean_value() },
        "fullScanRequired" => lambda {|n| @full_scan_required = n.get_boolean_value() },
        "isVirtualMachine" => lambda {|n| @is_virtual_machine = n.get_boolean_value() },
        "lastFullScanDateTime" => lambda {|n| @last_full_scan_date_time = n.get_date_time_value() },
        "lastFullScanSignatureVersion" => lambda {|n| @last_full_scan_signature_version = n.get_string_value() },
        "lastQuickScanDateTime" => lambda {|n| @last_quick_scan_date_time = n.get_date_time_value() },
        "lastQuickScanSignatureVersion" => lambda {|n| @last_quick_scan_signature_version = n.get_string_value() },
        "lastReportedDateTime" => lambda {|n| @last_reported_date_time = n.get_date_time_value() },
        "malwareProtectionEnabled" => lambda {|n| @malware_protection_enabled = n.get_boolean_value() },
        "networkInspectionSystemEnabled" => lambda {|n| @network_inspection_system_enabled = n.get_boolean_value() },
        "productStatus" => lambda {|n| @product_status = n.get_enum_value(MicrosoftGraph::Models::WindowsDefenderProductStatus) },
        "quickScanOverdue" => lambda {|n| @quick_scan_overdue = n.get_boolean_value() },
        "realTimeProtectionEnabled" => lambda {|n| @real_time_protection_enabled = n.get_boolean_value() },
        "rebootRequired" => lambda {|n| @reboot_required = n.get_boolean_value() },
        "signatureUpdateOverdue" => lambda {|n| @signature_update_overdue = n.get_boolean_value() },
        "signatureVersion" => lambda {|n| @signature_version = n.get_string_value() },
        "tamperProtectionEnabled" => lambda {|n| @tamper_protection_enabled = n.get_boolean_value() },
    })
end

#is_virtual_machineObject

Gets the isVirtualMachine property value. When TRUE indicates the device is a virtual machine, when FALSE indicates the device is not a virtual machine. Defaults to setting on client device.

Returns:

  • a boolean



214
215
216
# File 'lib/models/windows_protection_state.rb', line 214

def is_virtual_machine
    return @is_virtual_machine
end

#is_virtual_machine=(value) ⇒ Object

Sets the isVirtualMachine property value. When TRUE indicates the device is a virtual machine, when FALSE indicates the device is not a virtual machine. Defaults to setting on client device.

Parameters:

  • value

    Value to set for the isVirtualMachine property.

Returns:

  • a void



222
223
224
# File 'lib/models/windows_protection_state.rb', line 222

def is_virtual_machine=(value)
    @is_virtual_machine = value
end

#last_full_scan_date_timeObject

Gets the lastFullScanDateTime property value. Last quick scan datetime

Returns:

  • a date_time



229
230
231
# File 'lib/models/windows_protection_state.rb', line 229

def last_full_scan_date_time
    return @last_full_scan_date_time
end

#last_full_scan_date_time=(value) ⇒ Object

Sets the lastFullScanDateTime property value. Last quick scan datetime

Parameters:

  • value

    Value to set for the lastFullScanDateTime property.

Returns:

  • a void



237
238
239
# File 'lib/models/windows_protection_state.rb', line 237

def last_full_scan_date_time=(value)
    @last_full_scan_date_time = value
end

#last_full_scan_signature_versionObject

Gets the lastFullScanSignatureVersion property value. Last full scan signature version

Returns:

  • a string



244
245
246
# File 'lib/models/windows_protection_state.rb', line 244

def last_full_scan_signature_version
    return @last_full_scan_signature_version
end

#last_full_scan_signature_version=(value) ⇒ Object

Sets the lastFullScanSignatureVersion property value. Last full scan signature version

Parameters:

  • value

    Value to set for the lastFullScanSignatureVersion property.

Returns:

  • a void



252
253
254
# File 'lib/models/windows_protection_state.rb', line 252

def last_full_scan_signature_version=(value)
    @last_full_scan_signature_version = value
end

#last_quick_scan_date_timeObject

Gets the lastQuickScanDateTime property value. Last quick scan datetime

Returns:

  • a date_time



259
260
261
# File 'lib/models/windows_protection_state.rb', line 259

def last_quick_scan_date_time
    return @last_quick_scan_date_time
end

#last_quick_scan_date_time=(value) ⇒ Object

Sets the lastQuickScanDateTime property value. Last quick scan datetime

Parameters:

  • value

    Value to set for the lastQuickScanDateTime property.

Returns:

  • a void



267
268
269
# File 'lib/models/windows_protection_state.rb', line 267

def last_quick_scan_date_time=(value)
    @last_quick_scan_date_time = value
end

#last_quick_scan_signature_versionObject

Gets the lastQuickScanSignatureVersion property value. Last quick scan signature version

Returns:

  • a string



274
275
276
# File 'lib/models/windows_protection_state.rb', line 274

def last_quick_scan_signature_version
    return @last_quick_scan_signature_version
end

#last_quick_scan_signature_version=(value) ⇒ Object

Sets the lastQuickScanSignatureVersion property value. Last quick scan signature version

Parameters:

  • value

    Value to set for the lastQuickScanSignatureVersion property.

Returns:

  • a void



282
283
284
# File 'lib/models/windows_protection_state.rb', line 282

def last_quick_scan_signature_version=(value)
    @last_quick_scan_signature_version = value
end

#last_reported_date_timeObject

Gets the lastReportedDateTime property value. Last device health status reported time

Returns:

  • a date_time



289
290
291
# File 'lib/models/windows_protection_state.rb', line 289

def last_reported_date_time
    return @last_reported_date_time
end

#last_reported_date_time=(value) ⇒ Object

Sets the lastReportedDateTime property value. Last device health status reported time

Parameters:

  • value

    Value to set for the lastReportedDateTime property.

Returns:

  • a void



297
298
299
# File 'lib/models/windows_protection_state.rb', line 297

def last_reported_date_time=(value)
    @last_reported_date_time = value
end

#malware_protection_enabledObject

Gets the malwareProtectionEnabled property value. When TRUE indicates anti malware is enabled when FALSE indicates anti malware is not enabled.

Returns:

  • a boolean



304
305
306
# File 'lib/models/windows_protection_state.rb', line 304

def malware_protection_enabled
    return @malware_protection_enabled
end

#malware_protection_enabled=(value) ⇒ Object

Sets the malwareProtectionEnabled property value. When TRUE indicates anti malware is enabled when FALSE indicates anti malware is not enabled.

Parameters:

  • value

    Value to set for the malwareProtectionEnabled property.

Returns:

  • a void



312
313
314
# File 'lib/models/windows_protection_state.rb', line 312

def malware_protection_enabled=(value)
    @malware_protection_enabled = value
end

#network_inspection_system_enabledObject

Gets the networkInspectionSystemEnabled property value. When TRUE indicates network inspection system enabled, when FALSE indicates network inspection system is not enabled. Defaults to setting on client device.

Returns:

  • a boolean



319
320
321
# File 'lib/models/windows_protection_state.rb', line 319

def network_inspection_system_enabled
    return @network_inspection_system_enabled
end

#network_inspection_system_enabled=(value) ⇒ Object

Sets the networkInspectionSystemEnabled property value. When TRUE indicates network inspection system enabled, when FALSE indicates network inspection system is not enabled. Defaults to setting on client device.

Parameters:

  • value

    Value to set for the networkInspectionSystemEnabled property.

Returns:

  • a void



327
328
329
# File 'lib/models/windows_protection_state.rb', line 327

def network_inspection_system_enabled=(value)
    @network_inspection_system_enabled = value
end

#product_statusObject

Gets the productStatus property value. Product Status of Windows Defender Antivirus. Possible values are: noStatus, serviceNotRunning, serviceStartedWithoutMalwareProtection, pendingFullScanDueToThreatAction, pendingRebootDueToThreatAction, pendingManualStepsDueToThreatAction, avSignaturesOutOfDate, asSignaturesOutOfDate, noQuickScanHappenedForSpecifiedPeriod, noFullScanHappenedForSpecifiedPeriod, systemInitiatedScanInProgress, systemInitiatedCleanInProgress, samplesPendingSubmission, productRunningInEvaluationMode, productRunningInNonGenuineMode, productExpired, offlineScanRequired, serviceShutdownAsPartOfSystemShutdown, threatRemediationFailedCritically, threatRemediationFailedNonCritically, noStatusFlagsSet, platformOutOfDate, platformUpdateInProgress, platformAboutToBeOutdated, signatureOrPlatformEndOfLifeIsPastOrIsImpending, windowsSModeSignaturesInUseOnNonWin10SInstall. Possible values are: noStatus, serviceNotRunning, serviceStartedWithoutMalwareProtection, pendingFullScanDueToThreatAction, pendingRebootDueToThreatAction, pendingManualStepsDueToThreatAction, avSignaturesOutOfDate, asSignaturesOutOfDate, noQuickScanHappenedForSpecifiedPeriod, noFullScanHappenedForSpecifiedPeriod, systemInitiatedScanInProgress, systemInitiatedCleanInProgress, samplesPendingSubmission, productRunningInEvaluationMode, productRunningInNonGenuineMode, productExpired, offlineScanRequired, serviceShutdownAsPartOfSystemShutdown, threatRemediationFailedCritically, threatRemediationFailedNonCritically, noStatusFlagsSet, platformOutOfDate, platformUpdateInProgress, platformAboutToBeOutdated, signatureOrPlatformEndOfLifeIsPastOrIsImpending, windowsSModeSignaturesInUseOnNonWin10SInstall.

Returns:

  • a windows_defender_product_status



334
335
336
# File 'lib/models/windows_protection_state.rb', line 334

def product_status
    return @product_status
end

#product_status=(value) ⇒ Object

Sets the productStatus property value. Product Status of Windows Defender Antivirus. Possible values are: noStatus, serviceNotRunning, serviceStartedWithoutMalwareProtection, pendingFullScanDueToThreatAction, pendingRebootDueToThreatAction, pendingManualStepsDueToThreatAction, avSignaturesOutOfDate, asSignaturesOutOfDate, noQuickScanHappenedForSpecifiedPeriod, noFullScanHappenedForSpecifiedPeriod, systemInitiatedScanInProgress, systemInitiatedCleanInProgress, samplesPendingSubmission, productRunningInEvaluationMode, productRunningInNonGenuineMode, productExpired, offlineScanRequired, serviceShutdownAsPartOfSystemShutdown, threatRemediationFailedCritically, threatRemediationFailedNonCritically, noStatusFlagsSet, platformOutOfDate, platformUpdateInProgress, platformAboutToBeOutdated, signatureOrPlatformEndOfLifeIsPastOrIsImpending, windowsSModeSignaturesInUseOnNonWin10SInstall. Possible values are: noStatus, serviceNotRunning, serviceStartedWithoutMalwareProtection, pendingFullScanDueToThreatAction, pendingRebootDueToThreatAction, pendingManualStepsDueToThreatAction, avSignaturesOutOfDate, asSignaturesOutOfDate, noQuickScanHappenedForSpecifiedPeriod, noFullScanHappenedForSpecifiedPeriod, systemInitiatedScanInProgress, systemInitiatedCleanInProgress, samplesPendingSubmission, productRunningInEvaluationMode, productRunningInNonGenuineMode, productExpired, offlineScanRequired, serviceShutdownAsPartOfSystemShutdown, threatRemediationFailedCritically, threatRemediationFailedNonCritically, noStatusFlagsSet, platformOutOfDate, platformUpdateInProgress, platformAboutToBeOutdated, signatureOrPlatformEndOfLifeIsPastOrIsImpending, windowsSModeSignaturesInUseOnNonWin10SInstall.

Parameters:

  • value

    Value to set for the productStatus property.

Returns:

  • a void



342
343
344
# File 'lib/models/windows_protection_state.rb', line 342

def product_status=(value)
    @product_status = value
end

#quick_scan_overdueObject

Gets the quickScanOverdue property value. When TRUE indicates quick scan is overdue, when FALSE indicates quick scan is not overdue. Defaults to setting on client device.

Returns:

  • a boolean



349
350
351
# File 'lib/models/windows_protection_state.rb', line 349

def quick_scan_overdue
    return @quick_scan_overdue
end

#quick_scan_overdue=(value) ⇒ Object

Sets the quickScanOverdue property value. When TRUE indicates quick scan is overdue, when FALSE indicates quick scan is not overdue. Defaults to setting on client device.

Parameters:

  • value

    Value to set for the quickScanOverdue property.

Returns:

  • a void



357
358
359
# File 'lib/models/windows_protection_state.rb', line 357

def quick_scan_overdue=(value)
    @quick_scan_overdue = value
end

#real_time_protection_enabledObject

Gets the realTimeProtectionEnabled property value. When TRUE indicates real time protection is enabled, when FALSE indicates real time protection is not enabled. Defaults to setting on client device.

Returns:

  • a boolean



364
365
366
# File 'lib/models/windows_protection_state.rb', line 364

def real_time_protection_enabled
    return @real_time_protection_enabled
end

#real_time_protection_enabled=(value) ⇒ Object

Sets the realTimeProtectionEnabled property value. When TRUE indicates real time protection is enabled, when FALSE indicates real time protection is not enabled. Defaults to setting on client device.

Parameters:

  • value

    Value to set for the realTimeProtectionEnabled property.

Returns:

  • a void



372
373
374
# File 'lib/models/windows_protection_state.rb', line 372

def real_time_protection_enabled=(value)
    @real_time_protection_enabled = value
end

#reboot_requiredObject

Gets the rebootRequired property value. When TRUE indicates reboot is required, when FALSE indicates when TRUE indicates reboot is not required. Defaults to setting on client device.

Returns:

  • a boolean



379
380
381
# File 'lib/models/windows_protection_state.rb', line 379

def reboot_required
    return @reboot_required
end

#reboot_required=(value) ⇒ Object

Sets the rebootRequired property value. When TRUE indicates reboot is required, when FALSE indicates when TRUE indicates reboot is not required. Defaults to setting on client device.

Parameters:

  • value

    Value to set for the rebootRequired property.

Returns:

  • a void



387
388
389
# File 'lib/models/windows_protection_state.rb', line 387

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


395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
# File 'lib/models/windows_protection_state.rb', line 395

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_string_value("antiMalwareVersion", @anti_malware_version)
    writer.write_collection_of_object_values("detectedMalwareState", @detected_malware_state)
    writer.write_enum_value("deviceState", @device_state)
    writer.write_string_value("engineVersion", @engine_version)
    writer.write_boolean_value("fullScanOverdue", @full_scan_overdue)
    writer.write_boolean_value("fullScanRequired", @full_scan_required)
    writer.write_boolean_value("isVirtualMachine", @is_virtual_machine)
    writer.write_date_time_value("lastFullScanDateTime", @last_full_scan_date_time)
    writer.write_string_value("lastFullScanSignatureVersion", @last_full_scan_signature_version)
    writer.write_date_time_value("lastQuickScanDateTime", @last_quick_scan_date_time)
    writer.write_string_value("lastQuickScanSignatureVersion", @last_quick_scan_signature_version)
    writer.write_date_time_value("lastReportedDateTime", @last_reported_date_time)
    writer.write_boolean_value("malwareProtectionEnabled", @malware_protection_enabled)
    writer.write_boolean_value("networkInspectionSystemEnabled", @network_inspection_system_enabled)
    writer.write_enum_value("productStatus", @product_status)
    writer.write_boolean_value("quickScanOverdue", @quick_scan_overdue)
    writer.write_boolean_value("realTimeProtectionEnabled", @real_time_protection_enabled)
    writer.write_boolean_value("rebootRequired", @reboot_required)
    writer.write_boolean_value("signatureUpdateOverdue", @signature_update_overdue)
    writer.write_string_value("signatureVersion", @signature_version)
    writer.write_boolean_value("tamperProtectionEnabled", @tamper_protection_enabled)
end

#signature_update_overdueObject

Gets the signatureUpdateOverdue property value. When TRUE indicates signature is out of date, when FALSE indicates signature is not out of date. Defaults to setting on client device.

Returns:

  • a boolean



424
425
426
# File 'lib/models/windows_protection_state.rb', line 424

def signature_update_overdue
    return @signature_update_overdue
end

#signature_update_overdue=(value) ⇒ Object

Sets the signatureUpdateOverdue property value. When TRUE indicates signature is out of date, when FALSE indicates signature is not out of date. Defaults to setting on client device.

Parameters:

  • value

    Value to set for the signatureUpdateOverdue property.

Returns:

  • a void



432
433
434
# File 'lib/models/windows_protection_state.rb', line 432

def signature_update_overdue=(value)
    @signature_update_overdue = value
end

#signature_versionObject

Gets the signatureVersion property value. Current malware definitions version

Returns:

  • a string



439
440
441
# File 'lib/models/windows_protection_state.rb', line 439

def signature_version
    return @signature_version
end

#signature_version=(value) ⇒ Object

Sets the signatureVersion property value. Current malware definitions version

Parameters:

  • value

    Value to set for the signatureVersion property.

Returns:

  • a void



447
448
449
# File 'lib/models/windows_protection_state.rb', line 447

def signature_version=(value)
    @signature_version = value
end

#tamper_protection_enabledObject

Gets the tamperProtectionEnabled property value. When TRUE indicates the Windows Defender tamper protection feature is enabled, when FALSE indicates the Windows Defender tamper protection feature is not enabled. Defaults to setting on client device.

Returns:

  • a boolean



454
455
456
# File 'lib/models/windows_protection_state.rb', line 454

def tamper_protection_enabled
    return @tamper_protection_enabled
end

#tamper_protection_enabled=(value) ⇒ Object

Sets the tamperProtectionEnabled property value. When TRUE indicates the Windows Defender tamper protection feature is enabled, when FALSE indicates the Windows Defender tamper protection feature is not enabled. Defaults to setting on client device.

Parameters:

  • value

    Value to set for the tamperProtectionEnabled property.

Returns:

  • a void



462
463
464
# File 'lib/models/windows_protection_state.rb', line 462

def tamper_protection_enabled=(value)
    @tamper_protection_enabled = value
end