Class: OCI::OperatorAccessControl::Models::CreateOperatorControlAssignmentDetails

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

Overview

Details of the Operator Control assignment. An Operator Control Assignment identifies the target resource that is placed under the governance of an Operator Control. Creating an Operator Control Assignment Assignment with a time duration ensures that human accesses to the target resource will be governed by Operator Control for the duration specified.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOperatorControlAssignmentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 173

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_id = attributes[:'operatorControlId'] if attributes[:'operatorControlId']

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

  self.operator_control_id = attributes[:'operator_control_id'] if attributes[:'operator_control_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.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.resource_compartment_id = attributes[:'resourceCompartmentId'] if attributes[:'resourceCompartmentId']

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

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

  self.time_assignment_from = attributes[:'timeAssignmentFrom'] if attributes[:'timeAssignmentFrom']

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

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

  self.time_assignment_to = attributes[:'timeAssignmentTo'] if attributes[:'timeAssignmentTo']

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

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

  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.is_enforced_always = attributes[:'isEnforcedAlways'] unless attributes[:'isEnforcedAlways'].nil?

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

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

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

  self.is_log_forwarded = attributes[:'isLogForwarded'] unless attributes[:'isLogForwarded'].nil?

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

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

  self.remote_syslog_server_address = attributes[:'remoteSyslogServerAddress'] if attributes[:'remoteSyslogServerAddress']

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

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

  self.remote_syslog_server_port = attributes[:'remoteSyslogServerPort'] if attributes[:'remoteSyslogServerPort']

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

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

  self.remote_syslog_server_ca_cert = attributes[:'remoteSyslogServerCACert'] if attributes[:'remoteSyslogServerCACert']

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

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

  self.is_hypervisor_log_forwarded = attributes[:'isHypervisorLogForwarded'] unless attributes[:'isHypervisorLogForwarded'].nil?

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

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

  self.is_auto_approve_during_maintenance = attributes[:'isAutoApproveDuringMaintenance'] unless attributes[:'isAutoApproveDuringMaintenance'].nil?

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

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

  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

#comment ⇒ String

Comment about the assignment of the operator control to this target resource.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 61

def comment
  @comment
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 53

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


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

def defined_tags
  @defined_tags
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>) 


90
91
92
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 90

def freeform_tags
  @freeform_tags
end

#is_auto_approve_during_maintenance ⇒ BOOLEAN

The boolean if true would autoApprove during maintenance.

Returns:

  • (BOOLEAN) 


85
86
87
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 85

def is_auto_approve_during_maintenance
  @is_auto_approve_during_maintenance
end

#is_enforced_always ⇒ BOOLEAN

[Required] If set, then the target resource is always governed by the operator control.

Returns:

  • (BOOLEAN) 


57
58
59
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 57

def is_enforced_always
  @is_enforced_always
end

#is_hypervisor_log_forwarded ⇒ BOOLEAN

If set, then the hypervisor audit logs will be forwarded to the relevant remote syslog server

Returns:

  • (BOOLEAN) 


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

def is_hypervisor_log_forwarded
  @is_hypervisor_log_forwarded
end

#is_log_forwarded ⇒ BOOLEAN

If set, then the audit logs will be forwarded to the relevant remote logging server

Returns:

  • (BOOLEAN) 


65
66
67
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 65

def is_log_forwarded
  @is_log_forwarded
end

#operator_control_id ⇒ String

[Required] The OCID of the operator control that is being assigned to a target resource.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 23

def operator_control_id
  @operator_control_id
end

#remote_syslog_server_address ⇒ String

The address of the remote syslog server where the audit logs will be forwarded to. Address in host or IP format.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 69

def remote_syslog_server_address
  @remote_syslog_server_address
end

#remote_syslog_server_ca_cert ⇒ String

The CA certificate of the remote syslog server. Identity of the remote syslog server will be asserted based on this certificate.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 77

def remote_syslog_server_ca_cert
  @remote_syslog_server_ca_cert
end

#remote_syslog_server_port ⇒ Integer

The listening port of the remote syslog server. The port range is 0 - 65535. Only TCP supported.

Returns:

  • (Integer) 


73
74
75
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 73

def remote_syslog_server_port
  @remote_syslog_server_port
end

#resource_compartment_id ⇒ String

[Required] The OCID of the compartment that contains the target resource.

Returns:

  • (String) 


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

def resource_compartment_id
  @resource_compartment_id
end

#resource_id ⇒ String

[Required] The OCID of the target resource being brought under the governance of the operator control.

Returns:

  • (String) 


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

def resource_id
  @resource_id
end

#resource_name ⇒ String

[Required] Name of the target resource.

Returns:

  • (String) 


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

def resource_name
  @resource_name
end

#resource_type ⇒ String

[Required] Type of the target resource.

Returns:

  • (String) 


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

def resource_type
  @resource_type
end

#time_assignment_from ⇒ DateTime

The time at which the target resource will be brought under the governance of the operator control in RFC 3339 timestamp format. Example: '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime) 


44
45
46
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 44

def time_assignment_from
  @time_assignment_from
end

#time_assignment_to ⇒ DateTime

The time at which the target resource will leave the governance of the operator control in 3339[https://tools.ietf.org/html/rfc3339]timestamp format.Example: '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime) 


49
50
51
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 49

def time_assignment_to
  @time_assignment_to
end

Class Method Details

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 98

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'operator_control_id': :'operatorControlId',
    'resource_id': :'resourceId',
    'resource_name': :'resourceName',
    'resource_type': :'resourceType',
    'resource_compartment_id': :'resourceCompartmentId',
    'time_assignment_from': :'timeAssignmentFrom',
    'time_assignment_to': :'timeAssignmentTo',
    'compartment_id': :'compartmentId',
    'is_enforced_always': :'isEnforcedAlways',
    'comment': :'comment',
    'is_log_forwarded': :'isLogForwarded',
    'remote_syslog_server_address': :'remoteSyslogServerAddress',
    'remote_syslog_server_port': :'remoteSyslogServerPort',
    'remote_syslog_server_ca_cert': :'remoteSyslogServerCACert',
    'is_hypervisor_log_forwarded': :'isHypervisorLogForwarded',
    'is_auto_approve_during_maintenance': :'isAutoApproveDuringMaintenance',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 124

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'operator_control_id': :'String',
    'resource_id': :'String',
    'resource_name': :'String',
    'resource_type': :'String',
    'resource_compartment_id': :'String',
    'time_assignment_from': :'DateTime',
    'time_assignment_to': :'DateTime',
    'compartment_id': :'String',
    'is_enforced_always': :'BOOLEAN',
    'comment': :'String',
    'is_log_forwarded': :'BOOLEAN',
    'remote_syslog_server_address': :'String',
    'remote_syslog_server_port': :'Integer',
    'remote_syslog_server_ca_cert': :'String',
    'is_hypervisor_log_forwarded': :'BOOLEAN',
    'is_auto_approve_during_maintenance': :'BOOLEAN',
    '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



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

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

  self.class == other.class &&
    operator_control_id == other.operator_control_id &&
    resource_id == other.resource_id &&
    resource_name == other.resource_name &&
    resource_type == other.resource_type &&
    resource_compartment_id == other.resource_compartment_id &&
    time_assignment_from == other.time_assignment_from &&
    time_assignment_to == other.time_assignment_to &&
    compartment_id == other.compartment_id &&
    is_enforced_always == other.is_enforced_always &&
    comment == other.comment &&
    is_log_forwarded == other.is_log_forwarded &&
    remote_syslog_server_address == other.remote_syslog_server_address &&
    remote_syslog_server_port == other.remote_syslog_server_port &&
    remote_syslog_server_ca_cert == other.remote_syslog_server_ca_cert &&
    is_hypervisor_log_forwarded == other.is_hypervisor_log_forwarded &&
    is_auto_approve_during_maintenance == other.is_auto_approve_during_maintenance &&
    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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 346

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


326
327
328
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 326

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



335
336
337
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 335

def hash
  [operator_control_id, resource_id, resource_name, resource_type, resource_compartment_id, time_assignment_from, time_assignment_to, compartment_id, is_enforced_always, comment, is_log_forwarded, remote_syslog_server_address, remote_syslog_server_port, remote_syslog_server_ca_cert, is_hypervisor_log_forwarded, is_auto_approve_during_maintenance, 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



379
380
381
382
383
384
385
386
387
388
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 379

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



373
374
375
 
# File 'lib/oci/operator_access_control/models/create_operator_control_assignment_details.rb', line 373

def to_s
  to_hash.to_s
end