Class: AkamaiApi::ECCU::FindRequest

Inherits:
BaseEditRequest show all
Defined in:
lib/akamai_api/eccu/find_request.rb

Overview

The FindRequest class is used to get the details of an ECCU request.

Examples:

begin
  res = AkamaiApi::ECCU::FindRequest.execute 12345, false
  puts "Request found, in status #{res.status[:message]}"
rescue AkamaiApi::Unauthorized
  puts "Invalid credentials"
rescue AkamaiApi::NotFound
  puts "No request found with the given code"
end

Instance Attribute Summary

Attributes inherited from BaseEditRequest

#code

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseEditRequest

#initialize, #with_soap_error_handling

Methods inherited from BaseRequest

#client, #client_call, #with_soap_error_handling

Constructor Details

This class inherits a constructor from AkamaiApi::ECCU::BaseEditRequest

Class Method Details

.execute(code, retrieve_content = false) ⇒ FindResponse

Returns the details of an ECCU request

Parameters:

  • code (Fixnum) —

    request code

  • retrieve_content (true, false) (defaults to: false) —

    set to true if you want to retrieve request content too

Returns:



21
22
23
 
# File 'lib/akamai_api/eccu/find_request.rb', line 21

def self.execute code, retrieve_content = false
  new(code).execute(retrieve_content)
end

Instance Method Details

#execute(retrieve_content = false) ⇒ FindResponse

Returns the details of an ECCU request

Parameters:

  • retrieve_content (true, false) (defaults to: false) —

    set to true if you want to retrieve request content too

Returns:



28
29
30
31
32
33
 
# File 'lib/akamai_api/eccu/find_request.rb', line 28

def execute retrieve_content = false
  with_soap_error_handling do
    response = client_call :get_info, message: request_body(retrieve_content).to_s
    FindResponse.new response[:eccu_info]
  end
end

#request_body(retrieve_content) ⇒ SoapBody (protected)

Creates the request body filling it with all necessary arguments

Returns:



39
40
41
42
43
 
# File 'lib/akamai_api/eccu/find_request.rb', line 39

def request_body retrieve_content
  super do |block|
    block.boolean :retrieveContents, retrieve_content == true
  end
end