Class: Fastly::DmRoutingConfigsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DmRoutingConfigsApi

Returns a new instance of DmRoutingConfigsApi.



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

def api_client
  @api_client
end

Instance Method Details

#activate_dm_routing_config_draft(opts = {}) ⇒ RoutingConfigVersionResponse

Activate the draft Activate the current draft version. The previously active version, if any, becomes inactive but is retained in version history.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required

Returns:



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

def activate_dm_routing_config_draft(opts = {})
  data, _status_code, _headers = activate_dm_routing_config_draft_with_http_info(opts)
  data
end

#activate_dm_routing_config_draft_with_http_info(opts = {}) ⇒ Array<(RoutingConfigVersionResponse, Integer, Hash)>

Activate the draft Activate the current draft version. The previously active version, if any, becomes inactive but is retained in version history.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required

Returns:



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/dm_routing_configs_api.rb', line 33

def activate_dm_routing_config_draft_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.activate_dm_routing_config_draft ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.activate_dm_routing_config_draft"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/activate'.sub('{' + 'config_id' + '}', CGI.escape(config_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] || 'RoutingConfigVersionResponse'

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

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

#create_dm_routing_config(opts = {}) ⇒ RoutingConfigResponse

Create a routing config Create a new routing config. An optional initial_version may be provided to seed the config with paths and rules in a single request, and may also be activated immediately.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



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

def create_dm_routing_config(opts = {})
  data, _status_code, _headers = create_dm_routing_config_with_http_info(opts)
  data
end

#create_dm_routing_config_path(opts = {}) ⇒ PathResponse

Create a path Add a new path to the config's draft version. If no draft exists, one is created automatically by cloning the active version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_create (PathCreate)

Returns:



151
152
153
154
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 151

def create_dm_routing_config_path(opts = {})
  data, _status_code, _headers = create_dm_routing_config_path_with_http_info(opts)
  data
end

#create_dm_routing_config_path_with_http_info(opts = {}) ⇒ Array<(PathResponse, Integer, Hash)>

Create a path Add a new path to the config's draft version. If no draft exists, one is created automatically by cloning the active version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_create (PathCreate)

Returns:

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

    PathResponse data, response status code and response headers



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
206
207
208
209
210
211
212
213
214
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 161

def create_dm_routing_config_path_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.create_dm_routing_config_path ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.create_dm_routing_config_path"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/paths'.sub('{' + 'config_id' + '}', CGI.escape(config_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[:'path_create'])

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

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

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

#create_dm_routing_config_rule(opts = {}) ⇒ RuleResponse

Create a rule Add a new rule to a path on the config's draft version. If no draft exists, one is created automatically by cloning the active version. A rule with an empty conditions array is a default (catch-all) rule and there can be at most one default rule per path.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required
  • :rule_create (RuleCreate)

Returns:



222
223
224
225
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 222

def create_dm_routing_config_rule(opts = {})
  data, _status_code, _headers = create_dm_routing_config_rule_with_http_info(opts)
  data
end

#create_dm_routing_config_rule_with_http_info(opts = {}) ⇒ Array<(RuleResponse, Integer, Hash)>

Create a rule Add a new rule to a path on the config's draft version. If no draft exists, one is created automatically by cloning the active version. A rule with an empty `conditions` array is a default (catch-all) rule and there can be at most one default rule per path.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required
  • :rule_create (RuleCreate)

Returns:

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

    RuleResponse data, response status code and response headers



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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 233

def create_dm_routing_config_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.create_dm_routing_config_rule ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  path_id = opts[:'path_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.create_dm_routing_config_rule"
  end
  # verify the required parameter 'path_id' is set
  if @api_client.config.client_side_validation && path_id.nil?
    fail ArgumentError, "Missing the required parameter 'path_id' when calling DmRoutingConfigsApi.create_dm_routing_config_rule"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/paths/{path_id}/rules'.sub('{' + 'config_id' + '}', CGI.escape(config_id.to_s)).sub('{' + 'path_id' + '}', CGI.escape(path_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[:'rule_create'])

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

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

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

#create_dm_routing_config_with_http_info(opts = {}) ⇒ Array<(RoutingConfigResponse, Integer, Hash)>

Create a routing config Create a new routing config. An optional `initial_version` may be provided to seed the config with paths and rules in a single request, and may also be activated immediately.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:

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

    RoutingConfigResponse data, 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
143
144
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 96

def create_dm_routing_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.create_dm_routing_config ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/domain-management/v1/routing-configs'

  # 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[:'routing_config'])

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

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

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

#deactivate_dm_routing_config(opts = {}) ⇒ RoutingConfigResponse

Deactivate a routing config Clear the active version designation. This is a bookkeeping operation only — it does not stop edge traffic. Minerva continues serving the last-activated version until the domain association is removed in Spotless. Only removing the routing config from the domain (via Spotless) triggers Neptune to drop the reference, which causes Minerva to stop fetching and eventually clean up the cached config. Idempotent: returns 200 even if already deactivated.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required

Returns:



297
298
299
300
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 297

def deactivate_dm_routing_config(opts = {})
  data, _status_code, _headers = deactivate_dm_routing_config_with_http_info(opts)
  data
end

#deactivate_dm_routing_config_with_http_info(opts = {}) ⇒ Array<(RoutingConfigResponse, Integer, Hash)>

Deactivate a routing config Clear the active version designation. This is a bookkeeping operation only — it does not stop edge traffic. Minerva continues serving the last-activated version until the domain association is removed in Spotless. Only removing the routing config from the domain (via Spotless) triggers Neptune to drop the reference, which causes Minerva to stop fetching and eventually clean up the cached config. Idempotent: returns 200 even if already deactivated.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required

Returns:

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

    RoutingConfigResponse data, response status code and response headers



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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 306

def deactivate_dm_routing_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.deactivate_dm_routing_config ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.deactivate_dm_routing_config"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/deactivate'.sub('{' + 'config_id' + '}', CGI.escape(config_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] || 'RoutingConfigResponse'

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

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

#delete_dm_routing_config(opts = {}) ⇒ nil

Delete a routing config Delete a routing config. By default, configs that have an active version cannot be deleted. Pass force=true to bypass the active-version check — this is destructive and will immediately stop traffic routing for any paths the config serves. The force parameter does not bypass the domain-association check; if domains are still associated, deletion is rejected with 409 regardless of force.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :force (Boolean) —

    When `true`, allows deleting a routing config that has an active version. This is destructive — traffic routing for any paths served by the config will stop immediately. (default to false)

Returns:

  • (nil) 


361
362
363
364
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 361

def delete_dm_routing_config(opts = {})
  delete_dm_routing_config_with_http_info(opts)
  nil
end

#delete_dm_routing_config_inactive_versions(opts = {}) ⇒ nil

Delete inactive versions Delete all inactive versions for a routing config. The currently active version, if any, is retained.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required

Returns:

  • (nil) 


424
425
426
427
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 424

def delete_dm_routing_config_inactive_versions(opts = {})
  delete_dm_routing_config_inactive_versions_with_http_info(opts)
  nil
end

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

Delete inactive versions Delete all inactive versions for a routing config. The currently active version, if any, is retained.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required

Returns:

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

    nil, response status code and response headers



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 433

def delete_dm_routing_config_inactive_versions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.delete_dm_routing_config_inactive_versions ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.delete_dm_routing_config_inactive_versions"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/versions/inactive'.sub('{' + 'config_id' + '}', CGI.escape(config_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 => :"DmRoutingConfigsApi.delete_dm_routing_config_inactive_versions",
    :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: DmRoutingConfigsApi#delete_dm_routing_config_inactive_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dm_routing_config_path(opts = {}) ⇒ nil

Delete a path Delete a path from the config's draft version. If no draft exists, one is created automatically by cloning the active version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required

Returns:

  • (nil) 


486
487
488
489
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 486

def delete_dm_routing_config_path(opts = {})
  delete_dm_routing_config_path_with_http_info(opts)
  nil
end

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

Delete a path Delete a path from the config's draft version. If no draft exists, one is created automatically by cloning the active version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required

Returns:

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

    nil, response status code and response headers



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 496

def delete_dm_routing_config_path_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.delete_dm_routing_config_path ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  path_id = opts[:'path_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.delete_dm_routing_config_path"
  end
  # verify the required parameter 'path_id' is set
  if @api_client.config.client_side_validation && path_id.nil?
    fail ArgumentError, "Missing the required parameter 'path_id' when calling DmRoutingConfigsApi.delete_dm_routing_config_path"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/paths/{path_id}'.sub('{' + 'config_id' + '}', CGI.escape(config_id.to_s)).sub('{' + 'path_id' + '}', CGI.escape(path_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 => :"DmRoutingConfigsApi.delete_dm_routing_config_path",
    :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: DmRoutingConfigsApi#delete_dm_routing_config_path\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dm_routing_config_rule(opts = {}) ⇒ nil

Delete a rule Delete a rule from the config's draft version. If no draft exists, one is created automatically by cloning the active version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required
  • :rule_id (String) — default: required

Returns:

  • (nil) 


555
556
557
558
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 555

def delete_dm_routing_config_rule(opts = {})
  delete_dm_routing_config_rule_with_http_info(opts)
  nil
end

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

Delete a rule Delete a rule from the config's draft version. If no draft exists, one is created automatically by cloning the active version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required
  • :rule_id (String) — default: required

Returns:

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

    nil, response status code and response headers



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 566

def delete_dm_routing_config_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.delete_dm_routing_config_rule ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  path_id = opts[:'path_id']
  rule_id = opts[:'rule_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.delete_dm_routing_config_rule"
  end
  # verify the required parameter 'path_id' is set
  if @api_client.config.client_side_validation && path_id.nil?
    fail ArgumentError, "Missing the required parameter 'path_id' when calling DmRoutingConfigsApi.delete_dm_routing_config_rule"
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling DmRoutingConfigsApi.delete_dm_routing_config_rule"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/paths/{path_id}/rules/{rule_id}'.sub('{' + 'config_id' + '}', CGI.escape(config_id.to_s)).sub('{' + 'path_id' + '}', CGI.escape(path_id.to_s)).sub('{' + 'rule_id' + '}', CGI.escape(rule_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 => :"DmRoutingConfigsApi.delete_dm_routing_config_rule",
    :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: DmRoutingConfigsApi#delete_dm_routing_config_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a routing config Delete a routing config. By default, configs that have an active version cannot be deleted. Pass `force=true` to bypass the active-version check — this is destructive and will immediately stop traffic routing for any paths the config serves. The `force` parameter does not bypass the domain-association check; if domains are still associated, deletion is rejected with 409 regardless of `force`.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :force (Boolean) —

    When `true`, allows deleting a routing config that has an active version. This is destructive — traffic routing for any paths served by the config will stop immediately. (default to false)

Returns:

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

    nil, response status code and response headers



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 371

def delete_dm_routing_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.delete_dm_routing_config ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.delete_dm_routing_config"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}'.sub('{' + 'config_id' + '}', CGI.escape(config_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?

  # 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 => :"DmRoutingConfigsApi.delete_dm_routing_config",
    :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: DmRoutingConfigsApi#delete_dm_routing_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#discard_dm_routing_config_draft(opts = {}) ⇒ nil

Discard the draft Delete the current draft version, reverting any unactivated changes.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required

Returns:

  • (nil) 


628
629
630
631
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 628

def discard_dm_routing_config_draft(opts = {})
  discard_dm_routing_config_draft_with_http_info(opts)
  nil
end

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

Discard the draft Delete the current draft version, reverting any unactivated changes.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required

Returns:

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

    nil, response status code and response headers



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 637

def discard_dm_routing_config_draft_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.discard_dm_routing_config_draft ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.discard_dm_routing_config_draft"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/draft'.sub('{' + 'config_id' + '}', CGI.escape(config_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 => :"DmRoutingConfigsApi.discard_dm_routing_config_draft",
    :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: DmRoutingConfigsApi#discard_dm_routing_config_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dm_routing_config(opts = {}) ⇒ RoutingConfigResponse

Get a routing config Retrieve a single routing config by its identifier.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required

Returns:



689
690
691
692
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 689

def get_dm_routing_config(opts = {})
  data, _status_code, _headers = get_dm_routing_config_with_http_info(opts)
  data
end

#get_dm_routing_config_draft_diff(opts = {}) ⇒ DraftDiff

Get the draft diff Compare the current draft version against the active version and return the paths and rules that have been added, modified, or deleted.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required

Returns:



752
753
754
755
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 752

def get_dm_routing_config_draft_diff(opts = {})
  data, _status_code, _headers = get_dm_routing_config_draft_diff_with_http_info(opts)
  data
end

#get_dm_routing_config_draft_diff_with_http_info(opts = {}) ⇒ Array<(DraftDiff, Integer, Hash)>

Get the draft diff Compare the current draft version against the active version and return the paths and rules that have been added, modified, or deleted.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required

Returns:

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

    DraftDiff data, response status code and response headers



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 761

def get_dm_routing_config_draft_diff_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.get_dm_routing_config_draft_diff ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.get_dm_routing_config_draft_diff"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/draft/diff'.sub('{' + 'config_id' + '}', CGI.escape(config_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] || 'DraftDiff'

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

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

#get_dm_routing_config_path(opts = {}) ⇒ PathResponse

Get a path Retrieve a single path by its stable identifier.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required

Returns:



816
817
818
819
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 816

def get_dm_routing_config_path(opts = {})
  data, _status_code, _headers = get_dm_routing_config_path_with_http_info(opts)
  data
end

#get_dm_routing_config_path_with_http_info(opts = {}) ⇒ Array<(PathResponse, Integer, Hash)>

Get a path Retrieve a single path by its stable identifier.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required

Returns:

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

    PathResponse data, response status code and response headers



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 826

def get_dm_routing_config_path_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.get_dm_routing_config_path ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  path_id = opts[:'path_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.get_dm_routing_config_path"
  end
  # verify the required parameter 'path_id' is set
  if @api_client.config.client_side_validation && path_id.nil?
    fail ArgumentError, "Missing the required parameter 'path_id' when calling DmRoutingConfigsApi.get_dm_routing_config_path"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/paths/{path_id}'.sub('{' + 'config_id' + '}', CGI.escape(config_id.to_s)).sub('{' + 'path_id' + '}', CGI.escape(path_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] || 'PathResponse'

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

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

#get_dm_routing_config_rule(opts = {}) ⇒ RuleResponse

Get a rule Retrieve a single rule by its stable identifier.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required
  • :rule_id (String) — default: required

Returns:



887
888
889
890
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 887

def get_dm_routing_config_rule(opts = {})
  data, _status_code, _headers = get_dm_routing_config_rule_with_http_info(opts)
  data
end

#get_dm_routing_config_rule_with_http_info(opts = {}) ⇒ Array<(RuleResponse, Integer, Hash)>

Get a rule Retrieve a single rule by its stable identifier.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required
  • :rule_id (String) — default: required

Returns:

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

    RuleResponse data, response status code and response headers



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 898

def get_dm_routing_config_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.get_dm_routing_config_rule ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  path_id = opts[:'path_id']
  rule_id = opts[:'rule_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.get_dm_routing_config_rule"
  end
  # verify the required parameter 'path_id' is set
  if @api_client.config.client_side_validation && path_id.nil?
    fail ArgumentError, "Missing the required parameter 'path_id' when calling DmRoutingConfigsApi.get_dm_routing_config_rule"
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling DmRoutingConfigsApi.get_dm_routing_config_rule"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/paths/{path_id}/rules/{rule_id}'.sub('{' + 'config_id' + '}', CGI.escape(config_id.to_s)).sub('{' + 'path_id' + '}', CGI.escape(path_id.to_s)).sub('{' + 'rule_id' + '}', CGI.escape(rule_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] || 'RuleResponse'

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

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

#get_dm_routing_config_with_http_info(opts = {}) ⇒ Array<(RoutingConfigResponse, Integer, Hash)>

Get a routing config Retrieve a single routing config by its identifier.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required

Returns:

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

    RoutingConfigResponse data, response status code and response headers



698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 698

def get_dm_routing_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.get_dm_routing_config ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.get_dm_routing_config"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}'.sub('{' + 'config_id' + '}', CGI.escape(config_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] || 'RoutingConfigResponse'

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

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

#list_dm_routing_config_paths(opts = {}) ⇒ PathsResponse

List paths List paths for the config. Returns paths from the active version if one exists, otherwise from the draft.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path (String) —

    Filter results by path pattern. The match strategy is controlled by the `match` parameter.

  • :match (String) —

    How to match the value of the `path` filter against existing path patterns. Has no effect unless `path` is also provided. (default to 'exact')

  • :sort (String) —

    The order in which to list the results. (default to '-created_at')

  • :cursor (String) —

    Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (Integer) —

    Limit how many results are returned. (default to 20)

Returns:



967
968
969
970
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 967

def list_dm_routing_config_paths(opts = {})
  data, _status_code, _headers = list_dm_routing_config_paths_with_http_info(opts)
  data
end

#list_dm_routing_config_paths_with_http_info(opts = {}) ⇒ Array<(PathsResponse, Integer, Hash)>

List paths List paths for the config. Returns paths from the active version if one exists, otherwise from the draft.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path (String) —

    Filter results by path pattern. The match strategy is controlled by the `match` parameter.

  • :match (String) —

    How to match the value of the `path` filter against existing path patterns. Has no effect unless `path` is also provided. (default to 'exact')

  • :sort (String) —

    The order in which to list the results. (default to '-created_at')

  • :cursor (String) —

    Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (Integer) —

    Limit how many results are returned. (default to 20)

Returns:

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

    PathsResponse data, response status code and response headers



981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 981

def list_dm_routing_config_paths_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.list_dm_routing_config_paths ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.list_dm_routing_config_paths"
  end
  allowable_values = ["exact", "starts_with", "ends_with", "contains"]
  if @api_client.config.client_side_validation && opts[:'match'] && !allowable_values.include?(opts[:'match'])
    fail ArgumentError, "invalid value for \"match\", must be one of #{allowable_values}"
  end
  allowable_values = ["created_at", "-created_at", "id", "-id", "path", "-path"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DmRoutingConfigsApi.list_dm_routing_config_paths, must be smaller than or equal to 100.'
  end

  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/paths'.sub('{' + 'config_id' + '}', CGI.escape(config_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
  query_params[:'match'] = opts[:'match'] if !opts[:'match'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].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] || 'PathsResponse'

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

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

#list_dm_routing_config_rules(opts = {}) ⇒ RulesResponse

List rules List all rules for a path in evaluation order.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required
  • :sort (String) —

    The order in which to list the results. (default to 'position')

  • :cursor (String) —

    Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (Integer) —

    Limit how many results are returned. (default to 20)

Returns:



1056
1057
1058
1059
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1056

def list_dm_routing_config_rules(opts = {})
  data, _status_code, _headers = list_dm_routing_config_rules_with_http_info(opts)
  data
end

#list_dm_routing_config_rules_with_http_info(opts = {}) ⇒ Array<(RulesResponse, Integer, Hash)>

List rules List all rules for a path in evaluation order.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required
  • :sort (String) —

    The order in which to list the results. (default to 'position')

  • :cursor (String) —

    Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (Integer) —

    Limit how many results are returned. (default to 20)

Returns:

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

    RulesResponse data, response status code and response headers



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1069

def list_dm_routing_config_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.list_dm_routing_config_rules ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  path_id = opts[:'path_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.list_dm_routing_config_rules"
  end
  # verify the required parameter 'path_id' is set
  if @api_client.config.client_side_validation && path_id.nil?
    fail ArgumentError, "Missing the required parameter 'path_id' when calling DmRoutingConfigsApi.list_dm_routing_config_rules"
  end
  allowable_values = ["created_at", "-created_at", "position", "-position"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DmRoutingConfigsApi.list_dm_routing_config_rules, must be smaller than or equal to 100.'
  end

  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/paths/{path_id}/rules'.sub('{' + 'config_id' + '}', CGI.escape(config_id.to_s)).sub('{' + 'path_id' + '}', CGI.escape(path_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].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] || 'RulesResponse'

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

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

#list_dm_routing_config_versions(opts = {}) ⇒ VersionsResponse

List versions List all versions for a routing config.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :sort (String) —

    The order in which to list the results. (default to '-activated_at')

  • :cursor (String) —

    Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (Integer) —

    Limit how many results are returned. (default to 20)

Returns:



1142
1143
1144
1145
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1142

def list_dm_routing_config_versions(opts = {})
  data, _status_code, _headers = list_dm_routing_config_versions_with_http_info(opts)
  data
end

#list_dm_routing_config_versions_with_http_info(opts = {}) ⇒ Array<(VersionsResponse, Integer, Hash)>

List versions List all versions for a routing config.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :sort (String) —

    The order in which to list the results. (default to '-activated_at')

  • :cursor (String) —

    Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (Integer) —

    Limit how many results are returned. (default to 20)

Returns:

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

    VersionsResponse data, response status code and response headers



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1154

def list_dm_routing_config_versions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.list_dm_routing_config_versions ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.list_dm_routing_config_versions"
  end
  allowable_values = ["activated_at", "-activated_at", "created_at", "-created_at"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DmRoutingConfigsApi.list_dm_routing_config_versions, must be smaller than or equal to 100.'
  end

  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/versions'.sub('{' + 'config_id' + '}', CGI.escape(config_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].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] || 'VersionsResponse'

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

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

#list_dm_routing_configs(opts = {}) ⇒ RoutingConfigsResponse

List routing configs List all routing configs for the authenticated customer.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :state (Array<String>) —

    Filter configs by lifecycle state. Accepts a comma-separated list of state values (e.g. `?state=active,active-with-draft`). Returns only configs whose current state matches one of the provided values. Returns 400 if any value is not a recognised state.

  • :sort (String) —

    The order in which to list the results. (default to '-created_at')

  • :cursor (String) —

    Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (Integer) —

    Limit how many results are returned. (default to 20)

Returns:



1222
1223
1224
1225
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1222

def list_dm_routing_configs(opts = {})
  data, _status_code, _headers = list_dm_routing_configs_with_http_info(opts)
  data
end

#list_dm_routing_configs_with_http_info(opts = {}) ⇒ Array<(RoutingConfigsResponse, Integer, Hash)>

List routing configs List all routing configs for the authenticated customer.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :state (Array<String>) —

    Filter configs by lifecycle state. Accepts a comma-separated list of state values (e.g. `?state=active,active-with-draft`). Returns only configs whose current state matches one of the provided values. Returns 400 if any value is not a recognised state.

  • :sort (String) —

    The order in which to list the results. (default to '-created_at')

  • :cursor (String) —

    Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (Integer) —

    Limit how many results are returned. (default to 20)

Returns:

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

    RoutingConfigsResponse data, response status code and response headers



1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1234

def list_dm_routing_configs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.list_dm_routing_configs ...'
  end
  # unbox the parameters from the hash
  allowable_values = ["draft-only", "active", "active-with-draft"]
  if @api_client.config.client_side_validation && opts[:'state'] && !opts[:'state'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"state\", must include one of #{allowable_values}"
  end
  allowable_values = ["created_at", "-created_at", "id", "-id", "name", "-name"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DmRoutingConfigsApi.list_dm_routing_configs, must be smaller than or equal to 100.'
  end

  # resource path
  local_var_path = '/domain-management/v1/routing-configs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'state'] = @api_client.build_collection_param(opts[:'state'], :csv) if !opts[:'state'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].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] || 'RoutingConfigsResponse'

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

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

#reactivate_dm_routing_config_version(opts = {}) ⇒ RoutingConfigVersionResponse

Reactivate a version Reactivate a previously-active version. The currently active version, if any, becomes inactive but is retained in version history.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :version_id (String) — default: required

Returns:



1300
1301
1302
1303
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1300

def reactivate_dm_routing_config_version(opts = {})
  data, _status_code, _headers = reactivate_dm_routing_config_version_with_http_info(opts)
  data
end

#reactivate_dm_routing_config_version_with_http_info(opts = {}) ⇒ Array<(RoutingConfigVersionResponse, Integer, Hash)>

Reactivate a version Reactivate a previously-active version. The currently active version, if any, becomes inactive but is retained in version history.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :version_id (String) — default: required

Returns:



1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1310

def reactivate_dm_routing_config_version_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.reactivate_dm_routing_config_version ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.reactivate_dm_routing_config_version"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling DmRoutingConfigsApi.reactivate_dm_routing_config_version"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/versions/{version_id}/activate'.sub('{' + 'config_id' + '}', CGI.escape(config_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_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] || 'RoutingConfigVersionResponse'

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

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

#update_dm_routing_config_draft(opts = {}) ⇒ RoutingConfigVersionResponse

Update the draft Update metadata on the draft version, such as its comment. If no draft exists, one is created automatically by cloning the active version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :draft_update (DraftUpdate)

Returns:



1370
1371
1372
1373
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1370

def update_dm_routing_config_draft(opts = {})
  data, _status_code, _headers = update_dm_routing_config_draft_with_http_info(opts)
  data
end

#update_dm_routing_config_draft_with_http_info(opts = {}) ⇒ Array<(RoutingConfigVersionResponse, Integer, Hash)>

Update the draft Update metadata on the draft version, such as its comment. If no draft exists, one is created automatically by cloning the active version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :draft_update (DraftUpdate)

Returns:



1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1380

def update_dm_routing_config_draft_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.update_dm_routing_config_draft ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.update_dm_routing_config_draft"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/draft'.sub('{' + 'config_id' + '}', CGI.escape(config_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[:'draft_update'])

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

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

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

#update_dm_routing_config_path(opts = {}) ⇒ PathResponse

Update a path Update a path on the config's draft version. If no draft exists, one is created automatically by cloning the active version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required
  • :path_update (PathUpdate)

Returns:



1441
1442
1443
1444
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1441

def update_dm_routing_config_path(opts = {})
  data, _status_code, _headers = update_dm_routing_config_path_with_http_info(opts)
  data
end

#update_dm_routing_config_path_with_http_info(opts = {}) ⇒ Array<(PathResponse, Integer, Hash)>

Update a path Update a path on the config's draft version. If no draft exists, one is created automatically by cloning the active version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required
  • :path_update (PathUpdate)

Returns:

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

    PathResponse data, response status code and response headers



1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1452

def update_dm_routing_config_path_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.update_dm_routing_config_path ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  path_id = opts[:'path_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.update_dm_routing_config_path"
  end
  # verify the required parameter 'path_id' is set
  if @api_client.config.client_side_validation && path_id.nil?
    fail ArgumentError, "Missing the required parameter 'path_id' when calling DmRoutingConfigsApi.update_dm_routing_config_path"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/paths/{path_id}'.sub('{' + 'config_id' + '}', CGI.escape(config_id.to_s)).sub('{' + 'path_id' + '}', CGI.escape(path_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[:'path_update'])

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

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

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

#update_dm_routing_config_rule(opts = {}) ⇒ RuleResponse

Update a rule Update a rule on the config's draft version. If no draft exists, one is created automatically by cloning the active version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required
  • :rule_id (String) — default: required
  • :rule_update (RuleUpdate)

Returns:



1519
1520
1521
1522
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1519

def update_dm_routing_config_rule(opts = {})
  data, _status_code, _headers = update_dm_routing_config_rule_with_http_info(opts)
  data
end

#update_dm_routing_config_rule_with_http_info(opts = {}) ⇒ Array<(RuleResponse, Integer, Hash)>

Update a rule Update a rule on the config's draft version. If no draft exists, one is created automatically by cloning the active version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :config_id (String) — default: required
  • :path_id (String) — default: required
  • :rule_id (String) — default: required
  • :rule_update (RuleUpdate)

Returns:

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

    RuleResponse data, response status code and response headers



1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
 
# File 'lib/fastly/api/dm_routing_configs_api.rb', line 1531

def update_dm_routing_config_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DmRoutingConfigsApi.update_dm_routing_config_rule ...'
  end
  # unbox the parameters from the hash
  config_id = opts[:'config_id']
  path_id = opts[:'path_id']
  rule_id = opts[:'rule_id']
  # verify the required parameter 'config_id' is set
  if @api_client.config.client_side_validation && config_id.nil?
    fail ArgumentError, "Missing the required parameter 'config_id' when calling DmRoutingConfigsApi.update_dm_routing_config_rule"
  end
  # verify the required parameter 'path_id' is set
  if @api_client.config.client_side_validation && path_id.nil?
    fail ArgumentError, "Missing the required parameter 'path_id' when calling DmRoutingConfigsApi.update_dm_routing_config_rule"
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling DmRoutingConfigsApi.update_dm_routing_config_rule"
  end
  # resource path
  local_var_path = '/domain-management/v1/routing-configs/{config_id}/paths/{path_id}/rules/{rule_id}'.sub('{' + 'config_id' + '}', CGI.escape(config_id.to_s)).sub('{' + 'path_id' + '}', CGI.escape(path_id.to_s)).sub('{' + 'rule_id' + '}', CGI.escape(rule_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[:'rule_update'])

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

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

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