Class: OCI::Sch::Models::DimensionDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/sch/models/dimension_details.rb

Overview

A dimension name and value.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DimensionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/sch/models/dimension_details.rb', line 53

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

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

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

Instance Attribute Details

#dimension_value ⇒ OCI::Sch::Models::DimensionValueDetails

This attribute is required.

Returns:



23
24
25
 
# File 'lib/oci/sch/models/dimension_details.rb', line 23

def dimension_value
  @dimension_value
end

#name ⇒ String

[Required] Dimension key. A valid dimension key includes only printable ASCII, excluding periods (.) and spaces. Custom dimension keys are acceptable. Avoid entering confidential information. Due to use by Connector Hub, the following dimension names are reserved: connectorId, connectorName, connectorSourceType. For information on valid dimension keys and values, see metric_data_details. Example: type

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/sch/models/dimension_details.rb', line 19

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
 
# File 'lib/oci/sch/models/dimension_details.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'dimension_value': :'dimensionValue'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



36
37
38
39
40
41
42
43
 
# File 'lib/oci/sch/models/dimension_details.rb', line 36

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'dimension_value': :'OCI::Sch::Models::DimensionValueDetails'
    # 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



75
76
77
78
79
80
81
 
# File 'lib/oci/sch/models/dimension_details.rb', line 75

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

  self.class == other.class &&
    name == other.name &&
    dimension_value == other.dimension_value
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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/sch/models/dimension_details.rb', line 106

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


86
87
88
 
# File 'lib/oci/sch/models/dimension_details.rb', line 86

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



95
96
97
 
# File 'lib/oci/sch/models/dimension_details.rb', line 95

def hash
  [name, dimension_value].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/sch/models/dimension_details.rb', line 139

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



133
134
135
 
# File 'lib/oci/sch/models/dimension_details.rb', line 133

def to_s
  to_hash.to_s
end