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

Enum Class InstanceStatus

java.lang.Object
java.lang.Enum<InstanceStatus>
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus
All Implemented Interfaces:
Serializable, Comparable<InstanceStatus>, Constable
public enum InstanceStatus extends Enum<InstanceStatus> implements Serializable
The InstanceStatus defines the status of an instance (classification, relationship or an entity) in the metadata collection. It effectively defines its visibility to different types of queries. Most queries by default will only return instances in the active status.
  • Unknown: Unknown instance status.
  • Draft: The content is incomplete.
  • Proposed: The content is in review.
  • Approved: The content is approved.
  • Rejected: The request or proposal is rejected.
  • Approved concept: The request or proposal is approved for development.
  • Under development: The instance is being developed.
  • Development complete: The development of the instance is complete.
  • Approved for deployment: The instance is approved for deployment.
  • StandBy: The instance is deployed in standby mode.
  • Active: The instance is approved and in use.
  • Failed: The instance is not in use due to failure.
  • Disabled: The instance is shutdown or disabled.
  • Complete: The activity associated with the instance is complete.
  • Deprecated: The instance is out of date and should not be used.
  • Other: The instance is in a locally defined state.
  • Deleted: The instance has been deleted and is waiting to be purged. It is kept in the metadata collection to support a restore request. It is not returned on normal queries.

  • Enum Constant Details

  • Method Details

    • values

      public static InstanceStatus[] 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 InstanceStatus 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 numerical value for the enum.
      Returns:
      int enum value ordinal

    • getName

      public String getName()
      Return the descriptive name for the enum.
      Returns:
      String name

    • getDescription

      public String getDescription()
      Return the description for the enum.
      Returns:
      String description

    • toString

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