Class: Fastly::InsightsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InsightsApi

Returns a new instance of InsightsApi.



17
18
19
 
# File 'lib/fastly/api/insights_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/insights_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_log_insights(opts = {}) ⇒ GetLogInsightsResponse

Retrieve log insights Retrieves statistics from sampled log records.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :visualization (String) — default: required
  • :service_id (String) — default: required
  • :start (String) — default: required
  • :_end (String) — default: required
  • :pops (String)
  • :domain (String)
  • :domain_exact_match (Boolean)
  • :limit (Float)

Returns:



31
32
33
34
 
# File 'lib/fastly/api/insights_api.rb', line 31

def get_log_insights(opts = {})
  data, _status_code, _headers = get_log_insights_with_http_info(opts)
  data
end

#get_log_insights_with_http_info(opts = {}) ⇒ Array<(GetLogInsightsResponse, Integer, Hash)>

Retrieve log insights Retrieves statistics from sampled log records.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :visualization (String) — default: required
  • :service_id (String) — default: required
  • :start (String) — default: required
  • :_end (String) — default: required
  • :pops (String)
  • :domain (String)
  • :domain_exact_match (Boolean)
  • :limit (Float)

Returns:

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

    GetLogInsightsResponse data, response status code and response headers



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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/fastly/api/insights_api.rb', line 47

def get_log_insights_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsightsApi.get_log_insights ...'
  end
  # unbox the parameters from the hash
  visualization = opts[:'visualization']
  service_id = opts[:'service_id']
  start = opts[:'start']
  _end = opts[:'_end']
  # verify the required parameter 'visualization' is set
  if @api_client.config.client_side_validation && visualization.nil?
    fail ArgumentError, "Missing the required parameter 'visualization' when calling InsightsApi.get_log_insights"
  end
  # verify enum value
  allowable_values = ["top-url-by-bandwidth", "bottom-url-by-cache-hit-ratio", "top-url-by-cache-hit-ratio", "country-statistics", "top-url-by-duration-sum", "top-4xx-urls", "top-5xx-urls", "top-url-by-misses", "top-url-by-requests", "top-browser-by-requests", "top-content-type-by-requests", "top-device-by-requests", "top-os-by-requests", "response-status-codes", "top-503-responses"]
  if @api_client.config.client_side_validation && !allowable_values.include?(visualization)
    fail ArgumentError, "invalid value for \"visualization\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling InsightsApi.get_log_insights"
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling InsightsApi.get_log_insights"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling InsightsApi.get_log_insights"
  end
  # resource path
  local_var_path = '/observability/log-insights'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'visualization'] = visualization
  query_params[:'service_id'] = service_id
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'pops'] = opts[:'pops'] if !opts[:'pops'].nil?
  query_params[:'domain'] = opts[:'domain'] if !opts[:'domain'].nil?
  query_params[:'domain_exact_match'] = opts[:'domain_exact_match'] if !opts[:'domain_exact_match'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'GetLogInsightsResponse'

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

  new_options = opts.merge(
    :operation => :"InsightsApi.get_log_insights",
    :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: InsightsApi#get_log_insights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end