Class: OCI::LogAnalytics::Models::CreateLogAnalyticsEntityDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/create_log_analytics_entity_details.rb

Overview

Details for new log analytics entity to be added.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateLogAnalyticsEntityDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :entity_type_name (String) —

    The value to assign to the #entity_type_name property

  • :management_agent_id (String) —

    The value to assign to the #management_agent_id property

  • :cloud_resource_id (String) —

    The value to assign to the #cloud_resource_id property

  • :timezone_region (String) —

    The value to assign to the #timezone_region property

  • :hostname (String) —

    The value to assign to the #hostname property

  • :source_id (String) —

    The value to assign to the #source_id property

  • :properties (Hash<String, String>) —

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



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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 126

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

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

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

  self.entity_type_name = attributes[:'entity_type_name'] if attributes[:'entity_type_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.cloud_resource_id = attributes[:'cloudResourceId'] if attributes[:'cloudResourceId']

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

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

  self.timezone_region = attributes[:'timezoneRegion'] if attributes[:'timezoneRegion']

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

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

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

  self.source_id = attributes[:'sourceId'] if attributes[:'sourceId']

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

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

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

  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

#cloud_resource_id ⇒ String

The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity represents a non-cloud resource that the customer may have on their premises.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 35

def cloud_resource_id
  @cloud_resource_id
end

#compartment_id ⇒ String

[Required] Compartment Identifier [OCID] (docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 19

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


69
70
71
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 69

def defined_tags
  @defined_tags
end

#entity_type_name ⇒ String

[Required] Log analytics entity type name.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 24

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


63
64
65
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 63

def freeform_tags
  @freeform_tags
end

#hostname ⇒ String

The hostname where the entity represented here is actually present. This would be the output one would get if they run echo $HOSTNAME on Linux or an equivalent OS command. This may be different from management agents host since logs may be collected remotely.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 47

def hostname
  @hostname
end

#management_agent_id ⇒ String

The OCID of the Management Agent.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 29

def management_agent_id
  @management_agent_id
end

#name ⇒ String

[Required] Log analytics entity name.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 15

def name
  @name
end

#properties ⇒ Hash<String, String>

The name/value pairs for parameter values to be used in file patterns specified in log sources.

Returns:

  • (Hash<String, String>) 


57
58
59
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 57

def properties
  @properties
end

#source_id ⇒ String

This indicates the type of source. It is primarily for Enterprise Manager Repository ID.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 52

def source_id
  @source_id
end

#timezone_region ⇒ String

The timezone region of the log analytics entity.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 40

def timezone_region
  @timezone_region
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 72

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'compartment_id': :'compartmentId',
    'entity_type_name': :'entityTypeName',
    'management_agent_id': :'managementAgentId',
    'cloud_resource_id': :'cloudResourceId',
    'timezone_region': :'timezoneRegion',
    'hostname': :'hostname',
    'source_id': :'sourceId',
    'properties': :'properties',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 91

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'compartment_id': :'String',
    'entity_type_name': :'String',
    'management_agent_id': :'String',
    'cloud_resource_id': :'String',
    'timezone_region': :'String',
    'hostname': :'String',
    'source_id': :'String',
    'properties': :'Hash<String, 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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 194

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

  self.class == other.class &&
    name == other.name &&
    compartment_id == other.compartment_id &&
    entity_type_name == other.entity_type_name &&
    management_agent_id == other.management_agent_id &&
    cloud_resource_id == other.cloud_resource_id &&
    timezone_region == other.timezone_region &&
    hostname == other.hostname &&
    source_id == other.source_id &&
    properties == other.properties &&
    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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 234

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


214
215
216
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 214

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



223
224
225
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 223

def hash
  [name, compartment_id, entity_type_name, management_agent_id, cloud_resource_id, timezone_region, hostname, source_id, properties, 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



267
268
269
270
271
272
273
274
275
276
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 267

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



261
262
263
 
# File 'lib/oci/log_analytics/models/create_log_analytics_entity_details.rb', line 261

def to_s
  to_hash.to_s
end