Registry Models
===============

Complete model class reference for Registry APIs.

This reference documents all **87** model classes used by Registry APIs. These classes are automatically cross-referenced from API documentation - click any model type in API documentation to jump directly to its definition here.

Model Type Patterns
--------------------

**Entity Classes** (e.g., ProcessGroupEntity): Complete API objects with metadata and revision information

**DTO Classes** (e.g., ProcessGroupDTO): Core data transfer objects containing the essential properties

**Status Classes** (e.g., ProcessGroupStatus): Runtime status and statistics for monitoring

**Configuration Classes**: Settings, parameters, and configuration objects


.. currentmodule:: nipyapi.registry.models

All Model Classes
------------------

.. autoclass:: AccessPolicy
   :members:
   :show-inheritance:

.. autoclass:: AccessPolicySummary
   :members:
   :show-inheritance:

.. autoclass:: AllowableValue
   :members:
   :show-inheritance:

.. autoclass:: Attribute
   :members:
   :show-inheritance:

.. autoclass:: BatchSize
   :members:
   :show-inheritance:

.. autoclass:: Bucket
   :members:
   :show-inheritance:

.. autoclass:: BucketItem
   :members:
   :show-inheritance:

.. autoclass:: BuildInfo
   :members:
   :show-inheritance:

.. autoclass:: Bundle
   :members:
   :show-inheritance:

.. autoclass:: BundleInfo
   :members:
   :show-inheritance:

.. autoclass:: BundleVersion
   :members:
   :show-inheritance:

.. autoclass:: BundleVersionDependency
   :members:
   :show-inheritance:

.. autoclass:: BundleVersionMetadata
   :members:
   :show-inheritance:

.. autoclass:: BundlesBundleTypeBody
   :members:
   :show-inheritance:

.. autoclass:: ClientIdParameter
   :members:
   :show-inheritance:

.. autoclass:: ComponentDifference
   :members:
   :show-inheritance:

.. autoclass:: ComponentDifferenceGroup
   :members:
   :show-inheritance:

.. autoclass:: ConnectableComponent
   :members:
   :show-inheritance:

.. autoclass:: ControllerServiceAPI
   :members:
   :show-inheritance:

.. autoclass:: ControllerServiceDefinition
   :members:
   :show-inheritance:

.. autoclass:: CurrentUser
   :members:
   :show-inheritance:

.. autoclass:: DefaultSchedule
   :members:
   :show-inheritance:

.. autoclass:: DefaultSettings
   :members:
   :show-inheritance:

.. autoclass:: Dependency
   :members:
   :show-inheritance:

.. autoclass:: DependentValues
   :members:
   :show-inheritance:

.. autoclass:: DeprecationNotice
   :members:
   :show-inheritance:

.. autoclass:: DynamicProperty
   :members:
   :show-inheritance:

.. autoclass:: DynamicRelationship
   :members:
   :show-inheritance:

.. autoclass:: Extension
   :members:
   :show-inheritance:

.. autoclass:: ExtensionFilterParams
   :members:
   :show-inheritance:

.. autoclass:: ExtensionMetadata
   :members:
   :show-inheritance:

.. autoclass:: ExtensionMetadataContainer
   :members:
   :show-inheritance:

.. autoclass:: ExtensionRepoArtifact
   :members:
   :show-inheritance:

.. autoclass:: ExtensionRepoBucket
   :members:
   :show-inheritance:

.. autoclass:: ExtensionRepoGroup
   :members:
   :show-inheritance:

.. autoclass:: ExtensionRepoVersion
   :members:
   :show-inheritance:

.. autoclass:: ExtensionRepoVersionSummary
   :members:
   :show-inheritance:

.. autoclass:: ExternalControllerServiceReference
   :members:
   :show-inheritance:

.. autoclass:: Fields
   :members:
   :show-inheritance:

.. autoclass:: FormDataContentDisposition
   :members:
   :show-inheritance:

.. autoclass:: Link
   :members:
   :show-inheritance:

.. autoclass:: ListenPortDefinition
   :members:
   :show-inheritance:

.. autoclass:: LongParameter
   :members:
   :show-inheritance:

.. autoclass:: ModelProperty
   :members:
   :show-inheritance:

.. autoclass:: MultiProcessorUseCase
   :members:
   :show-inheritance:

.. autoclass:: ParameterProviderReference
   :members:
   :show-inheritance:

.. autoclass:: Permissions
   :members:
   :show-inheritance:

.. autoclass:: Position
   :members:
   :show-inheritance:

.. autoclass:: ProcessorConfiguration
   :members:
   :show-inheritance:

.. autoclass:: ProvidedServiceAPI
   :members:
   :show-inheritance:

.. autoclass:: RegistryAbout
   :members:
   :show-inheritance:

.. autoclass:: RegistryConfiguration
   :members:
   :show-inheritance:

.. autoclass:: Relationship
   :members:
   :show-inheritance:

.. autoclass:: Resource
   :members:
   :show-inheritance:

.. autoclass:: ResourceDefinition
   :members:
   :show-inheritance:

.. autoclass:: ResourcePermissions
   :members:
   :show-inheritance:

.. autoclass:: Restricted
   :members:
   :show-inheritance:

.. autoclass:: Restriction
   :members:
   :show-inheritance:

.. autoclass:: RevisionInfo
   :members:
   :show-inheritance:

.. autoclass:: Stateful
   :members:
   :show-inheritance:

.. autoclass:: SystemResourceConsideration
   :members:
   :show-inheritance:

.. autoclass:: TagCount
   :members:
   :show-inheritance:

.. autoclass:: Tenant
   :members:
   :show-inheritance:

.. autoclass:: UriBuilder
   :members:
   :show-inheritance:

.. autoclass:: UseCase
   :members:
   :show-inheritance:

.. autoclass:: User
   :members:
   :show-inheritance:

.. autoclass:: UserGroup
   :members:
   :show-inheritance:

.. autoclass:: VersionedAsset
   :members:
   :show-inheritance:

.. autoclass:: VersionedConnection
   :members:
   :show-inheritance:

.. autoclass:: VersionedControllerService
   :members:
   :show-inheritance:

.. autoclass:: VersionedFlow
   :members:
   :show-inheritance:

.. autoclass:: VersionedFlowCoordinates
   :members:
   :show-inheritance:

.. autoclass:: VersionedFlowDifference
   :members:
   :show-inheritance:

.. autoclass:: VersionedFlowSnapshot
   :members:
   :show-inheritance:

.. autoclass:: VersionedFlowSnapshotMetadata
   :members:
   :show-inheritance:

.. autoclass:: VersionedFunnel
   :members:
   :show-inheritance:

.. autoclass:: VersionedLabel
   :members:
   :show-inheritance:

.. autoclass:: VersionedListenPortDefinition
   :members:
   :show-inheritance:

.. autoclass:: VersionedParameter
   :members:
   :show-inheritance:

.. autoclass:: VersionedParameterContext
   :members:
   :show-inheritance:

.. autoclass:: VersionedPort
   :members:
   :show-inheritance:

.. autoclass:: VersionedProcessGroup
   :members:
   :show-inheritance:

.. autoclass:: VersionedProcessor
   :members:
   :show-inheritance:

.. autoclass:: VersionedPropertyDescriptor
   :members:
   :show-inheritance:

.. autoclass:: VersionedRemoteGroupPort
   :members:
   :show-inheritance:

.. autoclass:: VersionedRemoteProcessGroup
   :members:
   :show-inheritance:

.. autoclass:: VersionedResourceDefinition
   :members:
   :show-inheritance: