Package org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances

Enum Class InstanceProvenanceType

java.lang.Object
java.lang.Enum<InstanceProvenanceType>
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProvenanceType
All Implemented Interfaces:
Serializable, Comparable<InstanceProvenanceType>, Constable
public enum InstanceProvenanceType extends Enum<InstanceProvenanceType> implements Serializable
InstanceProvenanceType defines where the metadata comes from and, hence if it can be updated.
  • UNKNOWN: uninitialized provenance value.
  • LOCAL_COHORT: the element is being maintained within the local cohort. The metadata collection id is for one of the repositories in the cohort. This metadata collection id identifies the home repository for this element.
  • EXPORT_ARCHIVE: the element was created from an export archive. The metadata collection id for the element is the metadata collection id of the originating server. If the originating server later joins the cohort with the same metadata collection id then these elements will be refreshed from the originating server's current repository.
  • CONTENT_PACK: the element comes from an open metadata content pack. The metadata collection id of the elements is set to the GUID of the pack.
  • DEREGISTERED_REPOSITORY: the element comes from a metadata repository that used to be a part of the repository cohort but has been deregistered. The metadata collection id remains the same. If the repository rejoins the cohort then these elements can be refreshed from the rejoining repository.
  • CONFIGURATION: the element comes from a configuration server. The metadata collection id is null.
  • DATA_PLATFORM: the element is being managed by an external data platform using the Data Platform OMAS. This data platform hosts the data assets it documents and the metadata is an integral part of its operation.
  • EXTERNAL_ENGINE: the element is being maintained by an external engine that is manipulating data assets in real-time. The metadata describes events in real-time and as such should not be updated by other metadata processes.
  • EXTERNAL_TOOL: the element is being maintained by an external tool. Typically this is descriptive metadata that the tool is using to provide a service. Hence it has tagged the metadata as read-only.

  • Enum Constant Details

    • UNKNOWN

      public static final InstanceProvenanceType UNKNOWN
      Unknown - Unknown provenance.

    • LOCAL_COHORT

      public static final InstanceProvenanceType LOCAL_COHORT
      Local to cohort - The instance is being maintained within one of the local cohort members. The metadata collection id is for one of the repositories in the cohort. This metadata collection id identifies the home repository for this element.

    • EXPORT_ARCHIVE

      public static final InstanceProvenanceType EXPORT_ARCHIVE
      Export Archive - The instance was created from an export archive. The metadata collection id for the element is the metadata collection id of the originating server. If the originating server later joins the cohort with the same metadata collection id then these elements will be refreshed from the originating server's current repository.

    • CONTENT_PACK

      public static final InstanceProvenanceType CONTENT_PACK
      Content Pack - The instance comes from an open metadata content pack. The metadata collection id of the elements is set to the GUID of the pack.

    • DEREGISTERED_REPOSITORY

      public static final InstanceProvenanceType DEREGISTERED_REPOSITORY
      Deregistered Repository - The instance comes from a metadata repository that used to be a member of the one of the local repository's cohorts, but it has been deregistered. The metadata collection id remains the same. If the repository rejoins the cohort then these elements can be refreshed from the rejoining repository.

    • CONFIGURATION

      public static final InstanceProvenanceType CONFIGURATION
      Configuration - The instance is part of a service's configuration. The metadata collection id is null.

    • EXTERNAL_SOURCE

      public static final InstanceProvenanceType EXTERNAL_SOURCE
      External Source - The instance is maintained by an external technology. The metadata collection id is the guid of the technology's descriptive entity.

  • Method Details

    • values

      public static InstanceProvenanceType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static InstanceProvenanceType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getOrdinal

      public int getOrdinal()
      Return the numeric representation of the instance provenance type.
      Returns:
      int ordinal

    • getName

      public String getName()
      Return the default name of the instance provenance type.
      Returns:
      String name

    • getDescription

      public String getDescription()
      Return the default description of the instance provenance type.
      Returns:
      String description

    • toString

      public String toString()
      toString() JSON-style
      Overrides:
      toString in class Enum<InstanceProvenanceType>
      Returns:
      string description