# PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi All URIs are relative to *http://localhost:24817* Method | HTTP request | Description ------------- | ------------- | ------------- [**create**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#create) | **POST** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/ | [**delete**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#delete) | **DELETE** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/{name}/ | [**list**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/ | [**partial_update**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#partial_update) | **PATCH** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/{name}/ | [**read**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/{name}/ | ## create > AsyncOperationResponse create(distro_base_path, name, opts) Provides the authentication and permission classes from settings. ### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new distro_base_path = 'distro_base_path_example' # String | name = 'name_example' # String | Required named, only accepts lowercase, numbers and underscores. opts = { company: 'company_example', # String | Optional namespace company owner. email: 'email_example', # String | Optional namespace contact email. description: 'description_example', # String | Optional short description. resources: 'resources_example', # String | Optional resource page in markdown format. links: PulpAnsibleClient::NamespaceLink.new, # Array | Labeled related links. avatar: File.new('/path/to/file') # File | Optional avatar image for Namespace } begin result = api_instance.create(distro_base_path, name, opts) p result rescue PulpAnsibleClient::ApiError => e puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->create: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **distro_base_path** | **String**| | **name** | **String**| Required named, only accepts lowercase, numbers and underscores. | **company** | **String**| Optional namespace company owner. | [optional] **email** | **String**| Optional namespace contact email. | [optional] **description** | **String**| Optional short description. | [optional] **resources** | **String**| Optional resource page in markdown format. | [optional] **links** | [**Array<NamespaceLink>**](NamespaceLink.md)| Labeled related links. | [optional] **avatar** | **File**| Optional avatar image for Namespace | [optional] ### Return type [**AsyncOperationResponse**](AsyncOperationResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded - **Accept**: application/json ## delete > AsyncOperationResponse delete(distro_base_path, name) Try to remove the Namespace if no Collections under Namespace are present. ### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new distro_base_path = 'distro_base_path_example' # String | name = 'name_example' # String | begin result = api_instance.delete(distro_base_path, name) p result rescue PulpAnsibleClient::ApiError => e puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->delete: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **distro_base_path** | **String**| | **name** | **String**| | ### Return type [**AsyncOperationResponse**](AsyncOperationResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## list > PaginatedansibleAnsibleNamespaceMetadataResponseList list(distro_base_path, opts) Provides the authentication and permission classes from settings. ### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new distro_base_path = 'distro_base_path_example' # String | opts = { company: 'company_example', # String | Filter results where company matches value company__contains: 'company__contains_example', # String | Filter results where company contains value company__icontains: 'company__icontains_example', # String | Filter results where company contains value company__iexact: 'company__iexact_example', # String | Filter results where company matches value company__in: ['company__in_example'], # Array | Filter results where company is in a comma-separated list of values company__iregex: 'company__iregex_example', # String | Filter results where company matches regex value company__istartswith: 'company__istartswith_example', # String | Filter results where company starts with value company__regex: 'company__regex_example', # String | Filter results where company matches regex value company__startswith: 'company__startswith_example', # String | Filter results where company starts with value limit: 56, # Integer | Number of results to return per page. metadata_sha256: 'metadata_sha256_example', # String | Filter results where metadata_sha256 matches value metadata_sha256__in: ['metadata_sha256__in_example'], # Array | Filter results where metadata_sha256 is in a comma-separated list of values name: 'name_example', # String | Filter results where name matches value name__contains: 'name__contains_example', # String | Filter results where name contains value name__icontains: 'name__icontains_example', # String | Filter results where name contains value name__iexact: 'name__iexact_example', # String | Filter results where name matches value name__in: ['name__in_example'], # Array | Filter results where name is in a comma-separated list of values name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value name__regex: 'name__regex_example', # String | Filter results where name matches regex value name__startswith: 'name__startswith_example', # String | Filter results where name starts with value offset: 56, # Integer | The initial index from which to return the results. ordering: ['ordering_example'], # Array | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `company` - Company * `-company` - Company (descending) * `email` - Email * `-email` - Email (descending) * `description` - Description * `-description` - Description (descending) * `resources` - Resources * `-resources` - Resources (descending) * `links` - Links * `-links` - Links (descending) * `avatar_sha256` - Avatar sha256 * `-avatar_sha256` - Avatar sha256 (descending) * `metadata_sha256` - Metadata sha256 * `-metadata_sha256` - Metadata sha256 (descending) * `pk` - Pk * `-pk` - Pk (descending) pulp_href__in: ['pulp_href__in_example'], # Array | Multiple values may be separated by commas. pulp_id__in: ['pulp_id__in_example'], # Array | Multiple values may be separated by commas. q: 'q_example', # String | fields: ['fields_example'], # Array | A list of fields to include in the response. exclude_fields: ['exclude_fields_example'] # Array | A list of fields to exclude from the response. } begin result = api_instance.list(distro_base_path, opts) p result rescue PulpAnsibleClient::ApiError => e puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->list: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **distro_base_path** | **String**| | **company** | **String**| Filter results where company matches value | [optional] **company__contains** | **String**| Filter results where company contains value | [optional] **company__icontains** | **String**| Filter results where company contains value | [optional] **company__iexact** | **String**| Filter results where company matches value | [optional] **company__in** | [**Array<String>**](String.md)| Filter results where company is in a comma-separated list of values | [optional] **company__iregex** | **String**| Filter results where company matches regex value | [optional] **company__istartswith** | **String**| Filter results where company starts with value | [optional] **company__regex** | **String**| Filter results where company matches regex value | [optional] **company__startswith** | **String**| Filter results where company starts with value | [optional] **limit** | **Integer**| Number of results to return per page. | [optional] **metadata_sha256** | **String**| Filter results where metadata_sha256 matches value | [optional] **metadata_sha256__in** | [**Array<String>**](String.md)| Filter results where metadata_sha256 is in a comma-separated list of values | [optional] **name** | **String**| Filter results where name matches value | [optional] **name__contains** | **String**| Filter results where name contains value | [optional] **name__icontains** | **String**| Filter results where name contains value | [optional] **name__iexact** | **String**| Filter results where name matches value | [optional] **name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional] **name__iregex** | **String**| Filter results where name matches regex value | [optional] **name__istartswith** | **String**| Filter results where name starts with value | [optional] **name__regex** | **String**| Filter results where name matches regex value | [optional] **name__startswith** | **String**| Filter results where name starts with value | [optional] **offset** | **Integer**| The initial index from which to return the results. | [optional] **ordering** | [**Array<String>**](String.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `company` - Company * `-company` - Company (descending) * `email` - Email * `-email` - Email (descending) * `description` - Description * `-description` - Description (descending) * `resources` - Resources * `-resources` - Resources (descending) * `links` - Links * `-links` - Links (descending) * `avatar_sha256` - Avatar sha256 * `-avatar_sha256` - Avatar sha256 (descending) * `metadata_sha256` - Metadata sha256 * `-metadata_sha256` - Metadata sha256 (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] **pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional] **pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional] **q** | **String**| | [optional] **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 [**PaginatedansibleAnsibleNamespaceMetadataResponseList**](PaginatedansibleAnsibleNamespaceMetadataResponseList.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## partial_update > AsyncOperationResponse partial_update(distro_base_path, name, opts) Provides the authentication and permission classes from settings. ### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new distro_base_path = 'distro_base_path_example' # String | name = 'name_example' # String | opts = { name: 'name_example', # String | Required named, only accepts lowercase, numbers and underscores. company: 'company_example', # String | Optional namespace company owner. email: 'email_example', # String | Optional namespace contact email. description: 'description_example', # String | Optional short description. resources: 'resources_example', # String | Optional resource page in markdown format. links: PulpAnsibleClient::NamespaceLink.new, # Array | Labeled related links. avatar: File.new('/path/to/file') # File | Optional avatar image for Namespace } begin result = api_instance.partial_update(distro_base_path, name, opts) p result rescue PulpAnsibleClient::ApiError => e puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->partial_update: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **distro_base_path** | **String**| | **name** | **String**| | **name** | **String**| Required named, only accepts lowercase, numbers and underscores. | [optional] **company** | **String**| Optional namespace company owner. | [optional] **email** | **String**| Optional namespace contact email. | [optional] **description** | **String**| Optional short description. | [optional] **resources** | **String**| Optional resource page in markdown format. | [optional] **links** | [**Array<NamespaceLink>**](NamespaceLink.md)| Labeled related links. | [optional] **avatar** | **File**| Optional avatar image for Namespace | [optional] ### Return type [**AsyncOperationResponse**](AsyncOperationResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded - **Accept**: application/json ## read > AnsibleAnsibleNamespaceMetadataResponse read(distro_base_path, name, opts) Provides the authentication and permission classes from settings. ### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new distro_base_path = 'distro_base_path_example' # String | name = 'name_example' # String | opts = { fields: ['fields_example'], # Array | A list of fields to include in the response. exclude_fields: ['exclude_fields_example'] # Array | A list of fields to exclude from the response. } begin result = api_instance.read(distro_base_path, name, opts) p result rescue PulpAnsibleClient::ApiError => e puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->read: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **distro_base_path** | **String**| | **name** | **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 [**AnsibleAnsibleNamespaceMetadataResponse**](AnsibleAnsibleNamespaceMetadataResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json