class AylienNewsApi::Entity

Attributes

body[RW]
external_ids[RW]
id[RW]

The unique ID of the entity

overall_frequency[RW]

Amount of entity surface form mentions in the article

overall_prominence[RW]

Describes how relevant an entity is to the article

overall_sentiment[RW]
stock_tickers[RW]

The stock tickers of the entity (might be empty)

title[RW]
types[RW]

An array of the entity types

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aylien_news_api/models/entity.rb, line 43
def self.attribute_map
  {
    :'id' => :'id',
    :'links' => :'links',
    :'stock_tickers' => :'stock_tickers',
    :'types' => :'types',
    :'overall_sentiment' => :'overall_sentiment',
    :'overall_prominence' => :'overall_prominence',
    :'overall_frequency' => :'overall_frequency',
    :'body' => :'body',
    :'title' => :'title',
    :'external_ids' => :'external_ids'
  }
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/aylien_news_api/models/entity.rb, line 224
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/aylien_news_api/models/entity.rb, line 82
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AylienNewsApi::Entity` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `AylienNewsApi::Entity`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'links')
    self.links = attributes[:'links']
  end

  if attributes.key?(:'stock_tickers')
    if (value = attributes[:'stock_tickers']).is_a?(Array)
      self.stock_tickers = value
    end
  end

  if attributes.key?(:'types')
    if (value = attributes[:'types']).is_a?(Array)
      self.types = value
    end
  end

  if attributes.key?(:'overall_sentiment')
    self.overall_sentiment = attributes[:'overall_sentiment']
  end

  if attributes.key?(:'overall_prominence')
    self.overall_prominence = attributes[:'overall_prominence']
  end

  if attributes.key?(:'overall_frequency')
    self.overall_frequency = attributes[:'overall_frequency']
  end

  if attributes.key?(:'body')
    self.body = attributes[:'body']
  end

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

  if attributes.key?(:'external_ids')
    self.external_ids = attributes[:'external_ids']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/aylien_news_api/models/entity.rb, line 75
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/aylien_news_api/models/entity.rb, line 59
def self.openapi_types
  {
    :'id' => :'String',
    :'links' => :'EntityLinks',
    :'stock_tickers' => :'Array<String>',
    :'types' => :'Array<String>',
    :'overall_sentiment' => :'EntitySentiment',
    :'overall_prominence' => :'Float',
    :'overall_frequency' => :'Integer',
    :'body' => :'EntityInText',
    :'title' => :'EntityInText',
    :'external_ids' => :'ExternalIds'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/aylien_news_api/models/entity.rb, line 194
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      links == o.links &&
      stock_tickers == o.stock_tickers &&
      types == o.types &&
      overall_sentiment == o.overall_sentiment &&
      overall_prominence == o.overall_prominence &&
      overall_frequency == o.overall_frequency &&
      body == o.body &&
      title == o.title &&
      external_ids == o.external_ids
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/aylien_news_api/models/entity.rb, line 252
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
    AylienNewsApi.const_get(type).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/aylien_news_api/models/entity.rb, line 321
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/aylien_news_api/models/entity.rb, line 231
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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/aylien_news_api/models/entity.rb, line 211
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/aylien_news_api/models/entity.rb, line 217
def hash
  [id, links, stock_tickers, types, overall_sentiment, overall_prominence, overall_frequency, body, title, external_ids].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/aylien_news_api/models/entity.rb, line 142
def list_invalid_properties
  invalid_properties = Array.new
  if !@overall_prominence.nil? && @overall_prominence > 1
    invalid_properties.push('invalid value for "overall_prominence", must be smaller than or equal to 1.')
  end

  if !@overall_prominence.nil? && @overall_prominence < 0
    invalid_properties.push('invalid value for "overall_prominence", must be greater than or equal to 0.')
  end

  if !@overall_frequency.nil? && @overall_frequency < 0
    invalid_properties.push('invalid value for "overall_frequency", must be greater than or equal to 0.')
  end

  invalid_properties
end
overall_frequency=(overall_frequency) click to toggle source

Custom attribute writer method with validation @param [Object] overall_frequency Value to be assigned

# File lib/aylien_news_api/models/entity.rb, line 184
def overall_frequency=(overall_frequency)
  if !overall_frequency.nil? && overall_frequency < 0
    fail ArgumentError, 'invalid value for "overall_frequency", must be greater than or equal to 0.'
  end

  @overall_frequency = overall_frequency
end
overall_prominence=(overall_prominence) click to toggle source

Custom attribute writer method with validation @param [Object] overall_prominence Value to be assigned

# File lib/aylien_news_api/models/entity.rb, line 170
def overall_prominence=(overall_prominence)
  if !overall_prominence.nil? && overall_prominence > 1
    fail ArgumentError, 'invalid value for "overall_prominence", must be smaller than or equal to 1.'
  end

  if !overall_prominence.nil? && overall_prominence < 0
    fail ArgumentError, 'invalid value for "overall_prominence", must be greater than or equal to 0.'
  end

  @overall_prominence = overall_prominence
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/aylien_news_api/models/entity.rb, line 297
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/aylien_news_api/models/entity.rb, line 303
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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/aylien_news_api/models/entity.rb, line 291
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/aylien_news_api/models/entity.rb, line 161
def valid?
  return false if !@overall_prominence.nil? && @overall_prominence > 1
  return false if !@overall_prominence.nil? && @overall_prominence < 0
  return false if !@overall_frequency.nil? && @overall_frequency < 0
  true
end