Class: Fastly::ConditionApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConditionApi

Returns a new instance of ConditionApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_condition(opts = {}) ⇒ ConditionResponse

Create a condition Creates a new condition.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :comment (String) —

    A freeform descriptive note.

  • :name (String) —

    Name of the condition. Required.

  • :priority (String) —

    A numeric string. Priority determines execution order. Lower numbers execute first. (default to ‘100’)

  • :statement (String) —

    A conditional expression in VCL used to determine if the condition is met.

  • :service_id (String)
  • :version (String) —

    A numeric string that represents the service version.

  • :type (String) —

    Type of the condition. Required.

Returns:



32
33
34
35
 
# File 'lib/fastly/api/condition_api.rb', line 32

def create_condition(opts = {})
  data, _status_code, _headers = create_condition_with_http_info(opts)
  data
end

#create_condition_with_http_info(opts = {}) ⇒ Array<(ConditionResponse, Integer, Hash)>

Create a condition Creates a new condition.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :comment (String) —

    A freeform descriptive note.

  • :name (String) —

    Name of the condition. Required.

  • :priority (String) —

    A numeric string. Priority determines execution order. Lower numbers execute first. (default to ‘100’)

  • :statement (String) —

    A conditional expression in VCL used to determine if the condition is met.

  • :service_id (String)
  • :version (String) —

    A numeric string that represents the service version.

  • :type (String) —

    Type of the condition. Required.

Returns:

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

    ConditionResponse data, response status code and response headers



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/fastly/api/condition_api.rb', line 49

def create_condition_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConditionApi.create_condition ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling ConditionApi.create_condition"
  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 ConditionApi.create_condition"
  end
  allowable_values = ["REQUEST", "CACHE", "RESPONSE", "PREFETCH"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/condition'.sub('{' + 'service_id' + '}', CGI.escape(service_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['comment'] = opts[:'comment'] if !opts[:'comment'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['priority'] = opts[:'priority'] if !opts[:'priority'].nil?
  form_params['statement'] = opts[:'statement'] if !opts[:'statement'].nil?
  form_params['service_id'] = opts[:'service_id'] if !opts[:'service_id'].nil?
  form_params['version'] = opts[:'version'] if !opts[:'version'].nil?
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?

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

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

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

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

#delete_condition(opts = {}) ⇒ InlineResponse200

Delete a condition Deletes the specified condition.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :condition_name (String) —

    Name of the condition. Required. (required)

Returns:



126
127
128
129
 
# File 'lib/fastly/api/condition_api.rb', line 126

def delete_condition(opts = {})
  data, _status_code, _headers = delete_condition_with_http_info(opts)
  data
end

#delete_condition_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Delete a condition Deletes the specified condition.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :condition_name (String) —

    Name of the condition. Required. (required)

Returns:

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

    InlineResponse200 data, response status code and response headers



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
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
 
# File 'lib/fastly/api/condition_api.rb', line 137

def delete_condition_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConditionApi.delete_condition ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  condition_name = opts[:'condition_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling ConditionApi.delete_condition"
  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 ConditionApi.delete_condition"
  end
  # verify the required parameter 'condition_name' is set
  if @api_client.config.client_side_validation && condition_name.nil?
    fail ArgumentError, "Missing the required parameter 'condition_name' when calling ConditionApi.delete_condition"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/condition/{condition_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'condition_name' + '}', CGI.escape(condition_name.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] || 'InlineResponse200'

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

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

#get_condition(opts = {}) ⇒ ConditionResponse

Describe a condition Gets the specified condition.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :condition_name (String) —

    Name of the condition. Required. (required)

Returns:



203
204
205
206
 
# File 'lib/fastly/api/condition_api.rb', line 203

def get_condition(opts = {})
  data, _status_code, _headers = get_condition_with_http_info(opts)
  data
end

#get_condition_with_http_info(opts = {}) ⇒ Array<(ConditionResponse, Integer, Hash)>

Describe a condition Gets the specified condition.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :condition_name (String) —

    Name of the condition. Required. (required)

Returns:

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

    ConditionResponse data, response status code and response headers



214
215
216
217
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
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/fastly/api/condition_api.rb', line 214

def get_condition_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConditionApi.get_condition ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  condition_name = opts[:'condition_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling ConditionApi.get_condition"
  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 ConditionApi.get_condition"
  end
  # verify the required parameter 'condition_name' is set
  if @api_client.config.client_side_validation && condition_name.nil?
    fail ArgumentError, "Missing the required parameter 'condition_name' when calling ConditionApi.get_condition"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/condition/{condition_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'condition_name' + '}', CGI.escape(condition_name.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] || 'ConditionResponse'

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

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

#list_conditions(opts = {}) ⇒ Array<ConditionResponse>

List conditions Gets all conditions for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:



279
280
281
282
 
# File 'lib/fastly/api/condition_api.rb', line 279

def list_conditions(opts = {})
  data, _status_code, _headers = list_conditions_with_http_info(opts)
  data
end

#list_conditions_with_http_info(opts = {}) ⇒ Array<(Array<ConditionResponse>, Integer, Hash)>

List conditions Gets all conditions for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:

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

    Array<ConditionResponse> data, response status code and response headers



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
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/fastly/api/condition_api.rb', line 289

def list_conditions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConditionApi.list_conditions ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling ConditionApi.list_conditions"
  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 ConditionApi.list_conditions"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/condition'.sub('{' + 'service_id' + '}', CGI.escape(service_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] || 'Array<ConditionResponse>'

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

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

#update_condition(opts = {}) ⇒ ConditionResponse

Update a condition Updates the specified condition.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :condition_name (String) —

    Name of the condition. Required. (required)

  • :comment (String) —

    A freeform descriptive note.

  • :name (String) —

    Name of the condition. Required.

  • :priority (String) —

    A numeric string. Priority determines execution order. Lower numbers execute first. (default to ‘100’)

  • :statement (String) —

    A conditional expression in VCL used to determine if the condition is met.

  • :service_id (String)
  • :version (String) —

    A numeric string that represents the service version.

  • :type (String) —

    Type of the condition. Required.

Returns:



357
358
359
360
 
# File 'lib/fastly/api/condition_api.rb', line 357

def update_condition(opts = {})
  data, _status_code, _headers = update_condition_with_http_info(opts)
  data
end

#update_condition_with_http_info(opts = {}) ⇒ Array<(ConditionResponse, Integer, Hash)>

Update a condition Updates the specified condition.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :condition_name (String) —

    Name of the condition. Required. (required)

  • :comment (String) —

    A freeform descriptive note.

  • :name (String) —

    Name of the condition. Required.

  • :priority (String) —

    A numeric string. Priority determines execution order. Lower numbers execute first. (default to ‘100’)

  • :statement (String) —

    A conditional expression in VCL used to determine if the condition is met.

  • :service_id (String)
  • :version (String) —

    A numeric string that represents the service version.

  • :type (String) —

    Type of the condition. Required.

Returns:

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

    ConditionResponse data, response status code and response headers



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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/fastly/api/condition_api.rb', line 375

def update_condition_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConditionApi.update_condition ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  condition_name = opts[:'condition_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling ConditionApi.update_condition"
  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 ConditionApi.update_condition"
  end
  # verify the required parameter 'condition_name' is set
  if @api_client.config.client_side_validation && condition_name.nil?
    fail ArgumentError, "Missing the required parameter 'condition_name' when calling ConditionApi.update_condition"
  end
  allowable_values = ["REQUEST", "CACHE", "RESPONSE", "PREFETCH"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/condition/{condition_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'condition_name' + '}', CGI.escape(condition_name.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/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['comment'] = opts[:'comment'] if !opts[:'comment'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['priority'] = opts[:'priority'] if !opts[:'priority'].nil?
  form_params['statement'] = opts[:'statement'] if !opts[:'statement'].nil?
  form_params['service_id'] = opts[:'service_id'] if !opts[:'service_id'].nil?
  form_params['version'] = opts[:'version'] if !opts[:'version'].nil?
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?

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

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

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

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