Class: IonoscloudDbaasPostgres::BackupsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BackupsApi

Returns a new instance of BackupsApi.



19
20
21
 
# File 'lib/ionoscloud-dbaas-postgres/api/backups_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/backups_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cluster_backups_get(cluster_id, opts = {}) ⇒ ClusterBackupList

List backups of cluster Retrieves a list of all backups of the given PostgreSQL cluster.

Parameters:

  • cluster_id (String) —

    The unique ID of the cluster.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The maximum number of elements to return. Use together with 'offset' for pagination. (default to 100)

  • :offset (Integer) —

    The first element to return. Use together with 'limit' for pagination. (default to 0)

Returns:



29
30
31
32
 
# File 'lib/ionoscloud-dbaas-postgres/api/backups_api.rb', line 29

def cluster_backups_get(cluster_id, opts = {})
  data, _status_code, _headers = cluster_backups_get_with_http_info(cluster_id, opts)
  data
end

#cluster_backups_get_with_http_info(cluster_id, opts = {}) ⇒ Array<(ClusterBackupList, Integer, Hash)>

List backups of cluster Retrieves a list of all backups of the given PostgreSQL cluster.

Parameters:

  • cluster_id (String) —

    The unique ID of the cluster.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The maximum number of elements to return. Use together with &#39;offset&#39; for pagination.

  • :offset (Integer) —

    The first element to return. Use together with &#39;limit&#39; for pagination.

Returns:

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

    ClusterBackupList data, response status code and response headers



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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/ionoscloud-dbaas-postgres/api/backups_api.rb', line 41

def cluster_backups_get_with_http_info(cluster_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackupsApi.cluster_backups_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 BackupsApi.cluster_backups_get"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BackupsApi.cluster_backups_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BackupsApi.cluster_backups_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/clusters/{clusterId}/backups'.sub('{' + 'clusterId' + '}', CGI.escape(cluster_id.to_s))

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

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

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

#clusters_backups_find_by_id(backup_id, opts = {}) ⇒ BackupResponse

Fetch a cluster backup Retrieve a PostgreSQL cluster backup by using its ID. This value can be found when you GET a list of PostgreSQL cluster backups.

Parameters:

  • backup_id (String) —

    The unique ID of the backup.

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

    the optional parameters

Returns:



104
105
106
107
 
# File 'lib/ionoscloud-dbaas-postgres/api/backups_api.rb', line 104

def clusters_backups_find_by_id(backup_id, opts = {})
  data, _status_code, _headers = clusters_backups_find_by_id_with_http_info(backup_id, opts)
  data
end

#clusters_backups_find_by_id_with_http_info(backup_id, opts = {}) ⇒ Array<(BackupResponse, Integer, Hash)>

Fetch a cluster backup Retrieve a PostgreSQL cluster backup by using its ID. This value can be found when you GET a list of PostgreSQL cluster backups.

Parameters:

  • backup_id (String) —

    The unique ID of the backup.

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

    the optional parameters

Returns:

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

    BackupResponse data, response status code and response headers



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/ionoscloud-dbaas-postgres/api/backups_api.rb', line 114

def clusters_backups_find_by_id_with_http_info(backup_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackupsApi.clusters_backups_find_by_id ...'
  end
  # verify the required parameter 'backup_id' is set
  if @api_client.config.client_side_validation && backup_id.nil?
    fail ArgumentError, "Missing the required parameter 'backup_id' when calling BackupsApi.clusters_backups_find_by_id"
  end
  # resource path
  local_var_path = '/clusters/backups/{backupId}'.sub('{' + 'backupId' + '}', CGI.escape(backup_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] || 'BackupResponse'

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

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

#clusters_backups_get(opts = {}) ⇒ ClusterBackupList

List cluster backups Retrieves a list of all PostgreSQL cluster backups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The maximum number of elements to return. Use together with &#39;offset&#39; for pagination. (default to 100)

  • :offset (Integer) —

    The first element to return. Use together with &#39;limit&#39; for pagination. (default to 0)

Returns:



168
169
170
171
 
# File 'lib/ionoscloud-dbaas-postgres/api/backups_api.rb', line 168

def clusters_backups_get(opts = {})
  data, _status_code, _headers = clusters_backups_get_with_http_info(opts)
  data
end

#clusters_backups_get_with_http_info(opts = {}) ⇒ Array<(ClusterBackupList, Integer, Hash)>

List cluster backups Retrieves a list of all PostgreSQL cluster backups.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The maximum number of elements to return. Use together with &#39;offset&#39; for pagination.

  • :offset (Integer) —

    The first element to return. Use together with &#39;limit&#39; for pagination.

Returns:

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

    ClusterBackupList data, response status code and response headers



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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/ionoscloud-dbaas-postgres/api/backups_api.rb', line 179

def clusters_backups_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BackupsApi.clusters_backups_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BackupsApi.clusters_backups_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BackupsApi.clusters_backups_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/clusters/backups'

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

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

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