Class: OCI::ApmConfig::Models::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_config/models/config.rb

Overview

A configuration item, which has a number of mutually exclusive properties that can be used to set specific portions of the configuration.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

CONFIG_TYPE_ENUM = 
[
  CONFIG_TYPE_SPAN_FILTER = 'SPAN_FILTER'.freeze,
  CONFIG_TYPE_METRIC_GROUP = 'METRIC_GROUP'.freeze,
  CONFIG_TYPE_APDEX = 'APDEX'.freeze,
  CONFIG_TYPE_OPTIONS = 'OPTIONS'.freeze,
  CONFIG_TYPE_AGENT = 'AGENT'.freeze,
  CONFIG_TYPE_MACS_APM_EXTENSION = 'MACS_APM_EXTENSION'.freeze,
  CONFIG_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 = {}) ⇒ Config

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

  • :config_type (String) —

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

  • :created_by (String) —

    The value to assign to the #created_by property

  • :updated_by (String) —

    The value to assign to the #updated_by property

  • :etag (String) —

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



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
 
# File 'lib/oci/apm_config/models/config.rb', line 145

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

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

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

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

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

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

  self.updated_by = attributes[:'updatedBy'] if attributes[:'updatedBy']

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

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

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

  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

#config_type ⇒ String

[Required] The type of configuration item.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/apm_config/models/config.rb', line 33

def config_type
  @config_type
end

#created_by ⇒ String

The OCID of a user.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/apm_config/models/config.rb', line 52

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


74
75
76
 
# File 'lib/oci/apm_config/models/config.rb', line 74

def defined_tags
  @defined_tags
end

#etag ⇒ String

For optimistic concurrency control. See if-match.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/apm_config/models/config.rb', line 62

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


68
69
70
 
# File 'lib/oci/apm_config/models/config.rb', line 68

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the configuration item. An OCID is generated when the item is created.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/apm_config/models/config.rb', line 29

def id
  @id
end

#time_created ⇒ DateTime

The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/apm_config/models/config.rb', line 40

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

Returns:

  • (DateTime) 


47
48
49
 
# File 'lib/oci/apm_config/models/config.rb', line 47

def time_updated
  @time_updated
end

#updated_by ⇒ String

The OCID of a user.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/apm_config/models/config.rb', line 57

def updated_by
  @updated_by
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
 
# File 'lib/oci/apm_config/models/config.rb', line 77

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'config_type': :'configType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'created_by': :'createdBy',
    'updated_by': :'updatedBy',
    'etag': :'etag',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/apm_config/models/config.rb', line 115

def self.get_subtype(object_hash)
  type = object_hash[:'configType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::ApmConfig::Models::AgentConfig' if type == 'AGENT'
  return 'OCI::ApmConfig::Models::Options' if type == 'OPTIONS'
  return 'OCI::ApmConfig::Models::MacsApmExtension' if type == 'MACS_APM_EXTENSION'
  return 'OCI::ApmConfig::Models::MetricGroup' if type == 'METRIC_GROUP'
  return 'OCI::ApmConfig::Models::ApdexRules' if type == 'APDEX'
  return 'OCI::ApmConfig::Models::SpanFilter' if type == 'SPAN_FILTER'

  # TODO: Log a warning when the subtype is not found.
  'OCI::ApmConfig::Models::Config'
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/apm_config/models/config.rb', line 94

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'config_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'created_by': :'String',
    'updated_by': :'String',
    'etag': :'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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/apm_config/models/config.rb', line 218

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

  self.class == other.class &&
    id == other.id &&
    config_type == other.config_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    created_by == other.created_by &&
    updated_by == other.updated_by &&
    etag == other.etag &&
    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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/oci/apm_config/models/config.rb', line 256

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


236
237
238
 
# File 'lib/oci/apm_config/models/config.rb', line 236

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



245
246
247
 
# File 'lib/oci/apm_config/models/config.rb', line 245

def hash
  [id, config_type, time_created, time_updated, created_by, updated_by, etag, 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



289
290
291
292
293
294
295
296
297
298
 
# File 'lib/oci/apm_config/models/config.rb', line 289

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



283
284
285
 
# File 'lib/oci/apm_config/models/config.rb', line 283

def to_s
  to_hash.to_s
end