Class: OCI::Cims::Models::Item

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cims/models/item.rb

Overview

Details of Item 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

Direct Known Subclasses

ActivityItem, LimitItem, TechSupportItem

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Item

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'lib/oci/cims/models/item.rb', line 89

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

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

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

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

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

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

  self.sub_category = attributes[:'subCategory'] if attributes[:'subCategory']

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

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

  self.issue_type = attributes[:'issueType'] if attributes[:'issueType']

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

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

Instance Attribute Details

#categoryOCI::Cims::Models::Category



24
25
26
# File 'lib/oci/cims/models/item.rb', line 24

def category
  @category
end

#issue_typeOCI::Cims::Models::IssueType



30
31
32
# File 'lib/oci/cims/models/item.rb', line 30

def issue_type
  @issue_type
end

#item_keyString

[Required] Unique ID that identifies an Item

Returns:

  • (String)


13
14
15
# File 'lib/oci/cims/models/item.rb', line 13

def item_key
  @item_key
end

#nameString

Name of item

Returns:

  • (String)


17
18
19
# File 'lib/oci/cims/models/item.rb', line 17

def name
  @name
end

#sub_categoryOCI::Cims::Models::SubCategory



27
28
29
# File 'lib/oci/cims/models/item.rb', line 27

def sub_category
  @sub_category
end

#typeString

Type of item. eg: ActivityItem, LimitItem

Returns:

  • (String)


21
22
23
# File 'lib/oci/cims/models/item.rb', line 21

def type
  @type
end

Class Method Details

.attribute_mapObject

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



33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/oci/cims/models/item.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'item_key': :'itemKey',
    'name': :'name',
    'type': :'type',
    'category': :'category',
    'sub_category': :'subCategory',
    'issue_type': :'issueType'
    # 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.



65
66
67
68
69
70
71
72
73
74
# File 'lib/oci/cims/models/item.rb', line 65

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

  return 'OCI::Cims::Models::LimitItem' if type == 'limit'
  return 'OCI::Cims::Models::TechSupportItem' if type == 'tech'
  return 'OCI::Cims::Models::ActivityItem' if type == 'activity'

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

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'item_key': :'String',
    'name': :'String',
    'type': :'String',
    'category': :'OCI::Cims::Models::Category',
    'sub_category': :'OCI::Cims::Models::SubCategory',
    'issue_type': :'OCI::Cims::Models::IssueType'
    # 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



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

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

  self.class == other.class &&
    item_key == other.item_key &&
    name == other.name &&
    type == other.type &&
    category == other.category &&
    sub_category == other.sub_category &&
    issue_type == other.issue_type
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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/oci/cims/models/item.rb', line 162

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


142
143
144
# File 'lib/oci/cims/models/item.rb', line 142

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



151
152
153
# File 'lib/oci/cims/models/item.rb', line 151

def hash
  [item_key, name, type, category, sub_category, issue_type].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



195
196
197
198
199
200
201
202
203
204
# File 'lib/oci/cims/models/item.rb', line 195

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



189
190
191
# File 'lib/oci/cims/models/item.rb', line 189

def to_s
  to_hash.to_s
end