class OCI::Cims::Models::Item

Details about the item object. 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

Attributes

category[RW]

@return [OCI::Cims::Models::Category]

issue_type[RW]

@return [OCI::Cims::Models::IssueType]

item_key[RW]

[Required] Unique identifier for the item. @return [String]

name[RW]

The display name of the item. @return [String]

sub_category[RW]

@return [OCI::Cims::Models::SubCategory]

type[RW]

The type of the support request. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# 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) click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :item_key The value to assign to the {#item_key} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :type The value to assign to the {#type} property @option attributes [OCI::Cims::Models::Category] :category The value to assign to the {#category} property @option attributes [OCI::Cims::Models::SubCategory] :sub_category The value to assign to the {#sub_category} property @option attributes [OCI::Cims::Models::IssueType] :issue_type The value to assign to the {#issue_type} property

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/cims/models/item.rb, line 142
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/cims/models/item.rb, line 151
def hash
  [item_key, name, type, category, sub_category, issue_type].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/cims/models/item.rb, line 189
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/cims/models/item.rb, line 212
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end