Sha256: ba53ab1dd1230a9cc7462a8f641e284f33eda51ac957118b57ac774b1e672b8e

Contents?: true

Size: 2 KB

Versions: 16

Compression:

Stored size: 2 KB

Contents

# PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**download**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md#download) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/artifacts/{filename} | 



## download

> download(distro_base_path, filename, opts)



Collection download endpoint.

### Example

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

api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.new
distro_base_path = 'distro_base_path_example' # String | 
filename = 'filename_example' # String | 
opts = {
  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
}

begin
  api_instance.download(distro_base_path, filename, opts)
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi->download: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **distro_base_path** | **String**|  | 
 **filename** | **String**|  | 
 **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
 **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 

### Return type

nil (empty response body)

### Authorization

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

### HTTP request headers

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

Version data entries

16 entries across 16 versions & 1 rubygems

Version Path
pulp_ansible_client-0.20.10 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.16.6 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.23.1 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.22.3 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.23.0 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.15.6 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.16.5 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.18.3 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.20.9 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.21.9 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.22.2 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.16.4 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.21.8 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.20.8 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.22.1 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md
pulp_ansible_client-0.21.7 docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md