Class: MicrosoftGraph::Models::AccessReviewInstance

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



41
42
43
 
# File 'lib/models/access_review_instance.rb', line 41

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_instance

Raises:

  • (StandardError) 


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

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

Instance Method Details

#contacted_reviewers ⇒ Object

Gets the contactedReviewers property value. Returns the collection of reviewers who were contacted to complete this review. While the reviewers and fallbackReviewers properties of the accessReviewScheduleDefinition might specify group owners or managers as reviewers, contactedReviewers returns their individual identities. Supports $select. Read-only.

Returns:

  • a access_review_reviewer



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

def contacted_reviewers
    return @contacted_reviewers
end

#contacted_reviewers=(value) ⇒ Object

Sets the contactedReviewers property value. Returns the collection of reviewers who were contacted to complete this review. While the reviewers and fallbackReviewers properties of the accessReviewScheduleDefinition might specify group owners or managers as reviewers, contactedReviewers returns their individual identities. Supports $select. Read-only.

Parameters:

  • value —

    Value to set for the contactedReviewers property.

Returns:

  • a void



56
57
58
 
# File 'lib/models/access_review_instance.rb', line 56

def contacted_reviewers=(value)
    @contacted_reviewers = value
end

#decisions ⇒ Object

Gets the decisions property value. Each user reviewed in an accessReviewInstance has a decision item representing if they were approved, denied, or not yet reviewed.

Returns:

  • a access_review_instance_decision_item



72
73
74
 
# File 'lib/models/access_review_instance.rb', line 72

def decisions
    return @decisions
end

#decisions=(value) ⇒ Object

Sets the decisions property value. Each user reviewed in an accessReviewInstance has a decision item representing if they were approved, denied, or not yet reviewed.

Parameters:

  • value —

    Value to set for the decisions property.

Returns:

  • a void



80
81
82
 
# File 'lib/models/access_review_instance.rb', line 80

def decisions=(value)
    @decisions = value
end

#end_date_time ⇒ Object

Gets the endDateTime property value. DateTime when review instance is scheduled to end.The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.

Returns:

  • a date_time



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

def end_date_time
    return @end_date_time
end

#end_date_time=(value) ⇒ Object

Sets the endDateTime property value. DateTime when review instance is scheduled to end.The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.

Parameters:

  • value —

    Value to set for the endDateTime property.

Returns:

  • a void



95
96
97
 
# File 'lib/models/access_review_instance.rb', line 95

def end_date_time=(value)
    @end_date_time = value
end

#fallback_reviewers ⇒ Object

Gets the fallbackReviewers property value. This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user’s manager does not exist. Supports $select.

Returns:

  • a access_review_reviewer_scope



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

def fallback_reviewers
    return @fallback_reviewers
end

#fallback_reviewers=(value) ⇒ Object

Sets the fallbackReviewers property value. This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user’s manager does not exist. Supports $select.

Parameters:

  • value —

    Value to set for the fallbackReviewers property.

Returns:

  • a void



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

def fallback_reviewers=(value)
    @fallback_reviewers = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/models/access_review_instance.rb', line 117

def get_field_deserializers()
    return super.merge({
        "contactedReviewers" => lambda {|n| @contacted_reviewers = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewReviewer.create_from_discriminator_value(pn) }) },
        "decisions" => lambda {|n| @decisions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewInstanceDecisionItem.create_from_discriminator_value(pn) }) },
        "endDateTime" => lambda {|n| @end_date_time = n.get_date_time_value() },
        "fallbackReviewers" => lambda {|n| @fallback_reviewers = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewReviewerScope.create_from_discriminator_value(pn) }) },
        "reviewers" => lambda {|n| @reviewers = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewReviewerScope.create_from_discriminator_value(pn) }) },
        "scope" => lambda {|n| @scope = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AccessReviewScope.create_from_discriminator_value(pn) }) },
        "stages" => lambda {|n| @stages = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessReviewStage.create_from_discriminator_value(pn) }) },
        "startDateTime" => lambda {|n| @start_date_time = n.get_date_time_value() },
        "status" => lambda {|n| @status = n.get_string_value() },
    })
end

#reviewers ⇒ Object

Gets the reviewers property value. This collection of access review scopes is used to define who the reviewers are. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.

Returns:

  • a access_review_reviewer_scope



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

def reviewers
    return @reviewers
end

#reviewers=(value) ⇒ Object

Sets the reviewers property value. This collection of access review scopes is used to define who the reviewers are. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.

Parameters:

  • value —

    Value to set for the reviewers property.

Returns:

  • a void



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

def reviewers=(value)
    @reviewers = value
end

#scope ⇒ Object

Gets the scope property value. Created based on scope and instanceEnumerationScope at the accessReviewScheduleDefinition level. Defines the scope of users reviewed in a group. Supports $select and $filter (contains only). Read-only.

Returns:

  • a access_review_scope



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

def scope
    return @scope
end

#scope=(value) ⇒ Object

Sets the scope property value. Created based on scope and instanceEnumerationScope at the accessReviewScheduleDefinition level. Defines the scope of users reviewed in a group. Supports $select and $filter (contains only). Read-only.

Parameters:

  • value —

    Value to set for the scope property.

Returns:

  • a void



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

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


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

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_collection_of_object_values("contactedReviewers", @contacted_reviewers)
    writer.write_collection_of_object_values("decisions", @decisions)
    writer.write_date_time_value("endDateTime", @end_date_time)
    writer.write_collection_of_object_values("fallbackReviewers", @fallback_reviewers)
    writer.write_collection_of_object_values("reviewers", @reviewers)
    writer.write_object_value("scope", @scope)
    writer.write_collection_of_object_values("stages", @stages)
    writer.write_date_time_value("startDateTime", @start_date_time)
    writer.write_string_value("status", @status)
end

#stages ⇒ Object

Gets the stages property value. If the instance has multiple stages, this returns the collection of stages. A new stage will only be created when the previous stage ends. The existence, number, and settings of stages on a review instance are created based on the accessReviewStageSettings on the parent accessReviewScheduleDefinition.

Returns:

  • a access_review_stage



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

def stages
    return @stages
end

#stages=(value) ⇒ Object

Sets the stages property value. If the instance has multiple stages, this returns the collection of stages. A new stage will only be created when the previous stage ends. The existence, number, and settings of stages on a review instance are created based on the accessReviewStageSettings on the parent accessReviewScheduleDefinition.

Parameters:

  • value —

    Value to set for the stages property.

Returns:

  • a void



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

def stages=(value)
    @stages = value
end

#start_date_time ⇒ Object

Gets the startDateTime property value. DateTime when review instance is scheduled to start. May be in the future. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.

Returns:

  • a date_time



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

def start_date_time
    return @start_date_time
end

#start_date_time=(value) ⇒ Object

Sets the startDateTime property value. DateTime when review instance is scheduled to start. May be in the future. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.

Parameters:

  • value —

    Value to set for the startDateTime property.

Returns:

  • a void



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

def start_date_time=(value)
    @start_date_time = value
end

#status ⇒ Object

Gets the status property value. Specifies the status of an accessReview. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.

Returns:

  • a string



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

def status
    return @status
end

#status=(value) ⇒ Object

Sets the status property value. Specifies the status of an accessReview. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.

Parameters:

  • value —

    Value to set for the status property.

Returns:

  • a void



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

def status=(value)
    @status = value
end