Class: OCI::ApmConfig::Models::UpdateMacsApmExtensionDetails

Inherits:
UpdateConfigDetails show all
Defined in:
lib/oci/apm_config/models/update_macs_apm_extension_details.rb

Overview

An object that represents APM Agent provisioning via a Management Agent.

Constant Summary

Constants inherited from UpdateConfigDetails

OCI::ApmConfig::Models::UpdateConfigDetails::CONFIG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateConfigDetails

#config_type, #defined_tags, #freeform_tags

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateConfigDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateMacsApmExtensionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags proprety

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

    The value to assign to the #defined_tags proprety

  • :display_name (String)

    The value to assign to the #display_name property

  • :process_filter (Array<String>)

    The value to assign to the #process_filter property

  • :run_as_user (String)

    The value to assign to the #run_as_user property

  • :service_name (String)

    The value to assign to the #service_name property

  • :agent_version (String)

    The value to assign to the #agent_version property

  • :attach_install_dir (String)

    The value to assign to the #attach_install_dir property



86
87
88
89
90
91
92
93
94
95
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
122
123
124
125
126
127
128
129
130
131
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 86

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

  attributes['configType'] = 'MACS_APM_EXTENSION'

  super(attributes)

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

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

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

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

  self.run_as_user = attributes[:'runAsUser'] if attributes[:'runAsUser']

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

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

  self.service_name = attributes[:'serviceName'] if attributes[:'serviceName']

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

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

  self.agent_version = attributes[:'agentVersion'] if attributes[:'agentVersion']

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

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

  self.attach_install_dir = attributes[:'attachInstallDir'] if attributes[:'attachInstallDir']

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

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

Instance Attribute Details

#agent_versionString

The version of the referenced agent bundle.

Returns:

  • (String)


32
33
34
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 32

def agent_version
  @agent_version
end

#attach_install_dirString

The directory owned by runAsUser.

Returns:

  • (String)


36
37
38
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 36

def attach_install_dir
  @attach_install_dir
end

#display_nameString

The name by which a configuration entity is displayed to the end user.

Returns:

  • (String)


14
15
16
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 14

def display_name
  @display_name
end

#process_filterArray<String>

Filter patterns used to discover active Java processes for provisioning the APM Agent.

Returns:

  • (Array<String>)


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

def process_filter
  @process_filter
end

#run_as_userString

The OS user that should be used to discover Java processes.

Returns:

  • (String)


22
23
24
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 22

def run_as_user
  @run_as_user
end

#service_nameString

The name of the service being monitored. This argument enables you to filter by service and view traces and other signals in the APM Explorer user interface.

Returns:

  • (String)


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

def service_name
  @service_name
end

Class Method Details

.attribute_mapObject

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'config_type': :'configType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'process_filter': :'processFilter',
    'run_as_user': :'runAsUser',
    'service_name': :'serviceName',
    'agent_version': :'agentVersion',
    'attach_install_dir': :'attachInstallDir'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'config_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'process_filter': :'Array<String>',
    'run_as_user': :'String',
    'service_name': :'String',
    'agent_version': :'String',
    'attach_install_dir': :'String'
    # 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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 140

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

  self.class == other.class &&
    config_type == other.config_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    process_filter == other.process_filter &&
    run_as_user == other.run_as_user &&
    service_name == other.service_name &&
    agent_version == other.agent_version &&
    attach_install_dir == other.attach_install_dir
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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 178

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


158
159
160
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 158

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



167
168
169
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 167

def hash
  [config_type, freeform_tags, defined_tags, display_name, process_filter, run_as_user, service_name, agent_version, attach_install_dir].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



211
212
213
214
215
216
217
218
219
220
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 211

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



205
206
207
# File 'lib/oci/apm_config/models/update_macs_apm_extension_details.rb', line 205

def to_s
  to_hash.to_s
end