Class: CloudmersiveConvertApiClient::ConvertDocumentJobStatusResult

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb

Overview

Result of performing a batch job operation

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConvertDocumentJobStatusResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.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?(:'Successful')
    self.successful = attributes[:'Successful']
  end

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

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

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

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

Instance Attribute Details

#async_job_id ⇒ Object

When the job exceeds 25 pages, an Async Job ID is returned. Use the CheckPdfOcrJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes



25
26
27
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 25

def async_job_id
  @async_job_id
end

#async_job_status ⇒ Object

Returns the job status of the Async Job, if applicable. Possible states are STARTED and COMPLETED



22
23
24
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 22

def async_job_status
  @async_job_status
end

#error_message ⇒ Object

Error message (if any)



31
32
33
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 31

def error_message
  @error_message
end

#output_file_result ⇒ Object

Output file result (if applicable)



28
29
30
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 28

def output_file_result
  @output_file_result
end

#successful ⇒ Object

Tru eif the operation to check the status of the job was successful, false otherwise



19
20
21
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 19

def successful
  @successful
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 34

def self.attribute_map
  {
    :'successful' => :'Successful',
    :'async_job_status' => :'AsyncJobStatus',
    :'async_job_id' => :'AsyncJobID',
    :'output_file_result' => :'OutputFileResult',
    :'error_message' => :'ErrorMessage'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 45

def self.swagger_types
  {
    :'successful' => :'BOOLEAN',
    :'async_job_status' => :'String',
    :'async_job_id' => :'String',
    :'output_file_result' => :'String',
    :'error_message' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



114
115
116
117
118
119
120
121
122
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 114

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      successful == o.successful &&
      async_job_status == o.async_job_status &&
      async_job_id == o.async_job_id &&
      output_file_result == o.output_file_result &&
      error_message == o.error_message
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 160

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 = CloudmersiveConvertApiClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 226

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 139

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 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


126
127
128
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 126

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



132
133
134
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 132

def hash
  [successful, async_job_status, async_job_id, output_file_result, error_message].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



86
87
88
89
90
91
92
93
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 86

def list_invalid_properties
  invalid_properties = Array.new
  if !@output_file_result.nil? && @output_file_result !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
    invalid_properties.push('invalid value for "output_file_result", must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 206

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



212
213
214
215
216
217
218
219
220
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 212

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



200
201
202
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 200

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



97
98
99
100
 
# File 'lib/cloudmersive-convert-api-client/models/convert_document_job_status_result.rb', line 97

def valid?
  return false if !@output_file_result.nil? && @output_file_result !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
  true
end