Class: MicrosoftGraph::Models::AccessReviewHistoryDefinition

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/access_review_history_definition.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 accessReviewHistoryDefinition and sets the default values.



44
45
46
 
# File 'lib/models/access_review_history_definition.rb', line 44

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 access_review_history_definition

Raises:

  • (StandardError) 


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

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

Instance Method Details

#created_by ⇒ Object

Gets the createdBy property value. The createdBy property

Returns:

  • a user_identity



51
52
53
 
# File 'lib/models/access_review_history_definition.rb', line 51

def created_by
    return @created_by
end

#created_by=(value) ⇒ Object

Sets the createdBy property value. The createdBy property

Parameters:

  • value —

    Value to set for the createdBy property.

Returns:

  • a void



59
60
61
 
# File 'lib/models/access_review_history_definition.rb', line 59

def created_by=(value)
    @created_by = value
end

#created_date_time ⇒ Object

Gets the createdDateTime property value. Timestamp when the access review definition was created.

Returns:

  • a date_time



66
67
68
 
# File 'lib/models/access_review_history_definition.rb', line 66

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. Timestamp when the access review definition was created.

Parameters:

  • value —

    Value to set for the createdDateTime property.

Returns:

  • a void



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

def created_date_time=(value)
    @created_date_time = value
end

#decisions ⇒ Object

Gets the decisions property value. Determines which review decisions will be included in the fetched review history data if specified. Optional on create. All decisions will be included by default if no decisions are provided on create. Possible values are: approve, deny, dontKnow, notReviewed, and notNotified.

Returns:

  • a access_review_history_decision_filter



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

def decisions
    return @decisions
end

#decisions=(value) ⇒ Object

Sets the decisions property value. Determines which review decisions will be included in the fetched review history data if specified. Optional on create. All decisions will be included by default if no decisions are provided on create. Possible values are: approve, deny, dontKnow, notReviewed, and notNotified.

Parameters:

  • value —

    Value to set for the decisions property.

Returns:

  • a void



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

def decisions=(value)
    @decisions = value
end

#display_name ⇒ Object

Gets the displayName property value. Name for the access review history data collection. Required.

Returns:

  • a string



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

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. Name for the access review history data collection. Required.

Parameters:

  • value —

    Value to set for the displayName property.

Returns:

  • a void



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

def display_name=(value)
    @display_name = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



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

def get_field_deserializers()
    return super.merge({
        "createdBy" => lambda {|n| @created_by = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::UserIdentity.create_from_discriminator_value(pn) }) },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "decisions" => lambda {|n| @decisions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewHistoryDecisionFilter.create_from_discriminator_value(pn) }) },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "instances" => lambda {|n| @instances = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewHistoryInstance.create_from_discriminator_value(pn) }) },
        "reviewHistoryPeriodEndDateTime" => lambda {|n| @review_history_period_end_date_time = n.get_date_time_value() },
        "reviewHistoryPeriodStartDateTime" => lambda {|n| @review_history_period_start_date_time = n.get_date_time_value() },
        "scheduleSettings" => lambda {|n| @schedule_settings = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AccessReviewHistoryScheduleSettings.create_from_discriminator_value(pn) }) },
        "scopes" => lambda {|n| @scopes = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewScope.create_from_discriminator_value(pn) }) },
        "status" => lambda {|n| @status = n.get_enum_value(MicrosoftGraph::Models::AccessReviewHistoryStatus) },
    })
end

#instances ⇒ Object

Gets the instances property value. If the accessReviewHistoryDefinition is a recurring definition, instances represent each recurrence. A definition that does not recur will have exactly one instance.

Returns:

  • a access_review_history_instance



138
139
140
 
# File 'lib/models/access_review_history_definition.rb', line 138

def instances
    return @instances
end

#instances=(value) ⇒ Object

Sets the instances property value. If the accessReviewHistoryDefinition is a recurring definition, instances represent each recurrence. A definition that does not recur will have exactly one instance.

Parameters:

  • value —

    Value to set for the instances property.

Returns:

  • a void



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

def instances=(value)
    @instances = value
end

#review_history_period_end_date_time ⇒ Object

Gets the reviewHistoryPeriodEndDateTime property value. A timestamp. Reviews ending on or before this date will be included in the fetched history data. Only required if scheduleSettings is not defined.

Returns:

  • a date_time



153
154
155
 
# File 'lib/models/access_review_history_definition.rb', line 153

def review_history_period_end_date_time
    return @review_history_period_end_date_time
end

#review_history_period_end_date_time=(value) ⇒ Object

Sets the reviewHistoryPeriodEndDateTime property value. A timestamp. Reviews ending on or before this date will be included in the fetched history data. Only required if scheduleSettings is not defined.

Parameters:

  • value —

    Value to set for the reviewHistoryPeriodEndDateTime property.

Returns:

  • a void



161
162
163
 
# File 'lib/models/access_review_history_definition.rb', line 161

def review_history_period_end_date_time=(value)
    @review_history_period_end_date_time = value
end

#review_history_period_start_date_time ⇒ Object

Gets the reviewHistoryPeriodStartDateTime property value. A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if scheduleSettings is not defined.

Returns:

  • a date_time



168
169
170
 
# File 'lib/models/access_review_history_definition.rb', line 168

def review_history_period_start_date_time
    return @review_history_period_start_date_time
end

#review_history_period_start_date_time=(value) ⇒ Object

Sets the reviewHistoryPeriodStartDateTime property value. A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if scheduleSettings is not defined.

Parameters:

  • value —

    Value to set for the reviewHistoryPeriodStartDateTime property.

Returns:

  • a void



176
177
178
 
# File 'lib/models/access_review_history_definition.rb', line 176

def review_history_period_start_date_time=(value)
    @review_history_period_start_date_time = value
end

#schedule_settings ⇒ Object

Gets the scheduleSettings property value. The settings for a recurring access review history definition series. Only required if reviewHistoryPeriodStartDateTime or reviewHistoryPeriodEndDateTime are not defined. Not supported yet.

Returns:

  • a access_review_history_schedule_settings



183
184
185
 
# File 'lib/models/access_review_history_definition.rb', line 183

def schedule_settings
    return @schedule_settings
end

#schedule_settings=(value) ⇒ Object

Sets the scheduleSettings property value. The settings for a recurring access review history definition series. Only required if reviewHistoryPeriodStartDateTime or reviewHistoryPeriodEndDateTime are not defined. Not supported yet.

Parameters:

  • value —

    Value to set for the scheduleSettings property.

Returns:

  • a void



191
192
193
 
# File 'lib/models/access_review_history_definition.rb', line 191

def schedule_settings=(value)
    @schedule_settings = value
end

#scopes ⇒ Object

Gets the scopes property value. Used to scope what reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required.

Returns:

  • a access_review_scope



198
199
200
 
# File 'lib/models/access_review_history_definition.rb', line 198

def scopes
    return @scopes
end

#scopes=(value) ⇒ Object

Sets the scopes property value. Used to scope what reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required.

Parameters:

  • value —

    Value to set for the scopes property.

Returns:

  • a void



206
207
208
 
# File 'lib/models/access_review_history_definition.rb', line 206

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


214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/models/access_review_history_definition.rb', line 214

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_object_value("createdBy", @created_by)
    writer.write_date_time_value("createdDateTime", @created_date_time)
    writer.write_collection_of_object_values("decisions", @decisions)
    writer.write_string_value("displayName", @display_name)
    writer.write_collection_of_object_values("instances", @instances)
    writer.write_date_time_value("reviewHistoryPeriodEndDateTime", @review_history_period_end_date_time)
    writer.write_date_time_value("reviewHistoryPeriodStartDateTime", @review_history_period_start_date_time)
    writer.write_object_value("scheduleSettings", @schedule_settings)
    writer.write_collection_of_object_values("scopes", @scopes)
    writer.write_enum_value("status", @status)
end

#status ⇒ Object

Gets the status property value. Represents the status of the review history data collection. The possible values are: done, inProgress, error, requested, unknownFutureValue.

Returns:

  • a access_review_history_status



232
233
234
 
# File 'lib/models/access_review_history_definition.rb', line 232

def status
    return @status
end

#status=(value) ⇒ Object

Sets the status property value. Represents the status of the review history data collection. The possible values are: done, inProgress, error, requested, unknownFutureValue.

Parameters:

  • value —

    Value to set for the status property.

Returns:

  • a void



240
241
242
 
# File 'lib/models/access_review_history_definition.rb', line 240

def status=(value)
    @status = value
end