Class: CloudConvert::Task

Inherits:
Entity show all
Defined in:
lib/cloudconvert/task.rb

Instance Attribute Summary collapse

Attributes inherited from Base

#attrs

Instance Method Summary collapse

Methods inherited from Entity

collection, result

Methods inherited from Base

attr_reader, collection_attr_reader, #initialize, object_attr_reader, predicate_attr_reader, struct_attr_reader, symbol_attr_reader, time_attr_reader

Constructor Details

This class inherits a constructor from CloudConvert::Base

Instance Attribute Details

#code ⇒ String (readonly)

Returns:

  • (String) 


4
5
6
 
# File 'lib/cloudconvert/task.rb', line 4

def code
  @code
end

#copy_of_task_id ⇒ String (readonly)

Returns:

  • (String) 


4
5
6
 
# File 'lib/cloudconvert/task.rb', line 4

def copy_of_task_id
  @copy_of_task_id
end

#engine ⇒ String (readonly)

Returns:

  • (String) 


4
5
6
 
# File 'lib/cloudconvert/task.rb', line 4

def engine
  @engine
end

#engine_version ⇒ String (readonly)

Returns:

  • (String) 


4
5
6
 
# File 'lib/cloudconvert/task.rb', line 4

def engine_version
  @engine_version
end

#host_name ⇒ String (readonly)

Returns:

  • (String) 


4
5
6
 
# File 'lib/cloudconvert/task.rb', line 4

def host_name
  @host_name
end

#id ⇒ String (readonly)

Returns:

  • (String) 


4
5
6
 
# File 'lib/cloudconvert/task.rb', line 4

def id
  @id
end

#job_id ⇒ String (readonly)

Returns:

  • (String) 


4
5
6
 
# File 'lib/cloudconvert/task.rb', line 4

def job_id
  @job_id
end

#message ⇒ String (readonly)

Returns:

  • (String) 


4
5
6
 
# File 'lib/cloudconvert/task.rb', line 4

def message
  @message
end

#name ⇒ String (readonly)

Returns:

  • (String) 


4
5
6
 
# File 'lib/cloudconvert/task.rb', line 4

def name
  @name
end

#operation ⇒ String (readonly)

Returns:

  • (String) 


4
5
6
 
# File 'lib/cloudconvert/task.rb', line 4

def operation
  @operation
end

#percent ⇒ Integer (readonly)

Returns:

  • (Integer) 


12
13
14
 
# File 'lib/cloudconvert/task.rb', line 12

def percent
  @percent
end

#priority ⇒ Integer (readonly)

Returns:

  • (Integer) 


12
13
14
 
# File 'lib/cloudconvert/task.rb', line 12

def priority
  @priority
end

#retry_of_task_id ⇒ String (readonly)

Returns:

  • (String) 


4
5
6
 
# File 'lib/cloudconvert/task.rb', line 4

def retry_of_task_id
  @retry_of_task_id
end

#storage ⇒ String (readonly)

Returns:

  • (String) 


4
5
6
 
# File 'lib/cloudconvert/task.rb', line 4

def storage
  @storage
end

Instance Method Details

#created_at ⇒ Time

Returns:

  • (Time) 


21
 
# File 'lib/cloudconvert/task.rb', line 21

time_attr_reader :created_at, :started_at, :ended_at

#error? ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/cloudconvert/task.rb', line 24

def error?
  status == :error
end

#finished? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/cloudconvert/task.rb', line 29

def finished?
  status == :finished
end

#payload ⇒ OpenStruct

Returns:

  • (OpenStruct) 


18
 
# File 'lib/cloudconvert/task.rb', line 18

struct_attr_reader :payload, :result, :links

#processing? ⇒ Boolean

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/cloudconvert/task.rb', line 34

def processing?
  status == :processing
end

#status ⇒ Symbol

Returns:

  • (Symbol) 


9
 
# File 'lib/cloudconvert/task.rb', line 9

symbol_attr_reader :status

#waiting? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/cloudconvert/task.rb', line 39

def waiting?
  status == :waiting
end