class PostlightMCTest::ProblemDetailDocument

An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.

Attributes

detail[RW]

A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).

instance[RW]

A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

status[RW]

The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.

title[RW]

A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.

type[RW]

An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/PostlightMCTest/models/problem_detail_document.rb, line 34
def self.attribute_map
  {
    :'type' => :'type',
    :'title' => :'title',
    :'status' => :'status',
    :'detail' => :'detail',
    :'instance' => :'instance'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/PostlightMCTest/models/problem_detail_document.rb, line 57
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 }

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'detail')
    self.detail = attributes[:'detail']
  end

  if attributes.has_key?(:'instance')
    self.instance = attributes[:'instance']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/PostlightMCTest/models/problem_detail_document.rb, line 45
def self.swagger_types
  {
    :'type' => :'String',
    :'title' => :'String',
    :'status' => :'Integer',
    :'detail' => :'String',
    :'instance' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/PostlightMCTest/models/problem_detail_document.rb, line 124
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      title == o.title &&
      status == o.status &&
      detail == o.detail &&
      instance == o.instance
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/PostlightMCTest/models/problem_detail_document.rb, line 170
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = PostlightMCTest.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_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/PostlightMCTest/models/problem_detail_document.rb, line 236
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
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/PostlightMCTest/models/problem_detail_document.rb, line 149
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/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)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(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?(o) click to toggle source

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

# File lib/PostlightMCTest/models/problem_detail_document.rb, line 136
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/PostlightMCTest/models/problem_detail_document.rb, line 142
def hash
  [type, title, status, detail, instance].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/PostlightMCTest/models/problem_detail_document.rb, line 86
def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @title.nil?
    invalid_properties.push('invalid value for "title", title cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @detail.nil?
    invalid_properties.push('invalid value for "detail", detail cannot be nil.')
  end

  if @instance.nil?
    invalid_properties.push('invalid value for "instance", instance cannot be nil.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/PostlightMCTest/models/problem_detail_document.rb, line 216
def to_body
  to_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/PostlightMCTest/models/problem_detail_document.rb, line 222
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/PostlightMCTest/models/problem_detail_document.rb, line 210
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/PostlightMCTest/models/problem_detail_document.rb, line 113
def valid?
  return false if @type.nil?
  return false if @title.nil?
  return false if @status.nil?
  return false if @detail.nil?
  return false if @instance.nil?
  true
end