Class: OCI::StackMonitoring::Models::BaselineableMetricSummary

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

Overview

Summary for the baseline-able metric

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.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 = {}) ⇒ BaselineableMetricSummary

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

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :tenancy_id (String) —

    The value to assign to the #tenancy_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :name (String) —

    The value to assign to the #name property

  • :column (String) —

    The value to assign to the #column property

  • :namespace (String) —

    The value to assign to the #namespace property

  • :resource_group (String) —

    The value to assign to the #resource_group property

  • :resource_type (String) —

    The value to assign to the #resource_type property

  • :is_out_of_box (BOOLEAN) —

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
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
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 137

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

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

  self.tenancy_id = attributes[:'tenancy_id'] if attributes[:'tenancy_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.name = attributes[:'name'] if attributes[:'name']

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

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

  self.resource_group = attributes[:'resourceGroup'] if attributes[:'resourceGroup']

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

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

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

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

  self.is_out_of_box = attributes[:'is_out_of_box'] unless attributes[:'is_out_of_box'].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']

  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

#column ⇒ String

[Required] metric column name

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 40

def column
  @column
end

#compartment_id ⇒ String

OCID of the compartment

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 32

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


68
69
70
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 68

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

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] OCID of the metric

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 20

def id
  @id
end

#is_out_of_box ⇒ BOOLEAN

[Required] Is the metric created out of box, default false

Returns:

  • (BOOLEAN) 


56
57
58
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 56

def is_out_of_box
  @is_out_of_box
end

#lifecycle_state ⇒ String

The current lifecycle state of the metric extension

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 24

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] name of the metric

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 36

def name
  @name
end

#namespace ⇒ String

[Required] namespace of the metric

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 44

def namespace
  @namespace
end

#resource_group ⇒ String

[Required] Resource group of the metric

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 48

def resource_group
  @resource_group
end

#resource_type ⇒ String

Resource type of the metric

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 52

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


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

def system_tags
  @system_tags
end

#tenancy_id ⇒ String

OCID of the tenancy

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 28

def tenancy_id
  @tenancy_id
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 77

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'tenancy_id': :'tenancyId',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'column': :'column',
    'namespace': :'namespace',
    'resource_group': :'resourceGroup',
    'resource_type': :'resourceType',
    'is_out_of_box': :'isOutOfBox',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'lifecycle_state': :'String',
    'tenancy_id': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'column': :'String',
    'namespace': :'String',
    'resource_group': :'String',
    'resource_type': :'String',
    'is_out_of_box': :'BOOLEAN',
    '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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 226

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

  self.class == other.class &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    tenancy_id == other.tenancy_id &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    column == other.column &&
    namespace == other.namespace &&
    resource_group == other.resource_group &&
    resource_type == other.resource_type &&
    is_out_of_box == other.is_out_of_box &&
    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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 268

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


248
249
250
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 248

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



257
258
259
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 257

def hash
  [id, lifecycle_state, tenancy_id, compartment_id, name, column, namespace, resource_group, resource_type, is_out_of_box, 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



301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 301

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



295
296
297
 
# File 'lib/oci/stack_monitoring/models/baselineable_metric_summary.rb', line 295

def to_s
  to_hash.to_s
end