Class: OCI::StackMonitoring::Models::MonitoringTemplateSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/stack_monitoring/models/monitoring_template_summary.rb

Overview

Summary information about Monitoring Template.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_NOT_APPLIED = 'NOT_APPLIED'.freeze,
  STATUS_APPLIED = 'APPLIED'.freeze,
  STATUS_PARTIAL_APPLIED = 'PARTIAL_APPLIED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MonitoringTemplateSummary

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

  • :tenant_id (String) —

    The value to assign to the #tenant_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :description (String) —

    The value to assign to the #description property

  • :status (String) —

    The value to assign to the #status property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :destinations (Array<String>) —

    The value to assign to the #destinations property

  • :members (Array<OCI::StackMonitoring::Models::MemberReference>) —

    The value to assign to the #members property

  • :total_alarm_conditions (Float) —

    The value to assign to the #total_alarm_conditions property

  • :total_applied_alarm_conditions (Float) —

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

  • :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



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
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 168

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

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

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

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

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

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

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

  self.total_alarm_conditions = attributes[:'totalAlarmConditions'] if attributes[:'totalAlarmConditions']

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

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

  self.total_applied_alarm_conditions = attributes[:'totalAppliedAlarmConditions'] if attributes[:'totalAppliedAlarmConditions']

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

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

  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.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 containing the monitoringTemplate.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 42

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


90
91
92
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 90

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description for the monitoring template

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 46

def description
  @description
end

#destinations ⇒ Array<String>

[Required] A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource

Returns:

  • (Array<String>) 


58
59
60
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 58

def destinations
  @destinations
end

#display_name ⇒ String

[Required] A user-friendly name for the monitoring template.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 34

def display_name
  @display_name
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. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


84
85
86
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 84

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the monitoringTemplate

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 30

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the monitoring template

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 54

def lifecycle_state
  @lifecycle_state
end

#members ⇒ Array<OCI::StackMonitoring::Models::MemberReference>

List of members of this monitoring template

Returns:



62
63
64
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 62

def members
  @members
end

#status ⇒ String

[Required] The current status of the monitoring template i.e. whether it is Applied or Not Applied

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 50

def status
  @status
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


96
97
98
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 96

def system_tags
  @system_tags
end

#tenant_id ⇒ String

[Required] Tenant Identifier OCID

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 38

def tenant_id
  @tenant_id
end

#time_created ⇒ DateTime

[Required] The date and time the monitoringTemplate was created. Format defined by RFC3339.

Returns:

  • (DateTime) 


74
75
76
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 74

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the monitoringTemplate was last updated. Format defined by RFC3339.

Returns:

  • (DateTime) 


78
79
80
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 78

def time_updated
  @time_updated
end

#total_alarm_conditions ⇒ Float

[Required] Total Alarm Conditions

Returns:

  • (Float) 


66
67
68
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 66

def total_alarm_conditions
  @total_alarm_conditions
end

#total_applied_alarm_conditions ⇒ Float

[Required] Total Applied Alarm Conditions

Returns:

  • (Float) 


70
71
72
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 70

def total_applied_alarm_conditions
  @total_applied_alarm_conditions
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'tenant_id': :'tenantId',
    'compartment_id': :'compartmentId',
    'description': :'description',
    'status': :'status',
    'lifecycle_state': :'lifecycleState',
    'destinations': :'destinations',
    'members': :'members',
    'total_alarm_conditions': :'totalAlarmConditions',
    'total_applied_alarm_conditions': :'totalAppliedAlarmConditions',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'tenant_id': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'status': :'String',
    'lifecycle_state': :'String',
    'destinations': :'Array<String>',
    'members': :'Array<OCI::StackMonitoring::Models::MemberReference>',
    'total_alarm_conditions': :'Float',
    'total_applied_alarm_conditions': :'Float',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



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

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    tenant_id == other.tenant_id &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    status == other.status &&
    lifecycle_state == other.lifecycle_state &&
    destinations == other.destinations &&
    members == other.members &&
    total_alarm_conditions == other.total_alarm_conditions &&
    total_applied_alarm_conditions == other.total_applied_alarm_conditions &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 329

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


309
310
311
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 309

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



318
319
320
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 318

def hash
  [id, display_name, tenant_id, compartment_id, description, status, lifecycle_state, destinations, members, total_alarm_conditions, total_applied_alarm_conditions, time_created, time_updated, 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



362
363
364
365
366
367
368
369
370
371
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 362

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



356
357
358
 
# File 'lib/oci/stack_monitoring/models/monitoring_template_summary.rb', line 356

def to_s
  to_hash.to_s
end