Class: Fastly::ObservabilityCustomDashboardsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ObservabilityCustomDashboardsApi

Returns a new instance of ObservabilityCustomDashboardsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_dashboard(opts = {}) ⇒ Dashboard

Create a new dashboard Create a new dashboard

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



24
25
26
27
 
# File 'lib/fastly/api/observability_custom_dashboards_api.rb', line 24

def create_dashboard(opts = {})
  data, _status_code, _headers = create_dashboard_with_http_info(opts)
  data
end

#create_dashboard_with_http_info(opts = {}) ⇒ Array<(Dashboard, Integer, Hash)>

Create a new dashboard Create a new dashboard

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:

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

    Dashboard data, response status code and response headers



33
34
35
36
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
 
# File 'lib/fastly/api/observability_custom_dashboards_api.rb', line 33

def create_dashboard_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObservabilityCustomDashboardsApi.create_dashboard ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/observability/dashboards'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_dashboard_request'])

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

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

  new_options = opts.merge(
    :operation => :"ObservabilityCustomDashboardsApi.create_dashboard",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObservabilityCustomDashboardsApi#create_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dashboard(opts = {}) ⇒ nil

Delete an existing dashboard Delete an existing dashboard

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :dashboard_id (String) — default: required

Returns:

  • (nil) 


87
88
89
90
 
# File 'lib/fastly/api/observability_custom_dashboards_api.rb', line 87

def delete_dashboard(opts = {})
  delete_dashboard_with_http_info(opts)
  nil
end

#delete_dashboard_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an existing dashboard Delete an existing dashboard

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :dashboard_id (String) — default: required

Returns:

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

    nil, response status code and response headers



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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/fastly/api/observability_custom_dashboards_api.rb', line 96

def delete_dashboard_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObservabilityCustomDashboardsApi.delete_dashboard ...'
  end
  # unbox the parameters from the hash
  dashboard_id = opts[:'dashboard_id']
  # verify the required parameter 'dashboard_id' is set
  if @api_client.config.client_side_validation && dashboard_id.nil?
    fail ArgumentError, "Missing the required parameter 'dashboard_id' when calling ObservabilityCustomDashboardsApi.delete_dashboard"
  end
  # resource path
  local_var_path = '/observability/dashboards/{dashboard_id}'.sub('{' + 'dashboard_id' + '}', CGI.escape(dashboard_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"ObservabilityCustomDashboardsApi.delete_dashboard",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObservabilityCustomDashboardsApi#delete_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dashboard(opts = {}) ⇒ Dashboard

Retrieve a dashboard by ID Retrieve a dashboard by ID

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :dashboard_id (String) — default: required

Returns:



148
149
150
151
 
# File 'lib/fastly/api/observability_custom_dashboards_api.rb', line 148

def get_dashboard(opts = {})
  data, _status_code, _headers = get_dashboard_with_http_info(opts)
  data
end

#get_dashboard_with_http_info(opts = {}) ⇒ Array<(Dashboard, Integer, Hash)>

Retrieve a dashboard by ID Retrieve a dashboard by ID

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :dashboard_id (String) — default: required

Returns:

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

    Dashboard data, response status code and response headers



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/fastly/api/observability_custom_dashboards_api.rb', line 157

def get_dashboard_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObservabilityCustomDashboardsApi.get_dashboard ...'
  end
  # unbox the parameters from the hash
  dashboard_id = opts[:'dashboard_id']
  # verify the required parameter 'dashboard_id' is set
  if @api_client.config.client_side_validation && dashboard_id.nil?
    fail ArgumentError, "Missing the required parameter 'dashboard_id' when calling ObservabilityCustomDashboardsApi.get_dashboard"
  end
  # resource path
  local_var_path = '/observability/dashboards/{dashboard_id}'.sub('{' + 'dashboard_id' + '}', CGI.escape(dashboard_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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] || 'Dashboard'

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

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

#list_dashboards(opts = {}) ⇒ ListDashboardsResponse

List all custom dashboards List all custom dashboards

Returns:



210
211
212
213
 
# File 'lib/fastly/api/observability_custom_dashboards_api.rb', line 210

def list_dashboards(opts = {})
  data, _status_code, _headers = list_dashboards_with_http_info(opts)
  data
end

#list_dashboards_with_http_info(opts = {}) ⇒ Array<(ListDashboardsResponse, Integer, Hash)>

List all custom dashboards List all custom dashboards

Returns:

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

    ListDashboardsResponse data, response status code and response headers



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/fastly/api/observability_custom_dashboards_api.rb', line 218

def list_dashboards_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObservabilityCustomDashboardsApi.list_dashboards ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/observability/dashboards'

  # query parameters
  query_params = opts[:query_params] || {}

  # 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] || 'ListDashboardsResponse'

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

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

#update_dashboard(opts = {}) ⇒ Dashboard

Update an existing dashboard Update an existing dashboard

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



268
269
270
271
 
# File 'lib/fastly/api/observability_custom_dashboards_api.rb', line 268

def update_dashboard(opts = {})
  data, _status_code, _headers = update_dashboard_with_http_info(opts)
  data
end

#update_dashboard_with_http_info(opts = {}) ⇒ Array<(Dashboard, Integer, Hash)>

Update an existing dashboard Update an existing dashboard

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:

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

    Dashboard data, response status code and response headers



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/fastly/api/observability_custom_dashboards_api.rb', line 278

def update_dashboard_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObservabilityCustomDashboardsApi.update_dashboard ...'
  end
  # unbox the parameters from the hash
  dashboard_id = opts[:'dashboard_id']
  # verify the required parameter 'dashboard_id' is set
  if @api_client.config.client_side_validation && dashboard_id.nil?
    fail ArgumentError, "Missing the required parameter 'dashboard_id' when calling ObservabilityCustomDashboardsApi.update_dashboard"
  end
  # resource path
  local_var_path = '/observability/dashboards/{dashboard_id}'.sub('{' + 'dashboard_id' + '}', CGI.escape(dashboard_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_dashboard_request'])

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

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

  new_options = opts.merge(
    :operation => :"ObservabilityCustomDashboardsApi.update_dashboard",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObservabilityCustomDashboardsApi#update_dashboard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end