Class: OCI::OperatorAccessControl::Models::CreateOperatorControlDetails

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

Overview

While creating the operator control, specify how operator actions are approved and the users who have the privilege of approving the operator actions associated with the Operator Control.

You must specify which operator actions must be pre-approved. The rest of the operator actions associated with the Operator Control will require an explicit approval from the users selected either through the approver groups or individually.

You must name your Operator Control appropriately so it reflects the resources that will be governed by the Operator Control. Neither the Operator Controls nor their assignments to resources are visible to the Oracle operators.

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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOperatorControlDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :operator_control_name (String) —

    The value to assign to the #operator_control_name property

  • :description (String) —

    The value to assign to the #description property

  • :approvers_list (Array<String>) —

    The value to assign to the #approvers_list property

  • :approver_groups_list (Array<String>) —

    The value to assign to the #approver_groups_list property

  • :pre_approved_op_action_list (Array<String>) —

    The value to assign to the #pre_approved_op_action_list property

  • :is_fully_pre_approved (BOOLEAN) —

    The value to assign to the #is_fully_pre_approved property

  • :resource_type (String) —

    The value to assign to the #resource_type property

  • :number_of_approvers (Integer) —

    The value to assign to the #number_of_approvers property

  • :notification_topic_id (String) —

    The value to assign to the #notification_topic_id property

  • :email_id_list (Array<String>) —

    The value to assign to the #email_id_list property

  • :system_message (String) —

    The value to assign to the #system_message property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



152
153
154
155
156
157
158
159
160
161
162
163
164
165
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
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
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 152

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.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.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.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.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.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.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.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

#approver_groups_list ⇒ Array<String>

[Required] List of user groups who can approve an access request associated with a resource governed by this operator control.

Returns:

  • (Array<String>) 


39
40
41
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 39

def approver_groups_list
  @approver_groups_list
end

#approvers_list ⇒ Array<String>

List of users who can approve an access request associated with a resource governed by this operator control.

Returns:

  • (Array<String>) 


35
36
37
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 35

def approvers_list
  @approvers_list
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains this operator control.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 76

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


86
87
88
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 86

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the operator control.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 31

def description
  @description
end

#email_id_list ⇒ Array<String>

List of emailId.

Returns:

  • (Array<String>) 


68
69
70
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 68

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.

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#is_fully_pre_approved ⇒ BOOLEAN

[Required] 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.

Returns:

  • (BOOLEAN) 


51
52
53
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 51

def is_fully_pre_approved
  @is_fully_pre_approved
end

#notification_topic_id ⇒ String

The OCID of the OCI Notification topic to publish messages related to this operator control.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 63

def notification_topic_id
  @notification_topic_id
end

#number_of_approvers ⇒ Integer

Number of approvers required to approve an access request.

Returns:

  • (Integer) 


59
60
61
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 59

def number_of_approvers
  @number_of_approvers
end

#operator_control_name ⇒ String

[Required] Name of the operator control.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 27

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 auto-approved if the access request only contain operator actions in the pre-approved list.

Returns:

  • (Array<String>) 


45
46
47
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 45

def pre_approved_op_action_list
  @pre_approved_op_action_list
end

#resource_type ⇒ String

[Required] resourceType for which the OperatorControl is applicable

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 55

def resource_type
  @resource_type
end

#system_message ⇒ String

This is the message that will be displayed to the operator users while accessing the system.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 72

def system_message
  @system_message
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 89

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'operator_control_name': :'operatorControlName',
    'description': :'description',
    'approvers_list': :'approversList',
    'approver_groups_list': :'approverGroupsList',
    'pre_approved_op_action_list': :'preApprovedOpActionList',
    'is_fully_pre_approved': :'isFullyPreApproved',
    'resource_type': :'resourceType',
    'number_of_approvers': :'numberOfApprovers',
    'notification_topic_id': :'notificationTopicId',
    'email_id_list': :'emailIdList',
    'system_message': :'systemMessage',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 111

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'operator_control_name': :'String',
    'description': :'String',
    'approvers_list': :'Array<String>',
    'approver_groups_list': :'Array<String>',
    'pre_approved_op_action_list': :'Array<String>',
    'is_fully_pre_approved': :'BOOLEAN',
    'resource_type': :'String',
    'number_of_approvers': :'Integer',
    'notification_topic_id': :'String',
    'email_id_list': :'Array<String>',
    'system_message': :'String',
    'compartment_id': :'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.

Parameters:

  • other (Object) —

    the other object to be compared



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 254

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

  self.class == other.class &&
    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 &&
    is_fully_pre_approved == other.is_fully_pre_approved &&
    resource_type == other.resource_type &&
    number_of_approvers == other.number_of_approvers &&
    notification_topic_id == other.notification_topic_id &&
    email_id_list == other.email_id_list &&
    system_message == other.system_message &&
    compartment_id == other.compartment_id &&
    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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 297

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


277
278
279
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 277

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



286
287
288
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 286

def hash
  [operator_control_name, description, approvers_list, approver_groups_list, pre_approved_op_action_list, is_fully_pre_approved, resource_type, number_of_approvers, notification_topic_id, email_id_list, system_message, compartment_id, 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



330
331
332
333
334
335
336
337
338
339
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 330

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



324
325
326
 
# File 'lib/oci/operator_access_control/models/create_operator_control_details.rb', line 324

def to_s
  to_hash.to_s
end