Class: ESP::CustomSignature::Result::Alert

Inherits:
Resource show all
Defined in:
lib/esp/resources/custom_signature/result/alert.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Dirty

#changed_attributes, #original_attributes, #original_attributes=

Methods included from LoadWithOriginalAttributes

#load

Class Method Details

.find ⇒ void

This method returns an undefined value.

Not Implemented. You cannot search for CustomSignature::Result::Alert.

Regular ARELlike methods are disabled.



25
26
27
 
# File 'lib/esp/resources/custom_signature/result/alert.rb', line 25

def self.find(*)
  fail ESP::NotImplementedError, 'Regular ARELlike methods are disabled. Use the .for_result method.'
end

.for_result(custom_signature_result_id = nil) ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Result::Alert>

Returns all the alerts for a custom signature result identified by the custom_signature_result_id parameter.

Parameters:

  • custom_signature_result_id (Integer, Numeric, #to_i) (defaults to: nil) —

    Required ID of the custom signature result to retrieve alerts for

Returns:

Raises:

  • (ArgumentError) —

    if no custom_signature_result_id is supplied.



14
15
16
17
18
 
# File 'lib/esp/resources/custom_signature/result/alert.rb', line 14

def self.for_result(custom_signature_result_id = nil)
  fail ArgumentError, "You must supply a custom signature result id." unless custom_signature_result_id.present?
  # call find_every directly since find is overriden/not implemented
  find_every(from: "#{prefix}custom_signature_results/#{custom_signature_result_id}/alerts.json")
end

.where ⇒ void

This method returns an undefined value.

Not Implemented. You cannot search for CustomSignature::Result::Alert.

Regular ARELlike methods are disabled.



34
35
36
 
# File 'lib/esp/resources/custom_signature/result/alert.rb', line 34

def self.where(*)
  fail ESP::NotImplementedError, 'Regular ARELlike methods are disabled. Use the .for_result method.'
end

Instance Method Details

#create ⇒ void

This method returns an undefined value.

Not Implemented. You cannot create a CustomSignature::Result::Alert.



41
42
43
 
# File 'lib/esp/resources/custom_signature/result/alert.rb', line 41

def create
  fail ESP::NotImplementedError
end

#destroy ⇒ void

This method returns an undefined value.

Not Implemented. You cannot destroy a CustomSignature::Result::Alert.



55
56
57
 
# File 'lib/esp/resources/custom_signature/result/alert.rb', line 55

def destroy
  fail ESP::NotImplementedError
end

#update ⇒ void

This method returns an undefined value.

Not Implemented. You cannot update a CustomSignature::Result::Alert.



48
49
50
 
# File 'lib/esp/resources/custom_signature/result/alert.rb', line 48

def update
  fail ESP::NotImplementedError
end