Class: OCI::ApmConfig::Models::MacsApmExtension

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

Overview

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

Constant Summary

Constants inherited from Config

Config::CONFIG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Config

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Config

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ MacsApmExtension

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 proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :created_by (String) —

    The value to assign to the #created_by proprety

  • :updated_by (String) —

    The value to assign to the #updated_by proprety

  • :etag (String) —

    The value to assign to the #etag proprety

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

  • :management_agent_id (String) —

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 112

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

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

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

  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_version ⇒ String

The version of the referenced agent bundle.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 37

def agent_version
  @agent_version
end

#attach_install_dir ⇒ String

The directory owned by runAsUser.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 41

def attach_install_dir
  @attach_install_dir
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#management_agent_id ⇒ String

The OCID of the Management Agent that will provision the APM Agent.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 19

def management_agent_id
  @management_agent_id
end

#process_filter ⇒ Array<String>

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

Returns:

  • (Array<String>) 


23
24
25
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 23

def process_filter
  @process_filter
end

#run_as_user ⇒ String

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

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 27

def run_as_user
  @run_as_user
end

#service_name ⇒ String

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) 


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

def service_name
  @service_name
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 44

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',
    'display_name': :'displayName',
    'management_agent_id': :'managementAgentId',
    'process_filter': :'processFilter',
    'run_as_user': :'runAsUser',
    'service_name': :'serviceName',
    'agent_version': :'agentVersion',
    'attach_install_dir': :'attachInstallDir'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 68

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>>',
    'display_name': :'String',
    'management_agent_id': :'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



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

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 &&
    display_name == other.display_name &&
    management_agent_id == other.management_agent_id &&
    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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 217

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


197
198
199
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 197

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



206
207
208
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 206

def hash
  [id, config_type, time_created, time_updated, created_by, updated_by, etag, freeform_tags, defined_tags, display_name, management_agent_id, process_filter, run_as_user, service_name, agent_version, attach_install_dir].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



250
251
252
253
254
255
256
257
258
259
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 250

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



244
245
246
 
# File 'lib/oci/apm_config/models/macs_apm_extension.rb', line 244

def to_s
  to_hash.to_s
end