Class: Fastly::WholePlatformDdosHistoricalApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/whole_platform_ddos_historical_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WholePlatformDdosHistoricalApi

Returns a new instance of WholePlatformDdosHistoricalApi.



17
18
19
 
# File 'lib/fastly/api/whole_platform_ddos_historical_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/whole_platform_ddos_historical_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_platform_ddos_historical(opts = {}) ⇒ PlatformDdosResponse

Get historical DDoS metrics for the entire Fastly platform Fetches historical DDoS metrics for the entire Fastly platform.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :start (String) —

    A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value.

  • :_end (String) —

    A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value.

  • :downsample (String) —

    Duration of sample windows. (default to ‘hour’)

Returns:



26
27
28
29
 
# File 'lib/fastly/api/whole_platform_ddos_historical_api.rb', line 26

def get_platform_ddos_historical(opts = {})
  data, _status_code, _headers = get_platform_ddos_historical_with_http_info(opts)
  data
end

#get_platform_ddos_historical_with_http_info(opts = {}) ⇒ Array<(PlatformDdosResponse, Integer, Hash)>

Get historical DDoS metrics for the entire Fastly platform Fetches historical DDoS metrics for the entire Fastly platform.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :start (String) —

    A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided &#x60;downsample&#x60; value.

  • :_end (String) —

    A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided &#x60;downsample&#x60; value.

  • :downsample (String) —

    Duration of sample windows. (default to ‘hour’)

Returns:

  • (Array<(PlatformDdosResponse, Integer, Hash)>) —

    PlatformDdosResponse data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/fastly/api/whole_platform_ddos_historical_api.rb', line 37

def get_platform_ddos_historical_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WholePlatformDdosHistoricalApi.get_platform_ddos_historical ...'
  end
  # unbox the parameters from the hash
  allowable_values = ["hour", "day"]
  if @api_client.config.client_side_validation && opts[:'downsample'] && !allowable_values.include?(opts[:'downsample'])
    fail ArgumentError, "invalid value for \"downsample\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/metrics/platform/ddos'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'end'] = opts[:'_end'] if !opts[:'_end'].nil?
  query_params[:'downsample'] = opts[:'downsample'] if !opts[:'downsample'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PlatformDdosResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"WholePlatformDdosHistoricalApi.get_platform_ddos_historical",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WholePlatformDdosHistoricalApi#get_platform_ddos_historical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end