Class: OCI::DataSafe::Models::TargetAlertPolicyAssociation

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/target_alert_policy_association.rb

Overview

The association of the target database to an alert policy.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TARGET_TYPE_ENUM = 
[
  TARGET_TYPE_TARGET_DATABASE = 'TARGET_DATABASE'.freeze,
  TARGET_TYPE_TARGET_DATABASE_GROUP = 'TARGET_DATABASE_GROUP'.freeze,
  TARGET_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TargetAlertPolicyAssociation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :policy_id (String) —

    The value to assign to the #policy_id property

  • :target_id (String) —

    The value to assign to the #target_id property

  • :is_enabled (BOOLEAN) —

    The value to assign to the #is_enabled property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :target_type (String) —

    The value to assign to the #target_type 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

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

    The value to assign to the #system_tags property



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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 162

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

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

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

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

  self.policy_id = attributes[:'policyId'] if attributes[:'policyId']

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

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

  self.target_id = attributes[:'targetId'] if attributes[:'targetId']

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

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

  self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') && !attributes.key?(:'is_enabled') # rubocop:disable Style/StringLiterals

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

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

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

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

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the policy.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 54

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. For more information, see Resource Tags Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


87
88
89
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 87

def defined_tags
  @defined_tags
end

#description ⇒ String

Describes the target-alert policy association.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 38

def description
  @description
end

#display_name ⇒ String

The display name of the target-alert policy association.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 34

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


81
82
83
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 81

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the target-alert policy association.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 30

def id
  @id
end

#is_enabled ⇒ BOOLEAN

Indicates if the target-alert policy association is enabled or disabled by user.

Returns:

  • (BOOLEAN) 


50
51
52
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 50

def is_enabled
  @is_enabled
end

#lifecycle_details ⇒ String

Details about the current state of the target-alert policy association.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 70

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the target-alert policy association.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 66

def lifecycle_state
  @lifecycle_state
end

#policy_id ⇒ String

The OCID of the alert policy.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 42

def policy_id
  @policy_id
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


93
94
95
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 93

def system_tags
  @system_tags
end

#target_id ⇒ String

The OCID of the target or target database group on which alert policy is to be applied.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 46

def target_id
  @target_id
end

#target_type ⇒ String

[Required] The resource type that is represented by the target alert policy association.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 74

def target_type
  @target_type
end

#time_created ⇒ DateTime

[Required] Creation date and time of the alert policy, in the format defined by RFC3339.

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 58

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] Last date and time the alert policy was updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 62

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 96

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'policy_id': :'policyId',
    'target_id': :'targetId',
    'is_enabled': :'isEnabled',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'target_type': :'targetType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 119

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'policy_id': :'String',
    'target_id': :'String',
    'is_enabled': :'BOOLEAN',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'target_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 286

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    policy_id == other.policy_id &&
    target_id == other.target_id &&
    is_enabled == other.is_enabled &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    target_type == other.target_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



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/data_safe/models/target_alert_policy_association.rb', line 330

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


310
311
312
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 310

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



319
320
321
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 319

def hash
  [id, display_name, description, policy_id, target_id, is_enabled, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, target_type, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



363
364
365
366
367
368
369
370
371
372
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 363

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



357
358
359
 
# File 'lib/oci/data_safe/models/target_alert_policy_association.rb', line 357

def to_s
  to_hash.to_s
end