Class: OCI::Opsi::Models::DataObjectColumnUnit

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opsi/models/data_object_column_unit.rb

Overview

Unit details of a data object column. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

UNIT_CATEGORY_ENUM = 
[
  UNIT_CATEGORY_DATA_SIZE = 'DATA_SIZE'.freeze,
  UNIT_CATEGORY_TIME = 'TIME'.freeze,
  UNIT_CATEGORY_POWER = 'POWER'.freeze,
  UNIT_CATEGORY_TEMPERATURE = 'TEMPERATURE'.freeze,
  UNIT_CATEGORY_CORE = 'CORE'.freeze,
  UNIT_CATEGORY_RATE = 'RATE'.freeze,
  UNIT_CATEGORY_FREQUENCY = 'FREQUENCY'.freeze,
  UNIT_CATEGORY_OTHER_STANDARD = 'OTHER_STANDARD'.freeze,
  UNIT_CATEGORY_CUSTOM = 'CUSTOM'.freeze,
  UNIT_CATEGORY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataObjectColumnUnit

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :unit_category (String) —

    The value to assign to the #unit_category property

  • :display_name (String) —

    The value to assign to the #display_name property



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/opsi/models/data_object_column_unit.rb', line 84

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

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

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

  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']
end

Instance Attribute Details

#display_name ⇒ String

Display name of the column's unit.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/opsi/models/data_object_column_unit.rb', line 31

def display_name
  @display_name
end

#unit_category ⇒ String

**[Required]** Category of the column's unit.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/opsi/models/data_object_column_unit.rb', line 27

def unit_category
  @unit_category
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
 
# File 'lib/oci/opsi/models/data_object_column_unit.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'unit_category': :'unitCategory',
    'display_name': :'displayName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/opsi/models/data_object_column_unit.rb', line 58

def self.get_subtype(object_hash)
  type = object_hash[:'unitCategory'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Opsi::Models::DataObjectCoreColumnUnit' if type == 'CORE'
  return 'OCI::Opsi::Models::DataObjectTimeColumnUnit' if type == 'TIME'
  return 'OCI::Opsi::Models::DataObjectOtherStandardColumnUnit' if type == 'OTHER_STANDARD'
  return 'OCI::Opsi::Models::DataObjectCustomColumnUnit' if type == 'CUSTOM'
  return 'OCI::Opsi::Models::DataObjectTemperatureColumnUnit' if type == 'TEMPERATURE'
  return 'OCI::Opsi::Models::DataObjectPowerColumnUnit' if type == 'POWER'
  return 'OCI::Opsi::Models::DataObjectRateColumnUnit' if type == 'RATE'
  return 'OCI::Opsi::Models::DataObjectFrequencyColumnUnit' if type == 'FREQUENCY'
  return 'OCI::Opsi::Models::DataObjectDataSizeColumnUnit' if type == 'DATA_SIZE'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Opsi::Models::DataObjectColumnUnit'
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
 
# File 'lib/oci/opsi/models/data_object_column_unit.rb', line 44

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



123
124
125
126
127
128
129
 
# File 'lib/oci/opsi/models/data_object_column_unit.rb', line 123

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

  self.class == other.class &&
    unit_category == other.unit_category &&
    display_name == other.display_name
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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/opsi/models/data_object_column_unit.rb', line 154

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


134
135
136
 
# File 'lib/oci/opsi/models/data_object_column_unit.rb', line 134

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/oci/opsi/models/data_object_column_unit.rb', line 143

def hash
  [unit_category, display_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/opsi/models/data_object_column_unit.rb', line 187

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



181
182
183
 
# File 'lib/oci/opsi/models/data_object_column_unit.rb', line 181

def to_s
  to_hash.to_s
end