Class: TaskStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/secured_cloud_api_client/task_status.rb

Overview

Status of asynchronous tasks in Secured Cloud.

@author

Alan Vella

Instance Method Summary collapse

Constructor Details

#initialize(percentageComplete, requestStateEnum, result, errorCode, errorMessage, latestTaskDescription, processDescription, createdTimestamp, lastUpdatedTimeStamp) ⇒ TaskStatus 



11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/secured_cloud_api_client/task_status.rb', line 11

def initialize(percentageComplete, requestStateEnum, result, errorCode, errorMessage, latestTaskDescription, processDescription, createdTimestamp, lastUpdatedTimeStamp)
  @percentageComplete = percentageComplete
  @requestStateEnum = requestStateEnum
  @result = result
  @errorCode = errorCode
  @errorMessage = errorMessage
  @latestTaskDescription = latestTaskDescription
  @processDescription = processDescription
  @createdTimestamp = createdTimestamp
  @lastUpdatedTimeStamp = lastUpdatedTimeStamp
end

Instance Method Details

#get_details ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/secured_cloud_api_client/task_status.rb', line 24

def get_details()
  details  = "Percentage Complete    : #{@percentageComplete}\n"
  details += "Request State          : #{@requestStateEnum}\n"
  details += "Result                 : #{@result}\n"
  details += "Error Code             : #{@errorCode}\n"
  details += "Error Message          : #{@errorMessage}\n"
  details += "Latest Task Description: #{@latestTaskDescription}\n"
  details += "Process Description    : #{@processDescription}\n"
  details += "Created Timestamp      : #{@createdTimestamp}\n"
  details += "Last Updated Timestamp : #{@lastUpdatedTimeStamp}\n"
  return details
end

#get_error_code ⇒ Object 



42
43
44
 
# File 'lib/secured_cloud_api_client/task_status.rb', line 42

def get_error_code
  return @errorCode
end

#get_error_message ⇒ Object 



47
48
49
 
# File 'lib/secured_cloud_api_client/task_status.rb', line 47

def get_error_message
  return @errorMessage
end

#get_latest_task_description ⇒ Object 



57
58
59
 
# File 'lib/secured_cloud_api_client/task_status.rb', line 57

def get_latest_task_description
  return @latestTaskDescription
end

#get_percentage_completed ⇒ Object 



52
53
54
 
# File 'lib/secured_cloud_api_client/task_status.rb', line 52

def get_percentage_completed
  return @percentageComplete
end

#get_result ⇒ Object 



38
39
40
 
# File 'lib/secured_cloud_api_client/task_status.rb', line 38

def get_result
  return (@result.nil?) ? nil : @result["resourceURL"]
end