# Pulp2to3MigrationClient::MigrationPlansApi

All URIs are relative to *http://localhost:24817*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](MigrationPlansApi.md#create) | **POST** /pulp/api/v3/migration-plans/ | Create a migration plan
[**delete**](MigrationPlansApi.md#delete) | **DELETE** {migration_plan_href} | Delete a migration plan
[**list**](MigrationPlansApi.md#list) | **GET** /pulp/api/v3/migration-plans/ | List migration plans
[**read**](MigrationPlansApi.md#read) | **GET** {migration_plan_href} | Inspect a migration plan
[**run**](MigrationPlansApi.md#run) | **POST** {migration_plan_href}run/ | Run migration plan



## create

> MigrationPlan create(data)

Create a migration plan

MigrationPlan ViewSet.

### Example

```ruby
# load the gem
require 'pulp_2to3_migration_client'
# setup authorization
Pulp2to3MigrationClient.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Pulp2to3MigrationClient::MigrationPlansApi.new
data = Pulp2to3MigrationClient::MigrationPlan.new # MigrationPlan | 

begin
  #Create a migration plan
  result = api_instance.create(data)
  p result
rescue Pulp2to3MigrationClient::ApiError => e
  puts "Exception when calling MigrationPlansApi->create: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **data** | [**MigrationPlan**](MigrationPlan.md)|  | 

### Return type

[**MigrationPlan**](MigrationPlan.md)

### Authorization

[Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## delete

> delete(migration_plan_href)

Delete a migration plan

MigrationPlan ViewSet.

### Example

```ruby
# load the gem
require 'pulp_2to3_migration_client'
# setup authorization
Pulp2to3MigrationClient.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Pulp2to3MigrationClient::MigrationPlansApi.new
migration_plan_href = 'migration_plan_href_example' # String | URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/

begin
  #Delete a migration plan
  api_instance.delete(migration_plan_href)
rescue Pulp2to3MigrationClient::ApiError => e
  puts "Exception when calling MigrationPlansApi->delete: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **migration_plan_href** | **String**| URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/ | 

### Return type

nil (empty response body)

### Authorization

[Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined


## list

> InlineResponse200 list(opts)

List migration plans

MigrationPlan ViewSet.

### Example

```ruby
# load the gem
require 'pulp_2to3_migration_client'
# setup authorization
Pulp2to3MigrationClient.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Pulp2to3MigrationClient::MigrationPlansApi.new
opts = {
  limit: 56, # Integer | Number of results to return per page.
  offset: 56, # Integer | The initial index from which to return the results.
  fields: 'fields_example', # String | A list of fields to include in the response.
  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
}

begin
  #List migration plans
  result = api_instance.list(opts)
  p result
rescue Pulp2to3MigrationClient::ApiError => e
  puts "Exception when calling MigrationPlansApi->list: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **limit** | **Integer**| Number of results to return per page. | [optional] 
 **offset** | **Integer**| The initial index from which to return the results. | [optional] 
 **fields** | **String**| A list of fields to include in the response. | [optional] 
 **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 

### Return type

[**InlineResponse200**](InlineResponse200.md)

### Authorization

[Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## read

> MigrationPlan read(migration_plan_href, opts)

Inspect a migration plan

MigrationPlan ViewSet.

### Example

```ruby
# load the gem
require 'pulp_2to3_migration_client'
# setup authorization
Pulp2to3MigrationClient.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Pulp2to3MigrationClient::MigrationPlansApi.new
migration_plan_href = 'migration_plan_href_example' # String | URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/
opts = {
  fields: 'fields_example', # String | A list of fields to include in the response.
  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
}

begin
  #Inspect a migration plan
  result = api_instance.read(migration_plan_href, opts)
  p result
rescue Pulp2to3MigrationClient::ApiError => e
  puts "Exception when calling MigrationPlansApi->read: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **migration_plan_href** | **String**| URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/ | 
 **fields** | **String**| A list of fields to include in the response. | [optional] 
 **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 

### Return type

[**MigrationPlan**](MigrationPlan.md)

### Authorization

[Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## run

> AsyncOperationResponse run(migration_plan_href, data)

Run migration plan

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

### Example

```ruby
# load the gem
require 'pulp_2to3_migration_client'
# setup authorization
Pulp2to3MigrationClient.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Pulp2to3MigrationClient::MigrationPlansApi.new
migration_plan_href = 'migration_plan_href_example' # String | URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/
data = Pulp2to3MigrationClient::MigrationPlanRun.new # MigrationPlanRun | 

begin
  #Run migration plan
  result = api_instance.run(migration_plan_href, data)
  p result
rescue Pulp2to3MigrationClient::ApiError => e
  puts "Exception when calling MigrationPlansApi->run: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **migration_plan_href** | **String**| URI of Migration Plan. e.g.: /pulp/api/v3/migration-plans/1/ | 
 **data** | [**MigrationPlanRun**](MigrationPlanRun.md)|  | 

### Return type

[**AsyncOperationResponse**](AsyncOperationResponse.md)

### Authorization

[Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json