Class: IonoscloudDbaasMongo::SnapshotsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SnapshotsApi

Returns a new instance of SnapshotsApi.



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

def api_client
  @api_client
end

Instance Method Details

#clusters_snapshots_get(cluster_id, opts = {}) ⇒ SnapshotList

Get the snapshots of your cluster Retrieves MongoDB snapshots.

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-mongo/api/snapshots_api.rb', line 29

def clusters_snapshots_get(cluster_id, opts = {})
  data, _status_code, _headers = clusters_snapshots_get_with_http_info(cluster_id, opts)
  data
end

#clusters_snapshots_get_with_http_info(cluster_id, opts = {}) ⇒ Array<(SnapshotList, Integer, Hash)>

Get the snapshots of your cluster Retrieves MongoDB snapshots.

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<(SnapshotList, Integer, Hash)>) —

    SnapshotList 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-mongo/api/snapshots_api.rb', line 41

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

  # resource path
  local_var_path = '/clusters/{clusterId}/snapshots'.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] || 'SnapshotList'

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

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