Class: MicrosoftGraph::Models::SimulationReportOverview

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new simulationReportOverview and sets the default values.



46
47
48
 
# File 'lib/models/simulation_report_overview.rb', line 46

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 simulation_report_overview

Raises:

  • (StandardError) 


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

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return SimulationReportOverview.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



31
32
33
 
# File 'lib/models/simulation_report_overview.rb', line 31

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



39
40
41
 
# File 'lib/models/simulation_report_overview.rb', line 39

def additional_data=(value)
    @additional_data = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



62
63
64
65
66
67
68
69
70
 
# File 'lib/models/simulation_report_overview.rb', line 62

def get_field_deserializers()
    return {
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "recommendedActions" => lambda {|n| @recommended_actions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::RecommendedAction.create_from_discriminator_value(pn) }) },
        "resolvedTargetsCount" => lambda {|n| @resolved_targets_count = n.get_number_value() },
        "simulationEventsContent" => lambda {|n| @simulation_events_content = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::SimulationEventsContent.create_from_discriminator_value(pn) }) },
        "trainingEventsContent" => lambda {|n| @training_events_content = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::TrainingEventsContent.create_from_discriminator_value(pn) }) },
    }
end

#odata_type ⇒ Object

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

Returns:

  • a string



75
76
77
 
# File 'lib/models/simulation_report_overview.rb', line 75

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



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

def odata_type=(value)
    @odata_type = value
end

#recommended_actions ⇒ Object

Gets the recommendedActions property value. List of recommended actions for a tenant to improve its security posture based on the attack simulation and training campaign attack type.

Returns:

  • a recommended_action



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

def recommended_actions
    return @recommended_actions
end

#recommended_actions=(value) ⇒ Object

Sets the recommendedActions property value. List of recommended actions for a tenant to improve its security posture based on the attack simulation and training campaign attack type.

Parameters:

  • value —

    Value to set for the recommended_actions property.

Returns:

  • a void



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

def recommended_actions=(value)
    @recommended_actions = value
end

#resolved_targets_count ⇒ Object

Gets the resolvedTargetsCount property value. Number of valid users in the attack simulation and training campaign.

Returns:

  • a integer



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

def resolved_targets_count
    return @resolved_targets_count
end

#resolved_targets_count=(value) ⇒ Object

Sets the resolvedTargetsCount property value. Number of valid users in the attack simulation and training campaign.

Parameters:

  • value —

    Value to set for the resolved_targets_count property.

Returns:

  • a void



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

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


121
122
123
124
125
126
127
128
129
 
# File 'lib/models/simulation_report_overview.rb', line 121

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_collection_of_object_values("recommendedActions", @recommended_actions)
    writer.write_number_value("resolvedTargetsCount", @resolved_targets_count)
    writer.write_object_value("simulationEventsContent", @simulation_events_content)
    writer.write_object_value("trainingEventsContent", @training_events_content)
    writer.write_additional_data(@additional_data)
end

#simulation_events_content ⇒ Object

Gets the simulationEventsContent property value. Summary of simulation events in the attack simulation and training campaign.

Returns:

  • a simulation_events_content



134
135
136
 
# File 'lib/models/simulation_report_overview.rb', line 134

def simulation_events_content
    return @simulation_events_content
end

#simulation_events_content=(value) ⇒ Object

Sets the simulationEventsContent property value. Summary of simulation events in the attack simulation and training campaign.

Parameters:

  • value —

    Value to set for the simulation_events_content property.

Returns:

  • a void



142
143
144
 
# File 'lib/models/simulation_report_overview.rb', line 142

def simulation_events_content=(value)
    @simulation_events_content = value
end

#training_events_content ⇒ Object

Gets the trainingEventsContent property value. Summary of assigned trainings in the attack simulation and training campaign.

Returns:

  • a training_events_content



149
150
151
 
# File 'lib/models/simulation_report_overview.rb', line 149

def training_events_content
    return @training_events_content
end

#training_events_content=(value) ⇒ Object

Sets the trainingEventsContent property value. Summary of assigned trainings in the attack simulation and training campaign.

Parameters:

  • value —

    Value to set for the training_events_content property.

Returns:

  • a void



157
158
159
 
# File 'lib/models/simulation_report_overview.rb', line 157

def training_events_content=(value)
    @training_events_content = value
end