class OCI::OperatorAccessControl::Models::OperatorControl
Operator Access Control enables you to grant, audit, or revoke the access Oracle has to your Exadata Customer at Cloud
infrastructure, and obtain audit reports of all actions taken by a human operator, in a near real-time manner.
Constants
- LIFECYCLE_STATE_ENUM
Attributes
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.
@return [Array<String>]
List of user groups who can approve an access request associated with a target resource under the governance of this operator control. @return [Array<String>]
List of users who can approve an access request associated with a target resource under the governance of this operator control. @return [Array<String>]
[Required] The OCID of the compartment that contains the operator control. @return [String]
Description of operator control. @return [String]
[Required] The OCID of the operator control. @return [String]
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.
@return [BOOLEAN]
Description associated with the latest modification of the operator control. @return [String]
The current lifecycle state of the operator control. @return [String]
[Required] Name of the operator control. The name must be unique. @return [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.
@return [Array<String>]
System message that would be displayed to the operator users on accessing the target resource under the governance of this operator control. @return [String]
Time when the operator control was created expressed in [RFC 3339](tools.ietf.org/html/rfc3339) timestamp format. Example: '2020-05-22T21:10:29.600Z'
@return [DateTime]
Time when deleted expressed in [RFC 3339](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.
@return [DateTime]
Time when the operator control was last modified expressed in [RFC 3339](tools.ietf.org/html/rfc3339) timestamp format. Example: '2020-05-22T21:10:29.600Z'
@return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/operator_access_control/models/operator_control.rb, line 103 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', 'system_message': :'systemMessage', 'compartment_id': :'compartmentId', 'lifecycle_state': :'lifecycleState', 'time_of_creation': :'timeOfCreation', 'time_of_modification': :'timeOfModification', 'time_of_deletion': :'timeOfDeletion', 'last_modified_info': :'lastModifiedInfo', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :operator_control_name The value to assign to the {#operator_control_name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [Array<String>] :approvers_list The value to assign to the {#approvers_list} property @option attributes [Array<String>] :approver_groups_list The value to assign to the {#approver_groups_list} property @option attributes [Array<String>] :pre_approved_op_action_list The value to assign to the {#pre_approved_op_action_list} property @option attributes [Array<String>] :approval_required_op_action_list The value to assign to the {#approval_required_op_action_list} property @option attributes [BOOLEAN] :is_fully_pre_approved The value to assign to the {#is_fully_pre_approved} property @option attributes [String] :system_message The value to assign to the {#system_message} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [DateTime] :time_of_creation The value to assign to the {#time_of_creation} property @option attributes [DateTime] :time_of_modification The value to assign to the {#time_of_modification} property @option attributes [DateTime] :time_of_deletion The value to assign to the {#time_of_deletion} property @option attributes [String] :last_modified_info The value to assign to the {#last_modified_info} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
# File lib/oci/operator_access_control/models/operator_control.rb, line 175 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.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.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.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.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
Attribute type mapping.
# File lib/oci/operator_access_control/models/operator_control.rb, line 128 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', 'system_message': :'String', 'compartment_id': :'String', 'lifecycle_state': :'String', 'time_of_creation': :'DateTime', 'time_of_modification': :'DateTime', '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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/operator_access_control/models/operator_control.rb, line 296 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 && system_message == other.system_message && compartment_id == other.compartment_id && lifecycle_state == other.lifecycle_state && time_of_creation == other.time_of_creation && time_of_modification == other.time_of_modification && time_of_deletion == other.time_of_deletion && last_modified_info == other.last_modified_info && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/operator_access_control/models/operator_control.rb, line 342 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/operator_access_control/models/operator_control.rb, line 322 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/operator_access_control/models/operator_control.rb, line 331 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, system_message, compartment_id, lifecycle_state, time_of_creation, time_of_modification, time_of_deletion, last_modified_info, freeform_tags, defined_tags].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/operator_access_control/models/operator_control.rb, line 280 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/operator_access_control/models/operator_control.rb, line 375 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/operator_access_control/models/operator_control.rb, line 369 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/operator_access_control/models/operator_control.rb, line 392 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end