Class: MicrosoftGraph::Models::AccessPackageAssignmentRequest

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



107
108
109
# File 'lib/models/access_package_assignment_request.rb', line 107

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_package_assignment_request

Raises:

  • (StandardError)


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

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

Instance Method Details

#access_packageObject

Gets the accessPackage property value. The access package associated with the accessPackageAssignmentRequest. An access package defines the collections of resource roles and the policies for how one or more users can get access to those resources. Read-only. Nullable. Supports $expand.

Returns:

  • a access_package



47
48
49
# File 'lib/models/access_package_assignment_request.rb', line 47

def access_package
    return @access_package
end

#access_package=(value) ⇒ Object

Sets the accessPackage property value. The access package associated with the accessPackageAssignmentRequest. An access package defines the collections of resource roles and the policies for how one or more users can get access to those resources. Read-only. Nullable. Supports $expand.

Parameters:

  • value

    Value to set for the accessPackage property.

Returns:

  • a void



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

def access_package=(value)
    @access_package = value
end

#answersObject

Gets the answers property value. Answers provided by the requestor to accessPackageQuestions asked of them at the time of request.

Returns:

  • a access_package_answer



62
63
64
# File 'lib/models/access_package_assignment_request.rb', line 62

def answers
    return @answers
end

#answers=(value) ⇒ Object

Sets the answers property value. Answers provided by the requestor to accessPackageQuestions asked of them at the time of request.

Parameters:

  • value

    Value to set for the answers property.

Returns:

  • a void



70
71
72
# File 'lib/models/access_package_assignment_request.rb', line 70

def answers=(value)
    @answers = value
end

#assignmentObject

Gets the assignment property value. For a requestType of userAdd or adminAdd, this is an access package assignment requested to be created. For a requestType of userRemove, adminRemove or systemRemove, this has the id property of an existing assignment to be removed. Supports $expand.

Returns:

  • a access_package_assignment



77
78
79
# File 'lib/models/access_package_assignment_request.rb', line 77

def assignment
    return @assignment
end

#assignment=(value) ⇒ Object

Sets the assignment property value. For a requestType of userAdd or adminAdd, this is an access package assignment requested to be created. For a requestType of userRemove, adminRemove or systemRemove, this has the id property of an existing assignment to be removed. Supports $expand.

Parameters:

  • value

    Value to set for the assignment property.

Returns:

  • a void



85
86
87
# File 'lib/models/access_package_assignment_request.rb', line 85

def assignment=(value)
    @assignment = value
end

#completed_date_timeObject

Gets the completedDateTime property value. The date of the end of processing, either successful or failure, of a request. The Timestamp 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. Read-only.

Returns:

  • a date_time



92
93
94
# File 'lib/models/access_package_assignment_request.rb', line 92

def completed_date_time
    return @completed_date_time
end

#completed_date_time=(value) ⇒ Object

Sets the completedDateTime property value. The date of the end of processing, either successful or failure, of a request. The Timestamp 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. Read-only.

Parameters:

  • value

    Value to set for the completedDateTime property.

Returns:

  • a void



100
101
102
# File 'lib/models/access_package_assignment_request.rb', line 100

def completed_date_time=(value)
    @completed_date_time = value
end

#created_date_timeObject

Gets the createdDateTime property value. The Timestamp 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. Read-only. Supports $filter.

Returns:

  • a date_time



114
115
116
# File 'lib/models/access_package_assignment_request.rb', line 114

def created_date_time
    return @created_date_time
end

#created_date_time=(value) ⇒ Object

Sets the createdDateTime property value. The Timestamp 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. Read-only. Supports $filter.

Parameters:

  • value

    Value to set for the createdDateTime property.

Returns:

  • a void



122
123
124
# File 'lib/models/access_package_assignment_request.rb', line 122

def created_date_time=(value)
    @created_date_time = value
end

#custom_extension_callout_instancesObject

Gets the customExtensionCalloutInstances property value. Information about all the custom extension calls that were made during the access package assignment workflow.

Returns:

  • a custom_extension_callout_instance



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

def custom_extension_callout_instances
    return @custom_extension_callout_instances
end

#custom_extension_callout_instances=(value) ⇒ Object

Sets the customExtensionCalloutInstances property value. Information about all the custom extension calls that were made during the access package assignment workflow.

Parameters:

  • value

    Value to set for the customExtensionCalloutInstances property.

Returns:

  • a void



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

def custom_extension_callout_instances=(value)
    @custom_extension_callout_instances = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'lib/models/access_package_assignment_request.rb', line 153

def get_field_deserializers()
    return super.merge({
        "accessPackage" => lambda {|n| @access_package = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AccessPackage.create_from_discriminator_value(pn) }) },
        "answers" => lambda {|n| @answers = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::AccessPackageAnswer.create_from_discriminator_value(pn) }) },
        "assignment" => lambda {|n| @assignment = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AccessPackageAssignment.create_from_discriminator_value(pn) }) },
        "completedDateTime" => lambda {|n| @completed_date_time = n.get_date_time_value() },
        "createdDateTime" => lambda {|n| @created_date_time = n.get_date_time_value() },
        "customExtensionCalloutInstances" => lambda {|n| @custom_extension_callout_instances = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::CustomExtensionCalloutInstance.create_from_discriminator_value(pn) }) },
        "requestType" => lambda {|n| @request_type = n.get_enum_value(MicrosoftGraph::Models::AccessPackageRequestType) },
        "requestor" => lambda {|n| @requestor = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AccessPackageSubject.create_from_discriminator_value(pn) }) },
        "schedule" => lambda {|n| @schedule = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EntitlementManagementSchedule.create_from_discriminator_value(pn) }) },
        "state" => lambda {|n| @state = n.get_enum_value(MicrosoftGraph::Models::AccessPackageRequestState) },
        "status" => lambda {|n| @status = n.get_string_value() },
    })
end

#request_typeObject

Gets the requestType property value. The type of the request. The possible values are: notSpecified, userAdd, UserExtend, userUpdate, userRemove, adminAdd, adminUpdate, adminRemove, systemAdd, systemUpdate, systemRemove, onBehalfAdd (not supported), unknownFutureValue. A request from the user themselves would have requestType of userAdd, userUpdate or userRemove. This property cannot be changed once set.

Returns:

  • a access_package_request_type



172
173
174
# File 'lib/models/access_package_assignment_request.rb', line 172

def request_type
    return @request_type
end

#request_type=(value) ⇒ Object

Sets the requestType property value. The type of the request. The possible values are: notSpecified, userAdd, UserExtend, userUpdate, userRemove, adminAdd, adminUpdate, adminRemove, systemAdd, systemUpdate, systemRemove, onBehalfAdd (not supported), unknownFutureValue. A request from the user themselves would have requestType of userAdd, userUpdate or userRemove. This property cannot be changed once set.

Parameters:

  • value

    Value to set for the requestType property.

Returns:

  • a void



180
181
182
# File 'lib/models/access_package_assignment_request.rb', line 180

def request_type=(value)
    @request_type = value
end

#requestorObject

Gets the requestor property value. The subject who requested or, if a direct assignment, was assigned. Read-only. Nullable. Supports $expand.

Returns:

  • a access_package_subject



187
188
189
# File 'lib/models/access_package_assignment_request.rb', line 187

def requestor
    return @requestor
end

#requestor=(value) ⇒ Object

Sets the requestor property value. The subject who requested or, if a direct assignment, was assigned. Read-only. Nullable. Supports $expand.

Parameters:

  • value

    Value to set for the requestor property.

Returns:

  • a void



195
196
197
# File 'lib/models/access_package_assignment_request.rb', line 195

def requestor=(value)
    @requestor = value
end

#scheduleObject

Gets the schedule property value. The range of dates that access is to be assigned to the requestor. This property cannot be changed once set.

Returns:

  • a entitlement_management_schedule



202
203
204
# File 'lib/models/access_package_assignment_request.rb', line 202

def schedule
    return @schedule
end

#schedule=(value) ⇒ Object

Sets the schedule property value. The range of dates that access is to be assigned to the requestor. This property cannot be changed once set.

Parameters:

  • value

    Value to set for the schedule property.

Returns:

  • a void



210
211
212
# File 'lib/models/access_package_assignment_request.rb', line 210

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


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/models/access_package_assignment_request.rb', line 218

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_object_value("accessPackage", @access_package)
    writer.write_collection_of_object_values("answers", @answers)
    writer.write_object_value("assignment", @assignment)
    writer.write_date_time_value("completedDateTime", @completed_date_time)
    writer.write_date_time_value("createdDateTime", @created_date_time)
    writer.write_collection_of_object_values("customExtensionCalloutInstances", @custom_extension_callout_instances)
    writer.write_enum_value("requestType", @request_type)
    writer.write_object_value("requestor", @requestor)
    writer.write_object_value("schedule", @schedule)
    writer.write_enum_value("state", @state)
    writer.write_string_value("status", @status)
end

#stateObject

Gets the state property value. The state of the request. The possible values are: submitted, pendingApproval, delivering, delivered, deliveryFailed, denied, scheduled, canceled, partiallyDelivered, unknownFutureValue. Read-only. Supports $filter (eq).

Returns:

  • a access_package_request_state



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

def state
    return @state
end

#state=(value) ⇒ Object

Sets the state property value. The state of the request. The possible values are: submitted, pendingApproval, delivering, delivered, deliveryFailed, denied, scheduled, canceled, partiallyDelivered, unknownFutureValue. Read-only. Supports $filter (eq).

Parameters:

  • value

    Value to set for the state property.

Returns:

  • a void



245
246
247
# File 'lib/models/access_package_assignment_request.rb', line 245

def state=(value)
    @state = value
end

#statusObject

Gets the status property value. More information on the request processing status. Read-only.

Returns:

  • a string



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

def status
    return @status
end

#status=(value) ⇒ Object

Sets the status property value. More information on the request processing status. Read-only.

Parameters:

  • value

    Value to set for the status property.

Returns:

  • a void



260
261
262
# File 'lib/models/access_package_assignment_request.rb', line 260

def status=(value)
    @status = value
end