Module: Controls::Client::Trends

Included in:
Controls::Client
Defined in:
lib/controls/client/trends.rb

Overview

A module to encapsulate API methods related to trends

Since:

  • API v1.0

Version:

  • v1.0.1

Trending Methods collapse

Instance Method Details

Returns a list of hashes representing trending data over time.

Parameters:

  • configuration (String) —

    the name of the configuration for which to receive trending for

Returns:

  • (Array<Hash>) —

    a list of hashes representing trending data over time

Since:

  • API v1.0



13
14
15
 
# File 'lib/controls/client/trends.rb', line 13

def configuration_trends(configuration)
  get "/configurations/#{configuration}/trend"
end

#threat_trends(threat) ⇒ Array<Hash> Also known as: trends_by_threat

Returns a list of hashes representing trending data over time.

Parameters:

  • threat (String) —

    the name of the threat for which to receive trending for

Returns:

  • (Array<Hash>) —

    a list of hashes representing trending data over time

Since:

  • API v1.0



22
23
24
 
# File 'lib/controls/client/trends.rb', line 22

def threat_trends(threat)
  get "/threats/#{threat}/trend"
end

#threat_vector_trends(threat_vector) ⇒ Array<Hash> Also known as: trends_by_threat_vector

Returns a list of hashes representing trending data over time.

Parameters:

  • threat_vector (String) —

    the name of the threat_vector for which to receive trending for

Returns:

  • (Array<Hash>) —

    a list of hashes representing trending data over time

Since:

  • API v1.0



31
32
33
 
# File 'lib/controls/client/trends.rb', line 31

def threat_vector_trends(threat_vector)
  get "/threat_vectors/#{threat_vector}/trend"
end