Class: AkamaiApi::CCU::PurgeStatus::Request

Inherits:
Object
  • Object
show all
Includes:
HTTParty
Defined in:
lib/akamai_api/ccu/purge_status/request.rb

Overview

Request is used to check the status of a purge request using Akamai CCU.

Examples:

Check using AkamaiApi::CCU::Purge::Response#purge_id

purge_id # => "12345678-1234-5678-1234-123456789012"
AkamaiApi::CCU::PurgeStatus::Request.execute(purge_id)

Check using AkamaiApi::CCU::Purge::Response#progress_uri

progress_uri # => "/CCU/v2/purges/12345678-1234-5678-1234-123456789012"
AkamaiApi::CCU::PurgeStatus::Request.execute(progress_uri)

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.execute(purge_id_or_progress_uri) ⇒ Response

Checks the status of the requested associated with the given argument

Parameters:

  • purge_id_or_progress_uri (String) —

    a purge request ID or URI

Returns:

  • (Response) —

    an object detailing the response

Raises:



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

def self.execute purge_id_or_progress_uri
  new.execute purge_id_or_progress_uri
end

Instance Method Details

#execute(purge_id_or_progress_uri) ⇒ Response

Checks the status of the requested associated with the given argument

Returns:

  • (Response) —

    an object detailing the response

Raises:



37
38
39
40
41
 
# File 'lib/akamai_api/ccu/purge_status/request.rb', line 37

def execute purge_id_or_progress_uri
  purge_id_or_progress_uri = normalize_progress_uri purge_id_or_progress_uri
  response = self.class.get purge_id_or_progress_uri, basic_auth: AkamaiApi.auth
  parse_response response
end