Sha256: 89eb013ea7833c5861d6e819123130793a0e6f28672ca4d4b8d7b62e17d5e732
Contents?: true
Size: 1.78 KB
Versions: 14
Compression:
Stored size: 1.78 KB
Contents
# PulpAnsibleClient::PulpAnsibleDefaultApiV3ArtifactsCollectionsApi
All URIs are relative to *https://pulp*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get**](PulpAnsibleDefaultApiV3ArtifactsCollectionsApi.md#get) | **GET** /pulp_ansible/galaxy/default/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::PulpAnsibleDefaultApiV3ArtifactsCollectionsApi.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 PulpAnsibleDefaultApiV3ArtifactsCollectionsApi->get: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filename** | **String**| |
**path** | **String**| |
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**Array<String>**](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
14 entries across 14 versions & 1 rubygems