Class: OCI::OperatorAccessControl::Models::OperatorControl
- Inherits:
-
Object
- Object
- OCI::OperatorAccessControl::Models::OperatorControl
- Defined in:
- lib/oci/operator_access_control/models/operator_control.rb
Overview
Operator Access Control enables you to grant, audit, or revoke the access Oracle has to your Exadata Cloud@Customer infrastructure, and obtain audit reports of all actions taken by a human operator, in a near real-time manner.
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_CLOUDEXADATAINFRASTRUCTURE = 'CLOUDEXADATAINFRASTRUCTURE'.freeze, RESOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATED = 'CREATED'.freeze, LIFECYCLE_STATE_ASSIGNED = 'ASSIGNED'.freeze, LIFECYCLE_STATE_UNASSIGNED = 'UNASSIGNED'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#approval_required_op_action_list ⇒ Array<String>
List of operator actions that need explicit approval.
-
#approver_groups_list ⇒ Array<String>
List of user groups who can approve an access request associated with a target resource under the governance of this operator control.
-
#approvers_list ⇒ Array<String>
List of users who can approve an access request associated with a target resource under the governance of this operator control.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the operator control.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
Description of operator control.
-
#email_id_list ⇒ Array<String>
List of emailId.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The OCID of the operator control.
-
#is_default_operator_control ⇒ BOOLEAN
Whether the operator control is a default Operator Control.
-
#is_fully_pre_approved ⇒ BOOLEAN
Whether all the operator actions have been pre-approved.
-
#last_modified_info ⇒ String
Description associated with the latest modification of the operator control.
-
#lifecycle_state ⇒ String
The current lifecycle state of the operator control.
-
#notification_topic_id ⇒ String
The OCID of the OCI Notification topic to publish messages related to this operator control.
-
#number_of_approvers ⇒ Integer
Number of approvers required to approve an access request.
-
#operator_control_name ⇒ String
[Required] Name of the operator control.
-
#pre_approved_op_action_list ⇒ Array<String>
List of pre-approved operator actions.
-
#resource_type ⇒ String
resourceType for which the OperatorControl is applicable.
-
#system_message ⇒ String
System message that would be displayed to the operator users on accessing the target resource under the governance of this operator control.
-
#time_of_creation ⇒ DateTime
Time when the operator control was created expressed in RFC 3339 timestamp format.
-
#time_of_deletion ⇒ DateTime
Time when deleted expressed in 3339[https://tools.ietf.org/html/rfc3339]timestamp format.
-
#time_of_modification ⇒ DateTime
Time when the operator control was last modified expressed in RFC 3339 timestamp format.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ OperatorControl
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ OperatorControl
Initializes the object
223 224 225 226 227 228 229 230 231 232 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 277 278 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 323 324 325 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 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 223 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.operator_control_name = attributes[:'operatorControlName'] if attributes[:'operatorControlName'] raise 'You cannot provide both :operatorControlName and :operator_control_name' if attributes.key?(:'operatorControlName') && attributes.key?(:'operator_control_name') self.operator_control_name = attributes[:'operator_control_name'] if attributes[:'operator_control_name'] self.description = attributes[:'description'] if attributes[:'description'] self.approvers_list = attributes[:'approversList'] if attributes[:'approversList'] raise 'You cannot provide both :approversList and :approvers_list' if attributes.key?(:'approversList') && attributes.key?(:'approvers_list') self.approvers_list = attributes[:'approvers_list'] if attributes[:'approvers_list'] self.approver_groups_list = attributes[:'approverGroupsList'] if attributes[:'approverGroupsList'] raise 'You cannot provide both :approverGroupsList and :approver_groups_list' if attributes.key?(:'approverGroupsList') && attributes.key?(:'approver_groups_list') self.approver_groups_list = attributes[:'approver_groups_list'] if attributes[:'approver_groups_list'] self.pre_approved_op_action_list = attributes[:'preApprovedOpActionList'] if attributes[:'preApprovedOpActionList'] raise 'You cannot provide both :preApprovedOpActionList and :pre_approved_op_action_list' if attributes.key?(:'preApprovedOpActionList') && attributes.key?(:'pre_approved_op_action_list') self.pre_approved_op_action_list = attributes[:'pre_approved_op_action_list'] if attributes[:'pre_approved_op_action_list'] self.approval_required_op_action_list = attributes[:'approvalRequiredOpActionList'] if attributes[:'approvalRequiredOpActionList'] raise 'You cannot provide both :approvalRequiredOpActionList and :approval_required_op_action_list' if attributes.key?(:'approvalRequiredOpActionList') && attributes.key?(:'approval_required_op_action_list') self.approval_required_op_action_list = attributes[:'approval_required_op_action_list'] if attributes[:'approval_required_op_action_list'] self.is_fully_pre_approved = attributes[:'isFullyPreApproved'] unless attributes[:'isFullyPreApproved'].nil? raise 'You cannot provide both :isFullyPreApproved and :is_fully_pre_approved' if attributes.key?(:'isFullyPreApproved') && attributes.key?(:'is_fully_pre_approved') self.is_fully_pre_approved = attributes[:'is_fully_pre_approved'] unless attributes[:'is_fully_pre_approved'].nil? 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.email_id_list = attributes[:'emailIdList'] if attributes[:'emailIdList'] raise 'You cannot provide both :emailIdList and :email_id_list' if attributes.key?(:'emailIdList') && attributes.key?(:'email_id_list') self.email_id_list = attributes[:'email_id_list'] if attributes[:'email_id_list'] 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. = attributes[:'systemMessage'] if attributes[:'systemMessage'] raise 'You cannot provide both :systemMessage and :system_message' if attributes.key?(:'systemMessage') && attributes.key?(:'system_message') self. = attributes[:'system_message'] if attributes[:'system_message'] 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.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.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.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.is_default_operator_control = attributes[:'isDefaultOperatorControl'] unless attributes[:'isDefaultOperatorControl'].nil? raise 'You cannot provide both :isDefaultOperatorControl and :is_default_operator_control' if attributes.key?(:'isDefaultOperatorControl') && attributes.key?(:'is_default_operator_control') self.is_default_operator_control = attributes[:'is_default_operator_control'] unless attributes[:'is_default_operator_control'].nil? self.time_of_deletion = attributes[:'timeOfDeletion'] if attributes[:'timeOfDeletion'] raise 'You cannot provide both :timeOfDeletion and :time_of_deletion' if attributes.key?(:'timeOfDeletion') && attributes.key?(:'time_of_deletion') self.time_of_deletion = attributes[:'time_of_deletion'] if attributes[:'time_of_deletion'] self.last_modified_info = attributes[:'lastModifiedInfo'] if attributes[:'lastModifiedInfo'] raise 'You cannot provide both :lastModifiedInfo and :last_modified_info' if attributes.key?(:'lastModifiedInfo') && attributes.key?(:'last_modified_info') self.last_modified_info = attributes[:'last_modified_info'] if attributes[:'last_modified_info'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#approval_required_op_action_list ⇒ Array<String>
List of operator actions that need explicit approval. Any operator action not in the pre-approved list will require explicit approval. Access requests associated with a resource governed by this operator control will be require explicit approval if the access request contains any operator action in this list.
62 63 64 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 62 def approval_required_op_action_list @approval_required_op_action_list end |
#approver_groups_list ⇒ Array<String>
List of user groups who can approve an access request associated with a target resource under the governance of this operator control.
49 50 51 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 49 def approver_groups_list @approver_groups_list end |
#approvers_list ⇒ Array<String>
List of users who can approve an access request associated with a target resource under the governance of this operator control.
45 46 47 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 45 def approvers_list @approvers_list end |
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the operator control.
89 90 91 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 89 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.
133 134 135 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 133 def @defined_tags end |
#description ⇒ String
Description of operator control.
41 42 43 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 41 def description @description end |
#email_id_list ⇒ Array<String>
List of emailId.
77 78 79 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 77 def email_id_list @email_id_list 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.
128 129 130 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 128 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the operator control.
33 34 35 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 33 def id @id end |
#is_default_operator_control ⇒ BOOLEAN
Whether the operator control is a default Operator Control.
112 113 114 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 112 def is_default_operator_control @is_default_operator_control end |
#is_fully_pre_approved ⇒ BOOLEAN
Whether all the operator actions have been pre-approved. If yes, all access requests associated with a resource governed by this operator control will be auto-approved.
68 69 70 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 68 def is_fully_pre_approved @is_fully_pre_approved end |
#last_modified_info ⇒ String
Description associated with the latest modification of the operator control.
123 124 125 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 123 def last_modified_info @last_modified_info end |
#lifecycle_state ⇒ String
The current lifecycle state of the operator control.
93 94 95 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 93 def lifecycle_state @lifecycle_state end |
#notification_topic_id ⇒ String
The OCID of the OCI Notification topic to publish messages related to this operator control.
72 73 74 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 72 def notification_topic_id @notification_topic_id end |
#number_of_approvers ⇒ Integer
Number of approvers required to approve an access request.
107 108 109 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 107 def number_of_approvers @number_of_approvers end |
#operator_control_name ⇒ String
[Required] Name of the operator control. The name must be unique.
37 38 39 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 37 def operator_control_name @operator_control_name end |
#pre_approved_op_action_list ⇒ Array<String>
List of pre-approved operator actions. Access requests associated with a resource governed by this operator control will be automatically approved if the access request only contain operator actions in the pre-approved list.
55 56 57 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 55 def pre_approved_op_action_list @pre_approved_op_action_list end |
#resource_type ⇒ String
resourceType for which the OperatorControl is applicable
81 82 83 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 81 def resource_type @resource_type end |
#system_message ⇒ String
System message that would be displayed to the operator users on accessing the target resource under the governance of this operator control.
85 86 87 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 85 def @system_message end |
#time_of_creation ⇒ DateTime
Time when the operator control was created expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
98 99 100 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 98 def time_of_creation @time_of_creation end |
#time_of_deletion ⇒ DateTime
Time when deleted expressed in 3339[https://tools.ietf.org/html/rfc3339]timestamp format. Example: '2020-05-22T21:10:29.600Z'. Note a deleted operator control still stays in the system, so that you can still audit operator actions associated with access requests raised on target resources governed by the deleted operator control.
119 120 121 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 119 def time_of_deletion @time_of_deletion end |
#time_of_modification ⇒ DateTime
Time when the operator control was last modified expressed in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'
103 104 105 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 103 def time_of_modification @time_of_modification end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 136 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'operator_control_name': :'operatorControlName', 'description': :'description', 'approvers_list': :'approversList', 'approver_groups_list': :'approverGroupsList', 'pre_approved_op_action_list': :'preApprovedOpActionList', 'approval_required_op_action_list': :'approvalRequiredOpActionList', 'is_fully_pre_approved': :'isFullyPreApproved', 'notification_topic_id': :'notificationTopicId', 'email_id_list': :'emailIdList', 'resource_type': :'resourceType', 'system_message': :'systemMessage', 'compartment_id': :'compartmentId', 'lifecycle_state': :'lifecycleState', 'time_of_creation': :'timeOfCreation', 'time_of_modification': :'timeOfModification', 'number_of_approvers': :'numberOfApprovers', 'is_default_operator_control': :'isDefaultOperatorControl', 'time_of_deletion': :'timeOfDeletion', 'last_modified_info': :'lastModifiedInfo', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 166 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'operator_control_name': :'String', 'description': :'String', 'approvers_list': :'Array<String>', 'approver_groups_list': :'Array<String>', 'pre_approved_op_action_list': :'Array<String>', 'approval_required_op_action_list': :'Array<String>', 'is_fully_pre_approved': :'BOOLEAN', 'notification_topic_id': :'String', 'email_id_list': :'Array<String>', 'resource_type': :'String', 'system_message': :'String', 'compartment_id': :'String', 'lifecycle_state': :'String', 'time_of_creation': :'DateTime', 'time_of_modification': :'DateTime', 'number_of_approvers': :'Integer', 'is_default_operator_control': :'BOOLEAN', 'time_of_deletion': :'DateTime', 'last_modified_info': :'String', '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.
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 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 387 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && operator_control_name == other.operator_control_name && description == other.description && approvers_list == other.approvers_list && approver_groups_list == other.approver_groups_list && pre_approved_op_action_list == other.pre_approved_op_action_list && approval_required_op_action_list == other.approval_required_op_action_list && is_fully_pre_approved == other.is_fully_pre_approved && notification_topic_id == other.notification_topic_id && email_id_list == other.email_id_list && resource_type == other.resource_type && == other. && compartment_id == other.compartment_id && lifecycle_state == other.lifecycle_state && time_of_creation == other.time_of_creation && time_of_modification == other.time_of_modification && number_of_approvers == other.number_of_approvers && is_default_operator_control == other.is_default_operator_control && time_of_deletion == other.time_of_deletion && last_modified_info == other.last_modified_info && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 438 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
418 419 420 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 418 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
427 428 429 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 427 def hash [id, operator_control_name, description, approvers_list, approver_groups_list, pre_approved_op_action_list, approval_required_op_action_list, is_fully_pre_approved, notification_topic_id, email_id_list, resource_type, , compartment_id, lifecycle_state, time_of_creation, time_of_modification, number_of_approvers, is_default_operator_control, time_of_deletion, last_modified_info, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
471 472 473 474 475 476 477 478 479 480 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 471 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
465 466 467 |
# File 'lib/oci/operator_access_control/models/operator_control.rb', line 465 def to_s to_hash.to_s end |