Class: FactPulse::ReponseRechercheFlux

Inherits:
ApiModelBase show all
Defined in:
lib/factpulse/models/reponse_recherche_flux.rb

Overview

Réponse d’une recherche de flux

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ReponseRechercheFlux

Initializes the object

Parameters:

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

    Model attributes in the form of hash



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 69

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::ReponseRechercheFlux` initialize method"
  end

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

  if attributes.key?(:'total')
    self.total = attributes[:'total']
  else
    self.total = nil
  end

  if attributes.key?(:'offset')
    self.offset = attributes[:'offset']
  else
    self.offset = nil
  end

  if attributes.key?(:'limit')
    self.limit = attributes[:'limit']
  else
    self.limit = nil
  end

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

Instance Attribute Details

#limit ⇒ Object

Limite de résultats



26
27
28
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 26

def limit
  @limit
end

#offset ⇒ Object

Décalage appliqué



23
24
25
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 23

def offset
  @offset
end

#resultats ⇒ Object

Liste des flux trouvés



29
30
31
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 29

def resultats
  @resultats
end

#total ⇒ Object

Nombre total de résultats



20
21
22
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 20

def total
  @total
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



42
43
44
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 47

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 32

def self.attribute_map
  {
    :'total' => :'total',
    :'offset' => :'offset',
    :'limit' => :'limit',
    :'resultats' => :'resultats'
  }
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 211

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 62

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 52

def self.openapi_types
  {
    :'total' => :'Integer',
    :'offset' => :'Integer',
    :'limit' => :'Integer',
    :'resultats' => :'Array<FluxResume>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total == o.total &&
      offset == o.offset &&
      limit == o.limit &&
      resultats == o.resultats
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


198
199
200
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



204
205
206
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 204

def hash
  [total, offset, limit, resultats].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 112

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @total.nil?
    invalid_properties.push('invalid value for "total", total cannot be nil.')
  end

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 233

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



136
137
138
139
140
141
142
143
 
# File 'lib/factpulse/models/reponse_recherche_flux.rb', line 136

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @total.nil?
  return false if @offset.nil?
  return false if @limit.nil?
  return false if @resultats.nil?
  true
end