Class: OCI::LogAnalytics::Models::LogAnalyticsCategory

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

Overview

A category into which resources can be placed.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogAnalyticsCategory

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

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :type (String) —

    The value to assign to the #type property

  • :is_system (BOOLEAN) —

    The value to assign to the #is_system property



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 70

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

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

  self.is_system = attributes[:'isSystem'] unless attributes[:'isSystem'].nil?

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

  self.is_system = attributes[:'is_system'] unless attributes[:'is_system'].nil?
end

Instance Attribute Details

#description ⇒ String

The category description.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 17

def description
  @description
end

#display_name ⇒ String

The category display name.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 21

def display_name
  @display_name
end

#is_system ⇒ BOOLEAN

The system flag. A value of false denotes a user-created category. A value of true denotes an Oracle-defined category.

Returns:

  • (BOOLEAN) 


31
32
33
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 31

def is_system
  @is_system
end

#name ⇒ String

The unique name that identifies the category.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 13

def name
  @name
end

#type ⇒ String

The category type. Values include "PRODUCT", "TIER", "VENDOR" and "GENERIC".

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 25

def type
  @type
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
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'display_name': :'displayName',
    'type': :'type',
    'is_system': :'isSystem'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 47

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'display_name': :'String',
    'type': :'String',
    'is_system': :'BOOLEAN'
    # 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



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 102

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    display_name == other.display_name &&
    type == other.type &&
    is_system == other.is_system
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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 136

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


116
117
118
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 116

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 125

def hash
  [name, description, display_name, type, is_system].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 169

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



163
164
165
 
# File 'lib/oci/log_analytics/models/log_analytics_category.rb', line 163

def to_s
  to_hash.to_s
end