Class: OCI::OperatorAccessControl::Models::AccessRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/operator_access_control/models/access_request.rb

Overview

An Oracle operator raises access request when they need access to any infrastructure resource governed by Operator Access Control. The access 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 access request are in the pre-approved list in the Operator Control that governs the target resource, then the access request is automatically approved. If not, then the access request requires explicit approval from the approver group specified by the Operator Control governing the target resource.

You can approve or reject an access request. You can also revoke the approval of an already approved access 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 access request was processed.

Constant Summary collapse

RESOURCE_TYPE_ENUM = 
[
  RESOURCE_TYPE_EXACC = 'EXACC'.freeze,
  RESOURCE_TYPE_EXADATAINFRASTRUCTURE = 'EXADATAINFRASTRUCTURE'.freeze,
  RESOURCE_TYPE_AUTONOMOUSVMCLUSTER = 'AUTONOMOUSVMCLUSTER'.freeze,
  RESOURCE_TYPE_CLOUDAUTONOMOUSVMCLUSTER = 'CLOUDAUTONOMOUSVMCLUSTER'.freeze,
  RESOURCE_TYPE_CCCINFRASTRUCTURE = 'CCCINFRASTRUCTURE'.freeze,
  RESOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SEVERITY_ENUM = 
[
  SEVERITY_S1 = 'S1'.freeze,
  SEVERITY_S2 = 'S2'.freeze,
  SEVERITY_S3 = 'S3'.freeze,
  SEVERITY_S4 = 'S4'.freeze,
  SEVERITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATED = 'CREATED'.freeze,
  LIFECYCLE_STATE_APPROVALWAITING = 'APPROVALWAITING'.freeze,
  LIFECYCLE_STATE_PREAPPROVED = 'PREAPPROVED'.freeze,
  LIFECYCLE_STATE_APPROVED = 'APPROVED'.freeze,
  LIFECYCLE_STATE_MOREINFO = 'MOREINFO'.freeze,
  LIFECYCLE_STATE_REJECTED = 'REJECTED'.freeze,
  LIFECYCLE_STATE_DEPLOYED = 'DEPLOYED'.freeze,
  LIFECYCLE_STATE_DEPLOYFAILED = 'DEPLOYFAILED'.freeze,
  LIFECYCLE_STATE_UNDEPLOYED = 'UNDEPLOYED'.freeze,
  LIFECYCLE_STATE_UNDEPLOYFAILED = 'UNDEPLOYFAILED'.freeze,
  LIFECYCLE_STATE_CLOSEFAILED = 'CLOSEFAILED'.freeze,
  LIFECYCLE_STATE_REVOKEFAILED = 'REVOKEFAILED'.freeze,
  LIFECYCLE_STATE_EXPIRYFAILED = 'EXPIRYFAILED'.freeze,
  LIFECYCLE_STATE_REVOKING = 'REVOKING'.freeze,
  LIFECYCLE_STATE_REVOKED = 'REVOKED'.freeze,
  LIFECYCLE_STATE_EXTENDING = 'EXTENDING'.freeze,
  LIFECYCLE_STATE_EXTENDED = 'EXTENDED'.freeze,
  LIFECYCLE_STATE_EXTENSIONREJECTED = 'EXTENSIONREJECTED'.freeze,
  LIFECYCLE_STATE_COMPLETING = 'COMPLETING'.freeze,
  LIFECYCLE_STATE_COMPLETED = 'COMPLETED'.freeze,
  LIFECYCLE_STATE_EXPIRED = 'EXPIRED'.freeze,
  LIFECYCLE_STATE_APPROVEDFORFUTURE = 'APPROVEDFORFUTURE'.freeze,
  LIFECYCLE_STATE_INREVIEW = 'INREVIEW'.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 = {}) ⇒ AccessRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
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
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 368

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.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.access_reason_summary = attributes[:'accessReasonSummary'] if attributes[:'accessReasonSummary']

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

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

  self.operator_id = attributes[:'operatorId'] if attributes[:'operatorId']

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

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

  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.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.sub_resource_list = attributes[:'subResourceList'] if attributes[:'subResourceList']

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

  self.sub_resource_list = attributes[:'sub_resource_list'] if attributes[:'sub_resource_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.action_requests_list = attributes[:'actionRequestsList'] if attributes[:'actionRequestsList']

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

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

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

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

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

  self.extend_duration = attributes[:'extendDuration'] if attributes[:'extendDuration']

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

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

  self.workflow_id = attributes[:'workflowId'] if attributes[:'workflowId']

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

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

  self.is_auto_approved = attributes[:'isAutoApproved'] unless attributes[:'isAutoApproved'].nil?

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

  self.is_auto_approved = attributes[:'is_auto_approved'] unless attributes[:'is_auto_approved'].nil?

  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_of_creation = attributes[:'timeOfCreation'] if attributes[:'timeOfCreation']

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

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

  self.time_of_modification = attributes[:'timeOfModification'] if attributes[:'timeOfModification']

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

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

  self.time_of_user_creation = attributes[:'timeOfUserCreation'] if attributes[:'timeOfUserCreation']

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

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

  self.user_id = attributes[:'userId'] if attributes[:'userId']

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

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

  self.approver_comment = attributes[:'approverComment'] if attributes[:'approverComment']

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

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

  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.opctl_id = attributes[:'opctlId'] if attributes[:'opctlId']

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

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

  self.opctl_name = attributes[:'opctlName'] if attributes[:'opctlName']

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

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

  self.system_message = attributes[:'systemMessage'] if attributes[:'systemMessage']

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

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

  self.opctl_additional_message = attributes[:'opctlAdditionalMessage'] if attributes[:'opctlAdditionalMessage']

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

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

  self.audit_type = attributes[:'auditType'] if attributes[:'auditType']

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

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

  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.number_of_approvers = attributes[:'numberOfApprovers'] if attributes[:'numberOfApprovers']

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

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

  self.number_of_extension_approvers = attributes[:'numberOfExtensionApprovers'] if attributes[:'numberOfExtensionApprovers']

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

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

  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.extension_approver_details = attributes[:'extensionApproverDetails'] if attributes[:'extensionApproverDetails']

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

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

  self.is_validate_assignment = attributes[:'isValidateAssignment'] unless attributes[:'isValidateAssignment'].nil?

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

  self.is_validate_assignment = attributes[:'is_validate_assignment'] unless attributes[:'is_validate_assignment'].nil?

  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']
end

Instance Attribute Details

#access_reason_summary ⇒ String

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

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 75

def access_reason_summary
  @access_reason_summary
end

#action_requests_list ⇒ Array<String>

List of operator actions for which approval is sought by the operator user.

Returns:

  • (Array<String>) 


107
108
109
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 107

def action_requests_list
  @action_requests_list
end

#approver_comment ⇒ String

The last recent Comment entered by the approver of the request.

Returns:

  • (String) 


164
165
166
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 164

def approver_comment
  @approver_comment
end

#approver_details ⇒ Array<OCI::OperatorAccessControl::Models::ApproverDetail>

Contains the user ids who have approved the accessRequest for extension.

Returns:



207
208
209
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 207

def approver_details
  @approver_details
end

#audit_type ⇒ Array<String>

Specifies the type of auditing to be enabled. There are two levels of auditing: command-level and keystroke-level. By default, auditing is enabled at the command level i.e., each command issued by the operator is audited. When keystroke-level is chosen, in addition to command level logging, key strokes are also logged.

Returns:

  • (Array<String>) 


191
192
193
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 191

def audit_type
  @audit_type
end

#closure_comment ⇒ String

The comment entered by the operator while closing the request.

Returns:

  • (String) 


168
169
170
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 168

def closure_comment
  @closure_comment
end

#compartment_id ⇒ String

The OCID of the compartment that contains the access request.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 99

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

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

Returns:

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


230
231
232
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 230

def defined_tags
  @defined_tags
end

#duration ⇒ Integer

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

Returns:

  • (Integer) 


119
120
121
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 119

def duration
  @duration
end

#extend_duration ⇒ Integer

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

Returns:

  • (Integer) 


123
124
125
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 123

def extend_duration
  @extend_duration
end

#extension_approver_details ⇒ Array<OCI::OperatorAccessControl::Models::ApproverDetail>

Contains the user ids who have approved the accessRequest for extension.

Returns:



211
212
213
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 211

def extension_approver_details
  @extension_approver_details
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

Returns:

  • (Hash<String, String>) 


225
226
227
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 225

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the access request.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 67

def id
  @id
end

#is_auto_approved ⇒ BOOLEAN

Whether the access request was automatically approved.

Returns:

  • (BOOLEAN) 


133
134
135
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 133

def is_auto_approved
  @is_auto_approved
end

#is_validate_assignment ⇒ BOOLEAN

Whether the access request was requested for Validate Assignment.

Returns:

  • (BOOLEAN) 


215
216
217
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 215

def is_validate_assignment
  @is_validate_assignment
end

#lifecycle_details ⇒ String

more in detail about the lifeCycleState.

Returns:

  • (String) 


141
142
143
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 141

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the AccessRequest.

Returns:

  • (String) 


137
138
139
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 137

def lifecycle_state
  @lifecycle_state
end

#number_of_approvers ⇒ Integer

Number of approvers who have authorized an access request.

Returns:

  • (Integer) 


199
200
201
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 199

def number_of_approvers
  @number_of_approvers
end

#number_of_approvers_required ⇒ Integer

Number of approvers required to approve an access request.

Returns:

  • (Integer) 


195
196
197
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 195

def number_of_approvers_required
  @number_of_approvers_required
end

#number_of_extension_approvers ⇒ Integer

Number of approvers who have authorized an access request for extension.

Returns:

  • (Integer) 


203
204
205
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 203

def number_of_extension_approvers
  @number_of_extension_approvers
end

#opctl_additional_message ⇒ String

Additional message specific to the access request that can be specified by the approver at the time of approval.

Returns:

  • (String) 


184
185
186
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 184

def opctl_additional_message
  @opctl_additional_message
end

#opctl_id ⇒ String

The OCID of the operator control governing the target resource.

Returns:

  • (String) 


172
173
174
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 172

def opctl_id
  @opctl_id
end

#opctl_name ⇒ String

Name of the Operator control governing the target resource.

Returns:

  • (String) 


176
177
178
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 176

def opctl_name
  @opctl_name
end

#operator_id ⇒ String

A unique identifier associated with the operator who raised the request. This identifier can not be used directly to identify the operator. You need to provide this identifier if you would like Oracle to provide additional information about the operator action within Oracle tenancy.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 81

def operator_id
  @operator_id
end

#reason ⇒ String

Summary reason for which the operator is requesting access on the target resource.

Returns:

  • (String) 


111
112
113
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 111

def reason
  @reason
end

#request_id ⇒ String

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

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 71

def request_id
  @request_id
end

#resource_id ⇒ String

[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) 


87
88
89
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 87

def resource_id
  @resource_id
end

#resource_name ⇒ String

The name of the target resource.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 91

def resource_name
  @resource_name
end

#resource_type ⇒ String

resourceType for which the AccessRequest is applicable

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 103

def resource_type
  @resource_type
end

#severity ⇒ String

Priority assigned to the access request by the operator

Returns:

  • (String) 


115
116
117
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 115

def severity
  @severity
end

#sub_resource_list ⇒ Array<String>

The subresources requested for approval.

Returns:

  • (Array<String>) 


95
96
97
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 95

def sub_resource_list
  @sub_resource_list
end

#system_message ⇒ String

System message that will be displayed to the operator at login to the target resource.

Returns:

  • (String) 


180
181
182
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 180

def system_message
  @system_message
end

#time_of_creation ⇒ DateTime

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

Returns:

  • (DateTime) 


146
147
148
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 146

def time_of_creation
  @time_of_creation
end

#time_of_modification ⇒ DateTime

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

Returns:

  • (DateTime) 


151
152
153
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 151

def time_of_modification
  @time_of_modification
end

#time_of_user_creation ⇒ DateTime

The time when access request is scheduled to be approved in RFC 3339 timestamp format.Example: '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime) 


156
157
158
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 156

def time_of_user_creation
  @time_of_user_creation
end

#time_requested_for_future_access ⇒ DateTime

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

Returns:

  • (DateTime) 


220
221
222
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 220

def time_requested_for_future_access
  @time_requested_for_future_access
end

#user_id ⇒ String

The OCID of the user that last modified the access request.

Returns:

  • (String) 


160
161
162
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 160

def user_id
  @user_id
end

#workflow_id ⇒ Array<String>

The OCID of the workflow associated with the access request. This is needed if you want to contact Oracle Support for a stuck access request or for an access request that encounters an internal error.

Returns:

  • (Array<String>) 


129
130
131
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 129

def workflow_id
  @workflow_id
end

Class Method Details

.attribute_map ⇒ Object

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
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
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 233

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'request_id': :'requestId',
    'access_reason_summary': :'accessReasonSummary',
    'operator_id': :'operatorId',
    'resource_id': :'resourceId',
    'resource_name': :'resourceName',
    'sub_resource_list': :'subResourceList',
    'compartment_id': :'compartmentId',
    'resource_type': :'resourceType',
    'action_requests_list': :'actionRequestsList',
    'reason': :'reason',
    'severity': :'severity',
    'duration': :'duration',
    'extend_duration': :'extendDuration',
    'workflow_id': :'workflowId',
    'is_auto_approved': :'isAutoApproved',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_of_creation': :'timeOfCreation',
    'time_of_modification': :'timeOfModification',
    'time_of_user_creation': :'timeOfUserCreation',
    'user_id': :'userId',
    'approver_comment': :'approverComment',
    'closure_comment': :'closureComment',
    'opctl_id': :'opctlId',
    'opctl_name': :'opctlName',
    'system_message': :'systemMessage',
    'opctl_additional_message': :'opctlAdditionalMessage',
    'audit_type': :'auditType',
    'number_of_approvers_required': :'numberOfApproversRequired',
    'number_of_approvers': :'numberOfApprovers',
    'number_of_extension_approvers': :'numberOfExtensionApprovers',
    'approver_details': :'approverDetails',
    'extension_approver_details': :'extensionApproverDetails',
    'is_validate_assignment': :'isValidateAssignment',
    'time_requested_for_future_access': :'timeRequestedForFutureAccess',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 279

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'request_id': :'String',
    'access_reason_summary': :'String',
    'operator_id': :'String',
    'resource_id': :'String',
    'resource_name': :'String',
    'sub_resource_list': :'Array<String>',
    'compartment_id': :'String',
    'resource_type': :'String',
    'action_requests_list': :'Array<String>',
    'reason': :'String',
    'severity': :'String',
    'duration': :'Integer',
    'extend_duration': :'Integer',
    'workflow_id': :'Array<String>',
    'is_auto_approved': :'BOOLEAN',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_of_creation': :'DateTime',
    'time_of_modification': :'DateTime',
    'time_of_user_creation': :'DateTime',
    'user_id': :'String',
    'approver_comment': :'String',
    'closure_comment': :'String',
    'opctl_id': :'String',
    'opctl_name': :'String',
    'system_message': :'String',
    'opctl_additional_message': :'String',
    'audit_type': :'Array<String>',
    'number_of_approvers_required': :'Integer',
    'number_of_approvers': :'Integer',
    'number_of_extension_approvers': :'Integer',
    'approver_details': :'Array<OCI::OperatorAccessControl::Models::ApproverDetail>',
    'extension_approver_details': :'Array<OCI::OperatorAccessControl::Models::ApproverDetail>',
    'is_validate_assignment': :'BOOLEAN',
    'time_requested_for_future_access': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 633

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

  self.class == other.class &&
    id == other.id &&
    request_id == other.request_id &&
    access_reason_summary == other.access_reason_summary &&
    operator_id == other.operator_id &&
    resource_id == other.resource_id &&
    resource_name == other.resource_name &&
    sub_resource_list == other.sub_resource_list &&
    compartment_id == other.compartment_id &&
    resource_type == other.resource_type &&
    action_requests_list == other.action_requests_list &&
    reason == other.reason &&
    severity == other.severity &&
    duration == other.duration &&
    extend_duration == other.extend_duration &&
    workflow_id == other.workflow_id &&
    is_auto_approved == other.is_auto_approved &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_of_creation == other.time_of_creation &&
    time_of_modification == other.time_of_modification &&
    time_of_user_creation == other.time_of_user_creation &&
    user_id == other.user_id &&
    approver_comment == other.approver_comment &&
    closure_comment == other.closure_comment &&
    opctl_id == other.opctl_id &&
    opctl_name == other.opctl_name &&
    system_message == other.system_message &&
    opctl_additional_message == other.opctl_additional_message &&
    audit_type == other.audit_type &&
    number_of_approvers_required == other.number_of_approvers_required &&
    number_of_approvers == other.number_of_approvers &&
    number_of_extension_approvers == other.number_of_extension_approvers &&
    approver_details == other.approver_details &&
    extension_approver_details == other.extension_approver_details &&
    is_validate_assignment == other.is_validate_assignment &&
    time_requested_for_future_access == other.time_requested_for_future_access &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 700

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


680
681
682
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 680

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



689
690
691
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 689

def hash
  [id, request_id, access_reason_summary, operator_id, resource_id, resource_name, sub_resource_list, compartment_id, resource_type, action_requests_list, reason, severity, duration, extend_duration, workflow_id, is_auto_approved, lifecycle_state, lifecycle_details, time_of_creation, time_of_modification, time_of_user_creation, user_id, approver_comment, closure_comment, opctl_id, opctl_name, system_message, opctl_additional_message, audit_type, number_of_approvers_required, number_of_approvers, number_of_extension_approvers, approver_details, extension_approver_details, is_validate_assignment, time_requested_for_future_access, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



733
734
735
736
737
738
739
740
741
742
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 733

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



727
728
729
 
# File 'lib/oci/operator_access_control/models/access_request.rb', line 727

def to_s
  to_hash.to_s
end