Class: Pulp2to3MigrationClient::MigrationPlansApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_2to3_migration_client/api/migration_plans_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MigrationPlansApi

Returns a new instance of MigrationPlansApi.



19
20
21
 
# File 'lib/pulp_2to3_migration_client/api/migration_plans_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/pulp_2to3_migration_client/api/migration_plans_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(data, opts = {}) ⇒ Pulp2to3MigrationMigrationPlan

Create a migration plan MigrationPlan ViewSet.

Parameters:

Returns:



27
28
29
30
 
# File 'lib/pulp_2to3_migration_client/api/migration_plans_api.rb', line 27

def create(data, opts = {})
  data, _status_code, _headers = create_with_http_info(data, opts)
  data
end

#create_with_http_info(data, opts = {}) ⇒ Array<(Pulp2to3MigrationMigrationPlan, Integer, Hash)>

Create a migration plan MigrationPlan ViewSet.

Parameters:

Returns:



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
 
# File 'lib/pulp_2to3_migration_client/api/migration_plans_api.rb', line 37

def create_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationPlansApi.create ...'
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling MigrationPlansApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/migration-plans/'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'Pulp2to3MigrationMigrationPlan' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

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

#delete(migration_plan_href, opts = {}) ⇒ nil

Delete a migration plan MigrationPlan ViewSet.

Parameters:

  • migration_plan_href (String) —

    URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/

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

    the optional parameters

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/pulp_2to3_migration_client/api/migration_plans_api.rb', line 91

def delete(migration_plan_href, opts = {})
  delete_with_http_info(migration_plan_href, opts)
  nil
end

#delete_with_http_info(migration_plan_href, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a migration plan MigrationPlan ViewSet.

Parameters:

  • migration_plan_href (String) —

    URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
137
138
139
140
141
142
143
144
 
# File 'lib/pulp_2to3_migration_client/api/migration_plans_api.rb', line 101

def delete_with_http_info(migration_plan_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationPlansApi.delete ...'
  end
  # verify the required parameter 'migration_plan_href' is set
  if @api_client.config.client_side_validation && migration_plan_href.nil?
    fail ArgumentError, "Missing the required parameter 'migration_plan_href' when calling MigrationPlansApi.delete"
  end
  # resource path
  local_var_path = '{migration_plan_href}'.sub('{' + 'migration_plan_href' + '}', CGI.escape(migration_plan_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MigrationPlansApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ InlineResponse200

List migration plans MigrationPlan ViewSet.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



154
155
156
157
 
# File 'lib/pulp_2to3_migration_client/api/migration_plans_api.rb', line 154

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

List migration plans MigrationPlan ViewSet.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    InlineResponse200 data, response status code and response headers



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
 
# File 'lib/pulp_2to3_migration_client/api/migration_plans_api.rb', line 167

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationPlansApi.list ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/migration-plans/'

  # 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?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].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[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse200' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

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

#read(migration_plan_href, opts = {}) ⇒ Pulp2to3MigrationMigrationPlan

Inspect a migration plan MigrationPlan ViewSet.

Parameters:

  • migration_plan_href (String) —

    URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



221
222
223
224
 
# File 'lib/pulp_2to3_migration_client/api/migration_plans_api.rb', line 221

def read(migration_plan_href, opts = {})
  data, _status_code, _headers = read_with_http_info(migration_plan_href, opts)
  data
end

#read_with_http_info(migration_plan_href, opts = {}) ⇒ Array<(Pulp2to3MigrationMigrationPlan, Integer, Hash)>

Inspect a migration plan MigrationPlan ViewSet.

Parameters:

  • migration_plan_href (String) —

    URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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
277
278
279
280
 
# File 'lib/pulp_2to3_migration_client/api/migration_plans_api.rb', line 233

def read_with_http_info(migration_plan_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationPlansApi.read ...'
  end
  # verify the required parameter 'migration_plan_href' is set
  if @api_client.config.client_side_validation && migration_plan_href.nil?
    fail ArgumentError, "Missing the required parameter 'migration_plan_href' when calling MigrationPlansApi.read"
  end
  # resource path
  local_var_path = '{migration_plan_href}'.sub('{' + 'migration_plan_href' + '}', CGI.escape(migration_plan_href.to_s).gsub('%2F', '/'))

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

  # return_type
  return_type = opts[:return_type] || 'Pulp2to3MigrationMigrationPlan' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

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

#run(migration_plan_href, data, opts = {}) ⇒ AsyncOperationResponse

Run migration plan Trigger an asynchronous task to run a migration from Pulp 2.

Parameters:

  • migration_plan_href (String) —

    URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/

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

    the optional parameters

Returns:



288
289
290
291
 
# File 'lib/pulp_2to3_migration_client/api/migration_plans_api.rb', line 288

def run(migration_plan_href, data, opts = {})
  data, _status_code, _headers = run_with_http_info(migration_plan_href, data, opts)
  data
end

#run_with_http_info(migration_plan_href, data, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Run migration plan Trigger an asynchronous task to run a migration from Pulp 2.

Parameters:

  • migration_plan_href (String) —

    URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/pulp_2to3_migration_client/api/migration_plans_api.rb', line 299

def run_with_http_info(migration_plan_href, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MigrationPlansApi.run ...'
  end
  # verify the required parameter 'migration_plan_href' is set
  if @api_client.config.client_side_validation && migration_plan_href.nil?
    fail ArgumentError, "Missing the required parameter 'migration_plan_href' when calling MigrationPlansApi.run"
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling MigrationPlansApi.run"
  end
  # resource path
  local_var_path = '{migration_plan_href}run/'.sub('{' + 'migration_plan_href' + '}', CGI.escape(migration_plan_href.to_s).gsub('%2F', '/'))

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'AsyncOperationResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

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