Class: OCI::Apiaccesscontrol::Models::PrivilegedApiRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apiaccesscontrol/models/privileged_api_request.rb

Overview

An Oracle operator raises privilegedApi request when they need access to any infrastructure resource governed by PrivilegedApi Access Control. The privilegedApi request identifies the target resource and the set of operator actions. Access request handling depends upon the Operator Control that governs the target resource, and the set of operator actions listed for approval in the access request. If all of the operator actions listed in the privilegedApi request are in the pre-approved list in the PrivilegedApi Control that governs the target resource, then the privilegedApi request is automatically approved. If not, then the privilegedApi request requires explicit approval from the approver group specified by the PrivilegedApi Control governing the target resource.

You can approve or reject an privilegedApi request. You can also revoke the approval of an already approved privilegedApi request. While creating an access request, the operator specifies the duration of access. You have the option to approve the entire duration or reduce or even increase the time duration. An operator can also request for an extension. The approval for such an extension is processed the same way the original privilegedApi request was processed.

Constant Summary collapse

SEVERITY_ENUM =
[
  SEVERITY_SEV_1 = 'SEV_1'.freeze,
  SEVERITY_SEV_2 = 'SEV_2'.freeze,
  SEVERITY_SEV_3 = 'SEV_3'.freeze,
  SEVERITY_SEV_4 = 'SEV_4'.freeze,
  SEVERITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATE_ENUM =
[
  STATE_CREATED = 'CREATED'.freeze,
  STATE_APPROVAL_WAITING = 'APPROVAL_WAITING'.freeze,
  STATE_APPROVED = 'APPROVED'.freeze,
  STATE_APPROVED_FOR_FUTURE = 'APPROVED_FOR_FUTURE'.freeze,
  STATE_REJECTED = 'REJECTED'.freeze,
  STATE_DEPLOYED = 'DEPLOYED'.freeze,
  STATE_DEPLOY_FAILED = 'DEPLOY_FAILED'.freeze,
  STATE_CLOSE_FAILED = 'CLOSE_FAILED'.freeze,
  STATE_REVOKE_FAILED = 'REVOKE_FAILED'.freeze,
  STATE_EXPIRY_FAILED = 'EXPIRY_FAILED'.freeze,
  STATE_REVOKING = 'REVOKING'.freeze,
  STATE_REVOKED = 'REVOKED'.freeze,
  STATE_CLOSING = 'CLOSING'.freeze,
  STATE_CLOSED = 'CLOSED'.freeze,
  STATE_EXPIRED = 'EXPIRED'.freeze,
  STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_WAITING = 'WAITING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PrivilegedApiRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 326

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.request_id = attributes[:'requestId'] if attributes[:'requestId']

  raise 'You cannot provide both :requestId and :request_id' if attributes.key?(:'requestId') && attributes.key?(:'request_id')

  self.request_id = attributes[:'request_id'] if attributes[:'request_id']

  self.reason_summary = attributes[:'reasonSummary'] if attributes[:'reasonSummary']

  raise 'You cannot provide both :reasonSummary and :reason_summary' if attributes.key?(:'reasonSummary') && attributes.key?(:'reason_summary')

  self.reason_summary = attributes[:'reason_summary'] if attributes[:'reason_summary']

  self.notification_topic_id = attributes[:'notificationTopicId'] if attributes[:'notificationTopicId']

  raise 'You cannot provide both :notificationTopicId and :notification_topic_id' if attributes.key?(:'notificationTopicId') && attributes.key?(:'notification_topic_id')

  self.notification_topic_id = attributes[:'notification_topic_id'] if attributes[:'notification_topic_id']

  self.requested_by = attributes[:'requestedBy'] if attributes[:'requestedBy']

  raise 'You cannot provide both :requestedBy and :requested_by' if attributes.key?(:'requestedBy') && attributes.key?(:'requested_by')

  self.requested_by = attributes[:'requested_by'] if attributes[:'requested_by']

  self.resource_name = attributes[:'resourceName'] if attributes[:'resourceName']

  raise 'You cannot provide both :resourceName and :resource_name' if attributes.key?(:'resourceName') && attributes.key?(:'resource_name')

  self.resource_name = attributes[:'resource_name'] if attributes[:'resource_name']

  self.resource_id = attributes[:'resourceId'] if attributes[:'resourceId']

  raise 'You cannot provide both :resourceId and :resource_id' if attributes.key?(:'resourceId') && attributes.key?(:'resource_id')

  self.resource_id = attributes[:'resource_id'] if attributes[:'resource_id']

  self.sub_resource_name_list = attributes[:'subResourceNameList'] if attributes[:'subResourceNameList']

  raise 'You cannot provide both :subResourceNameList and :sub_resource_name_list' if attributes.key?(:'subResourceNameList') && attributes.key?(:'sub_resource_name_list')

  self.sub_resource_name_list = attributes[:'sub_resource_name_list'] if attributes[:'sub_resource_name_list']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']

  raise 'You cannot provide both :resourceType and :resource_type' if attributes.key?(:'resourceType') && attributes.key?(:'resource_type')

  self.resource_type = attributes[:'resource_type'] if attributes[:'resource_type']

  self.entity_type = attributes[:'entityType'] if attributes[:'entityType']

  raise 'You cannot provide both :entityType and :entity_type' if attributes.key?(:'entityType') && attributes.key?(:'entity_type')

  self.entity_type = attributes[:'entity_type'] if attributes[:'entity_type']

  self.privileged_operation_list = attributes[:'privilegedOperationList'] if attributes[:'privilegedOperationList']

  raise 'You cannot provide both :privilegedOperationList and :privileged_operation_list' if attributes.key?(:'privilegedOperationList') && attributes.key?(:'privileged_operation_list')

  self.privileged_operation_list = attributes[:'privileged_operation_list'] if attributes[:'privileged_operation_list']

  self.reason_detail = attributes[:'reasonDetail'] if attributes[:'reasonDetail']

  raise 'You cannot provide both :reasonDetail and :reason_detail' if attributes.key?(:'reasonDetail') && attributes.key?(:'reason_detail')

  self.reason_detail = attributes[:'reason_detail'] if attributes[:'reason_detail']

  self.severity = attributes[:'severity'] if attributes[:'severity']

  self.duration_in_hrs = attributes[:'durationInHrs'] if attributes[:'durationInHrs']

  raise 'You cannot provide both :durationInHrs and :duration_in_hrs' if attributes.key?(:'durationInHrs') && attributes.key?(:'duration_in_hrs')

  self.duration_in_hrs = attributes[:'duration_in_hrs'] if attributes[:'duration_in_hrs']

  self.ticket_numbers = attributes[:'ticketNumbers'] if attributes[:'ticketNumbers']

  raise 'You cannot provide both :ticketNumbers and :ticket_numbers' if attributes.key?(:'ticketNumbers') && attributes.key?(:'ticket_numbers')

  self.ticket_numbers = attributes[:'ticket_numbers'] if attributes[:'ticket_numbers']

  self.state = attributes[:'state'] if attributes[:'state']

  self.state_details = attributes[:'stateDetails'] if attributes[:'stateDetails']

  raise 'You cannot provide both :stateDetails and :state_details' if attributes.key?(:'stateDetails') && attributes.key?(:'state_details')

  self.state_details = attributes[:'state_details'] if attributes[:'state_details']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

  raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details')

  self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.closure_comment = attributes[:'closureComment'] if attributes[:'closureComment']

  raise 'You cannot provide both :closureComment and :closure_comment' if attributes.key?(:'closureComment') && attributes.key?(:'closure_comment')

  self.closure_comment = attributes[:'closure_comment'] if attributes[:'closure_comment']

  self.privileged_api_control_id = attributes[:'privilegedApiControlId'] if attributes[:'privilegedApiControlId']

  raise 'You cannot provide both :privilegedApiControlId and :privileged_api_control_id' if attributes.key?(:'privilegedApiControlId') && attributes.key?(:'privileged_api_control_id')

  self.privileged_api_control_id = attributes[:'privileged_api_control_id'] if attributes[:'privileged_api_control_id']

  self.privileged_api_control_name = attributes[:'privilegedApiControlName'] if attributes[:'privilegedApiControlName']

  raise 'You cannot provide both :privilegedApiControlName and :privileged_api_control_name' if attributes.key?(:'privilegedApiControlName') && attributes.key?(:'privileged_api_control_name')

  self.privileged_api_control_name = attributes[:'privileged_api_control_name'] if attributes[:'privileged_api_control_name']

  self.number_of_approvers_required = attributes[:'numberOfApproversRequired'] if attributes[:'numberOfApproversRequired']

  raise 'You cannot provide both :numberOfApproversRequired and :number_of_approvers_required' if attributes.key?(:'numberOfApproversRequired') && attributes.key?(:'number_of_approvers_required')

  self.number_of_approvers_required = attributes[:'number_of_approvers_required'] if attributes[:'number_of_approvers_required']

  self.approver_details = attributes[:'approverDetails'] if attributes[:'approverDetails']

  raise 'You cannot provide both :approverDetails and :approver_details' if attributes.key?(:'approverDetails') && attributes.key?(:'approver_details')

  self.approver_details = attributes[:'approver_details'] if attributes[:'approver_details']

  self.time_requested_for_future_access = attributes[:'timeRequestedForFutureAccess'] if attributes[:'timeRequestedForFutureAccess']

  raise 'You cannot provide both :timeRequestedForFutureAccess and :time_requested_for_future_access' if attributes.key?(:'timeRequestedForFutureAccess') && attributes.key?(:'time_requested_for_future_access')

  self.time_requested_for_future_access = attributes[:'time_requested_for_future_access'] if attributes[:'time_requested_for_future_access']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#approver_detailsArray<OCI::Apiaccesscontrol::Models::ApproverDetail>

Contains the approver details who have approved the privilegedApi Request during the initial request.



178
179
180
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 178

def approver_details
  @approver_details
end

#closure_commentString

The comment entered by the operator while closing the request.

Returns:

  • (String)


162
163
164
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 162

def closure_comment
  @closure_comment
end

#compartment_idString

The OCID of the compartment that contains the access request.

Returns:

  • (String)


100
101
102
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 100

def compartment_id
  @compartment_id
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>)


199
200
201
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 199

def defined_tags
  @defined_tags
end

#display_nameString

Name of the privilegedApi control. The name must be unique.

Returns:

  • (String)


66
67
68
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 66

def display_name
  @display_name
end

#duration_in_hrsInteger

Duration in hours for which access is sought on the target resource.

Returns:

  • (Integer)


125
126
127
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 125

def duration_in_hrs
  @duration_in_hrs
end

#entity_typeString

entityType of resource for which the AccessRequest is applicable

Returns:

  • (String)


108
109
110
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 108

def entity_type
  @entity_type
end

#freeform_tagsHash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


191
192
193
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 191

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the privilegedApi request.

Returns:

  • (String)


62
63
64
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 62

def id
  @id
end

#lifecycle_detailsString

more in detail about the lifeCycleState.

Returns:

  • (String)


148
149
150
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 148

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

The current state of the PrivilegedApiRequest.

Returns:

  • (String)


144
145
146
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 144

def lifecycle_state
  @lifecycle_state
end

#notification_topic_idString

The OCID of the OCI Notification topic to publish messages related to this privileged api request.

Returns:

  • (String)


78
79
80
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 78

def notification_topic_id
  @notification_topic_id
end

#number_of_approvers_requiredInteger

Number of approvers required to approve an privilegedApi request.

Returns:

  • (Integer)


174
175
176
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 174

def number_of_approvers_required
  @number_of_approvers_required
end

#privileged_api_control_idString

The OCID of the privilegedApi control governing the target resource.

Returns:

  • (String)


166
167
168
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 166

def privileged_api_control_id
  @privileged_api_control_id
end

#privileged_api_control_nameString

Name of the privilegedApi control governing the target resource.

Returns:

  • (String)


170
171
172
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 170

def privileged_api_control_name
  @privileged_api_control_name
end

#privileged_operation_listArray<OCI::Apiaccesscontrol::Models::PrivilegedApiRequestOperationDetails>

List of api names, attributes for which approval is sought by the user.



113
114
115
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 113

def privileged_operation_list
  @privileged_operation_list
end

#reason_detailString

Reason in Detail for which the operator is requesting access on the target resource.

Returns:

  • (String)


117
118
119
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 117

def reason_detail
  @reason_detail
end

#reason_summaryString

[Required] Summary comment by the operator creating the access request.

Returns:

  • (String)


74
75
76
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 74

def reason_summary
  @reason_summary
end

#request_idString

This is an automatic identifier generated by the system which is easier for human comprehension.

Returns:

  • (String)


70
71
72
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 70

def request_id
  @request_id
end

#requested_byArray<String>

List of Users who has created this privilegedApiRequest.

Returns:

  • (Array<String>)


83
84
85
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 83

def requested_by
  @requested_by
end

#resource_idString

[Required] The OCID of the target resource associated with the access request. The operator raises an access request to get approval to access the target resource.

Returns:

  • (String)


92
93
94
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 92

def resource_id
  @resource_id
end

#resource_nameString

resourceName for which the PrivilegedApiRequest is applicable

Returns:

  • (String)


87
88
89
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 87

def resource_name
  @resource_name
end

#resource_typeString

resourceType for which the AccessRequest is applicable

Returns:

  • (String)


104
105
106
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 104

def resource_type
  @resource_type
end

#severityString

Priority assigned to the access request by the operator

Returns:

  • (String)


121
122
123
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 121

def severity
  @severity
end

#stateString

[Required] The current state of the Access Request.

Returns:

  • (String)


134
135
136
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 134

def state
  @state
end

#state_detailsString

A message that describes the current state of the PrivilegedApiControl in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String)


140
141
142
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 140

def state_details
  @state_details
end

#sub_resource_name_listArray<String>

The subresource names requested for approval.

Returns:

  • (Array<String>)


96
97
98
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 96

def sub_resource_name_list
  @sub_resource_name_list
end

#system_tagsHash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>)


206
207
208
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 206

def system_tags
  @system_tags
end

#ticket_numbersArray<String>

A list of ticket numbers related to this Privileged Api Access Request, e.g. Service Request (SR) number and JIRA ticket number.

Returns:

  • (Array<String>)


130
131
132
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 130

def ticket_numbers
  @ticket_numbers
end

#time_createdDateTime

Time when the privilegedApi request was created in 3339[https://tools.ietf.org/html/rfc3339]timestamp format. Example: '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime)


153
154
155
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 153

def time_created
  @time_created
end

#time_requested_for_future_accessDateTime

Time in future when the user for the privilegedApi request needs to be created in 3339[https://tools.ietf.org/html/rfc3339]timestamp format. Example: '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime)


183
184
185
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 183

def time_requested_for_future_access
  @time_requested_for_future_access
end

#time_updatedDateTime

Time when the privilegedApi request was last modified in 3339[https://tools.ietf.org/html/rfc3339]timestamp format. Example: '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime)


158
159
160
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 158

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 209

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'request_id': :'requestId',
    'reason_summary': :'reasonSummary',
    'notification_topic_id': :'notificationTopicId',
    'requested_by': :'requestedBy',
    'resource_name': :'resourceName',
    'resource_id': :'resourceId',
    'sub_resource_name_list': :'subResourceNameList',
    'compartment_id': :'compartmentId',
    'resource_type': :'resourceType',
    'entity_type': :'entityType',
    'privileged_operation_list': :'privilegedOperationList',
    'reason_detail': :'reasonDetail',
    'severity': :'severity',
    'duration_in_hrs': :'durationInHrs',
    'ticket_numbers': :'ticketNumbers',
    'state': :'state',
    'state_details': :'stateDetails',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'closure_comment': :'closureComment',
    'privileged_api_control_id': :'privilegedApiControlId',
    'privileged_api_control_name': :'privilegedApiControlName',
    'number_of_approvers_required': :'numberOfApproversRequired',
    'approver_details': :'approverDetails',
    'time_requested_for_future_access': :'timeRequestedForFutureAccess',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 249

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'request_id': :'String',
    'reason_summary': :'String',
    'notification_topic_id': :'String',
    'requested_by': :'Array<String>',
    'resource_name': :'String',
    'resource_id': :'String',
    'sub_resource_name_list': :'Array<String>',
    'compartment_id': :'String',
    'resource_type': :'String',
    'entity_type': :'String',
    'privileged_operation_list': :'Array<OCI::Apiaccesscontrol::Models::PrivilegedApiRequestOperationDetails>',
    'reason_detail': :'String',
    'severity': :'String',
    'duration_in_hrs': :'Integer',
    'ticket_numbers': :'Array<String>',
    'state': :'String',
    'state_details': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'closure_comment': :'String',
    'privileged_api_control_id': :'String',
    'privileged_api_control_name': :'String',
    'number_of_approvers_required': :'Integer',
    'approver_details': :'Array<OCI::Apiaccesscontrol::Models::ApproverDetail>',
    'time_requested_for_future_access': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 559

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    request_id == other.request_id &&
    reason_summary == other.reason_summary &&
    notification_topic_id == other.notification_topic_id &&
    requested_by == other.requested_by &&
    resource_name == other.resource_name &&
    resource_id == other.resource_id &&
    sub_resource_name_list == other.sub_resource_name_list &&
    compartment_id == other.compartment_id &&
    resource_type == other.resource_type &&
    entity_type == other.entity_type &&
    privileged_operation_list == other.privileged_operation_list &&
    reason_detail == other.reason_detail &&
    severity == other.severity &&
    duration_in_hrs == other.duration_in_hrs &&
    ticket_numbers == other.ticket_numbers &&
    state == other.state &&
    state_details == other.state_details &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    closure_comment == other.closure_comment &&
    privileged_api_control_id == other.privileged_api_control_id &&
    privileged_api_control_name == other.privileged_api_control_name &&
    number_of_approvers_required == other.number_of_approvers_required &&
    approver_details == other.approver_details &&
    time_requested_for_future_access == other.time_requested_for_future_access &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 620

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


600
601
602
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 600

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



609
610
611
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 609

def hash
  [id, display_name, request_id, reason_summary, notification_topic_id, requested_by, resource_name, resource_id, sub_resource_name_list, compartment_id, resource_type, entity_type, privileged_operation_list, reason_detail, severity, duration_in_hrs, ticket_numbers, state, state_details, lifecycle_state, lifecycle_details, time_created, time_updated, closure_comment, privileged_api_control_id, privileged_api_control_name, number_of_approvers_required, approver_details, time_requested_for_future_access, freeform_tags, defined_tags, system_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



653
654
655
656
657
658
659
660
661
662
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 653

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



647
648
649
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request.rb', line 647

def to_s
  to_hash.to_s
end