crc-pulp-file-client 20260205.2

Pulp 3 API

pulpcore.client.pulp_file.AcsFileApi

All URIs are relative to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
add_role	POST {file_file_alternate_content_source_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/acs/file/file/	Create a file alternate content source
delete	DELETE {file_file_alternate_content_source_href}	Delete a file alternate content source
list	GET /api/pulp/{pulp_domain}/api/v3/acs/file/file/	List file alternate content sources
list_roles	GET {file_file_alternate_content_source_href}list_roles/	List roles
my_permissions	GET {file_file_alternate_content_source_href}my_permissions/	List user permissions
partial_update	PATCH {file_file_alternate_content_source_href}	Update a file alternate content source
read	GET {file_file_alternate_content_source_href}	Inspect a file alternate content source
refresh	POST {file_file_alternate_content_source_href}refresh/	Refresh metadata
remove_role	POST {file_file_alternate_content_source_href}remove_role/	Remove a role
update	PUT {file_file_alternate_content_source_href}	Update a file alternate content source

add_role

NestedRoleResponse add_role(file_file_alternate_content_source_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.nested_role import NestedRole
from pulpcore.client.pulp_file.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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 | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

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

Parameters

Name	Type	Description	Notes
file_file_alternate_content_source_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

FileFileAlternateContentSourceResponse create(pulp_domain, file_file_alternate_content_source, x_task_diagnostics=x_task_diagnostics)

Create a file alternate content source

Alternate Content Source ViewSet for File

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_alternate_content_source import FileFileAlternateContentSource
from pulpcore.client.pulp_file.models.file_file_alternate_content_source_response import FileFileAlternateContentSourceResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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)
    pulp_domain = 'pulp_domain_example' # str | 
    file_file_alternate_content_source = pulpcore.client.pulp_file.FileFileAlternateContentSource() # FileFileAlternateContentSource | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a file alternate content source
        api_response = api_instance.create(pulp_domain, file_file_alternate_content_source, x_task_diagnostics=x_task_diagnostics)
        print("The response of AcsFileApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AcsFileApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
file_file_alternate_content_source	FileFileAlternateContentSource
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

FileFileAlternateContentSourceResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

AsyncOperationResponse delete(file_file_alternate_content_source_href, x_task_diagnostics=x_task_diagnostics)

Delete a file alternate content source

Trigger an asynchronous delete ACS task

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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 | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a file alternate content source
        api_response = api_instance.delete(file_file_alternate_content_source_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of AcsFileApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AcsFileApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_alternate_content_source_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedfileFileAlternateContentSourceResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, fields=fields, exclude_fields=exclude_fields)

List file alternate content sources

Alternate Content Source ViewSet for File

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.paginatedfile_file_alternate_content_source_response_list import PaginatedfileFileAlternateContentSourceResponseList
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
    name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
    name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
    name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
    name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | 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) * `name` - Name * `-name` - Name (descending) * `last_refreshed` - Last refreshed * `-last_refreshed` - Last refreshed (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List file alternate content sources
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of AcsFileApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AcsFileApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Number of results to return per page.	[optional]
name	str	Filter results where name matches value	[optional]
name__contains	str	Filter results where name contains value	[optional]
name__icontains	str	Filter results where name contains value	[optional]
name__iexact	str	Filter results where name matches value	[optional]
name__in	List[str]	Filter results where name is in a comma-separated list of values	[optional]
name__iregex	str	Filter results where name matches regex value	[optional]
name__istartswith	str	Filter results where name starts with value	[optional]
name__regex	str	Filter results where name matches regex value	[optional]
name__startswith	str	Filter results where name starts with value	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	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) * `name` - Name * `-name` - Name (descending) * `last_refreshed` - Last refreshed * `-last_refreshed` - Last refreshed (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedfileFileAlternateContentSourceResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_roles

ObjectRolesResponse list_roles(file_file_alternate_content_source_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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 | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List roles
        api_response = api_instance.list_roles(file_file_alternate_content_source_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of AcsFileApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AcsFileApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_alternate_content_source_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

ObjectRolesResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

my_permissions

MyPermissionsResponse my_permissions(file_file_alternate_content_source_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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 | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List user permissions
        api_response = api_instance.my_permissions(file_file_alternate_content_source_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of AcsFileApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AcsFileApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_alternate_content_source_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

MyPermissionsResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

partial_update

FileFileAlternateContentSourceResponse partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source, x_task_diagnostics=x_task_diagnostics)

Update a file alternate content source

Update the entity partially and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_alternate_content_source_response import FileFileAlternateContentSourceResponse
from pulpcore.client.pulp_file.models.patchedfile_file_alternate_content_source import PatchedfileFileAlternateContentSource
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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 | 
    patchedfile_file_alternate_content_source = pulpcore.client.pulp_file.PatchedfileFileAlternateContentSource() # PatchedfileFileAlternateContentSource | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a file alternate content source
        api_response = api_instance.partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source, x_task_diagnostics=x_task_diagnostics)
        print("The response of AcsFileApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AcsFileApi->partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_alternate_content_source_href	str
patchedfile_file_alternate_content_source	PatchedfileFileAlternateContentSource
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

FileFileAlternateContentSourceResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

FileFileAlternateContentSourceResponse read(file_file_alternate_content_source_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a file alternate content source

Alternate Content Source ViewSet for File

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_alternate_content_source_response import FileFileAlternateContentSourceResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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 | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a file alternate content source
        api_response = api_instance.read(file_file_alternate_content_source_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of AcsFileApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AcsFileApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_alternate_content_source_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

FileFileAlternateContentSourceResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

refresh

TaskGroupOperationResponse refresh(file_file_alternate_content_source_href, x_task_diagnostics=x_task_diagnostics)

Refresh metadata

Trigger an asynchronous task to create Alternate Content Source content.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.task_group_operation_response import TaskGroupOperationResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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 | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Refresh metadata
        api_response = api_instance.refresh(file_file_alternate_content_source_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of AcsFileApi->refresh:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AcsFileApi->refresh: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_alternate_content_source_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

TaskGroupOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_role

NestedRoleResponse remove_role(file_file_alternate_content_source_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.nested_role import NestedRole
from pulpcore.client.pulp_file.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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 | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(file_file_alternate_content_source_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of AcsFileApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AcsFileApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_alternate_content_source_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

FileFileAlternateContentSourceResponse update(file_file_alternate_content_source_href, file_file_alternate_content_source, x_task_diagnostics=x_task_diagnostics)

Update a file alternate content source

Update the entity and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_alternate_content_source import FileFileAlternateContentSource
from pulpcore.client.pulp_file.models.file_file_alternate_content_source_response import FileFileAlternateContentSourceResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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 | 
    file_file_alternate_content_source = pulpcore.client.pulp_file.FileFileAlternateContentSource() # FileFileAlternateContentSource | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a file alternate content source
        api_response = api_instance.update(file_file_alternate_content_source_href, file_file_alternate_content_source, x_task_diagnostics=x_task_diagnostics)
        print("The response of AcsFileApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AcsFileApi->update: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_alternate_content_source_href	str
file_file_alternate_content_source	FileFileAlternateContentSource
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

FileFileAlternateContentSourceResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AsyncOperationResponse

Serializer for asynchronous operations.

Properties

Name	Type	Description	Notes
task	str	The href of the task.

Example

from pulpcore.client.pulp_file.models.async_operation_response import AsyncOperationResponse

# TODO update the JSON string below
json = "{}"
# create an instance of AsyncOperationResponse from a JSON string
async_operation_response_instance = AsyncOperationResponse.from_json(json)
# print the JSON string representation of the object
print(AsyncOperationResponse.to_json())

# convert the object into a dict
async_operation_response_dict = async_operation_response_instance.to_dict()
# create an instance of AsyncOperationResponse from a dict
async_operation_response_from_dict = AsyncOperationResponse.from_dict(async_operation_response_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_file.ContentFilesApi

All URIs are relative to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
create	POST /api/pulp/{pulp_domain}/api/v3/content/file/files/	Create a file content
list	GET /api/pulp/{pulp_domain}/api/v3/content/file/files/	List file contents
read	GET {file_file_content_href}	Inspect a file content
set_label	POST {file_file_content_href}set_label/	Set a label
unset_label	POST {file_file_content_href}unset_label/	Unset a label
upload	POST /api/pulp/{pulp_domain}/api/v3/content/file/files/upload/	Upload a File synchronously.

create

AsyncOperationResponse create(pulp_domain, relative_path, x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url, downloader_config=downloader_config)

Create a file content

Trigger an asynchronous task to create content,optionally create new repository version.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.ContentFilesApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    relative_path = 'relative_path_example' # str | Path where the artifact is located relative to distributions base_path
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    repository = 'repository_example' # str | A URI of a repository the new content unit should be associated with. (optional)
    pulp_labels = None # Dict[str, Optional[str]] | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. (optional)
    artifact = 'artifact_example' # str | Artifact file representing the physical content (optional)
    file = None # bytearray | An uploaded file that may be turned into the content unit. (optional)
    upload = 'upload_example' # str | An uncommitted upload that may be turned into the content unit. (optional)
    file_url = 'file_url_example' # str | A url that Pulp can download and turn into the content unit. (optional)
    downloader_config = pulpcore.client.pulp_file.RemoteNetworkConfig() # RemoteNetworkConfig | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url. (optional)

    try:
        # Create a file content
        api_response = api_instance.create(pulp_domain, relative_path, x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url, downloader_config=downloader_config)
        print("The response of ContentFilesApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentFilesApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
relative_path	str	Path where the artifact is located relative to distributions base_path
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
repository	str	A URI of a repository the new content unit should be associated with.	[optional]
pulp_labels	Dict[str, Optional[str]]	A dictionary of arbitrary key/value pairs used to describe a specific Content instance.	[optional]
artifact	str	Artifact file representing the physical content	[optional]
file	bytearray	An uploaded file that may be turned into the content unit.	[optional]
upload	str	An uncommitted upload that may be turned into the content unit.	[optional]
file_url	str	A url that Pulp can download and turn into the content unit.	[optional]
downloader_config	RemoteNetworkConfig	Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: multipart/form-data, application/x-www-form-urlencoded
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedfileFileContentResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, digest=digest, limit=limit, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, relative_path=relative_path, relative_path__contains=relative_path__contains, relative_path__icontains=relative_path__icontains, relative_path__iexact=relative_path__iexact, relative_path__in=relative_path__in, relative_path__iregex=relative_path__iregex, relative_path__istartswith=relative_path__istartswith, relative_path__regex=relative_path__regex, relative_path__startswith=relative_path__startswith, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, sha256=sha256, fields=fields, exclude_fields=exclude_fields)

List file contents

FileContent represents a single file and its metadata, which can be added and removed from repositories.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.paginatedfile_file_content_response_list import PaginatedfileFileContentResponseList
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.ContentFilesApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    digest = 'digest_example' # str | Filter results where digest matches value (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | 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) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `digest` - Digest * `-digest` - Digest (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    orphaned_for = 3.4 # float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    relative_path = 'relative_path_example' # str | Filter results where relative_path matches value (optional)
    relative_path__contains = 'relative_path__contains_example' # str | Filter results where relative_path contains value (optional)
    relative_path__icontains = 'relative_path__icontains_example' # str | Filter results where relative_path contains value (optional)
    relative_path__iexact = 'relative_path__iexact_example' # str | Filter results where relative_path matches value (optional)
    relative_path__in = ['relative_path__in_example'] # List[str] | Filter results where relative_path is in a comma-separated list of values (optional)
    relative_path__iregex = 'relative_path__iregex_example' # str | Filter results where relative_path matches regex value (optional)
    relative_path__istartswith = 'relative_path__istartswith_example' # str | Filter results where relative_path starts with value (optional)
    relative_path__regex = 'relative_path__regex_example' # str | Filter results where relative_path matches regex value (optional)
    relative_path__startswith = 'relative_path__startswith_example' # str | Filter results where relative_path starts with value (optional)
    repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_added = 'repository_version_added_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_removed = 'repository_version_removed_example' # str | Repository Version referenced by HREF/PRN (optional)
    sha256 = 'sha256_example' # str |  (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List file contents
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, digest=digest, limit=limit, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, relative_path=relative_path, relative_path__contains=relative_path__contains, relative_path__icontains=relative_path__icontains, relative_path__iexact=relative_path__iexact, relative_path__in=relative_path__in, relative_path__iregex=relative_path__iregex, relative_path__istartswith=relative_path__istartswith, relative_path__regex=relative_path__regex, relative_path__startswith=relative_path__startswith, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, sha256=sha256, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentFilesApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentFilesApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
digest	str	Filter results where digest matches value	[optional]
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	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) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `digest` - Digest * `-digest` - Digest (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
orphaned_for	float	Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_label_select	str	Filter labels by search string	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
relative_path	str	Filter results where relative_path matches value	[optional]
relative_path__contains	str	Filter results where relative_path contains value	[optional]
relative_path__icontains	str	Filter results where relative_path contains value	[optional]
relative_path__iexact	str	Filter results where relative_path matches value	[optional]
relative_path__in	List[str]	Filter results where relative_path is in a comma-separated list of values	[optional]
relative_path__iregex	str	Filter results where relative_path matches regex value	[optional]
relative_path__istartswith	str	Filter results where relative_path starts with value	[optional]
relative_path__regex	str	Filter results where relative_path matches regex value	[optional]
relative_path__startswith	str	Filter results where relative_path starts with value	[optional]
repository_version	str	Repository Version referenced by HREF/PRN	[optional]
repository_version_added	str	Repository Version referenced by HREF/PRN	[optional]
repository_version_removed	str	Repository Version referenced by HREF/PRN	[optional]
sha256	str		[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedfileFileContentResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

FileFileContentResponse read(file_file_content_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a file content

FileContent represents a single file and its metadata, which can be added and removed from repositories.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_content_response import FileFileContentResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.ContentFilesApi(api_client)
    file_file_content_href = 'file_file_content_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a file content
        api_response = api_instance.read(file_file_content_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentFilesApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentFilesApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_content_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

FileFileContentResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

SetLabelResponse set_label(file_file_content_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.set_label import SetLabel
from pulpcore.client.pulp_file.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.ContentFilesApi(api_client)
    file_file_content_href = 'file_file_content_href_example' # str | 
    set_label = pulpcore.client.pulp_file.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(file_file_content_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentFilesApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentFilesApi->set_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_content_href	str
set_label	SetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

SetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unset_label

UnsetLabelResponse unset_label(file_file_content_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.unset_label import UnsetLabel
from pulpcore.client.pulp_file.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.ContentFilesApi(api_client)
    file_file_content_href = 'file_file_content_href_example' # str | 
    unset_label = pulpcore.client.pulp_file.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(file_file_content_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentFilesApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentFilesApi->unset_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_content_href	str
unset_label	UnsetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

UnsetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload

FileContentUploadResponse upload(pulp_domain, relative_path, x_task_diagnostics=x_task_diagnostics, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url, downloader_config=downloader_config)

Upload a File synchronously.

Synchronously upload a File.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_content_upload_response import FileContentUploadResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.ContentFilesApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    relative_path = 'relative_path_example' # str | Path where the artifact is located relative to distributions base_path
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    pulp_labels = None # Dict[str, Optional[str]] | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. (optional)
    artifact = 'artifact_example' # str | Artifact file representing the physical content (optional)
    file = None # bytearray | An uploaded file that may be turned into the content unit. (optional)
    upload = 'upload_example' # str | An uncommitted upload that may be turned into the content unit. (optional)
    file_url = 'file_url_example' # str | A url that Pulp can download and turn into the content unit. (optional)
    downloader_config = pulpcore.client.pulp_file.RemoteNetworkConfig() # RemoteNetworkConfig | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url. (optional)

    try:
        # Upload a File synchronously.
        api_response = api_instance.upload(pulp_domain, relative_path, x_task_diagnostics=x_task_diagnostics, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url, downloader_config=downloader_config)
        print("The response of ContentFilesApi->upload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentFilesApi->upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
relative_path	str	Path where the artifact is located relative to distributions base_path
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
pulp_labels	Dict[str, Optional[str]]	A dictionary of arbitrary key/value pairs used to describe a specific Content instance.	[optional]
artifact	str	Artifact file representing the physical content	[optional]
file	bytearray	An uploaded file that may be turned into the content unit.	[optional]
upload	str	An uncommitted upload that may be turned into the content unit.	[optional]
file_url	str	A url that Pulp can download and turn into the content unit.	[optional]
downloader_config	RemoteNetworkConfig	Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url.	[optional]

Return type

FileContentUploadResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: multipart/form-data, application/x-www-form-urlencoded
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentSummaryResponse

Serializer for the RepositoryVersion content summary

Properties

Name	Type	Description	Notes
added	Dict[str, object]
removed	Dict[str, object]
present	Dict[str, object]

Example

from pulpcore.client.pulp_file.models.content_summary_response import ContentSummaryResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ContentSummaryResponse from a JSON string
content_summary_response_instance = ContentSummaryResponse.from_json(json)
# print the JSON string representation of the object
print(ContentSummaryResponse.to_json())

# convert the object into a dict
content_summary_response_dict = content_summary_response_instance.to_dict()
# create an instance of ContentSummaryResponse from a dict
content_summary_response_from_dict = ContentSummaryResponse.from_dict(content_summary_response_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_file.DistributionsFileApi

All URIs are relative to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
add_role	POST {file_file_distribution_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/distributions/file/file/	Create a file distribution
delete	DELETE {file_file_distribution_href}	Delete a file distribution
list	GET /api/pulp/{pulp_domain}/api/v3/distributions/file/file/	List file distributions
list_roles	GET {file_file_distribution_href}list_roles/	List roles
my_permissions	GET {file_file_distribution_href}my_permissions/	List user permissions
partial_update	PATCH {file_file_distribution_href}	Update a file distribution
read	GET {file_file_distribution_href}	Inspect a file distribution
remove_role	POST {file_file_distribution_href}remove_role/	Remove a role
set_label	POST {file_file_distribution_href}set_label/	Set a label
unset_label	POST {file_file_distribution_href}unset_label/	Unset a label
update	PUT {file_file_distribution_href}	Update a file distribution

add_role

NestedRoleResponse add_role(file_file_distribution_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.nested_role import NestedRole
from pulpcore.client.pulp_file.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.DistributionsFileApi(api_client)
    file_file_distribution_href = 'file_file_distribution_href_example' # str | 
    nested_role = pulpcore.client.pulp_file.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(file_file_distribution_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsFileApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsFileApi->add_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_distribution_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

AsyncOperationResponse create(pulp_domain, file_file_distribution, x_task_diagnostics=x_task_diagnostics)

Create a file distribution

Trigger an asynchronous create task

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_file.models.file_file_distribution import FileFileDistribution
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.DistributionsFileApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    file_file_distribution = pulpcore.client.pulp_file.FileFileDistribution() # FileFileDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a file distribution
        api_response = api_instance.create(pulp_domain, file_file_distribution, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsFileApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsFileApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
file_file_distribution	FileFileDistribution
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

AsyncOperationResponse delete(file_file_distribution_href, x_task_diagnostics=x_task_diagnostics)

Delete a file distribution

Trigger an asynchronous delete task

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.DistributionsFileApi(api_client)
    file_file_distribution_href = 'file_file_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a file distribution
        api_response = api_instance.delete(file_file_distribution_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsFileApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsFileApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_distribution_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedfileFileDistributionResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_path=base_path, base_path__contains=base_path__contains, base_path__icontains=base_path__icontains, base_path__in=base_path__in, checkpoint=checkpoint, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)

List file distributions

FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.paginatedfile_file_distribution_response_list import PaginatedfileFileDistributionResponseList
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.DistributionsFileApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    base_path = 'base_path_example' # str | Filter results where base_path matches value (optional)
    base_path__contains = 'base_path__contains_example' # str | Filter results where base_path contains value (optional)
    base_path__icontains = 'base_path__icontains_example' # str | Filter results where base_path contains value (optional)
    base_path__in = ['base_path__in_example'] # List[str] | Filter results where base_path is in a comma-separated list of values (optional)
    checkpoint = True # bool | Filter results where checkpoint matches value (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
    name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
    name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
    name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
    name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository = 'repository_example' # str | Filter results where repository matches value (optional)
    repository__in = ['repository__in_example'] # List[str] | Filter results where repository is in a comma-separated list of values (optional)
    with_content = 'with_content_example' # str | Filter distributions based on the content served by them (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List file distributions
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_path=base_path, base_path__contains=base_path__contains, base_path__icontains=base_path__icontains, base_path__in=base_path__in, checkpoint=checkpoint, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsFileApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsFileApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
base_path	str	Filter results where base_path matches value	[optional]
base_path__contains	str	Filter results where base_path contains value	[optional]
base_path__icontains	str	Filter results where base_path contains value	[optional]
base_path__in	List[str]	Filter results where base_path is in a comma-separated list of values	[optional]
checkpoint	bool	Filter results where checkpoint matches value	[optional]
limit	int	Number of results to return per page.	[optional]
name	str	Filter results where name matches value	[optional]
name__contains	str	Filter results where name contains value	[optional]
name__icontains	str	Filter results where name contains value	[optional]
name__iexact	str	Filter results where name matches value	[optional]
name__in	List[str]	Filter results where name is in a comma-separated list of values	[optional]
name__iregex	str	Filter results where name matches regex value	[optional]
name__istartswith	str	Filter results where name starts with value	[optional]
name__regex	str	Filter results where name matches regex value	[optional]
name__startswith	str	Filter results where name starts with value	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_label_select	str	Filter labels by search string	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
repository	str	Filter results where repository matches value	[optional]
repository__in	List[str]	Filter results where repository is in a comma-separated list of values	[optional]
with_content	str	Filter distributions based on the content served by them	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedfileFileDistributionResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_roles

ObjectRolesResponse list_roles(file_file_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.DistributionsFileApi(api_client)
    file_file_distribution_href = 'file_file_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List roles
        api_response = api_instance.list_roles(file_file_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsFileApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsFileApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_distribution_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

ObjectRolesResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

my_permissions

MyPermissionsResponse my_permissions(file_file_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.DistributionsFileApi(api_client)
    file_file_distribution_href = 'file_file_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List user permissions
        api_response = api_instance.my_permissions(file_file_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsFileApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsFileApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_distribution_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

MyPermissionsResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

partial_update

FileFileDistributionResponse partial_update(file_file_distribution_href, patchedfile_file_distribution, x_task_diagnostics=x_task_diagnostics)

Update a file distribution

Update the entity partially and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_distribution_response import FileFileDistributionResponse
from pulpcore.client.pulp_file.models.patchedfile_file_distribution import PatchedfileFileDistribution
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.DistributionsFileApi(api_client)
    file_file_distribution_href = 'file_file_distribution_href_example' # str | 
    patchedfile_file_distribution = pulpcore.client.pulp_file.PatchedfileFileDistribution() # PatchedfileFileDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a file distribution
        api_response = api_instance.partial_update(file_file_distribution_href, patchedfile_file_distribution, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsFileApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsFileApi->partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_distribution_href	str
patchedfile_file_distribution	PatchedfileFileDistribution
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

FileFileDistributionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

FileFileDistributionResponse read(file_file_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a file distribution

FileDistributions host File Publications which makes the metadata and the referenced File Content available to HTTP clients. Additionally, a FileDistribution with an associated FilePublication can be the target url of a File Remote , allowing another instance of Pulp to sync the content.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_distribution_response import FileFileDistributionResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.DistributionsFileApi(api_client)
    file_file_distribution_href = 'file_file_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a file distribution
        api_response = api_instance.read(file_file_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsFileApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsFileApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_distribution_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

FileFileDistributionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_role

NestedRoleResponse remove_role(file_file_distribution_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.nested_role import NestedRole
from pulpcore.client.pulp_file.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.DistributionsFileApi(api_client)
    file_file_distribution_href = 'file_file_distribution_href_example' # str | 
    nested_role = pulpcore.client.pulp_file.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(file_file_distribution_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsFileApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsFileApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_distribution_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

SetLabelResponse set_label(file_file_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.set_label import SetLabel
from pulpcore.client.pulp_file.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.DistributionsFileApi(api_client)
    file_file_distribution_href = 'file_file_distribution_href_example' # str | 
    set_label = pulpcore.client.pulp_file.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(file_file_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsFileApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsFileApi->set_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_distribution_href	str
set_label	SetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

SetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unset_label

UnsetLabelResponse unset_label(file_file_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.unset_label import UnsetLabel
from pulpcore.client.pulp_file.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.DistributionsFileApi(api_client)
    file_file_distribution_href = 'file_file_distribution_href_example' # str | 
    unset_label = pulpcore.client.pulp_file.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(file_file_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsFileApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsFileApi->unset_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_distribution_href	str
unset_label	UnsetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

UnsetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

FileFileDistributionResponse update(file_file_distribution_href, file_file_distribution, x_task_diagnostics=x_task_diagnostics)

Update a file distribution

Update the entity and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_distribution import FileFileDistribution
from pulpcore.client.pulp_file.models.file_file_distribution_response import FileFileDistributionResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.DistributionsFileApi(api_client)
    file_file_distribution_href = 'file_file_distribution_href_example' # str | 
    file_file_distribution = pulpcore.client.pulp_file.FileFileDistribution() # FileFileDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a file distribution
        api_response = api_instance.update(file_file_distribution_href, file_file_distribution, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsFileApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsFileApi->update: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_distribution_href	str
file_file_distribution	FileFileDistribution
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

FileFileDistributionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FileContentUploadResponse

Serializer for File Content.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
pulp_labels	Dict[str, Optional[str]]	A dictionary of arbitrary key/value pairs used to describe a specific Content instance.	[optional]
vuln_report	str		[optional] [readonly]
artifact	str	Artifact file representing the physical content	[optional]
relative_path	str	Path where the artifact is located relative to distributions base_path
md5	str	The MD5 checksum if available.	[optional] [readonly]
sha1	str	The SHA-1 checksum if available.	[optional] [readonly]
sha224	str	The SHA-224 checksum if available.	[optional] [readonly]
sha256	str	The SHA-256 checksum if available.	[optional] [readonly]
sha384	str	The SHA-384 checksum if available.	[optional] [readonly]
sha512	str	The SHA-512 checksum if available.	[optional] [readonly]

Example

from pulpcore.client.pulp_file.models.file_content_upload_response import FileContentUploadResponse

# TODO update the JSON string below
json = "{}"
# create an instance of FileContentUploadResponse from a JSON string
file_content_upload_response_instance = FileContentUploadResponse.from_json(json)
# print the JSON string representation of the object
print(FileContentUploadResponse.to_json())

# convert the object into a dict
file_content_upload_response_dict = file_content_upload_response_instance.to_dict()
# create an instance of FileContentUploadResponse from a dict
file_content_upload_response_from_dict = FileContentUploadResponse.from_dict(file_content_upload_response_dict)

[Back to Model list] [Back to API list] [Back to README]

FileFileAlternateContentSource

Serializer for File alternate content source.

Properties

Name	Type	Description	Notes
name	str	Name of Alternate Content Source.
last_refreshed	datetime	Date of last refresh of AlternateContentSource.	[optional]
paths	List[str]	List of paths that will be appended to the Remote url when searching for content.	[optional]
remote	str	The remote to provide alternate content source.

Example

from pulpcore.client.pulp_file.models.file_file_alternate_content_source import FileFileAlternateContentSource

# TODO update the JSON string below
json = "{}"
# create an instance of FileFileAlternateContentSource from a JSON string
file_file_alternate_content_source_instance = FileFileAlternateContentSource.from_json(json)
# print the JSON string representation of the object
print(FileFileAlternateContentSource.to_json())

# convert the object into a dict
file_file_alternate_content_source_dict = file_file_alternate_content_source_instance.to_dict()
# create an instance of FileFileAlternateContentSource from a dict
file_file_alternate_content_source_from_dict = FileFileAlternateContentSource.from_dict(file_file_alternate_content_source_dict)

[Back to Model list] [Back to API list] [Back to README]

FileFileAlternateContentSourceResponse

Serializer for File alternate content source.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
name	str	Name of Alternate Content Source.
last_refreshed	datetime	Date of last refresh of AlternateContentSource.	[optional]
paths	List[str]	List of paths that will be appended to the Remote url when searching for content.	[optional]
remote	str	The remote to provide alternate content source.

Example

from pulpcore.client.pulp_file.models.file_file_alternate_content_source_response import FileFileAlternateContentSourceResponse

# TODO update the JSON string below
json = "{}"
# create an instance of FileFileAlternateContentSourceResponse from a JSON string
file_file_alternate_content_source_response_instance = FileFileAlternateContentSourceResponse.from_json(json)
# print the JSON string representation of the object
print(FileFileAlternateContentSourceResponse.to_json())

# convert the object into a dict
file_file_alternate_content_source_response_dict = file_file_alternate_content_source_response_instance.to_dict()
# create an instance of FileFileAlternateContentSourceResponse from a dict
file_file_alternate_content_source_response_from_dict = FileFileAlternateContentSourceResponse.from_dict(file_file_alternate_content_source_response_dict)

[Back to Model list] [Back to API list] [Back to README]

FileFileContentResponse

Serializer for File Content.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
pulp_labels	Dict[str, Optional[str]]	A dictionary of arbitrary key/value pairs used to describe a specific Content instance.	[optional]
vuln_report	str		[optional] [readonly]
artifact	str	Artifact file representing the physical content	[optional]
relative_path	str	Path where the artifact is located relative to distributions base_path
md5	str	The MD5 checksum if available.	[optional] [readonly]
sha1	str	The SHA-1 checksum if available.	[optional] [readonly]
sha224	str	The SHA-224 checksum if available.	[optional] [readonly]
sha256	str	The SHA-256 checksum if available.	[optional] [readonly]
sha384	str	The SHA-384 checksum if available.	[optional] [readonly]
sha512	str	The SHA-512 checksum if available.	[optional] [readonly]

Example

from pulpcore.client.pulp_file.models.file_file_content_response import FileFileContentResponse

# TODO update the JSON string below
json = "{}"
# create an instance of FileFileContentResponse from a JSON string
file_file_content_response_instance = FileFileContentResponse.from_json(json)
# print the JSON string representation of the object
print(FileFileContentResponse.to_json())

# convert the object into a dict
file_file_content_response_dict = file_file_content_response_instance.to_dict()
# create an instance of FileFileContentResponse from a dict
file_file_content_response_from_dict = FileFileContentResponse.from_dict(file_file_content_response_dict)

[Back to Model list] [Back to API list] [Back to README]

FileFileDistribution

Serializer for File Distributions.

Properties

Name	Type	Description	Notes
base_path	str	The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. "foo" and "foo/bar")
content_guard	str	An optional content-guard.	[optional]
hidden	bool	Whether this distribution should be shown in the content app.	[optional] [default to False]
pulp_labels	Dict[str, Optional[str]]		[optional]
name	str	A unique name. Ex, `rawhide` and `stable`.
repository	str	The latest RepositoryVersion for this Repository will be served.	[optional]
publication	str	Publication to be served	[optional]
checkpoint	bool		[optional]

Example

from pulpcore.client.pulp_file.models.file_file_distribution import FileFileDistribution

# TODO update the JSON string below
json = "{}"
# create an instance of FileFileDistribution from a JSON string
file_file_distribution_instance = FileFileDistribution.from_json(json)
# print the JSON string representation of the object
print(FileFileDistribution.to_json())

# convert the object into a dict
file_file_distribution_dict = file_file_distribution_instance.to_dict()
# create an instance of FileFileDistribution from a dict
file_file_distribution_from_dict = FileFileDistribution.from_dict(file_file_distribution_dict)

[Back to Model list] [Back to API list] [Back to README]

FileFileDistributionResponse

Serializer for File Distributions.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
base_path	str	The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. "foo" and "foo/bar")
base_url	str	The URL for accessing the publication as defined by this distribution.	[optional] [readonly]
content_guard	str	An optional content-guard.	[optional]
no_content_change_since	str	Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes.	[optional] [readonly]
hidden	bool	Whether this distribution should be shown in the content app.	[optional] [default to False]
pulp_labels	Dict[str, Optional[str]]		[optional]
name	str	A unique name. Ex, `rawhide` and `stable`.
repository	str	The latest RepositoryVersion for this Repository will be served.	[optional]
publication	str	Publication to be served	[optional]
checkpoint	bool		[optional]

Example

from pulpcore.client.pulp_file.models.file_file_distribution_response import FileFileDistributionResponse

# TODO update the JSON string below
json = "{}"
# create an instance of FileFileDistributionResponse from a JSON string
file_file_distribution_response_instance = FileFileDistributionResponse.from_json(json)
# print the JSON string representation of the object
print(FileFileDistributionResponse.to_json())

# convert the object into a dict
file_file_distribution_response_dict = file_file_distribution_response_instance.to_dict()
# create an instance of FileFileDistributionResponse from a dict
file_file_distribution_response_from_dict = FileFileDistributionResponse.from_dict(file_file_distribution_response_dict)

[Back to Model list] [Back to API list] [Back to README]

FileFilePublication

Serializer for File Publications.

Properties

Name	Type	Description	Notes
repository_version	str		[optional]
repository	str	A URI of the repository to be published.	[optional]
manifest	str	Filename to use for manifest file containing metadata for all the files.	[optional] [default to 'PULP_MANIFEST']
checkpoint	bool		[optional]

Example

from pulpcore.client.pulp_file.models.file_file_publication import FileFilePublication

# TODO update the JSON string below
json = "{}"
# create an instance of FileFilePublication from a JSON string
file_file_publication_instance = FileFilePublication.from_json(json)
# print the JSON string representation of the object
print(FileFilePublication.to_json())

# convert the object into a dict
file_file_publication_dict = file_file_publication_instance.to_dict()
# create an instance of FileFilePublication from a dict
file_file_publication_from_dict = FileFilePublication.from_dict(file_file_publication_dict)

[Back to Model list] [Back to API list] [Back to README]

FileFilePublicationResponse

Serializer for File Publications.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
repository_version	str		[optional]
repository	str	A URI of the repository to be published.	[optional]
distributions	List[str]	This publication is currently hosted as defined by these distributions.	[optional] [readonly]
manifest	str	Filename to use for manifest file containing metadata for all the files.	[optional] [default to 'PULP_MANIFEST']
checkpoint	bool		[optional]

Example

from pulpcore.client.pulp_file.models.file_file_publication_response import FileFilePublicationResponse

# TODO update the JSON string below
json = "{}"
# create an instance of FileFilePublicationResponse from a JSON string
file_file_publication_response_instance = FileFilePublicationResponse.from_json(json)
# print the JSON string representation of the object
print(FileFilePublicationResponse.to_json())

# convert the object into a dict
file_file_publication_response_dict = file_file_publication_response_instance.to_dict()
# create an instance of FileFilePublicationResponse from a dict
file_file_publication_response_from_dict = FileFilePublicationResponse.from_dict(file_file_publication_response_dict)

[Back to Model list] [Back to API list] [Back to README]

FileFileRemote

Serializer for File Remotes.

Properties

Name	Type	Description	Notes
name	str	A unique name for this remote.
url	str	The URL of an external content source.
pulp_labels	Dict[str, Optional[str]]		[optional]
policy	PolicyEnum	The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.	[optional]
ca_cert	str	A PEM encoded CA certificate used to validate the server certificate presented by the remote server.	[optional]
client_cert	str	A PEM encoded client certificate used for authentication.	[optional]
client_key	str	A PEM encoded private key used for authentication.	[optional]
tls_validation	bool	If True, TLS peer validation must be performed.	[optional]
proxy_url	str	The proxy URL. Format: scheme://host:port	[optional]
proxy_username	str	The username to authenticte to the proxy.	[optional]
proxy_password	str	The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed.	[optional]
username	str	The username to be used for authentication when syncing.	[optional]
password	str	The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed.	[optional]
max_retries	int	Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.	[optional]
total_timeout	float	aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
connect_timeout	float	aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_connect_timeout	float	aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_read_timeout	float	aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
headers	List[object]	Headers for aiohttp.Clientsession	[optional]
download_concurrency	int	Total number of simultaneous connections. If not set then the default value will be used.	[optional]
rate_limit	int	Limits requests per second for each concurrent downloader	[optional]

Example

from pulpcore.client.pulp_file.models.file_file_remote import FileFileRemote

# TODO update the JSON string below
json = "{}"
# create an instance of FileFileRemote from a JSON string
file_file_remote_instance = FileFileRemote.from_json(json)
# print the JSON string representation of the object
print(FileFileRemote.to_json())

# convert the object into a dict
file_file_remote_dict = file_file_remote_instance.to_dict()
# create an instance of FileFileRemote from a dict
file_file_remote_from_dict = FileFileRemote.from_dict(file_file_remote_dict)

[Back to Model list] [Back to API list] [Back to README]

FileFileRemoteResponseHiddenFieldsInner

Properties

Name	Type	Description	Notes
name	str
is_set	bool

Example

from pulpcore.client.pulp_file.models.file_file_remote_response_hidden_fields_inner import FileFileRemoteResponseHiddenFieldsInner

# TODO update the JSON string below
json = "{}"
# create an instance of FileFileRemoteResponseHiddenFieldsInner from a JSON string
file_file_remote_response_hidden_fields_inner_instance = FileFileRemoteResponseHiddenFieldsInner.from_json(json)
# print the JSON string representation of the object
print(FileFileRemoteResponseHiddenFieldsInner.to_json())

# convert the object into a dict
file_file_remote_response_hidden_fields_inner_dict = file_file_remote_response_hidden_fields_inner_instance.to_dict()
# create an instance of FileFileRemoteResponseHiddenFieldsInner from a dict
file_file_remote_response_hidden_fields_inner_from_dict = FileFileRemoteResponseHiddenFieldsInner.from_dict(file_file_remote_response_hidden_fields_inner_dict)

[Back to Model list] [Back to API list] [Back to README]

FileFileRemoteResponse

Serializer for File Remotes.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the most recent update of the remote.	[optional] [readonly]
name	str	A unique name for this remote.
url	str	The URL of an external content source.
pulp_labels	Dict[str, Optional[str]]		[optional]
policy	PolicyEnum	The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.	[optional]
hidden_fields	List[FileFileRemoteResponseHiddenFieldsInner]	List of hidden (write only) fields	[optional] [readonly]
ca_cert	str	A PEM encoded CA certificate used to validate the server certificate presented by the remote server.	[optional]
client_cert	str	A PEM encoded client certificate used for authentication.	[optional]
tls_validation	bool	If True, TLS peer validation must be performed.	[optional]
proxy_url	str	The proxy URL. Format: scheme://host:port	[optional]
max_retries	int	Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.	[optional]
total_timeout	float	aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
connect_timeout	float	aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_connect_timeout	float	aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_read_timeout	float	aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
headers	List[object]	Headers for aiohttp.Clientsession	[optional]
download_concurrency	int	Total number of simultaneous connections. If not set then the default value will be used.	[optional]
rate_limit	int	Limits requests per second for each concurrent downloader	[optional]

Example

from pulpcore.client.pulp_file.models.file_file_remote_response import FileFileRemoteResponse

# TODO update the JSON string below
json = "{}"
# create an instance of FileFileRemoteResponse from a JSON string
file_file_remote_response_instance = FileFileRemoteResponse.from_json(json)
# print the JSON string representation of the object
print(FileFileRemoteResponse.to_json())

# convert the object into a dict
file_file_remote_response_dict = file_file_remote_response_instance.to_dict()
# create an instance of FileFileRemoteResponse from a dict
file_file_remote_response_from_dict = FileFileRemoteResponse.from_dict(file_file_remote_response_dict)

[Back to Model list] [Back to API list] [Back to README]

FileFileRepository

Serializer for File Repositories.

Properties

Name	Type	Description	Notes
pulp_labels	Dict[str, Optional[str]]		[optional]
name	str	A unique name for this repository.
description	str	An optional description.	[optional]
retain_repo_versions	int	Retain X versions of the repository. Default is null which retains all versions.	[optional]
remote	str	An optional remote to use by default when syncing.	[optional]
autopublish	bool	Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository.	[optional] [default to False]
manifest	str	Filename to use for manifest file containing metadata for all the files.	[optional] [default to 'PULP_MANIFEST']

Example

from pulpcore.client.pulp_file.models.file_file_repository import FileFileRepository

# TODO update the JSON string below
json = "{}"
# create an instance of FileFileRepository from a JSON string
file_file_repository_instance = FileFileRepository.from_json(json)
# print the JSON string representation of the object
print(FileFileRepository.to_json())

# convert the object into a dict
file_file_repository_dict = file_file_repository_instance.to_dict()
# create an instance of FileFileRepository from a dict
file_file_repository_from_dict = FileFileRepository.from_dict(file_file_repository_dict)

[Back to Model list] [Back to API list] [Back to README]

FileFileRepositoryResponse

Serializer for File Repositories.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
versions_href	str		[optional] [readonly]
pulp_labels	Dict[str, Optional[str]]		[optional]
latest_version_href	str		[optional] [readonly]
name	str	A unique name for this repository.
description	str	An optional description.	[optional]
retain_repo_versions	int	Retain X versions of the repository. Default is null which retains all versions.	[optional]
remote	str	An optional remote to use by default when syncing.	[optional]
autopublish	bool	Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository.	[optional] [default to False]
manifest	str	Filename to use for manifest file containing metadata for all the files.	[optional] [default to 'PULP_MANIFEST']

Example

from pulpcore.client.pulp_file.models.file_file_repository_response import FileFileRepositoryResponse

# TODO update the JSON string below
json = "{}"
# create an instance of FileFileRepositoryResponse from a JSON string
file_file_repository_response_instance = FileFileRepositoryResponse.from_json(json)
# print the JSON string representation of the object
print(FileFileRepositoryResponse.to_json())

# convert the object into a dict
file_file_repository_response_dict = file_file_repository_response_instance.to_dict()
# create an instance of FileFileRepositoryResponse from a dict
file_file_repository_response_from_dict = FileFileRepositoryResponse.from_dict(file_file_repository_response_dict)

[Back to Model list] [Back to API list] [Back to README]

MyPermissionsResponse

Properties

Name	Type	Description	Notes
permissions	List[str]

Example

from pulpcore.client.pulp_file.models.my_permissions_response import MyPermissionsResponse

# TODO update the JSON string below
json = "{}"
# create an instance of MyPermissionsResponse from a JSON string
my_permissions_response_instance = MyPermissionsResponse.from_json(json)
# print the JSON string representation of the object
print(MyPermissionsResponse.to_json())

# convert the object into a dict
my_permissions_response_dict = my_permissions_response_instance.to_dict()
# create an instance of MyPermissionsResponse from a dict
my_permissions_response_from_dict = MyPermissionsResponse.from_dict(my_permissions_response_dict)

[Back to Model list] [Back to API list] [Back to README]

NestedRole

Serializer to add/remove object roles to/from users/groups. This is used in conjunction with pulpcore.app.viewsets.base.RolesMixin and requires the underlying object to be passed as content_object in the context.

Properties

Name	Type	Description	Notes
users	List[str]		[optional] [default to []]
groups	List[str]		[optional] [default to []]
role	str

Example

from pulpcore.client.pulp_file.models.nested_role import NestedRole

# TODO update the JSON string below
json = "{}"
# create an instance of NestedRole from a JSON string
nested_role_instance = NestedRole.from_json(json)
# print the JSON string representation of the object
print(NestedRole.to_json())

# convert the object into a dict
nested_role_dict = nested_role_instance.to_dict()
# create an instance of NestedRole from a dict
nested_role_from_dict = NestedRole.from_dict(nested_role_dict)

[Back to Model list] [Back to API list] [Back to README]

NestedRoleResponse

Serializer to add/remove object roles to/from users/groups. This is used in conjunction with pulpcore.app.viewsets.base.RolesMixin and requires the underlying object to be passed as content_object in the context.

Properties

Name	Type	Description	Notes
users	List[str]		[optional] [default to []]
groups	List[str]		[optional] [default to []]
role	str

Example

from pulpcore.client.pulp_file.models.nested_role_response import NestedRoleResponse

# TODO update the JSON string below
json = "{}"
# create an instance of NestedRoleResponse from a JSON string
nested_role_response_instance = NestedRoleResponse.from_json(json)
# print the JSON string representation of the object
print(NestedRoleResponse.to_json())

# convert the object into a dict
nested_role_response_dict = nested_role_response_instance.to_dict()
# create an instance of NestedRoleResponse from a dict
nested_role_response_from_dict = NestedRoleResponse.from_dict(nested_role_response_dict)

[Back to Model list] [Back to API list] [Back to README]

ObjectRolesResponse

Properties

Name	Type	Description	Notes
roles	List[NestedRoleResponse]

Example

from pulpcore.client.pulp_file.models.object_roles_response import ObjectRolesResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ObjectRolesResponse from a JSON string
object_roles_response_instance = ObjectRolesResponse.from_json(json)
# print the JSON string representation of the object
print(ObjectRolesResponse.to_json())

# convert the object into a dict
object_roles_response_dict = object_roles_response_instance.to_dict()
# create an instance of ObjectRolesResponse from a dict
object_roles_response_from_dict = ObjectRolesResponse.from_dict(object_roles_response_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedfileFileAlternateContentSourceResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[FileFileAlternateContentSourceResponse]

Example

from pulpcore.client.pulp_file.models.paginatedfile_file_alternate_content_source_response_list import PaginatedfileFileAlternateContentSourceResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedfileFileAlternateContentSourceResponseList from a JSON string
paginatedfile_file_alternate_content_source_response_list_instance = PaginatedfileFileAlternateContentSourceResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedfileFileAlternateContentSourceResponseList.to_json())

# convert the object into a dict
paginatedfile_file_alternate_content_source_response_list_dict = paginatedfile_file_alternate_content_source_response_list_instance.to_dict()
# create an instance of PaginatedfileFileAlternateContentSourceResponseList from a dict
paginatedfile_file_alternate_content_source_response_list_from_dict = PaginatedfileFileAlternateContentSourceResponseList.from_dict(paginatedfile_file_alternate_content_source_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedfileFileContentResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[FileFileContentResponse]

Example

from pulpcore.client.pulp_file.models.paginatedfile_file_content_response_list import PaginatedfileFileContentResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedfileFileContentResponseList from a JSON string
paginatedfile_file_content_response_list_instance = PaginatedfileFileContentResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedfileFileContentResponseList.to_json())

# convert the object into a dict
paginatedfile_file_content_response_list_dict = paginatedfile_file_content_response_list_instance.to_dict()
# create an instance of PaginatedfileFileContentResponseList from a dict
paginatedfile_file_content_response_list_from_dict = PaginatedfileFileContentResponseList.from_dict(paginatedfile_file_content_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedfileFileDistributionResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[FileFileDistributionResponse]

Example

from pulpcore.client.pulp_file.models.paginatedfile_file_distribution_response_list import PaginatedfileFileDistributionResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedfileFileDistributionResponseList from a JSON string
paginatedfile_file_distribution_response_list_instance = PaginatedfileFileDistributionResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedfileFileDistributionResponseList.to_json())

# convert the object into a dict
paginatedfile_file_distribution_response_list_dict = paginatedfile_file_distribution_response_list_instance.to_dict()
# create an instance of PaginatedfileFileDistributionResponseList from a dict
paginatedfile_file_distribution_response_list_from_dict = PaginatedfileFileDistributionResponseList.from_dict(paginatedfile_file_distribution_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedfileFilePublicationResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[FileFilePublicationResponse]

Example

from pulpcore.client.pulp_file.models.paginatedfile_file_publication_response_list import PaginatedfileFilePublicationResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedfileFilePublicationResponseList from a JSON string
paginatedfile_file_publication_response_list_instance = PaginatedfileFilePublicationResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedfileFilePublicationResponseList.to_json())

# convert the object into a dict
paginatedfile_file_publication_response_list_dict = paginatedfile_file_publication_response_list_instance.to_dict()
# create an instance of PaginatedfileFilePublicationResponseList from a dict
paginatedfile_file_publication_response_list_from_dict = PaginatedfileFilePublicationResponseList.from_dict(paginatedfile_file_publication_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedfileFileRemoteResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[FileFileRemoteResponse]

Example

from pulpcore.client.pulp_file.models.paginatedfile_file_remote_response_list import PaginatedfileFileRemoteResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedfileFileRemoteResponseList from a JSON string
paginatedfile_file_remote_response_list_instance = PaginatedfileFileRemoteResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedfileFileRemoteResponseList.to_json())

# convert the object into a dict
paginatedfile_file_remote_response_list_dict = paginatedfile_file_remote_response_list_instance.to_dict()
# create an instance of PaginatedfileFileRemoteResponseList from a dict
paginatedfile_file_remote_response_list_from_dict = PaginatedfileFileRemoteResponseList.from_dict(paginatedfile_file_remote_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedfileFileRepositoryResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[FileFileRepositoryResponse]

Example

from pulpcore.client.pulp_file.models.paginatedfile_file_repository_response_list import PaginatedfileFileRepositoryResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedfileFileRepositoryResponseList from a JSON string
paginatedfile_file_repository_response_list_instance = PaginatedfileFileRepositoryResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedfileFileRepositoryResponseList.to_json())

# convert the object into a dict
paginatedfile_file_repository_response_list_dict = paginatedfile_file_repository_response_list_instance.to_dict()
# create an instance of PaginatedfileFileRepositoryResponseList from a dict
paginatedfile_file_repository_response_list_from_dict = PaginatedfileFileRepositoryResponseList.from_dict(paginatedfile_file_repository_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedRepositoryVersionResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[RepositoryVersionResponse]

Example

from pulpcore.client.pulp_file.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedRepositoryVersionResponseList from a JSON string
paginated_repository_version_response_list_instance = PaginatedRepositoryVersionResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedRepositoryVersionResponseList.to_json())

# convert the object into a dict
paginated_repository_version_response_list_dict = paginated_repository_version_response_list_instance.to_dict()
# create an instance of PaginatedRepositoryVersionResponseList from a dict
paginated_repository_version_response_list_from_dict = PaginatedRepositoryVersionResponseList.from_dict(paginated_repository_version_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PatchedfileFileAlternateContentSource

Serializer for File alternate content source.

Properties

Name	Type	Description	Notes
name	str	Name of Alternate Content Source.	[optional]
last_refreshed	datetime	Date of last refresh of AlternateContentSource.	[optional]
paths	List[str]	List of paths that will be appended to the Remote url when searching for content.	[optional]
remote	str	The remote to provide alternate content source.	[optional]

Example

from pulpcore.client.pulp_file.models.patchedfile_file_alternate_content_source import PatchedfileFileAlternateContentSource

# TODO update the JSON string below
json = "{}"
# create an instance of PatchedfileFileAlternateContentSource from a JSON string
patchedfile_file_alternate_content_source_instance = PatchedfileFileAlternateContentSource.from_json(json)
# print the JSON string representation of the object
print(PatchedfileFileAlternateContentSource.to_json())

# convert the object into a dict
patchedfile_file_alternate_content_source_dict = patchedfile_file_alternate_content_source_instance.to_dict()
# create an instance of PatchedfileFileAlternateContentSource from a dict
patchedfile_file_alternate_content_source_from_dict = PatchedfileFileAlternateContentSource.from_dict(patchedfile_file_alternate_content_source_dict)

[Back to Model list] [Back to API list] [Back to README]

PatchedfileFileDistribution

Serializer for File Distributions.

Properties

Name	Type	Description	Notes
base_path	str	The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. "foo" and "foo/bar")	[optional]
content_guard	str	An optional content-guard.	[optional]
hidden	bool	Whether this distribution should be shown in the content app.	[optional] [default to False]
pulp_labels	Dict[str, Optional[str]]		[optional]
name	str	A unique name. Ex, `rawhide` and `stable`.	[optional]
repository	str	The latest RepositoryVersion for this Repository will be served.	[optional]
publication	str	Publication to be served	[optional]
checkpoint	bool		[optional]

Example

from pulpcore.client.pulp_file.models.patchedfile_file_distribution import PatchedfileFileDistribution

# TODO update the JSON string below
json = "{}"
# create an instance of PatchedfileFileDistribution from a JSON string
patchedfile_file_distribution_instance = PatchedfileFileDistribution.from_json(json)
# print the JSON string representation of the object
print(PatchedfileFileDistribution.to_json())

# convert the object into a dict
patchedfile_file_distribution_dict = patchedfile_file_distribution_instance.to_dict()
# create an instance of PatchedfileFileDistribution from a dict
patchedfile_file_distribution_from_dict = PatchedfileFileDistribution.from_dict(patchedfile_file_distribution_dict)

[Back to Model list] [Back to API list] [Back to README]

PatchedfileFileRemote

Serializer for File Remotes.

Properties

Name	Type	Description	Notes
name	str	A unique name for this remote.	[optional]
url	str	The URL of an external content source.	[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
policy	PolicyEnum	The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.	[optional]
ca_cert	str	A PEM encoded CA certificate used to validate the server certificate presented by the remote server.	[optional]
client_cert	str	A PEM encoded client certificate used for authentication.	[optional]
client_key	str	A PEM encoded private key used for authentication.	[optional]
tls_validation	bool	If True, TLS peer validation must be performed.	[optional]
proxy_url	str	The proxy URL. Format: scheme://host:port	[optional]
proxy_username	str	The username to authenticte to the proxy.	[optional]
proxy_password	str	The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed.	[optional]
username	str	The username to be used for authentication when syncing.	[optional]
password	str	The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed.	[optional]
max_retries	int	Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.	[optional]
total_timeout	float	aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
connect_timeout	float	aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_connect_timeout	float	aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_read_timeout	float	aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
headers	List[object]	Headers for aiohttp.Clientsession	[optional]
download_concurrency	int	Total number of simultaneous connections. If not set then the default value will be used.	[optional]
rate_limit	int	Limits requests per second for each concurrent downloader	[optional]

Example

from pulpcore.client.pulp_file.models.patchedfile_file_remote import PatchedfileFileRemote

# TODO update the JSON string below
json = "{}"
# create an instance of PatchedfileFileRemote from a JSON string
patchedfile_file_remote_instance = PatchedfileFileRemote.from_json(json)
# print the JSON string representation of the object
print(PatchedfileFileRemote.to_json())

# convert the object into a dict
patchedfile_file_remote_dict = patchedfile_file_remote_instance.to_dict()
# create an instance of PatchedfileFileRemote from a dict
patchedfile_file_remote_from_dict = PatchedfileFileRemote.from_dict(patchedfile_file_remote_dict)

[Back to Model list] [Back to API list] [Back to README]

PatchedfileFileRepository

Serializer for File Repositories.

Properties

Name	Type	Description	Notes
pulp_labels	Dict[str, Optional[str]]		[optional]
name	str	A unique name for this repository.	[optional]
description	str	An optional description.	[optional]
retain_repo_versions	int	Retain X versions of the repository. Default is null which retains all versions.	[optional]
remote	str	An optional remote to use by default when syncing.	[optional]
autopublish	bool	Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository.	[optional] [default to False]
manifest	str	Filename to use for manifest file containing metadata for all the files.	[optional] [default to 'PULP_MANIFEST']

Example

from pulpcore.client.pulp_file.models.patchedfile_file_repository import PatchedfileFileRepository

# TODO update the JSON string below
json = "{}"
# create an instance of PatchedfileFileRepository from a JSON string
patchedfile_file_repository_instance = PatchedfileFileRepository.from_json(json)
# print the JSON string representation of the object
print(PatchedfileFileRepository.to_json())

# convert the object into a dict
patchedfile_file_repository_dict = patchedfile_file_repository_instance.to_dict()
# create an instance of PatchedfileFileRepository from a dict
patchedfile_file_repository_from_dict = PatchedfileFileRepository.from_dict(patchedfile_file_repository_dict)

[Back to Model list] [Back to API list] [Back to README]

PolicyEnum

• immediate - When syncing, download all metadata and content now. * on_demand - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * streamed - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.

Enum

• IMMEDIATE (value: 'immediate')

• ON_DEMAND (value: 'on_demand')

• STREAMED (value: 'streamed')

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_file.PublicationsFileApi

All URIs are relative to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
add_role	POST {file_file_publication_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/publications/file/file/	Create a file publication
delete	DELETE {file_file_publication_href}	Delete a file publication
list	GET /api/pulp/{pulp_domain}/api/v3/publications/file/file/	List file publications
list_roles	GET {file_file_publication_href}list_roles/	List roles
my_permissions	GET {file_file_publication_href}my_permissions/	List user permissions
read	GET {file_file_publication_href}	Inspect a file publication
remove_role	POST {file_file_publication_href}remove_role/	Remove a role

add_role

NestedRoleResponse add_role(file_file_publication_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.nested_role import NestedRole
from pulpcore.client.pulp_file.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.PublicationsFileApi(api_client)
    file_file_publication_href = 'file_file_publication_href_example' # str | 
    nested_role = pulpcore.client.pulp_file.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(file_file_publication_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of PublicationsFileApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsFileApi->add_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_publication_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

AsyncOperationResponse create(pulp_domain, file_file_publication, x_task_diagnostics=x_task_diagnostics)

Create a file publication

Trigger an asynchronous task to publish file content.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_file.models.file_file_publication import FileFilePublication
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.PublicationsFileApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    file_file_publication = pulpcore.client.pulp_file.FileFilePublication() # FileFilePublication | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a file publication
        api_response = api_instance.create(pulp_domain, file_file_publication, x_task_diagnostics=x_task_diagnostics)
        print("The response of PublicationsFileApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsFileApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
file_file_publication	FileFilePublication
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

delete(file_file_publication_href, x_task_diagnostics=x_task_diagnostics)

Delete a file publication

A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

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 https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.PublicationsFileApi(api_client)
    file_file_publication_href = 'file_file_publication_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a file publication
        api_instance.delete(file_file_publication_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling PublicationsFileApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_publication_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

void (empty response body)

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedfileFilePublicationResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, checkpoint=checkpoint, content=content, content__in=content__in, limit=limit, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, repository=repository, repository_version=repository_version, fields=fields, exclude_fields=exclude_fields)

List file publications

A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.paginatedfile_file_publication_response_list import PaginatedfileFilePublicationResponseList
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.PublicationsFileApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    checkpoint = True # bool | Filter results where checkpoint matches value (optional)
    content = 'content_example' # str | Content Unit referenced by HREF/PRN (optional)
    content__in = ['content__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | 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) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)
    pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)
    pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)
    pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)
    pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)
    pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)
    pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository = 'repository_example' # str | Repository referenced by HREF/PRN (optional)
    repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List file publications
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, checkpoint=checkpoint, content=content, content__in=content__in, limit=limit, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, repository=repository, repository_version=repository_version, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsFileApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsFileApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
checkpoint	bool	Filter results where checkpoint matches value	[optional]
content	str	Content Unit referenced by HREF/PRN	[optional]
content__in	List[str]	Multiple values may be separated by commas.	[optional]
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	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) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_created	datetime	Filter results where pulp_created matches value	[optional]
pulp_created__gt	datetime	Filter results where pulp_created is greater than value	[optional]
pulp_created__gte	datetime	Filter results where pulp_created is greater than or equal to value	[optional]
pulp_created__isnull	bool	Filter results where pulp_created has a null value	[optional]
pulp_created__lt	datetime	Filter results where pulp_created is less than value	[optional]
pulp_created__lte	datetime	Filter results where pulp_created is less than or equal to value	[optional]
pulp_created__range	List[datetime]	Filter results where pulp_created is between two comma separated values	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
repository	str	Repository referenced by HREF/PRN	[optional]
repository_version	str	Repository Version referenced by HREF/PRN	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedfileFilePublicationResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_roles

ObjectRolesResponse list_roles(file_file_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.PublicationsFileApi(api_client)
    file_file_publication_href = 'file_file_publication_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List roles
        api_response = api_instance.list_roles(file_file_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsFileApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsFileApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_publication_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

ObjectRolesResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

my_permissions

MyPermissionsResponse my_permissions(file_file_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.PublicationsFileApi(api_client)
    file_file_publication_href = 'file_file_publication_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List user permissions
        api_response = api_instance.my_permissions(file_file_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsFileApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsFileApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_publication_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

MyPermissionsResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

FileFilePublicationResponse read(file_file_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a file publication

A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_publication_response import FileFilePublicationResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.PublicationsFileApi(api_client)
    file_file_publication_href = 'file_file_publication_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a file publication
        api_response = api_instance.read(file_file_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsFileApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsFileApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_publication_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

FileFilePublicationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_role

NestedRoleResponse remove_role(file_file_publication_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.nested_role import NestedRole
from pulpcore.client.pulp_file.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.PublicationsFileApi(api_client)
    file_file_publication_href = 'file_file_publication_href_example' # str | 
    nested_role = pulpcore.client.pulp_file.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(file_file_publication_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of PublicationsFileApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsFileApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_publication_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoteNetworkConfig

Shared network configuration fields and validation logic used by both RemoteSerializer and UploadSerializerFieldsMixin.

Properties

Name	Type	Description	Notes
ca_cert	str	A PEM encoded CA certificate used to validate the server certificate presented by the remote server.	[optional]
client_cert	str	A PEM encoded client certificate used for authentication.	[optional]
client_key	str	A PEM encoded private key used for authentication.	[optional]
tls_validation	bool	If True, TLS peer validation must be performed.	[optional]
proxy_url	str	The proxy URL. Format: scheme://host:port	[optional]
proxy_username	str	The username to authenticte to the proxy.	[optional]
proxy_password	str	The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed.	[optional]
username	str	The username to be used for authentication when syncing.	[optional]
password	str	The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed.	[optional]
max_retries	int	Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.	[optional]
total_timeout	float	aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
connect_timeout	float	aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_connect_timeout	float	aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_read_timeout	float	aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
headers	List[object]	Headers for aiohttp.Clientsession	[optional]
download_concurrency	int	Total number of simultaneous connections. If not set then the default value will be used.	[optional]
rate_limit	int	Limits requests per second for each concurrent downloader	[optional]

Example

from pulpcore.client.pulp_file.models.remote_network_config import RemoteNetworkConfig

# TODO update the JSON string below
json = "{}"
# create an instance of RemoteNetworkConfig from a JSON string
remote_network_config_instance = RemoteNetworkConfig.from_json(json)
# print the JSON string representation of the object
print(RemoteNetworkConfig.to_json())

# convert the object into a dict
remote_network_config_dict = remote_network_config_instance.to_dict()
# create an instance of RemoteNetworkConfig from a dict
remote_network_config_from_dict = RemoteNetworkConfig.from_dict(remote_network_config_dict)

[Back to Model list] [Back to API list] [Back to README]

RemoteNetworkConfigResponse

Shared network configuration fields and validation logic used by both RemoteSerializer and UploadSerializerFieldsMixin.

Properties

Name	Type	Description	Notes
ca_cert	str	A PEM encoded CA certificate used to validate the server certificate presented by the remote server.	[optional]
client_cert	str	A PEM encoded client certificate used for authentication.	[optional]
tls_validation	bool	If True, TLS peer validation must be performed.	[optional]
proxy_url	str	The proxy URL. Format: scheme://host:port	[optional]
max_retries	int	Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.	[optional]
total_timeout	float	aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
connect_timeout	float	aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_connect_timeout	float	aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_read_timeout	float	aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
headers	List[object]	Headers for aiohttp.Clientsession	[optional]
download_concurrency	int	Total number of simultaneous connections. If not set then the default value will be used.	[optional]
rate_limit	int	Limits requests per second for each concurrent downloader	[optional]

Example

from pulpcore.client.pulp_file.models.remote_network_config_response import RemoteNetworkConfigResponse

# TODO update the JSON string below
json = "{}"
# create an instance of RemoteNetworkConfigResponse from a JSON string
remote_network_config_response_instance = RemoteNetworkConfigResponse.from_json(json)
# print the JSON string representation of the object
print(RemoteNetworkConfigResponse.to_json())

# convert the object into a dict
remote_network_config_response_dict = remote_network_config_response_instance.to_dict()
# create an instance of RemoteNetworkConfigResponse from a dict
remote_network_config_response_from_dict = RemoteNetworkConfigResponse.from_dict(remote_network_config_response_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_file.RemotesFileApi

All URIs are relative to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
add_role	POST {file_file_remote_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/remotes/file/file/	Create a file remote
delete	DELETE {file_file_remote_href}	Delete a file remote
list	GET /api/pulp/{pulp_domain}/api/v3/remotes/file/file/	List file remotes
list_roles	GET {file_file_remote_href}list_roles/	List roles
my_permissions	GET {file_file_remote_href}my_permissions/	List user permissions
partial_update	PATCH {file_file_remote_href}	Update a file remote
read	GET {file_file_remote_href}	Inspect a file remote
remove_role	POST {file_file_remote_href}remove_role/	Remove a role
set_label	POST {file_file_remote_href}set_label/	Set a label
unset_label	POST {file_file_remote_href}unset_label/	Unset a label
update	PUT {file_file_remote_href}	Update a file remote

add_role

NestedRoleResponse add_role(file_file_remote_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.nested_role import NestedRole
from pulpcore.client.pulp_file.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RemotesFileApi(api_client)
    file_file_remote_href = 'file_file_remote_href_example' # str | 
    nested_role = pulpcore.client.pulp_file.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(file_file_remote_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesFileApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesFileApi->add_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_remote_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

FileFileRemoteResponse create(pulp_domain, file_file_remote, x_task_diagnostics=x_task_diagnostics)

Create a file remote

FileRemote represents an external source of File Content. The target url of a FileRemote must contain a file manifest, which contains the metadata for all files at the source.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_remote import FileFileRemote
from pulpcore.client.pulp_file.models.file_file_remote_response import FileFileRemoteResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RemotesFileApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    file_file_remote = pulpcore.client.pulp_file.FileFileRemote() # FileFileRemote | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a file remote
        api_response = api_instance.create(pulp_domain, file_file_remote, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesFileApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesFileApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
file_file_remote	FileFileRemote
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

FileFileRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

AsyncOperationResponse delete(file_file_remote_href, x_task_diagnostics=x_task_diagnostics)

Delete a file remote

Trigger an asynchronous delete task

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RemotesFileApi(api_client)
    file_file_remote_href = 'file_file_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a file remote
        api_response = api_instance.delete(file_file_remote_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesFileApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesFileApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_remote_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedfileFileRemoteResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)

List file remotes

FileRemote represents an external source of File Content. The target url of a FileRemote must contain a file manifest, which contains the metadata for all files at the source.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.paginatedfile_file_remote_response_list import PaginatedfileFileRemoteResponseList
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RemotesFileApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
    name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
    name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
    name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
    name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    pulp_last_updated = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated matches value (optional)
    pulp_last_updated__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than value (optional)
    pulp_last_updated__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than or equal to value (optional)
    pulp_last_updated__isnull = True # bool | Filter results where pulp_last_updated has a null value (optional)
    pulp_last_updated__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than value (optional)
    pulp_last_updated__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than or equal to value (optional)
    pulp_last_updated__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_last_updated is between two comma separated values (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List file remotes
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesFileApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesFileApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Number of results to return per page.	[optional]
name	str	Filter results where name matches value	[optional]
name__contains	str	Filter results where name contains value	[optional]
name__icontains	str	Filter results where name contains value	[optional]
name__iexact	str	Filter results where name matches value	[optional]
name__in	List[str]	Filter results where name is in a comma-separated list of values	[optional]
name__iregex	str	Filter results where name matches regex value	[optional]
name__istartswith	str	Filter results where name starts with value	[optional]
name__regex	str	Filter results where name matches regex value	[optional]
name__startswith	str	Filter results where name starts with value	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_label_select	str	Filter labels by search string	[optional]
pulp_last_updated	datetime	Filter results where pulp_last_updated matches value	[optional]
pulp_last_updated__gt	datetime	Filter results where pulp_last_updated is greater than value	[optional]
pulp_last_updated__gte	datetime	Filter results where pulp_last_updated is greater than or equal to value	[optional]
pulp_last_updated__isnull	bool	Filter results where pulp_last_updated has a null value	[optional]
pulp_last_updated__lt	datetime	Filter results where pulp_last_updated is less than value	[optional]
pulp_last_updated__lte	datetime	Filter results where pulp_last_updated is less than or equal to value	[optional]
pulp_last_updated__range	List[datetime]	Filter results where pulp_last_updated is between two comma separated values	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedfileFileRemoteResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_roles

ObjectRolesResponse list_roles(file_file_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RemotesFileApi(api_client)
    file_file_remote_href = 'file_file_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List roles
        api_response = api_instance.list_roles(file_file_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesFileApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesFileApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_remote_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

ObjectRolesResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

my_permissions

MyPermissionsResponse my_permissions(file_file_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RemotesFileApi(api_client)
    file_file_remote_href = 'file_file_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List user permissions
        api_response = api_instance.my_permissions(file_file_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesFileApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesFileApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_remote_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

MyPermissionsResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

partial_update

FileFileRemoteResponse partial_update(file_file_remote_href, patchedfile_file_remote, x_task_diagnostics=x_task_diagnostics)

Update a file remote

Update the entity partially and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_remote_response import FileFileRemoteResponse
from pulpcore.client.pulp_file.models.patchedfile_file_remote import PatchedfileFileRemote
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RemotesFileApi(api_client)
    file_file_remote_href = 'file_file_remote_href_example' # str | 
    patchedfile_file_remote = pulpcore.client.pulp_file.PatchedfileFileRemote() # PatchedfileFileRemote | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a file remote
        api_response = api_instance.partial_update(file_file_remote_href, patchedfile_file_remote, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesFileApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesFileApi->partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_remote_href	str
patchedfile_file_remote	PatchedfileFileRemote
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

FileFileRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

FileFileRemoteResponse read(file_file_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a file remote

FileRemote represents an external source of File Content. The target url of a FileRemote must contain a file manifest, which contains the metadata for all files at the source.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_remote_response import FileFileRemoteResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RemotesFileApi(api_client)
    file_file_remote_href = 'file_file_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a file remote
        api_response = api_instance.read(file_file_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesFileApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesFileApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_remote_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

FileFileRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_role

NestedRoleResponse remove_role(file_file_remote_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.nested_role import NestedRole
from pulpcore.client.pulp_file.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RemotesFileApi(api_client)
    file_file_remote_href = 'file_file_remote_href_example' # str | 
    nested_role = pulpcore.client.pulp_file.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(file_file_remote_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesFileApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesFileApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_remote_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

SetLabelResponse set_label(file_file_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.set_label import SetLabel
from pulpcore.client.pulp_file.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RemotesFileApi(api_client)
    file_file_remote_href = 'file_file_remote_href_example' # str | 
    set_label = pulpcore.client.pulp_file.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(file_file_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesFileApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesFileApi->set_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_remote_href	str
set_label	SetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

SetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unset_label

UnsetLabelResponse unset_label(file_file_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.unset_label import UnsetLabel
from pulpcore.client.pulp_file.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RemotesFileApi(api_client)
    file_file_remote_href = 'file_file_remote_href_example' # str | 
    unset_label = pulpcore.client.pulp_file.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(file_file_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesFileApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesFileApi->unset_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_remote_href	str
unset_label	UnsetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

UnsetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

FileFileRemoteResponse update(file_file_remote_href, file_file_remote, x_task_diagnostics=x_task_diagnostics)

Update a file remote

Update the entity and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_remote import FileFileRemote
from pulpcore.client.pulp_file.models.file_file_remote_response import FileFileRemoteResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RemotesFileApi(api_client)
    file_file_remote_href = 'file_file_remote_href_example' # str | 
    file_file_remote = pulpcore.client.pulp_file.FileFileRemote() # FileFileRemote | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a file remote
        api_response = api_instance.update(file_file_remote_href, file_file_remote, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesFileApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesFileApi->update: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_remote_href	str
file_file_remote	FileFileRemote
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

FileFileRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Repair

Properties

Name	Type	Description	Notes
verify_checksums	bool	Will verify that the checksum of all stored files matches what saved in the database. Otherwise only the existence of the files will be checked. Enabled by default	[optional] [default to True]

Example

from pulpcore.client.pulp_file.models.repair import Repair

# TODO update the JSON string below
json = "{}"
# create an instance of Repair from a JSON string
repair_instance = Repair.from_json(json)
# print the JSON string representation of the object
print(Repair.to_json())

# convert the object into a dict
repair_dict = repair_instance.to_dict()
# create an instance of Repair from a dict
repair_from_dict = Repair.from_dict(repair_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_file.RepositoriesFileApi

All URIs are relative to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
add_role	POST {file_file_repository_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/repositories/file/file/	Create a file repository
delete	DELETE {file_file_repository_href}	Delete a file repository
list	GET /api/pulp/{pulp_domain}/api/v3/repositories/file/file/	List file repositorys
list_roles	GET {file_file_repository_href}list_roles/	List roles
modify	POST {file_file_repository_href}modify/	Modify Repository Content
my_permissions	GET {file_file_repository_href}my_permissions/	List user permissions
partial_update	PATCH {file_file_repository_href}	Update a file repository
read	GET {file_file_repository_href}	Inspect a file repository
remove_role	POST {file_file_repository_href}remove_role/	Remove a role
set_label	POST {file_file_repository_href}set_label/	Set a label
sync	POST {file_file_repository_href}sync/	Sync from a remote
unset_label	POST {file_file_repository_href}unset_label/	Unset a label
update	PUT {file_file_repository_href}	Update a file repository

add_role

NestedRoleResponse add_role(file_file_repository_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.nested_role import NestedRole
from pulpcore.client.pulp_file.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    nested_role = pulpcore.client.pulp_file.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(file_file_repository_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesFileApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->add_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

FileFileRepositoryResponse create(pulp_domain, file_file_repository, x_task_diagnostics=x_task_diagnostics)

Create a file repository

FileRepository represents a single file repository, to which content can be synced, added, or removed.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_repository import FileFileRepository
from pulpcore.client.pulp_file.models.file_file_repository_response import FileFileRepositoryResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    file_file_repository = pulpcore.client.pulp_file.FileFileRepository() # FileFileRepository | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a file repository
        api_response = api_instance.create(pulp_domain, file_file_repository, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesFileApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
file_file_repository	FileFileRepository
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

FileFileRepositoryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

AsyncOperationResponse delete(file_file_repository_href, x_task_diagnostics=x_task_diagnostics)

Delete a file repository

Trigger an asynchronous delete task

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a file repository
        api_response = api_instance.delete(file_file_repository_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesFileApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedfileFileRepositoryResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)

List file repositorys

FileRepository represents a single file repository, to which content can be synced, added, or removed.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.paginatedfile_file_repository_response_list import PaginatedfileFileRepositoryResponseList
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    latest_with_content = 'latest_with_content_example' # str | Content Unit referenced by HREF/PRN (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
    name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
    name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
    name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
    name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    remote = 'remote_example' # str | Foreign Key referenced by HREF (optional)
    retain_repo_versions = 56 # int | Filter results where retain_repo_versions matches value (optional)
    retain_repo_versions__gt = 56 # int | Filter results where retain_repo_versions is greater than value (optional)
    retain_repo_versions__gte = 56 # int | Filter results where retain_repo_versions is greater than or equal to value (optional)
    retain_repo_versions__isnull = True # bool | Filter results where retain_repo_versions has a null value (optional)
    retain_repo_versions__lt = 56 # int | Filter results where retain_repo_versions is less than value (optional)
    retain_repo_versions__lte = 56 # int | Filter results where retain_repo_versions is less than or equal to value (optional)
    retain_repo_versions__ne = 56 # int | Filter results where retain_repo_versions not equal to value (optional)
    retain_repo_versions__range = [56] # List[int] | Filter results where retain_repo_versions is between two comma separated values (optional)
    with_content = 'with_content_example' # str | Content Unit referenced by HREF/PRN (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List file repositorys
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesFileApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
latest_with_content	str	Content Unit referenced by HREF/PRN	[optional]
limit	int	Number of results to return per page.	[optional]
name	str	Filter results where name matches value	[optional]
name__contains	str	Filter results where name contains value	[optional]
name__icontains	str	Filter results where name contains value	[optional]
name__iexact	str	Filter results where name matches value	[optional]
name__in	List[str]	Filter results where name is in a comma-separated list of values	[optional]
name__iregex	str	Filter results where name matches regex value	[optional]
name__istartswith	str	Filter results where name starts with value	[optional]
name__regex	str	Filter results where name matches regex value	[optional]
name__startswith	str	Filter results where name starts with value	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_label_select	str	Filter labels by search string	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
remote	str	Foreign Key referenced by HREF	[optional]
retain_repo_versions	int	Filter results where retain_repo_versions matches value	[optional]
retain_repo_versions__gt	int	Filter results where retain_repo_versions is greater than value	[optional]
retain_repo_versions__gte	int	Filter results where retain_repo_versions is greater than or equal to value	[optional]
retain_repo_versions__isnull	bool	Filter results where retain_repo_versions has a null value	[optional]
retain_repo_versions__lt	int	Filter results where retain_repo_versions is less than value	[optional]
retain_repo_versions__lte	int	Filter results where retain_repo_versions is less than or equal to value	[optional]
retain_repo_versions__ne	int	Filter results where retain_repo_versions not equal to value	[optional]
retain_repo_versions__range	List[int]	Filter results where retain_repo_versions is between two comma separated values	[optional]
with_content	str	Content Unit referenced by HREF/PRN	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedfileFileRepositoryResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_roles

ObjectRolesResponse list_roles(file_file_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List roles
        api_response = api_instance.list_roles(file_file_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesFileApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

ObjectRolesResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

modify

AsyncOperationResponse modify(file_file_repository_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)

Modify Repository Content

Trigger an asynchronous task to create a new repository version.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_file.models.repository_add_remove_content import RepositoryAddRemoveContent
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    repository_add_remove_content = pulpcore.client.pulp_file.RepositoryAddRemoveContent() # RepositoryAddRemoveContent | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Modify Repository Content
        api_response = api_instance.modify(file_file_repository_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesFileApi->modify:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->modify: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
repository_add_remove_content	RepositoryAddRemoveContent
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

my_permissions

MyPermissionsResponse my_permissions(file_file_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List user permissions
        api_response = api_instance.my_permissions(file_file_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesFileApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

MyPermissionsResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

partial_update

FileFileRepositoryResponse partial_update(file_file_repository_href, patchedfile_file_repository, x_task_diagnostics=x_task_diagnostics)

Update a file repository

Update the entity partially and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_repository_response import FileFileRepositoryResponse
from pulpcore.client.pulp_file.models.patchedfile_file_repository import PatchedfileFileRepository
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    patchedfile_file_repository = pulpcore.client.pulp_file.PatchedfileFileRepository() # PatchedfileFileRepository | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a file repository
        api_response = api_instance.partial_update(file_file_repository_href, patchedfile_file_repository, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesFileApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
patchedfile_file_repository	PatchedfileFileRepository
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

FileFileRepositoryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

FileFileRepositoryResponse read(file_file_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a file repository

FileRepository represents a single file repository, to which content can be synced, added, or removed.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_repository_response import FileFileRepositoryResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a file repository
        api_response = api_instance.read(file_file_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesFileApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

FileFileRepositoryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_role

NestedRoleResponse remove_role(file_file_repository_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.nested_role import NestedRole
from pulpcore.client.pulp_file.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    nested_role = pulpcore.client.pulp_file.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(file_file_repository_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesFileApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

SetLabelResponse set_label(file_file_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.set_label import SetLabel
from pulpcore.client.pulp_file.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    set_label = pulpcore.client.pulp_file.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(file_file_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesFileApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->set_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
set_label	SetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

SetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sync

AsyncOperationResponse sync(file_file_repository_href, repository_sync_url, x_task_diagnostics=x_task_diagnostics)

Sync from a remote

Trigger an asynchronous task to sync file content.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_file.models.repository_sync_url import RepositorySyncURL
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    repository_sync_url = pulpcore.client.pulp_file.RepositorySyncURL() # RepositorySyncURL | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Sync from a remote
        api_response = api_instance.sync(file_file_repository_href, repository_sync_url, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesFileApi->sync:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->sync: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
repository_sync_url	RepositorySyncURL
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unset_label

UnsetLabelResponse unset_label(file_file_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.unset_label import UnsetLabel
from pulpcore.client.pulp_file.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    unset_label = pulpcore.client.pulp_file.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(file_file_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesFileApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->unset_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
unset_label	UnsetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

UnsetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

FileFileRepositoryResponse update(file_file_repository_href, file_file_repository, x_task_diagnostics=x_task_diagnostics)

Update a file repository

Update the entity and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.file_file_repository import FileFileRepository
from pulpcore.client.pulp_file.models.file_file_repository_response import FileFileRepositoryResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    file_file_repository = pulpcore.client.pulp_file.FileFileRepository() # FileFileRepository | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a file repository
        api_response = api_instance.update(file_file_repository_href, file_file_repository, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesFileApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileApi->update: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
file_file_repository	FileFileRepository
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

FileFileRepositoryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pulpcore.client.pulp_file.RepositoriesFileVersionsApi

All URIs are relative to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
delete	DELETE {file_file_repository_version_href}	Delete a repository version
list	GET {file_file_repository_href}versions/	List repository versions
read	GET {file_file_repository_version_href}	Inspect a repository version
repair	POST {file_file_repository_version_href}repair/

delete

AsyncOperationResponse delete(file_file_repository_version_href, x_task_diagnostics=x_task_diagnostics)

Delete a repository version

Trigger an asynchronous task to delete a repository version.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileVersionsApi(api_client)
    file_file_repository_version_href = 'file_file_repository_version_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a repository version
        api_response = api_instance.delete(file_file_repository_version_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesFileVersionsApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileVersionsApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_version_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedRepositoryVersionResponseList list(file_file_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)

List repository versions

FileRepositoryVersion represents a single file repository version.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileVersionsApi(api_client)
    file_file_repository_href = 'file_file_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    content = 'content_example' # str | Content Unit referenced by HREF/PRN (optional)
    content__in = ['content__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    number = 56 # int | Filter results where number matches value (optional)
    number__gt = 56 # int | Filter results where number is greater than value (optional)
    number__gte = 56 # int | Filter results where number is greater than or equal to value (optional)
    number__lt = 56 # int | Filter results where number is less than value (optional)
    number__lte = 56 # int | Filter results where number is less than or equal to value (optional)
    number__range = [56] # List[int] | Filter results where number is between two comma separated values (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | 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) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)
    pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)
    pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)
    pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)
    pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)
    pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)
    pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List repository versions
        api_response = api_instance.list(file_file_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesFileVersionsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileVersionsApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
content	str	Content Unit referenced by HREF/PRN	[optional]
content__in	List[str]	Multiple values may be separated by commas.	[optional]
limit	int	Number of results to return per page.	[optional]
number	int	Filter results where number matches value	[optional]
number__gt	int	Filter results where number is greater than value	[optional]
number__gte	int	Filter results where number is greater than or equal to value	[optional]
number__lt	int	Filter results where number is less than value	[optional]
number__lte	int	Filter results where number is less than or equal to value	[optional]
number__range	List[int]	Filter results where number is between two comma separated values	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	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) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_created	datetime	Filter results where pulp_created matches value	[optional]
pulp_created__gt	datetime	Filter results where pulp_created is greater than value	[optional]
pulp_created__gte	datetime	Filter results where pulp_created is greater than or equal to value	[optional]
pulp_created__isnull	bool	Filter results where pulp_created has a null value	[optional]
pulp_created__lt	datetime	Filter results where pulp_created is less than value	[optional]
pulp_created__lte	datetime	Filter results where pulp_created is less than or equal to value	[optional]
pulp_created__range	List[datetime]	Filter results where pulp_created is between two comma separated values	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedRepositoryVersionResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

RepositoryVersionResponse read(file_file_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a repository version

FileRepositoryVersion represents a single file repository version.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.repository_version_response import RepositoryVersionResponse
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileVersionsApi(api_client)
    file_file_repository_version_href = 'file_file_repository_version_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a repository version
        api_response = api_instance.read(file_file_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesFileVersionsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileVersionsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_version_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

RepositoryVersionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repair

AsyncOperationResponse repair(file_file_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)

Trigger an asynchronous task to repair a repository version.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_file
from pulpcore.client.pulp_file.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_file.models.repair import Repair
from pulpcore.client.pulp_file.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_file.Configuration(
    host = "https://env-ephemeral-lyisiw.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_file.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = '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.RepositoriesFileVersionsApi(api_client)
    file_file_repository_version_href = 'file_file_repository_version_href_example' # str | 
    repair = pulpcore.client.pulp_file.Repair() # Repair | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        api_response = api_instance.repair(file_file_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesFileVersionsApi->repair:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesFileVersionsApi->repair: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_file_repository_version_href	str
repair	Repair
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoryAddRemoveContent

Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ref_name attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.

Properties

Name	Type	Description	Notes
add_content_units	List[str]	A list of content units to add to a new repository version. This content is added after remove_content_units are removed.	[optional]
remove_content_units	List[str]	A list of content units to remove from the latest repository version. You may also specify '*' as an entry to remove all content. This content is removed before add_content_units are added.	[optional]
base_version	str	A repository version whose content will be used as the initial set of content for the new repository version	[optional]

Example

from pulpcore.client.pulp_file.models.repository_add_remove_content import RepositoryAddRemoveContent

# TODO update the JSON string below
json = "{}"
# create an instance of RepositoryAddRemoveContent from a JSON string
repository_add_remove_content_instance = RepositoryAddRemoveContent.from_json(json)
# print the JSON string representation of the object
print(RepositoryAddRemoveContent.to_json())

# convert the object into a dict
repository_add_remove_content_dict = repository_add_remove_content_instance.to_dict()
# create an instance of RepositoryAddRemoveContent from a dict
repository_add_remove_content_from_dict = RepositoryAddRemoveContent.from_dict(repository_add_remove_content_dict)

[Back to Model list] [Back to API list] [Back to README]

RepositorySyncURL

A mixin for validating unknown serializers' fields.

Properties

Name	Type	Description	Notes
remote	str	A remote to sync from. This will override a remote set on repository.	[optional]
mirror	bool	If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only.	[optional] [default to False]

Example

from pulpcore.client.pulp_file.models.repository_sync_url import RepositorySyncURL

# TODO update the JSON string below
json = "{}"
# create an instance of RepositorySyncURL from a JSON string
repository_sync_url_instance = RepositorySyncURL.from_json(json)
# print the JSON string representation of the object
print(RepositorySyncURL.to_json())

# convert the object into a dict
repository_sync_url_dict = repository_sync_url_instance.to_dict()
# create an instance of RepositorySyncURL from a dict
repository_sync_url_from_dict = RepositorySyncURL.from_dict(repository_sync_url_dict)

[Back to Model list] [Back to API list] [Back to README]

RepositoryVersionResponse

Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ref_name attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
number	int		[optional] [readonly]
repository	str		[optional] [readonly]
base_version	str	A repository version whose content was used as the initial set of content for this repository version	[optional]
content_summary	ContentSummaryResponse	Various count summaries of the content in the version and the HREF to view them.	[optional] [readonly]
vuln_report	str		[optional] [readonly]

Example

from pulpcore.client.pulp_file.models.repository_version_response import RepositoryVersionResponse

# TODO update the JSON string below
json = "{}"
# create an instance of RepositoryVersionResponse from a JSON string
repository_version_response_instance = RepositoryVersionResponse.from_json(json)
# print the JSON string representation of the object
print(RepositoryVersionResponse.to_json())

# convert the object into a dict
repository_version_response_dict = repository_version_response_instance.to_dict()
# create an instance of RepositoryVersionResponse from a dict
repository_version_response_from_dict = RepositoryVersionResponse.from_dict(repository_version_response_dict)

[Back to Model list] [Back to API list] [Back to README]

SetLabel

Serializer for synchronously setting a label.

Properties

Name	Type	Description	Notes
key	str
value	str

Example

from pulpcore.client.pulp_file.models.set_label import SetLabel

# TODO update the JSON string below
json = "{}"
# create an instance of SetLabel from a JSON string
set_label_instance = SetLabel.from_json(json)
# print the JSON string representation of the object
print(SetLabel.to_json())

# convert the object into a dict
set_label_dict = set_label_instance.to_dict()
# create an instance of SetLabel from a dict
set_label_from_dict = SetLabel.from_dict(set_label_dict)

[Back to Model list] [Back to API list] [Back to README]

SetLabelResponse

Serializer for synchronously setting a label.

Properties

Name	Type	Description	Notes
key	str
value	str

Example

from pulpcore.client.pulp_file.models.set_label_response import SetLabelResponse

# TODO update the JSON string below
json = "{}"
# create an instance of SetLabelResponse from a JSON string
set_label_response_instance = SetLabelResponse.from_json(json)
# print the JSON string representation of the object
print(SetLabelResponse.to_json())

# convert the object into a dict
set_label_response_dict = set_label_response_instance.to_dict()
# create an instance of SetLabelResponse from a dict
set_label_response_from_dict = SetLabelResponse.from_dict(set_label_response_dict)

[Back to Model list] [Back to API list] [Back to README]

TaskGroupOperationResponse

Serializer for asynchronous operations that return a task group.

Properties

Name	Type	Description	Notes
task_group	str	The href of the task group.

Example

from pulpcore.client.pulp_file.models.task_group_operation_response import TaskGroupOperationResponse

# TODO update the JSON string below
json = "{}"
# create an instance of TaskGroupOperationResponse from a JSON string
task_group_operation_response_instance = TaskGroupOperationResponse.from_json(json)
# print the JSON string representation of the object
print(TaskGroupOperationResponse.to_json())

# convert the object into a dict
task_group_operation_response_dict = task_group_operation_response_instance.to_dict()
# create an instance of TaskGroupOperationResponse from a dict
task_group_operation_response_from_dict = TaskGroupOperationResponse.from_dict(task_group_operation_response_dict)

[Back to Model list] [Back to API list] [Back to README]

UnsetLabel

Serializer for synchronously UNsetting a label.

Properties

Name	Type	Description	Notes
key	str

Example

from pulpcore.client.pulp_file.models.unset_label import UnsetLabel

# TODO update the JSON string below
json = "{}"
# create an instance of UnsetLabel from a JSON string
unset_label_instance = UnsetLabel.from_json(json)
# print the JSON string representation of the object
print(UnsetLabel.to_json())

# convert the object into a dict
unset_label_dict = unset_label_instance.to_dict()
# create an instance of UnsetLabel from a dict
unset_label_from_dict = UnsetLabel.from_dict(unset_label_dict)

[Back to Model list] [Back to API list] [Back to README]

UnsetLabelResponse

Serializer for synchronously UNsetting a label.

Properties

Name	Type	Description	Notes
key	str
value	str		[optional] [readonly]

Example

from pulpcore.client.pulp_file.models.unset_label_response import UnsetLabelResponse

# TODO update the JSON string below
json = "{}"
# create an instance of UnsetLabelResponse from a JSON string
unset_label_response_instance = UnsetLabelResponse.from_json(json)
# print the JSON string representation of the object
print(UnsetLabelResponse.to_json())

# convert the object into a dict
unset_label_response_dict = unset_label_response_instance.to_dict()
# create an instance of UnsetLabelResponse from a dict
unset_label_response_from_dict = UnsetLabelResponse.from_dict(unset_label_response_dict)

[Back to Model list] [Back to API list] [Back to README]