Class: Fastly::GzipApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GzipApi

Returns a new instance of GzipApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_gzip_config(opts = {}) ⇒ GzipResponse

Create a gzip configuration Create a named gzip configuration on 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)

  • :cache_condition (String) —

    Name of the cache condition controlling when this configuration applies.

  • :content_types (String) —

    Space-separated list of content types to compress. If you omit this field a default list will be used.

  • :extensions (String) —

    Space-separated list of file extensions to compress. If you omit this field a default list will be used.

  • :name (String) —

    Name of the gzip configuration.

Returns:



29
30
31
32
 
# File 'lib/fastly/api/gzip_api.rb', line 29

def create_gzip_config(opts = {})
  data, _status_code, _headers = create_gzip_config_with_http_info(opts)
  data
end

#create_gzip_config_with_http_info(opts = {}) ⇒ Array<(GzipResponse, Integer, Hash)>

Create a gzip configuration Create a named gzip configuration on 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)

  • :cache_condition (String) —

    Name of the cache condition controlling when this configuration applies.

  • :content_types (String) —

    Space-separated list of content types to compress. If you omit this field a default list will be used.

  • :extensions (String) —

    Space-separated list of file extensions to compress. If you omit this field a default list will be used.

  • :name (String) —

    Name of the gzip configuration.

Returns:

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

    GzipResponse data, response status code and response headers



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/fastly/api/gzip_api.rb', line 43

def create_gzip_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GzipApi.create_gzip_config ...'
  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 GzipApi.create_gzip_config"
  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 GzipApi.create_gzip_config"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/gzip'.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['cache_condition'] = opts[:'cache_condition'] if !opts[:'cache_condition'].nil?
  form_params['content_types'] = opts[:'content_types'] if !opts[:'content_types'].nil?
  form_params['extensions'] = opts[:'extensions'] if !opts[:'extensions'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

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

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

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

#delete_gzip_config(opts = {}) ⇒ InlineResponse200

Delete a gzip configuration Delete a named gzip configuration on 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)

  • :gzip_name (String) —

    Name of the gzip configuration. (required)

Returns:



113
114
115
116
 
# File 'lib/fastly/api/gzip_api.rb', line 113

def delete_gzip_config(opts = {})
  data, _status_code, _headers = delete_gzip_config_with_http_info(opts)
  data
end

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

Delete a gzip configuration Delete a named gzip configuration on 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)

  • :gzip_name (String) —

    Name of the gzip configuration. (required)

Returns:

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

    InlineResponse200 data, response status code and response headers



124
125
126
127
128
129
130
131
132
133
134
135
136
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
 
# File 'lib/fastly/api/gzip_api.rb', line 124

def delete_gzip_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GzipApi.delete_gzip_config ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  gzip_name = opts[:'gzip_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 GzipApi.delete_gzip_config"
  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 GzipApi.delete_gzip_config"
  end
  # verify the required parameter 'gzip_name' is set
  if @api_client.config.client_side_validation && gzip_name.nil?
    fail ArgumentError, "Missing the required parameter 'gzip_name' when calling GzipApi.delete_gzip_config"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/gzip/{gzip_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'gzip_name' + '}', CGI.escape(gzip_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 => :"GzipApi.delete_gzip_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: GzipApi#delete_gzip_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_gzip_configs(opts = {}) ⇒ GzipResponse

Get a gzip configuration Get the gzip configuration for a particular service, version, and name.

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)

  • :gzip_name (String) —

    Name of the gzip configuration. (required)

Returns:



190
191
192
193
 
# File 'lib/fastly/api/gzip_api.rb', line 190

def get_gzip_configs(opts = {})
  data, _status_code, _headers = get_gzip_configs_with_http_info(opts)
  data
end

#get_gzip_configs_with_http_info(opts = {}) ⇒ Array<(GzipResponse, Integer, Hash)>

Get a gzip configuration Get the gzip configuration for a particular service, version, and name.

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)

  • :gzip_name (String) —

    Name of the gzip configuration. (required)

Returns:

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

    GzipResponse data, response status code and response headers



201
202
203
204
205
206
207
208
209
210
211
212
213
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
 
# File 'lib/fastly/api/gzip_api.rb', line 201

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

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

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

#list_gzip_configs(opts = {}) ⇒ Array<GzipResponse>

List gzip configurations List all gzip configurations 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:



266
267
268
269
 
# File 'lib/fastly/api/gzip_api.rb', line 266

def list_gzip_configs(opts = {})
  data, _status_code, _headers = list_gzip_configs_with_http_info(opts)
  data
end

#list_gzip_configs_with_http_info(opts = {}) ⇒ Array<(Array<GzipResponse>, Integer, Hash)>

List gzip configurations List all gzip configurations 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<GzipResponse>, Integer, Hash)>) —

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



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

def list_gzip_configs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GzipApi.list_gzip_configs ...'
  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 GzipApi.list_gzip_configs"
  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 GzipApi.list_gzip_configs"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/gzip'.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<GzipResponse>'

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

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

#update_gzip_config(opts = {}) ⇒ GzipResponse

Update a gzip configuration Update a named gzip configuration on 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)

  • :gzip_name (String) —

    Name of the gzip configuration. (required)

  • :cache_condition (String) —

    Name of the cache condition controlling when this configuration applies.

  • :content_types (String) —

    Space-separated list of content types to compress. If you omit this field a default list will be used.

  • :extensions (String) —

    Space-separated list of file extensions to compress. If you omit this field a default list will be used.

  • :name (String) —

    Name of the gzip configuration.

Returns:



341
342
343
344
 
# File 'lib/fastly/api/gzip_api.rb', line 341

def update_gzip_config(opts = {})
  data, _status_code, _headers = update_gzip_config_with_http_info(opts)
  data
end

#update_gzip_config_with_http_info(opts = {}) ⇒ Array<(GzipResponse, Integer, Hash)>

Update a gzip configuration Update a named gzip configuration on 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)

  • :gzip_name (String) —

    Name of the gzip configuration. (required)

  • :cache_condition (String) —

    Name of the cache condition controlling when this configuration applies.

  • :content_types (String) —

    Space-separated list of content types to compress. If you omit this field a default list will be used.

  • :extensions (String) —

    Space-separated list of file extensions to compress. If you omit this field a default list will be used.

  • :name (String) —

    Name of the gzip configuration.

Returns:

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

    GzipResponse data, response status code and response headers



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
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
419
420
421
422
423
 
# File 'lib/fastly/api/gzip_api.rb', line 356

def update_gzip_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GzipApi.update_gzip_config ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  gzip_name = opts[:'gzip_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 GzipApi.update_gzip_config"
  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 GzipApi.update_gzip_config"
  end
  # verify the required parameter 'gzip_name' is set
  if @api_client.config.client_side_validation && gzip_name.nil?
    fail ArgumentError, "Missing the required parameter 'gzip_name' when calling GzipApi.update_gzip_config"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/gzip/{gzip_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'gzip_name' + '}', CGI.escape(gzip_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['cache_condition'] = opts[:'cache_condition'] if !opts[:'cache_condition'].nil?
  form_params['content_types'] = opts[:'content_types'] if !opts[:'content_types'].nil?
  form_params['extensions'] = opts[:'extensions'] if !opts[:'extensions'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

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

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

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