Class: AkamaiApi::ECCU::DestroyRequest

Inherits:

BaseEditRequest

• Object
• BaseRequest
• BaseEditRequest
• AkamaiApi::ECCU::DestroyRequest

Defined in:

lib/akamai_api/eccu/destroy_request.rb

Overview

The DestroyRequest class is used to delete an ECCU request.

Examples:

AkamaiApi::ECCU::DestroyRequest.execute(12345)

Instance Attribute Summary

Attributes inherited from BaseEditRequest

#code

Class Method Summary

• .execute(code) ⇒ true, false

  Deletes an ECCU request.

Instance Method Summary

• #execute ⇒ true, false

  Deletes an ECCU request.

Methods inherited from BaseEditRequest

#initialize, #request_body, #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) ⇒ true, false

Deletes an ECCU request

Parameters:

• code (Fixnum) —

  request code

Returns:

• (true) —

  when the request has been deleted

• (false) —

  when the request cannot be deleted

Raises:

• (AkamaiApi::Unauthorized) —

  when login credentials are invalid

• (AkamaiApi::ECCU::NotFound) —

  when no request can be found with the given code

# File 'lib/akamai_api/eccu/destroy_request.rb', line 15

def self.execute code
  new(code).execute
end

Instance Method Details

#execute ⇒ true, false

Deletes an ECCU request

Returns:

• (true) —

  when the request has been deleted

• (false) —

  when the request cannot be deleted

Raises:

• (AkamaiApi::Unauthorized) —

  when login credentials are invalid

• (AkamaiApi::ECCU::NotFound) —

  when no request can be found with the given code

# File 'lib/akamai_api/eccu/destroy_request.rb', line 24

def execute
  with_soap_error_handling do
    client_call(:delete, message: request_body.to_s)[:success]
  end
end