Class: OCI::LogAnalytics::Models::LogAnalyticsEntityTypeSummary

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

Overview

Summary of a log analytics entity type.

Constant Summary collapse

CLOUD_TYPE_ENUM =
[
  CLOUD_TYPE_CLOUD = 'CLOUD'.freeze,
  CLOUD_TYPE_NON_CLOUD = 'NON_CLOUD'.freeze,
  CLOUD_TYPE_ALL = 'ALL'.freeze,
  CLOUD_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MANAGEMENT_AGENT_ELIGIBILITY_STATUS_ENUM =
[
  MANAGEMENT_AGENT_ELIGIBILITY_STATUS_ELIGIBLE = 'ELIGIBLE'.freeze,
  MANAGEMENT_AGENT_ELIGIBILITY_STATUS_INELIGIBLE = 'INELIGIBLE'.freeze,
  MANAGEMENT_AGENT_ELIGIBILITY_STATUS_UNKNOWN = 'UNKNOWN'.freeze,
  MANAGEMENT_AGENT_ELIGIBILITY_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogAnalyticsEntityTypeSummary

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

  • :internal_name (String)

    The value to assign to the #internal_name property

  • :category (String)

    The value to assign to the #category property

  • :cloud_type (String)

    The value to assign to the #cloud_type property

  • :lifecycle_state (String)

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

  • :management_agent_eligibility_status (String)

    The value to assign to the #management_agent_eligibility_status property



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
164
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 119

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

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

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

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

  self.cloud_type = attributes[:'cloudType'] if attributes[:'cloudType']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

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

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

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

Instance Attribute Details

#categoryString

[Required] Log analytics entity type category. Category will be used for grouping and filtering.

Returns:

  • (String)


46
47
48
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 46

def category
  @category
end

#cloud_typeString

[Required] Log analytics entity type group. This can be CLOUD (OCI) or NON_CLOUD otherwise.

Returns:

  • (String)


51
52
53
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 51

def cloud_type
  @cloud_type
end

#internal_nameString

[Required] Internal name for the log analytics entity type.

Returns:

  • (String)


41
42
43
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 41

def internal_name
  @internal_name
end

#lifecycle_stateString

[Required] The current lifecycle state of the log analytics entity type.

Returns:

  • (String)


56
57
58
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 56

def lifecycle_state
  @lifecycle_state
end

#management_agent_eligibility_statusString

This field indicates whether logs for entities of this type can be collected using a management agent.

Returns:

  • (String)


71
72
73
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 71

def management_agent_eligibility_status
  @management_agent_eligibility_status
end

#nameString

[Required] Log analytics entity type name.

Returns:

  • (String)


36
37
38
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 36

def name
  @name
end

#time_createdDateTime

[Required] Time the log analytics entity type was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime)


61
62
63
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 61

def time_created
  @time_created
end

#time_updatedDateTime

[Required] Time the log analytics entity type was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime)


66
67
68
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 66

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'internal_name': :'internalName',
    'category': :'category',
    'cloud_type': :'cloudType',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'management_agent_eligibility_status': :'managementAgentEligibilityStatus'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 90

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'internal_name': :'String',
    'category': :'String',
    'cloud_type': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'management_agent_eligibility_status': :'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



212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 212

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

  self.class == other.class &&
    name == other.name &&
    internal_name == other.internal_name &&
    category == other.category &&
    cloud_type == other.cloud_type &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    management_agent_eligibility_status == other.management_agent_eligibility_status
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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 249

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


229
230
231
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 229

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



238
239
240
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 238

def hash
  [name, internal_name, category, cloud_type, lifecycle_state, time_created, time_updated, management_agent_eligibility_status].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



282
283
284
285
286
287
288
289
290
291
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 282

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



276
277
278
# File 'lib/oci/log_analytics/models/log_analytics_entity_type_summary.rb', line 276

def to_s
  to_hash.to_s
end