Class: OCI::Limits::Models::ServiceSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/limits/models/service_summary.rb

Overview

A specific OCI service supported by resource limits.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ServiceSummary

Initializes the object

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :description (String) —

    The value to assign to the #description property



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/limits/models/service_summary.rb', line 45

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

Instance Attribute Details

#description ⇒ String

The friendly service name.



15
16
17
 
# File 'lib/oci/limits/models/service_summary.rb', line 15

def description
  @description
end

#name ⇒ String

The service name. Use this when calling the other APIs.



11
12
13
 
# File 'lib/oci/limits/models/service_summary.rb', line 11

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
24
25
 
# File 'lib/oci/limits/models/service_summary.rb', line 18

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

.swagger_types ⇒ Object

Attribute type mapping.



28
29
30
31
32
33
34
35
 
# File 'lib/oci/limits/models/service_summary.rb', line 28

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



63
64
65
66
67
68
69
 
# File 'lib/oci/limits/models/service_summary.rb', line 63

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

  self.class == other.class &&
    name == other.name &&
    description == other.description
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/limits/models/service_summary.rb', line 94

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

See Also:

  • `==` method


74
75
76
 
# File 'lib/oci/limits/models/service_summary.rb', line 74

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



83
84
85
 
# File 'lib/oci/limits/models/service_summary.rb', line 83

def hash
  [name, description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/limits/models/service_summary.rb', line 127

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



121
122
123
 
# File 'lib/oci/limits/models/service_summary.rb', line 121

def to_s
  to_hash.to_s
end