pulp_file-client

Fetch, Upload, Organize, and Distribute Software Packages

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v3
  • Package version: 3.56.0.dev0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://pulpproject.org

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import pulpcore.client.pulp_file

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import pulpcore.client.pulp_file

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "http://localhost:24817"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration = pulpcore.client.pulp_file.Configuration(
    host = "http://localhost:24817",
    api_key = {
        'sessionid': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionid'] = 'Bearer'


# Enter a context with an instance of the API client
with pulpcore.client.pulp_file.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_file.AcsFileApi(api_client)
    file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # str | 
nested_role = pulpcore.client.pulp_file.NestedRole() # NestedRole | 

    try:
        # Add a role
        api_response = api_instance.add_role(file_file_alternate_content_source_href, nested_role)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AcsFileApi->add_role: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AcsFileApi add_role POST {file_file_alternate_content_source_href}add_role/ Add a role
AcsFileApi create POST /pulp/api/v3/acs/file/file/ Create a file alternate content source
AcsFileApi delete DELETE {file_file_alternate_content_source_href} Delete a file alternate content source
AcsFileApi list GET /pulp/api/v3/acs/file/file/ List file alternate content sources
AcsFileApi list_roles GET {file_file_alternate_content_source_href}list_roles/ List roles
AcsFileApi my_permissions GET {file_file_alternate_content_source_href}my_permissions/ List user permissions
AcsFileApi partial_update PATCH {file_file_alternate_content_source_href} Update a file alternate content source
AcsFileApi read GET {file_file_alternate_content_source_href} Inspect a file alternate content source
AcsFileApi refresh POST {file_file_alternate_content_source_href}refresh/ Refresh metadata
AcsFileApi remove_role POST {file_file_alternate_content_source_href}remove_role/ Remove a role
AcsFileApi update PUT {file_file_alternate_content_source_href} Update a file alternate content source
ContentFilesApi create POST /pulp/api/v3/content/file/files/ Create a file content
ContentFilesApi list GET /pulp/api/v3/content/file/files/ List file contents
ContentFilesApi read GET {file_file_content_href} Inspect a file content
DistributionsFileApi add_role POST {file_file_distribution_href}add_role/ Add a role
DistributionsFileApi create POST /pulp/api/v3/distributions/file/file/ Create a file distribution
DistributionsFileApi delete DELETE {file_file_distribution_href} Delete a file distribution
DistributionsFileApi list GET /pulp/api/v3/distributions/file/file/ List file distributions
DistributionsFileApi list_roles GET {file_file_distribution_href}list_roles/ List roles
DistributionsFileApi my_permissions GET {file_file_distribution_href}my_permissions/ List user permissions
DistributionsFileApi partial_update PATCH {file_file_distribution_href} Update a file distribution
DistributionsFileApi read GET {file_file_distribution_href} Inspect a file distribution
DistributionsFileApi remove_role POST {file_file_distribution_href}remove_role/ Remove a role
DistributionsFileApi set_label POST {file_file_distribution_href}set_label/ Set a label
DistributionsFileApi unset_label POST {file_file_distribution_href}unset_label/ Unset a label
DistributionsFileApi update PUT {file_file_distribution_href} Update a file distribution
PublicationsFileApi add_role POST {file_file_publication_href}add_role/ Add a role
PublicationsFileApi create POST /pulp/api/v3/publications/file/file/ Create a file publication
PublicationsFileApi delete DELETE {file_file_publication_href} Delete a file publication
PublicationsFileApi list GET /pulp/api/v3/publications/file/file/ List file publications
PublicationsFileApi list_roles GET {file_file_publication_href}list_roles/ List roles
PublicationsFileApi my_permissions GET {file_file_publication_href}my_permissions/ List user permissions
PublicationsFileApi read GET {file_file_publication_href} Inspect a file publication
PublicationsFileApi remove_role POST {file_file_publication_href}remove_role/ Remove a role
RemotesFileApi add_role POST {file_file_remote_href}add_role/ Add a role
RemotesFileApi create POST /pulp/api/v3/remotes/file/file/ Create a file remote
RemotesFileApi delete DELETE {file_file_remote_href} Delete a file remote
RemotesFileApi list GET /pulp/api/v3/remotes/file/file/ List file remotes
RemotesFileApi list_roles GET {file_file_remote_href}list_roles/ List roles
RemotesFileApi my_permissions GET {file_file_remote_href}my_permissions/ List user permissions
RemotesFileApi partial_update PATCH {file_file_remote_href} Update a file remote
RemotesFileApi read GET {file_file_remote_href} Inspect a file remote
RemotesFileApi remove_role POST {file_file_remote_href}remove_role/ Remove a role
RemotesFileApi set_label POST {file_file_remote_href}set_label/ Set a label
RemotesFileApi unset_label POST {file_file_remote_href}unset_label/ Unset a label
RemotesFileApi update PUT {file_file_remote_href} Update a file remote
RepositoriesFileApi add_role POST {file_file_repository_href}add_role/ Add a role
RepositoriesFileApi create POST /pulp/api/v3/repositories/file/file/ Create a file repository
RepositoriesFileApi delete DELETE {file_file_repository_href} Delete a file repository
RepositoriesFileApi list GET /pulp/api/v3/repositories/file/file/ List file repositorys
RepositoriesFileApi list_roles GET {file_file_repository_href}list_roles/ List roles
RepositoriesFileApi modify POST {file_file_repository_href}modify/ Modify Repository Content
RepositoriesFileApi my_permissions GET {file_file_repository_href}my_permissions/ List user permissions
RepositoriesFileApi partial_update PATCH {file_file_repository_href} Update a file repository
RepositoriesFileApi read GET {file_file_repository_href} Inspect a file repository
RepositoriesFileApi remove_role POST {file_file_repository_href}remove_role/ Remove a role
RepositoriesFileApi set_label POST {file_file_repository_href}set_label/ Set a label
RepositoriesFileApi sync POST {file_file_repository_href}sync/ Sync from a remote
RepositoriesFileApi unset_label POST {file_file_repository_href}unset_label/ Unset a label
RepositoriesFileApi update PUT {file_file_repository_href} Update a file repository
RepositoriesFileVersionsApi delete DELETE {file_file_repository_version_href} Delete a repository version
RepositoriesFileVersionsApi list GET {file_file_repository_href}versions/ List repository versions
RepositoriesFileVersionsApi read GET {file_file_repository_version_href} Inspect a repository version
RepositoriesFileVersionsApi repair POST {file_file_repository_version_href}repair/

Documentation For Models

Documentation For Authorization

basicAuth

  • Type: HTTP basic authentication

cookieAuth

  • Type: API key
  • API key parameter name: sessionid
  • Location:

Author

pulp-list@redhat.com