# PulpAnsibleClient::RemotesCollectionApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](RemotesCollectionApi.md#create) | **POST** /pulp/api/v3/remotes/ansible/collection/ | Create a collection remote
[**delete**](RemotesCollectionApi.md#delete) | **DELETE** {collection_remote_href} | Delete a collection remote
[**list**](RemotesCollectionApi.md#list) | **GET** /pulp/api/v3/remotes/ansible/collection/ | List collection remotes
[**partial_update**](RemotesCollectionApi.md#partial_update) | **PATCH** {collection_remote_href} | Partially update a collection remote
[**read**](RemotesCollectionApi.md#read) | **GET** {collection_remote_href} | Inspect a collection remote
[**sync**](RemotesCollectionApi.md#sync) | **POST** {collection_remote_href}sync/ | 
[**update**](RemotesCollectionApi.md#update) | **PUT** {collection_remote_href} | Update a collection remote



## create

> CollectionRemote create(data)

Create a collection remote

ViewSet for Collection Remotes.

### Example

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

api_instance = PulpAnsibleClient::RemotesCollectionApi.new
data = PulpAnsibleClient::CollectionRemote.new # CollectionRemote | 

begin
  #Create a collection remote
  result = api_instance.create(data)
  p result
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling RemotesCollectionApi->create: #{e}"
end
```

### Parameters


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

### Return type

[**CollectionRemote**](CollectionRemote.md)

### Authorization

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

### HTTP request headers

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


## delete

> AsyncOperationResponse delete(collection_remote_href)

Delete a collection remote

Trigger an asynchronous delete task

### Example

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

api_instance = PulpAnsibleClient::RemotesCollectionApi.new
collection_remote_href = 'collection_remote_href_example' # String | URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/

begin
  #Delete a collection remote
  result = api_instance.delete(collection_remote_href)
  p result
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling RemotesCollectionApi->delete: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_remote_href** | **String**| URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ | 

### Return type

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

### Authorization

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

### HTTP request headers

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


## list

> InlineResponse2004 list(opts)

List collection remotes

ViewSet for Collection Remotes.

### Example

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

api_instance = PulpAnsibleClient::RemotesCollectionApi.new
opts = {
  name: 'name_example', # String | 
  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
  _last_updated__lt: '_last_updated__lt_example', # String | Filter results where _last_updated is less than value
  _last_updated__lte: '_last_updated__lte_example', # String | Filter results where _last_updated is less than or equal to value
  _last_updated__gt: '_last_updated__gt_example', # String | Filter results where _last_updated is greater than value
  _last_updated__gte: '_last_updated__gte_example', # String | Filter results where _last_updated is greater than or equal to value
  _last_updated__range: '_last_updated__range_example', # String | Filter results where _last_updated is between two comma separated values
  _last_updated: '_last_updated_example', # String | ISO 8601 formatted dates are supported
  page: 56, # Integer | A page number within the paginated result set.
  page_size: 56 # Integer | Number of results to return per page.
}

begin
  #List collection remotes
  result = api_instance.list(opts)
  p result
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling RemotesCollectionApi->list: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **name** | **String**|  | [optional] 
 **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional] 
 **_last_updated__lt** | **String**| Filter results where _last_updated is less than value | [optional] 
 **_last_updated__lte** | **String**| Filter results where _last_updated is less than or equal to value | [optional] 
 **_last_updated__gt** | **String**| Filter results where _last_updated is greater than value | [optional] 
 **_last_updated__gte** | **String**| Filter results where _last_updated is greater than or equal to value | [optional] 
 **_last_updated__range** | **String**| Filter results where _last_updated is between two comma separated values | [optional] 
 **_last_updated** | **String**| ISO 8601 formatted dates are supported | [optional] 
 **page** | **Integer**| A page number within the paginated result set. | [optional] 
 **page_size** | **Integer**| Number of results to return per page. | [optional] 

### Return type

[**InlineResponse2004**](InlineResponse2004.md)

### Authorization

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

### HTTP request headers

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


## partial_update

> AsyncOperationResponse partial_update(collection_remote_href, data)

Partially update a collection remote

Trigger an asynchronous partial update task

### Example

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

api_instance = PulpAnsibleClient::RemotesCollectionApi.new
collection_remote_href = 'collection_remote_href_example' # String | URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/
data = PulpAnsibleClient::CollectionRemote.new # CollectionRemote | 

begin
  #Partially update a collection remote
  result = api_instance.partial_update(collection_remote_href, data)
  p result
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling RemotesCollectionApi->partial_update: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_remote_href** | **String**| URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ | 
 **data** | [**CollectionRemote**](CollectionRemote.md)|  | 

### Return type

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

### Authorization

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

### HTTP request headers

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


## read

> CollectionRemote read(collection_remote_href)

Inspect a collection remote

ViewSet for Collection Remotes.

### Example

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

api_instance = PulpAnsibleClient::RemotesCollectionApi.new
collection_remote_href = 'collection_remote_href_example' # String | URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/

begin
  #Inspect a collection remote
  result = api_instance.read(collection_remote_href)
  p result
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling RemotesCollectionApi->read: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_remote_href** | **String**| URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ | 

### Return type

[**CollectionRemote**](CollectionRemote.md)

### Authorization

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

### HTTP request headers

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


## sync

> AsyncOperationResponse sync(collection_remote_href, data)



Trigger an asynchronous task to sync Collection content.

### Example

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

api_instance = PulpAnsibleClient::RemotesCollectionApi.new
collection_remote_href = 'collection_remote_href_example' # String | URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/
data = PulpAnsibleClient::RepositorySyncURL.new # RepositorySyncURL | 

begin
  result = api_instance.sync(collection_remote_href, data)
  p result
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling RemotesCollectionApi->sync: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_remote_href** | **String**| URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ | 
 **data** | [**RepositorySyncURL**](RepositorySyncURL.md)|  | 

### Return type

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

### Authorization

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

### HTTP request headers

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


## update

> AsyncOperationResponse update(collection_remote_href, data)

Update a collection remote

Trigger an asynchronous update task

### Example

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

api_instance = PulpAnsibleClient::RemotesCollectionApi.new
collection_remote_href = 'collection_remote_href_example' # String | URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/
data = PulpAnsibleClient::CollectionRemote.new # CollectionRemote | 

begin
  #Update a collection remote
  result = api_instance.update(collection_remote_href, data)
  p result
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling RemotesCollectionApi->update: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **collection_remote_href** | **String**| URI of Collection Remote. e.g.: /pulp/api/v3/remotes/ansible/collection/1/ | 
 **data** | [**CollectionRemote**](CollectionRemote.md)|  | 

### Return type

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

### Authorization

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

### HTTP request headers

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