Class: FactPulse::StatutTache

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

Overview

Description complète du statut d’une tâche asynchrone. Le champ ‘statut` indique l’état Celery de la tâche. Quand ‘statut="SUCCESS"`, consultez `resultat.statut` pour le résultat métier ("SUCCES" ou "ERREUR").

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ StatutTache

Initializes the object

Parameters:

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

    Model attributes in the form of hash



85
86
87
88
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
 
# File 'lib/factpulse/models/statut_tache.rb', line 85

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::StatutTache` 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::StatutTache`. 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?(:'id_tache')
    self.id_tache = attributes[:'id_tache']
  else
    self.id_tache = nil
  end

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

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

Instance Attribute Details

#id_tache ⇒ Object

Returns the value of attribute id_tache.



19
20
21
 
# File 'lib/factpulse/models/statut_tache.rb', line 19

def id_tache
  @id_tache
end

#resultat ⇒ Object

Returns the value of attribute resultat.



24
25
26
 
# File 'lib/factpulse/models/statut_tache.rb', line 24

def resultat
  @resultat
end

#statut ⇒ Object

Statut Celery de la tâche (PENDING, STARTED, SUCCESS, FAILURE, RETRY)



22
23
24
 
# File 'lib/factpulse/models/statut_tache.rb', line 22

def statut
  @statut
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



58
59
60
 
# File 'lib/factpulse/models/statut_tache.rb', line 58

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
 
# File 'lib/factpulse/models/statut_tache.rb', line 49

def self.attribute_map
  {
    :'id_tache' => :'id_tache',
    :'statut' => :'statut',
    :'resultat' => :'resultat'
  }
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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/factpulse/models/statut_tache.rb', line 188

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



77
78
79
80
81
 
# File 'lib/factpulse/models/statut_tache.rb', line 77

def self.openapi_nullable
  Set.new([
    :'resultat'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
 
# File 'lib/factpulse/models/statut_tache.rb', line 68

def self.openapi_types
  {
    :'id_tache' => :'String',
    :'statut' => :'StatutCelery',
    :'resultat' => :'Hash<String, Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
 
# File 'lib/factpulse/models/statut_tache.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id_tache == o.id_tache &&
      statut == o.statut &&
      resultat == o.resultat
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


175
176
177
 
# File 'lib/factpulse/models/statut_tache.rb', line 175

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



181
182
183
 
# File 'lib/factpulse/models/statut_tache.rb', line 181

def hash
  [id_tache, statut, resultat].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



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/factpulse/models/statut_tache.rb', line 120

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

  if @statut.nil?
    invalid_properties.push('invalid value for "statut", statut 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



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/factpulse/models/statut_tache.rb', line 210

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
 
# File 'lib/factpulse/models/statut_tache.rb', line 136

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id_tache.nil?
  return false if @statut.nil?
  true
end