Class: IonoscloudDbaasPostgres::ClustersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud-dbaas-postgres/api/clusters_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ClustersApi

Returns a new instance of ClustersApi.



19
20
21
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cluster_postgres_versions_get(cluster_id, opts = {}) ⇒ PostgresVersionList

List PostgreSQL versions Retrieves a list of all PostgreSQL versions available for this cluster including the current version.

Parameters:

  • cluster_id (String) —

    The unique ID of the cluster.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 27

def cluster_postgres_versions_get(cluster_id, opts = {})
  data, _status_code, _headers = cluster_postgres_versions_get_with_http_info(cluster_id, opts)
  data
end

#cluster_postgres_versions_get_with_http_info(cluster_id, opts = {}) ⇒ Array<(PostgresVersionList, Integer, Hash)>

List PostgreSQL versions Retrieves a list of all PostgreSQL versions available for this cluster including the current version.

Parameters:

  • cluster_id (String) —

    The unique ID of the cluster.

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

    the optional parameters

Returns:

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

    PostgresVersionList data, response status code and response headers



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
82
83
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 37

def cluster_postgres_versions_get_with_http_info(cluster_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClustersApi.cluster_postgres_versions_get ...'
  end
  # verify the required parameter 'cluster_id' is set
  if @api_client.config.client_side_validation && cluster_id.nil?
    fail ArgumentError, "Missing the required parameter 'cluster_id' when calling ClustersApi.cluster_postgres_versions_get"
  end
  # resource path
  local_var_path = '/clusters/{clusterId}/postgresversions'.sub('{' + 'clusterId' + '}', CGI.escape(cluster_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] || 'PostgresVersionList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

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

#clusters_delete(cluster_id, opts = {}) ⇒ ClusterResponse

Delete a cluster Delete a PostgreSQL cluster.

Parameters:

  • cluster_id (String) —

    The unique ID of the cluster.

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 90

def clusters_delete(cluster_id, opts = {})
  data, _status_code, _headers = clusters_delete_with_http_info(cluster_id, opts)
  data
end

#clusters_delete_with_http_info(cluster_id, opts = {}) ⇒ Array<(ClusterResponse, Integer, Hash)>

Delete a cluster Delete a PostgreSQL cluster.

Parameters:

  • cluster_id (String) —

    The unique ID of the cluster.

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

    the optional parameters

Returns:

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

    ClusterResponse data, response status code and response headers



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
145
146
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 100

def clusters_delete_with_http_info(cluster_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClustersApi.clusters_delete ...'
  end
  # verify the required parameter 'cluster_id' is set
  if @api_client.config.client_side_validation && cluster_id.nil?
    fail ArgumentError, "Missing the required parameter 'cluster_id' when calling ClustersApi.clusters_delete"
  end
  # resource path
  local_var_path = '/clusters/{clusterId}'.sub('{' + 'clusterId' + '}', CGI.escape(cluster_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] || 'ClusterResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

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

#clusters_find_by_id(cluster_id, opts = {}) ⇒ ClusterResponse

Fetch a cluster You can retrieve a PostgreSQL cluster by using its ID. This value can be found in the response body when a PostgreSQL cluster is created or when you GET a list of PostgreSQL clusters.

Parameters:

  • cluster_id (String) —

    The unique ID of the cluster.

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

    the optional parameters

Returns:



153
154
155
156
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 153

def clusters_find_by_id(cluster_id, opts = {})
  data, _status_code, _headers = clusters_find_by_id_with_http_info(cluster_id, opts)
  data
end

#clusters_find_by_id_with_http_info(cluster_id, opts = {}) ⇒ Array<(ClusterResponse, Integer, Hash)>

Fetch a cluster You can retrieve a PostgreSQL cluster by using its ID. This value can be found in the response body when a PostgreSQL cluster is created or when you GET a list of PostgreSQL clusters.

Parameters:

  • cluster_id (String) —

    The unique ID of the cluster.

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

    the optional parameters

Returns:

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

    ClusterResponse data, response status code and response headers



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
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 163

def clusters_find_by_id_with_http_info(cluster_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClustersApi.clusters_find_by_id ...'
  end
  # verify the required parameter 'cluster_id' is set
  if @api_client.config.client_side_validation && cluster_id.nil?
    fail ArgumentError, "Missing the required parameter 'cluster_id' when calling ClustersApi.clusters_find_by_id"
  end
  # resource path
  local_var_path = '/clusters/{clusterId}'.sub('{' + 'clusterId' + '}', CGI.escape(cluster_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] || 'ClusterResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

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

#clusters_get(opts = {}) ⇒ ClusterList

List clusters Retrieves a list of PostgreSQL clusters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_name (String) —

    Response filter to list only the PostgreSQL clusters that contain the specified name. The value is case insensitive and matched on the &#39;displayName&#39; field.

Returns:



216
217
218
219
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 216

def clusters_get(opts = {})
  data, _status_code, _headers = clusters_get_with_http_info(opts)
  data
end

#clusters_get_with_http_info(opts = {}) ⇒ Array<(ClusterList, Integer, Hash)>

List clusters Retrieves a list of PostgreSQL clusters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_name (String) —

    Response filter to list only the PostgreSQL clusters that contain the specified name. The value is case insensitive and matched on the &#39;displayName&#39; field.

Returns:

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

    ClusterList data, response status code and response headers



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
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 226

def clusters_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClustersApi.clusters_get ...'
  end
  # resource path
  local_var_path = '/clusters'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter.name'] = opts[:'filter_name'] if !opts[:'filter_name'].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] || 'ClusterList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

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

#clusters_patch(cluster_id, patch_cluster_request, opts = {}) ⇒ ClusterResponse

Patch a cluster Patch attributes of a PostgreSQL cluster.

Parameters:

  • cluster_id (String) —

    The unique ID of the cluster.

  • patch_cluster_request (PatchClusterRequest) —

    The modified cluster.

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

    the optional parameters

Returns:



277
278
279
280
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 277

def clusters_patch(cluster_id, patch_cluster_request, opts = {})
  data, _status_code, _headers = clusters_patch_with_http_info(cluster_id, patch_cluster_request, opts)
  data
end

#clusters_patch_with_http_info(cluster_id, patch_cluster_request, opts = {}) ⇒ Array<(ClusterResponse, Integer, Hash)>

Patch a cluster Patch attributes of a PostgreSQL cluster.

Parameters:

  • cluster_id (String) —

    The unique ID of the cluster.

  • patch_cluster_request (PatchClusterRequest) —

    The modified cluster.

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

    the optional parameters

Returns:

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

    ClusterResponse data, response status code and response headers



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 288

def clusters_patch_with_http_info(cluster_id, patch_cluster_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClustersApi.clusters_patch ...'
  end
  # verify the required parameter 'cluster_id' is set
  if @api_client.config.client_side_validation && cluster_id.nil?
    fail ArgumentError, "Missing the required parameter 'cluster_id' when calling ClustersApi.clusters_patch"
  end
  # verify the required parameter 'patch_cluster_request' is set
  if @api_client.config.client_side_validation && patch_cluster_request.nil?
    fail ArgumentError, "Missing the required parameter 'patch_cluster_request' when calling ClustersApi.clusters_patch"
  end
  # resource path
  local_var_path = '/clusters/{clusterId}'.sub('{' + 'clusterId' + '}', CGI.escape(cluster_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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

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

#clusters_post(create_cluster_request, opts = {}) ⇒ ClusterResponse

Create a cluster Creates a new PostgreSQL cluster. If the ‘fromBackup` field is populated, the new cluster will be created based on the given backup.

Parameters:

  • create_cluster_request (CreateClusterRequest) —

    The cluster to be created.

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

    the optional parameters

Returns:



347
348
349
350
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 347

def clusters_post(create_cluster_request, opts = {})
  data, _status_code, _headers = clusters_post_with_http_info(create_cluster_request, opts)
  data
end

#clusters_post_with_http_info(create_cluster_request, opts = {}) ⇒ Array<(ClusterResponse, Integer, Hash)>

Create a cluster Creates a new PostgreSQL cluster. If the &#x60;fromBackup&#x60; field is populated, the new cluster will be created based on the given backup.

Parameters:

  • create_cluster_request (CreateClusterRequest) —

    The cluster to be created.

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

    the optional parameters

Returns:

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

    ClusterResponse data, response status code and response headers



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
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 357

def clusters_post_with_http_info(create_cluster_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClustersApi.clusters_post ...'
  end
  # verify the required parameter 'create_cluster_request' is set
  if @api_client.config.client_side_validation && create_cluster_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_cluster_request' when calling ClustersApi.clusters_post"
  end
  # resource path
  local_var_path = '/clusters'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

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

#postgres_versions_get(opts = {}) ⇒ PostgresVersionList

List PostgreSQL versions Retrieves a list of all available PostgreSQL versions.

Parameters:

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

    the optional parameters

Returns:



411
412
413
414
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 411

def postgres_versions_get(opts = {})
  data, _status_code, _headers = postgres_versions_get_with_http_info(opts)
  data
end

#postgres_versions_get_with_http_info(opts = {}) ⇒ Array<(PostgresVersionList, Integer, Hash)>

List PostgreSQL versions Retrieves a list of all available PostgreSQL versions.

Parameters:

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

    the optional parameters

Returns:

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

    PostgresVersionList data, response status code and response headers



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
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/ionoscloud-dbaas-postgres/api/clusters_api.rb', line 420

def postgres_versions_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClustersApi.postgres_versions_get ...'
  end
  # resource path
  local_var_path = '/clusters/postgresversions'

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

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