Class: AkamaiApi::CCU::Purge::Response

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

Overview

This class represents the response received after a successful purge request

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

#estimated_timeFixnum Also known as: estimated_seconds

Returns Estimated time (in seconds) for the operation to be completed.

Returns:

  • (Fixnum)

    Estimated time (in seconds) for the operation to be completed



26
27
28
# File 'lib/akamai_api/ccu/purge/response.rb', line 26

def estimated_time
  raw['estimatedSeconds']
end

#messageString Also known as: detail

Message detailing the response

Returns:

  • (String)

    message detailing the response.



20
21
22
# File 'lib/akamai_api/ccu/purge/response.rb', line 20

def message
  raw['detail']
end

#purge_idString

Purge Request identifier

Returns:

  • (String)

    Purge Request identifier



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

def purge_id
  raw['purgeId']
end

#time_to_waitFixnum 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



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

def time_to_wait
  raw['pingAfterSeconds']
end

#uriString Also known as: progress_uri

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

Returns:

  • (String)

    URI to use to check the status of the request



32
33
34
# File 'lib/akamai_api/ccu/purge/response.rb', line 32

def uri
  raw['progressUri']
end