Class: OCI::ApmConfig::Models::AgentConfigSummary

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

Overview

Agent configuration for any Agent complying with the OpAMP specification.

Constant Summary

Constants inherited from ConfigSummary

ConfigSummary::CONFIG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ConfigSummary

#config_type, #created_by, #defined_tags, #etag, #freeform_tags, #id, #system_tags, #time_created, #time_updated, #updated_by

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ConfigSummary

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ AgentConfigSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



96
97
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/apm_config/models/agent_config_summary.rb', line 96

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['configType'] = 'AGENT'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.match_agents_with_attribute_key = attributes[:'matchAgentsWithAttributeKey'] if attributes[:'matchAgentsWithAttributeKey']

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

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

  self.match_agents_with_attribute_value = attributes[:'matchAgentsWithAttributeValue'] if attributes[:'matchAgentsWithAttributeValue']

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

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

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

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

Instance Attribute Details

#config ⇒ OCI::ApmConfig::Models::AgentConfigMap

Returns:



28
29
30
 
# File 'lib/oci/apm_config/models/agent_config_summary.rb', line 28

def config
  @config
end

#match_agents_with_attribute_key ⇒ Array<String>

The agent attribute KEY by which an Agent configuration is matched to an agent. All agent configuration objects share the same key. It is [ServiceName, service.name] by default. The attribute VALUE corresponding to this KEY is in the matchAgentsWithAttributeValue field.

Returns:

  • (Array<String>) 


18
19
20
 
# File 'lib/oci/apm_config/models/agent_config_summary.rb', line 18

def match_agents_with_attribute_key
  @match_agents_with_attribute_key
end

#match_agents_with_attribute_value ⇒ String

The agent attribute VALUE by which an agent configuration is matched to an agent. Each agent configuration object must specify a different value. The attribute KEY corresponding to this VALUE is in the matchAgentsWithAttributeKey field.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/apm_config/models/agent_config_summary.rb', line 25

def match_agents_with_attribute_value
  @match_agents_with_attribute_value
end

#overrides ⇒ OCI::ApmConfig::Models::AgentConfigOverrides

Returns:



31
32
33
 
# File 'lib/oci/apm_config/models/agent_config_summary.rb', line 31

def overrides
  @overrides
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/apm_config/models/agent_config_summary.rb', line 34

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',
    'system_tags': :'systemTags',
    'match_agents_with_attribute_key': :'matchAgentsWithAttributeKey',
    'match_agents_with_attribute_value': :'matchAgentsWithAttributeValue',
    'config': :'config',
    'overrides': :'overrides'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/apm_config/models/agent_config_summary.rb', line 56

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>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'match_agents_with_attribute_key': :'Array<String>',
    'match_agents_with_attribute_value': :'String',
    'config': :'OCI::ApmConfig::Models::AgentConfigMap',
    'overrides': :'OCI::ApmConfig::Models::AgentConfigOverrides'
    # 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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/apm_config/models/agent_config_summary.rb', line 130

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 &&
    system_tags == other.system_tags &&
    match_agents_with_attribute_key == other.match_agents_with_attribute_key &&
    match_agents_with_attribute_value == other.match_agents_with_attribute_value &&
    config == other.config &&
    overrides == other.overrides
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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/apm_config/models/agent_config_summary.rb', line 173

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


153
154
155
 
# File 'lib/oci/apm_config/models/agent_config_summary.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
 
# File 'lib/oci/apm_config/models/agent_config_summary.rb', line 162

def hash
  [id, config_type, time_created, time_updated, created_by, updated_by, etag, freeform_tags, defined_tags, system_tags, match_agents_with_attribute_key, match_agents_with_attribute_value, config, overrides].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/apm_config/models/agent_config_summary.rb', line 206

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



200
201
202
 
# File 'lib/oci/apm_config/models/agent_config_summary.rb', line 200

def to_s
  to_hash.to_s
end