Sha256: a0cf4e03bb16e0ec831540959216fef2293b54e3c479bf10e775bf5ec40448e3

Contents?: true

Size: 1.75 KB

Versions: 15

Compression:

Stored size: 1.75 KB

Contents

# PulpAnsibleClient::PulpAnsibleApiV3ArtifactsCollectionsApi

All URIs are relative to *http://pulp*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get**](PulpAnsibleApiV3ArtifactsCollectionsApi.md#get) | **GET** /pulp_ansible/galaxy/{path}/api/v3/artifacts/collections/{path}/{filename} | 



## get

> get(filename, path, opts)



Download collection.

### 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::PulpAnsibleApiV3ArtifactsCollectionsApi.new
filename = 'filename_example' # String | 
path = 'path_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.get(filename, path, opts)
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling PulpAnsibleApiV3ArtifactsCollectionsApi->get: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **filename** | **String**|  | 
 **path** | **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

15 entries across 15 versions & 1 rubygems

Version Path
pulp_ansible_client-0.22.0 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.20.7 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.21.6 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.20.5 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.20.4 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.21.3 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.21.2 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.20.3 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.21.1 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.21.0 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.20.2 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.20.1 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.18.2 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.20.0 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md
pulp_ansible_client-0.18.1 docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md