Class: IbmCloudPower::PCloudVolumeOnboardingApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PCloudVolumeOnboardingApi

Returns a new instance of PCloudVolumeOnboardingApi.



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

def api_client
  @api_client
end

Instance Method Details

#pcloud_volume_onboarding_get(cloud_instance_id, volume_onboarding_id, opts = {}) ⇒ VolumeOnboarding

Get the information of volume onboarding operation

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • volume_onboarding_id (String) —

    Indicates volume onboarding operation id

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

    the optional parameters

Returns:



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

def pcloud_volume_onboarding_get(cloud_instance_id, volume_onboarding_id, opts = {})
  data, _status_code, _headers = pcloud_volume_onboarding_get_with_http_info(cloud_instance_id, volume_onboarding_id, opts)
  data
end

#pcloud_volume_onboarding_get_with_http_info(cloud_instance_id, volume_onboarding_id, opts = {}) ⇒ Array<(VolumeOnboarding, Integer, Hash)>

Get the information of volume onboarding operation

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • volume_onboarding_id (String) —

    Indicates volume onboarding operation id

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

    the optional parameters

Returns:

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

    VolumeOnboarding 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_volume_onboarding_api.rb', line 37

def pcloud_volume_onboarding_get_with_http_info(cloud_instance_id, volume_onboarding_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVolumeOnboardingApi.pcloud_volume_onboarding_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 PCloudVolumeOnboardingApi.pcloud_volume_onboarding_get"
  end
  # verify the required parameter 'volume_onboarding_id' is set
  if @api_client.config.client_side_validation && volume_onboarding_id.nil?
    fail ArgumentError, "Missing the required parameter 'volume_onboarding_id' when calling PCloudVolumeOnboardingApi.pcloud_volume_onboarding_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/onboarding/{volume_onboarding_id}'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'volume_onboarding_id' + '}', CGI.escape(volume_onboarding_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] || 'VolumeOnboarding'

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

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

#pcloud_volume_onboarding_getall(cloud_instance_id, opts = {}) ⇒ VolumeOnboardings

List all volume onboardings for this cloud instance

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_volume_onboarding_api.rb', line 93

def pcloud_volume_onboarding_getall(cloud_instance_id, opts = {})
  data, _status_code, _headers = pcloud_volume_onboarding_getall_with_http_info(cloud_instance_id, opts)
  data
end

#pcloud_volume_onboarding_getall_with_http_info(cloud_instance_id, opts = {}) ⇒ Array<(VolumeOnboardings, Integer, Hash)>

List all volume onboardings for this cloud instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Returns:

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

    VolumeOnboardings 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_volume_onboarding_api.rb', line 102

def pcloud_volume_onboarding_getall_with_http_info(cloud_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVolumeOnboardingApi.pcloud_volume_onboarding_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 PCloudVolumeOnboardingApi.pcloud_volume_onboarding_getall"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/onboarding'.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] || 'VolumeOnboardings'

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

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

#pcloud_volume_onboarding_post(cloud_instance_id, body, opts = {}) ⇒ VolumeOnboardingCreateResponse

Onboard auxiliary volumes to target site

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • body (VolumeOnboardingCreate) —

    Parameters for the creation of volume onboarding

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

    the optional parameters

Returns:



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

def pcloud_volume_onboarding_post(cloud_instance_id, body, opts = {})
  data, _status_code, _headers = pcloud_volume_onboarding_post_with_http_info(cloud_instance_id, body, opts)
  data
end

#pcloud_volume_onboarding_post_with_http_info(cloud_instance_id, body, opts = {}) ⇒ Array<(VolumeOnboardingCreateResponse, Integer, Hash)>

Onboard auxiliary volumes to target site

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • body (VolumeOnboardingCreate) —

    Parameters for the creation of volume onboarding

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

    the optional parameters

Returns:



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
216
217
218
219
220
 
# File 'lib/ibm_cloud_power/api/p_cloud_volume_onboarding_api.rb', line 165

def pcloud_volume_onboarding_post_with_http_info(cloud_instance_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudVolumeOnboardingApi.pcloud_volume_onboarding_post ...'
  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 PCloudVolumeOnboardingApi.pcloud_volume_onboarding_post"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PCloudVolumeOnboardingApi.pcloud_volume_onboarding_post"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/onboarding'.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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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