Class: AkamaiApi::CCU::PurgeStatus::Response

Inherits:
BaseResponse show all
Defined in:
lib/akamai_api/ccu/purge_status/response.rb

Overview

This class represents a successful response and details a purge request status

Instance Attribute Summary

Attributes inherited from BaseResponse

#raw

Instance Method Summary collapse

Methods inherited from BaseResponse

#code, #initialize, #support_id

Constructor Details

This class inherits a constructor from AkamaiApi::CCU::BaseResponse

Instance Method Details

#completed_at ⇒ Time? Also known as: completion_time

The time the request was completed

Returns:

  • (Time) —

    the time the request was completed

  • (nil) —

    when the request has not been completed (= its status isn’t ‘Done’)



47
48
49
 
# File 'lib/akamai_api/ccu/purge_status/response.rb', line 47

def completed_at
  raw['completionTime'] && Time.iso8601(raw['completionTime'])
end

#original_estimated_time ⇒ Fixnum Also known as: original_estimated_seconds

Returns Estimated time (in seconds) for the operation to be completed, calculated when the request was submitted.

Returns:

  • (Fixnum) —

    Estimated time (in seconds) for the operation to be completed, calculated when the request was submitted



34
35
36
 
# File 'lib/akamai_api/ccu/purge_status/response.rb', line 34

def original_estimated_time
  raw['originalEstimatedSeconds']
end

#original_queue_length ⇒ Fixnum

Returns Number of jobs in queue, calculated when the request was submitted.

Returns:

  • (Fixnum) —

    Number of jobs in queue, calculated when the request was submitted



40
41
42
 
# File 'lib/akamai_api/ccu/purge_status/response.rb', line 40

def original_queue_length
  raw['originalQueueLength']
end

#progress_uri ⇒ String Also known as: uri

Returns URI to use to check the status of the request.

Returns:

  • (String) —

    URI to use to check the status of the request



7
8
9
 
# File 'lib/akamai_api/ccu/purge_status/response.rb', line 7

def progress_uri
  raw['progressUri']
end

#purge_id ⇒ String

Purge Request identifier

Returns:

  • (String) —

    Purge Request identifier



14
15
16
 
# File 'lib/akamai_api/ccu/purge_status/response.rb', line 14

def purge_id
  raw['purgeId']
end

#purge_status ⇒ 'In-Progress', ... Also known as: status

Status of the purge request

Returns:

  • ('In-Progress') —

    when the request is in progress

  • ('Done') —

    when the request has been completed

  • ('Unknown') 


22
23
24
 
# File 'lib/akamai_api/ccu/purge_status/response.rb', line 22

def purge_status
  raw['purgeStatus']
end

#submitted_at ⇒ Time? Also known as: submission_time

The time the request was accepted

Returns:

  • (Time) —

    the time the request was accepted

  • (nil) —

    when the request is still not accepted (= its status is neither ‘Done’ nor ‘In-Progress’)



60
61
62
 
# File 'lib/akamai_api/ccu/purge_status/response.rb', line 60

def submitted_at
  raw['submissionTime'] && Time.iso8601(raw['submissionTime'])
end

#submitted_by ⇒ String

Returns The request author name.

Returns:

  • (String) —

    The request author name



53
54
55
 
# File 'lib/akamai_api/ccu/purge_status/response.rb', line 53

def submitted_by
  raw['submittedBy']
end

#time_to_wait ⇒ Fixnum Also known as: ping_after_seconds

Returns Suggested time to wait (in seconds) before asking the status again.

Returns:

  • (Fixnum) —

    Suggested time to wait (in seconds) before asking the status again



28
29
30
 
# File 'lib/akamai_api/ccu/purge_status/response.rb', line 28

def time_to_wait
  raw['pingAfterSeconds']
end