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
  • DigestValidationError
  • InvalidSignatureError
  • MissingDigestValidationError
  • PulpException
  • SizeValidationError
  • UnsupportedDigestValidationError
• pulpcore.plugin.serializers
  • AlternateContentSourcePathSerializer
  • AlternateContentSourceSerializer
    • AlternateContentSourceSerializer.create()
    • AlternateContentSourceSerializer.update()
  • ArtifactSerializer
    • ArtifactSerializer.validate()
  • AsyncOperationResponseSerializer
  • ContentChecksumSerializer
  • ContentGuardSerializer
  • ContentRedirectContentGuardSerializer
  • DetailRelatedField
    • DetailRelatedField.get_object()
    • DetailRelatedField.use_pk_only_optimization()
  • DistributionSerializer
  • ExportSerializer
  • ExporterSerializer
    • ExporterSerializer.validate_path()
  • GetOrCreateSerializerMixin
  • IdentityField
    • IdentityField.get_url()
  • ImportSerializer
  • ImporterSerializer
  • LabelsField
    • LabelsField.to_internal_value()
    • LabelsField.to_representation()
  • ModelSerializer
    • ModelSerializer.create()
    • ModelSerializer.update()
  • MultipleArtifactContentSerializer
    • MultipleArtifactContentSerializer.create()
  • NestedRelatedField
    • NestedRelatedField.get_url()
  • NoArtifactContentSerializer
  • NoArtifactContentUploadSerializer
    • NoArtifactContentUploadSerializer.create()
  • ProgressReportSerializer
  • PublicationSerializer
  • RelatedField
    • RelatedField.get_url()
  • RemoteSerializer
    • RemoteSerializer.validate()
    • RemoteSerializer.validate_proxy_url()
    • RemoteSerializer.validate_url()
  • RepositoryAddRemoveContentSerializer
  • RepositorySerializer
  • RepositorySyncURLSerializer
  • RepositoryVersionRelatedField
    • RepositoryVersionRelatedField.get_object()
  • SingleArtifactContentSerializer
    • SingleArtifactContentSerializer.create()
    • SingleArtifactContentSerializer.retrieve()
  • SingleArtifactContentUploadSerializer
    • SingleArtifactContentUploadSerializer.create()
    • SingleArtifactContentUploadSerializer.deferred_validate()
    • SingleArtifactContentUploadSerializer.validate()
  • SingleContentArtifactField
    • SingleContentArtifactField.get_attribute()
  • TaskGroupOperationResponseSerializer
  • ValidateFieldsMixin
  • validate_unknown_fields()
• pulpcore.plugin.storage
  • get_tls_path()
• pulpcore.plugin.viewsets
  • AlternateContentSourceViewSet
    • AlternateContentSourceViewSet.serializer_class
  • AsyncUpdateMixin
  • BaseFilterSet
    • BaseFilterSet.filter_for_field()
    • BaseFilterSet.get_filters()
    • BaseFilterSet.is_valid()
  • CharInFilter
  • ContentFilter
  • ContentGuardFilter
  • ContentGuardViewSet
  • ContentViewSet
  • DistributionFilter
  • DistributionViewSet
  • ExportViewSet
    • ExportViewSet.parent_viewset
    • ExportViewSet.serializer_class
  • ExporterViewSet
    • ExporterViewSet.serializer_class
  • HyperlinkRelatedFilter
    • HyperlinkRelatedFilter.filter()
  • ImmutableRepositoryViewSet
  • ImportViewSet
    • ImportViewSet.parent_viewset
    • ImportViewSet.serializer_class
  • ImporterViewSet
    • ImporterViewSet.serializer_class
  • LabelSelectFilter
    • LabelSelectFilter.filter()
  • 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
    • NoArtifactContentUploadViewSet.create()
  • OperationPostponedResponse
  • PublicationFilter
  • PublicationViewSet
    • PublicationViewSet.filterset_class
    • PublicationViewSet.serializer_class
  • ReadOnlyContentViewSet
  • ReadOnlyRepositoryViewSet
    • ReadOnlyRepositoryViewSet.filterset_class
    • ReadOnlyRepositoryViewSet.serializer_class
  • RemoteFilter
  • RemoteViewSet
    • RemoteViewSet.filterset_class
    • RemoteViewSet.serializer_class
  • RepositoryVersionFilter
    • RepositoryVersionFilter.filter()
  • RepositoryVersionViewSet
    • RepositoryVersionViewSet.filterset_class
    • RepositoryVersionViewSet.parent_viewset
    • RepositoryVersionViewSet.serializer_class
    • RepositoryVersionViewSet.destroy()
    • RepositoryVersionViewSet.repair()
  • RepositoryViewSet
  • SingleArtifactContentUploadViewSet
    • SingleArtifactContentUploadViewSet.create()
    • SingleArtifactContentUploadViewSet.init_content_data()
  • TaskGroupOperationResponse
  • TaskGroupViewSet
    • TaskGroupViewSet.serializer_class
  • TaskViewSet
    • TaskViewSet.filterset_class
    • TaskViewSet.minimal_serializer_class
    • TaskViewSet.serializer_class
    • TaskViewSet.get_serializer_class()
    • TaskViewSet.purge()
• pulpcore.plugin.tasking
  • add_and_remove()
  • dispatch()
  • fs_publication_export()
  • fs_repo_version_export()
  • general_create()
  • general_create_from_temp_file()
  • general_delete()
  • general_multi_delete()
  • general_update()
  • orphan_cleanup()
  • reclaim_space()
• pulpcore.plugin.download
  • Basic Downloading
  • Parallel Downloading
  • Download Results
    • DownloadResult
  • Configuring from a Remote
  • Automatic Retry
  • Exception Handling
  • Custom Download Behavior
  • Adding New Protocol Support
  • Download Factory
    • DownloaderFactory
      • DownloaderFactory.build()
      • DownloaderFactory.user_agent()
  • HttpDownloader
    • HttpDownloader
      • HttpDownloader.fetch()
      • HttpDownloader.finalize()
      • HttpDownloader.handle_data()
      • HttpDownloader.raise_for_status()
      • HttpDownloader.run()
      • HttpDownloader.validate_digests()
      • HttpDownloader.validate_size()
      • HttpDownloader.artifact_attributes
  • FileDownloader
    • FileDownloader
      • FileDownloader.fetch()
      • FileDownloader.finalize()
      • FileDownloader.handle_data()
      • FileDownloader.run()
      • FileDownloader.validate_digests()
      • FileDownloader.validate_size()
      • FileDownloader.artifact_attributes
  • BaseDownloader
    • BaseDownloader
      • BaseDownloader.fetch()
      • BaseDownloader.finalize()
      • BaseDownloader.handle_data()
      • BaseDownloader.run()
      • BaseDownloader.validate_digests()
      • BaseDownloader.validate_size()
      • BaseDownloader.artifact_attributes
  • Validation Exceptions
• pulpcore.plugin.stages
  • DeclarativeVersion
    • DeclarativeVersion
    • DeclarativeArtifact
    • DeclarativeContent
      • DeclarativeContent.resolution()
  • Stages API
    • create_pipeline()
    • Stage
      • Stage.__call__()
    • EndStage
      • EndStage.__call__()
  • Artifact Related Stages
    • ArtifactDownloader
    • ArtifactSaver
    • RemoteArtifactSaver
    • QueryExistingArtifacts
  • Content Related Stages
    • ContentSaver
      • ContentSaver._post_save()
      • ContentSaver._pre_save()
    • QueryExistingContents
    • ResolveContentFutures
    • ContentAssociation
• Profiling the Stages API Performance
  • Summarizing Performance Data
  • Profiling API Machinery
    • ProfilingQueue
    • stages.create_profile_db_and_connection()
• pulpcore.plugin.content
  • Creating your Handler
  • Registering your Handler
  • Restricting which detail Distributions Match
  • pulpcore.plugin.content.Handler
    • Handler
• pulpcore.plugin.util
  • assign_role()
  • get_artifact_url()
  • get_url()
  • gpg_verify()
  • remove_role()
  • verify_signature()

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.