Plugin API Reference¶
The Plugin API is versioned in sync with pulpcore
and consists of everything importable within
the pulpcore.plugin
namespace. It is governed by the deprecation policy.
When writing plugins, care should be taken to only import pulpcore
components exposed in this
namespace; importing from elsewhere within the pulpcore
module (e.g. importing directly from
pulpcore.app
, pulpcore.exceptions
, etc.) is unsupported, and not protected by the
aforementioned Pulp Plugin API deprecation policy.
- pulpcore.plugin.models
- pulpcore.plugin.exceptions
- pulpcore.plugin.serializers
AlternateContentSourcePathSerializer
AlternateContentSourceSerializer
ArtifactSerializer
AsyncOperationResponseSerializer
ContentChecksumSerializer
ContentGuardSerializer
ContentRedirectContentGuardSerializer
DetailRelatedField
DistributionSerializer
ExportSerializer
ExporterSerializer
GetOrCreateSerializerMixin
IdentityField
ImportSerializer
ImporterSerializer
LabelsField
ModelSerializer
MultipleArtifactContentSerializer
NestedRelatedField
NoArtifactContentSerializer
NoArtifactContentUploadSerializer
ProgressReportSerializer
PublicationSerializer
RelatedField
RemoteSerializer
RepositoryAddRemoveContentSerializer
RepositorySerializer
RepositorySyncURLSerializer
RepositoryVersionRelatedField
SingleArtifactContentSerializer
SingleArtifactContentUploadSerializer
SingleContentArtifactField
TaskGroupOperationResponseSerializer
ValidateFieldsMixin
validate_unknown_fields()
- pulpcore.plugin.storage
- pulpcore.plugin.viewsets
AlternateContentSourceViewSet
AsyncUpdateMixin
BaseFilterSet
CharInFilter
ContentFilter
ContentGuardFilter
ContentGuardViewSet
ContentViewSet
DistributionFilter
DistributionViewSet
ExportViewSet
ExporterViewSet
HyperlinkRelatedFilter
ImmutableRepositoryViewSet
ImportViewSet
ImporterViewSet
LabelSelectFilter
NamedModelViewSet
NamedModelViewSet.extract_pk()
NamedModelViewSet.get_parent_field_and_object()
NamedModelViewSet.get_parent_object()
NamedModelViewSet.get_queryset()
NamedModelViewSet.get_resource()
NamedModelViewSet.get_resource_model()
NamedModelViewSet.get_serializer_class()
NamedModelViewSet.initial()
NamedModelViewSet.scope_queryset()
NoArtifactContentUploadViewSet
OperationPostponedResponse
PublicationFilter
PublicationViewSet
ReadOnlyContentViewSet
ReadOnlyRepositoryViewSet
RemoteFilter
RemoteViewSet
RepositoryVersionFilter
RepositoryVersionViewSet
RepositoryViewSet
SingleArtifactContentUploadViewSet
TaskGroupOperationResponse
TaskGroupViewSet
TaskViewSet
- pulpcore.plugin.tasking
- pulpcore.plugin.download
- pulpcore.plugin.stages
- Profiling the Stages API Performance
- pulpcore.plugin.content
- pulpcore.plugin.util
- class pulpcore.plugin.PulpPluginAppConfig(app_name, app_module)¶
AppConfig class. Use this in plugins to identify your app as a Pulp plugin.
- import_modelresources()¶
If a plugin has a modelresource.py, import it
(This exists when a plugin knows how to import-export itself)
- import_urls()¶
If a plugin defines a urls.py, include it.
- ready()¶
Override this method in subclasses to run code when Django starts.