Class: MailSafePro::JobStatusResponse

Inherits:
ApiModelBase show all
Defined in:
lib/mailsafepro/models/job_status_response.rb

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 75

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

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

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

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

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

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

Instance Attribute Details

#counts ⇒ Object

Returns the value of attribute counts.



22
23
24
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 22

def counts
  @counts
end

#error ⇒ Object

Returns the value of attribute error.



28
29
30
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 28

def error
  @error
end

#finished_at ⇒ Object

Returns the value of attribute finished_at.



26
27
28
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 26

def finished_at
  @finished_at
end

#job_id ⇒ Object

Returns the value of attribute job_id.



18
19
20
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 18

def job_id
  @job_id
end

#started_at ⇒ Object

Returns the value of attribute started_at.



24
25
26
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 24

def started_at
  @started_at
end

#status ⇒ Object

Returns the value of attribute status.



20
21
22
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 20

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



43
44
45
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 43

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



48
49
50
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 48

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 31

def self.attribute_map
  {
    :'job_id' => :'job_id',
    :'status' => :'status',
    :'counts' => :'counts',
    :'started_at' => :'started_at',
    :'finished_at' => :'finished_at',
    :'error' => :'error'
  }
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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 193

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



65
66
67
68
69
70
71
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 65

def self.openapi_nullable
  Set.new([
    :'started_at',
    :'finished_at',
    :'error'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 53

def self.openapi_types
  {
    :'job_id' => :'String',
    :'status' => :'String',
    :'counts' => :'Hash<String, Integer>',
    :'started_at' => :'String',
    :'finished_at' => :'String',
    :'error' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 167

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      job_id == o.job_id &&
      status == o.status &&
      counts == o.counts &&
      started_at == o.started_at &&
      finished_at == o.finished_at &&
      error == o.error
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


180
181
182
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 180

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



186
187
188
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 186

def hash
  [job_id, status, counts, started_at, finished_at, error].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



122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 122

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

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



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 215

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



138
139
140
141
142
143
 
# File 'lib/mailsafepro/models/job_status_response.rb', line 138

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