Class: IbmCloudPower::PCloudStorageCapacityApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_power/api/p_cloud_storage_capacity_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PCloudStorageCapacityApi

Returns a new instance of PCloudStorageCapacityApi.



19
20
21
 
# File 'lib/ibm_cloud_power/api/p_cloud_storage_capacity_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/ibm_cloud_power/api/p_cloud_storage_capacity_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#pcloud_storagecapacity_pools_get(cloud_instance_id, storage_pool_name, opts = {}) ⇒ StoragePoolCapacity

Storage capacity for a storage pool in a region

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • storage_pool_name (String) —

    Storage pool name

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/ibm_cloud_power/api/p_cloud_storage_capacity_api.rb', line 27

def pcloud_storagecapacity_pools_get(cloud_instance_id, storage_pool_name, opts = {})
  data, _status_code, _headers = pcloud_storagecapacity_pools_get_with_http_info(cloud_instance_id, storage_pool_name, opts)
  data
end

#pcloud_storagecapacity_pools_get_with_http_info(cloud_instance_id, storage_pool_name, opts = {}) ⇒ Array<(StoragePoolCapacity, Integer, Hash)>

Storage capacity for a storage pool in a region

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • storage_pool_name (String) —

    Storage pool name

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

    the optional parameters

Returns:

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

    StoragePoolCapacity 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
84
85
86
87
 
# File 'lib/ibm_cloud_power/api/p_cloud_storage_capacity_api.rb', line 37

def pcloud_storagecapacity_pools_get_with_http_info(cloud_instance_id, storage_pool_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudStorageCapacityApi.pcloud_storagecapacity_pools_get ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudStorageCapacityApi.pcloud_storagecapacity_pools_get"
  end
  # verify the required parameter 'storage_pool_name' is set
  if @api_client.config.client_side_validation && storage_pool_name.nil?
    fail ArgumentError, "Missing the required parameter 'storage_pool_name' when calling PCloudStorageCapacityApi.pcloud_storagecapacity_pools_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/storage-capacity/storage-pools/{storage_pool_name}'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'storage_pool_name' + '}', CGI.escape(storage_pool_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] || 'StoragePoolCapacity'

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

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

#pcloud_storagecapacity_pools_getall(cloud_instance_id, opts = {}) ⇒ StoragePoolsCapacity

Storage capacity for all available storage pools in a region

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:



93
94
95
96
 
# File 'lib/ibm_cloud_power/api/p_cloud_storage_capacity_api.rb', line 93

def pcloud_storagecapacity_pools_getall(cloud_instance_id, opts = {})
  data, _status_code, _headers = pcloud_storagecapacity_pools_getall_with_http_info(cloud_instance_id, opts)
  data
end

#pcloud_storagecapacity_pools_getall_with_http_info(cloud_instance_id, opts = {}) ⇒ Array<(StoragePoolsCapacity, Integer, Hash)>

Storage capacity for all available storage pools in a region

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:

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

    StoragePoolsCapacity data, response status code and response headers



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
147
148
 
# File 'lib/ibm_cloud_power/api/p_cloud_storage_capacity_api.rb', line 102

def pcloud_storagecapacity_pools_getall_with_http_info(cloud_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudStorageCapacityApi.pcloud_storagecapacity_pools_getall ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudStorageCapacityApi.pcloud_storagecapacity_pools_getall"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/storage-capacity/storage-pools'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_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] || 'StoragePoolsCapacity'

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

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

#pcloud_storagecapacity_types_get(cloud_instance_id, storage_type_name, opts = {}) ⇒ StorageTypeCapacity

Storage capacity for a storage type in a region

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • storage_type_name (String) —

    Storage type name

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

    the optional parameters

Returns:



155
156
157
158
 
# File 'lib/ibm_cloud_power/api/p_cloud_storage_capacity_api.rb', line 155

def pcloud_storagecapacity_types_get(cloud_instance_id, storage_type_name, opts = {})
  data, _status_code, _headers = pcloud_storagecapacity_types_get_with_http_info(cloud_instance_id, storage_type_name, opts)
  data
end

#pcloud_storagecapacity_types_get_with_http_info(cloud_instance_id, storage_type_name, opts = {}) ⇒ Array<(StorageTypeCapacity, Integer, Hash)>

Storage capacity for a storage type in a region

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • storage_type_name (String) —

    Storage type name

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

    the optional parameters

Returns:

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

    StorageTypeCapacity data, response status code and response headers



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
210
211
212
213
214
215
 
# File 'lib/ibm_cloud_power/api/p_cloud_storage_capacity_api.rb', line 165

def pcloud_storagecapacity_types_get_with_http_info(cloud_instance_id, storage_type_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudStorageCapacityApi.pcloud_storagecapacity_types_get ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudStorageCapacityApi.pcloud_storagecapacity_types_get"
  end
  # verify the required parameter 'storage_type_name' is set
  if @api_client.config.client_side_validation && storage_type_name.nil?
    fail ArgumentError, "Missing the required parameter 'storage_type_name' when calling PCloudStorageCapacityApi.pcloud_storagecapacity_types_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/storage-capacity/storage-types/{storage_type_name}'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'storage_type_name' + '}', CGI.escape(storage_type_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] || 'StorageTypeCapacity'

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

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

#pcloud_storagecapacity_types_getall(cloud_instance_id, opts = {}) ⇒ StorageTypesCapacity

Storage capacity for all available storage types in a region

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:



221
222
223
224
 
# File 'lib/ibm_cloud_power/api/p_cloud_storage_capacity_api.rb', line 221

def pcloud_storagecapacity_types_getall(cloud_instance_id, opts = {})
  data, _status_code, _headers = pcloud_storagecapacity_types_getall_with_http_info(cloud_instance_id, opts)
  data
end

#pcloud_storagecapacity_types_getall_with_http_info(cloud_instance_id, opts = {}) ⇒ Array<(StorageTypesCapacity, Integer, Hash)>

Storage capacity for all available storage types in a region

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:

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

    StorageTypesCapacity data, response status code and response headers



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
273
274
275
276
 
# File 'lib/ibm_cloud_power/api/p_cloud_storage_capacity_api.rb', line 230

def pcloud_storagecapacity_types_getall_with_http_info(cloud_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudStorageCapacityApi.pcloud_storagecapacity_types_getall ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudStorageCapacityApi.pcloud_storagecapacity_types_getall"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/storage-capacity/storage-types'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_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] || 'StorageTypesCapacity'

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

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