Class: IbmCloudPower::DatacentersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DatacentersApi

Returns a new instance of DatacentersApi.



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

def api_client
  @api_client
end

Instance Method Details

#v1_datacenters_get(datacenter_region, opts = {}) ⇒ Datacenter

Get a Datacenter's information and capabilities

Parameters:

  • datacenter_region (String) —

    Datacenter Region

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/ibm_cloud_power/api/datacenters_api.rb', line 26

def v1_datacenters_get(datacenter_region, opts = {})
  data, _status_code, _headers = v1_datacenters_get_with_http_info(datacenter_region, opts)
  data
end

#v1_datacenters_get_with_http_info(datacenter_region, opts = {}) ⇒ Array<(Datacenter, Integer, Hash)>

Get a Datacenter's information and capabilities

Parameters:

  • datacenter_region (String) —

    Datacenter Region

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

    the optional parameters

Returns:

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

    Datacenter data, response status code and response headers



35
36
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
 
# File 'lib/ibm_cloud_power/api/datacenters_api.rb', line 35

def v1_datacenters_get_with_http_info(datacenter_region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatacentersApi.v1_datacenters_get ...'
  end
  # verify the required parameter 'datacenter_region' is set
  if @api_client.config.client_side_validation && datacenter_region.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_region' when calling DatacentersApi.v1_datacenters_get"
  end
  # resource path
  local_var_path = '/v1/datacenters/{datacenter_region}'.sub('{datacenter_region}', CGI.escape(datacenter_region.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']) unless header_params['Accept']

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

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

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

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

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

#v1_datacenters_getall(opts = {}) ⇒ Datacenters

Get all Datacenters information and capabilities

Parameters:

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

    the optional parameters

Returns:



86
87
88
89
 
# File 'lib/ibm_cloud_power/api/datacenters_api.rb', line 86

def v1_datacenters_getall(opts = {})
  data, _status_code, _headers = v1_datacenters_getall_with_http_info(opts)
  data
end

#v1_datacenters_getall_with_http_info(opts = {}) ⇒ Array<(Datacenters, Integer, Hash)>

Get all Datacenters information and capabilities

Parameters:

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

    the optional parameters

Returns:

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

    Datacenters data, response status code and response headers



94
95
96
97
98
99
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
 
# File 'lib/ibm_cloud_power/api/datacenters_api.rb', line 94

def v1_datacenters_getall_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatacentersApi.v1_datacenters_getall ...'
  end
  # resource path
  local_var_path = '/v1/datacenters'

  # 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']) unless header_params['Accept']

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

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

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

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

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

#v1_datacenters_private_get(datacenter_region, opts = {}) ⇒ Datacenter

Get a private Datacenter's information and capabilities

Parameters:

  • datacenter_region (String) —

    Datacenter Region

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

    the optional parameters

Returns:



142
143
144
145
 
# File 'lib/ibm_cloud_power/api/datacenters_api.rb', line 142

def v1_datacenters_private_get(datacenter_region, opts = {})
  data, _status_code, _headers = v1_datacenters_private_get_with_http_info(datacenter_region, opts)
  data
end

#v1_datacenters_private_get_with_http_info(datacenter_region, opts = {}) ⇒ Array<(Datacenter, Integer, Hash)>

Get a private Datacenter's information and capabilities

Parameters:

  • datacenter_region (String) —

    Datacenter Region

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

    the optional parameters

Returns:

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

    Datacenter data, response status code and response headers



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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/ibm_cloud_power/api/datacenters_api.rb', line 151

def v1_datacenters_private_get_with_http_info(datacenter_region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatacentersApi.v1_datacenters_private_get ...'
  end
  # verify the required parameter 'datacenter_region' is set
  if @api_client.config.client_side_validation && datacenter_region.nil?
    fail ArgumentError, "Missing the required parameter 'datacenter_region' when calling DatacentersApi.v1_datacenters_private_get"
  end
  # resource path
  local_var_path = '/v1/datacenters/private/{datacenter_region}'.sub('{datacenter_region}', CGI.escape(datacenter_region.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']) unless header_params['Accept']

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

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

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

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

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

#v1_datacenters_private_getall(opts = {}) ⇒ Datacenters

Get private Datacenter information and capabilities

Parameters:

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

    the optional parameters

Returns:



202
203
204
205
 
# File 'lib/ibm_cloud_power/api/datacenters_api.rb', line 202

def v1_datacenters_private_getall(opts = {})
  data, _status_code, _headers = v1_datacenters_private_getall_with_http_info(opts)
  data
end

#v1_datacenters_private_getall_with_http_info(opts = {}) ⇒ Array<(Datacenters, Integer, Hash)>

Get private Datacenter information and capabilities

Parameters:

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

    the optional parameters

Returns:

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

    Datacenters data, response status code and response headers



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
 
# File 'lib/ibm_cloud_power/api/datacenters_api.rb', line 210

def v1_datacenters_private_getall_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatacentersApi.v1_datacenters_private_getall ...'
  end
  # resource path
  local_var_path = '/v1/datacenters/private'

  # 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']) unless header_params['Accept']

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

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

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

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

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