Package org.odpi.openmetadata.frameworks.openmetadata.types

Enum Class OpenMetadataProperty

java.lang.Object

java.lang.Enum<OpenMetadataProperty>

org.odpi.openmetadata.frameworks.openmetadata.types.OpenMetadataProperty

All Implemented Interfaces:

Serializable, Comparable<OpenMetadataProperty>, Constable

public enum OpenMetadataProperty
extends Enum<OpenMetadataProperty>

Provides the definition for all properties defined in the open metadata types.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABBREVIATION	How this concept name is abbreviated.
ACTION_DESCRIPTION	Description of the activity.
ACTION_PROPERTIES	Additional information for use during action processing.
ACTION_REQUESTED	What needs to be done.
ACTION_SOURCE_NAME	Name of the activity that revealed the need for action.
ACTION_STATUS	Defines the current execution status of an engine action.
ACTION_TARGET_FILTER	Lists the names of the action targets to remove from the supplied action targets.
ACTION_TARGET_MAP	Provides a translation map between the supplied name of an action target and the name supported by the implementation of the governance service.
ACTION_TARGET_NAME	The name to identify the action target to the actor that processes it.
ACTIVITY_TYPE	Different types of activities.
ADDITIONAL_PROPERTIES	Additional properties for the element.
ANALYSIS_PARAMETERS	Additional request parameters passed to the service.
ANALYSIS_STEP	The step in the analysis that produced the annotation.
ANCHOR_GUID	The unique identifier of the referenceable that this element is directly or indirectly anchored to.
ANCHOR_TYPE_NAME	Unique name of the type of the anchor.
ANNOTATION_STATUS	Status of the processing as a result of the annotation.
ANNOTATION_TYPE	Name of the type of annotation.
ARCHIVE_DATE	Timestamp when the archive occurred or was detected.
ARCHIVE_METHOD	Name of method that created this classification.
ARCHIVE_PROCESS	Name of process that performed the archive - or detected the archive.
ARCHIVE_PROPERTIES	Properties to locate the real-world counterpart in the archive.
ARCHIVE_SERVICE	Name of service that created this classification.
ARCHIVE_USER	Name of user that performed the archive - or detected the archive.
ASSET_GUID	The unique identifier of the associated asset.
ATTACHMENT_GUID	If an attached entity or relationship to it changed, this is its unique identifier.
ATTACHMENT_TYPE	If an attached entity or relationship to changed, this is its unique type name.
AVERAGE_VALUE	Typical value in the data.
BYTE_ORDERING	Defines the sequential order in which bytes are arranged into larger numerical values when stored in memory or when transmitted over digital links.
CANDIDATE_CLASSIFICATIONS	Potential classification names and properties as JSON.
CANDIDATE_DATA_CLASS_GUIDS	List of possible matching data classes.
CANDIDATE_GLOSSARY_CATEGORY_GUIDS	List of potentially matching glossary categories.
CANDIDATE_GLOSSARY_TERM_GUIDS	List of potentially matching glossary terms.
CAPABILITY_TYPE	Type of the software capability.
CAPABILITY_VERSION	Version number of the software capability.
CHANGE_ACTION	The type of change.
CHANGE_TARGET	The relationship of element that has been changed to the anchor.
CLASSIFICATION_NAME	The name of the associated classification.
CLASSIFICATION_PROPERTY_NAME	Name of the property in the classification where this value is used.
COLLECTION_ORDER	Defines the sequencing for a collection.
COLLECTION_TYPE	Descriptive name of the concept that this collection represents.
COMMENT	Notes provided by the steward.
COMMENT_TYPE	Descriptor for a comment that indicated its intent.
COMPLETION_DATE	Date/time that work stopped on this element.
COMPLETION_MESSAGE	Message to provide additional information on the results of acting on the target by the actor or the reasons for any failures.
CONFIDENCE	Level of confidence in the correctness of the element.
CONFIDENCE_LEVEL	Level of certainty in the accuracy of the results.
CONFIDENCE_LEVEL_IDENTIFIER	Defines the level of confidence to place in the accuracy of a data item.
CONFIDENTIALITY_LEVEL_IDENTIFIER	Defines how confidential a data item is.
CONTACT_METHOD_SERVICE	Details of the service supporting the contact method.
CONTACT_METHOD_TYPE	Type of mechanism to contact an actor.
CONTACT_METHOD_VALUE	Details of the contact method
CONTACT_TYPE	Type of contact - such as home address, work mobile, emergency contact ...
CREATE_TIME	Time that an instance was created.
CRITICALITY_LEVEL_IDENTIFIER	Defines how important a data item is to the organization.
CURRENT_VERSION	Which is the current supported version that is recommended for consumers.
DATA_CLASS_ASSIGNMENT_STATUS	Defines the provenance and confidence of a data class assignment.
DATA_FIELD_SORT_ORDER	Defines the suggested order that data values in this data item should be sorted by.
DATA_TYPE	The name of a primitive data type.
DEPLOYED_IMPLEMENTATION_TYPE	Name of a particular type of technology.
DEPLOYER	Person, organization or engine that deployed the IT Infrastructure.
DEPLOYER_PROPERTY_NAME	Identifying property name of deployer.
DEPLOYER_TYPE_NAME	Type name of deployer.
DEPLOYMENT_TIME	"Time that the IT Infrastructure was deployed."
DESCRIPTION	Description of the element or associated resource in free-text.
DISPLAY_NAME	Display name of the element used for summary tables and titles
EMBEDDED_METADATA	Metadata properties embedded in the media file.
ENCODING	Encoding scheme used on the data.
ENCODING_DESCRIPTION	Description of the encoding.
ENCODING_LANGUAGE	Language used in the encoding.
ENCODING_PROPERTIES	Additional properties describing the encoding.
ENGINE_ACTION_GUID	The unique identifier of the engine action that initiated the governance service that created this element.
EXAMPLE	An example of the described concept, element or value.
EXAMPLES	An example of the described concept, element or value.
EXPLANATION	Explanation of the analysis.
EXPRESSION	Expression used to create the annotation.
EXT_INSTANCE_CREATED_BY	The username of the person or process that created the instance in the external system.
EXT_INSTANCE_CREATION_TIME	The date/time when the instance in the external system was created.
EXT_INSTANCE_LAST_UPDATE_TIME	The date/time when the instance in the external system was last updated.
EXT_INSTANCE_LAST_UPDATED_BY	The username of the person or process that last updated the instance in the external system.
EXT_INSTANCE_VERSION	The latest version of the element in the external system.
FILE_EXTENSION	The file extension used at the end of the file's name.
FILE_NAME	The name of the file with extension.
FILE_TYPE	File type descriptor (or logical file type) typically extracted from the file name.
FORMULA	Formula that describes the behaviour of the element.
FORMULA_TYPE	Format of the expression provided in the formula attribute.
GOVERNANCE_ACTION_TYPE_GUID	Unique identifier of the governance action type that initiated this request (if applicable).
GOVERNANCE_ACTION_TYPE_NAME	Unique name of the governance action type that initiated this request (if applicable).
GUID	Unique identifier of an open metadata entity or relationship.
IDENTIFIER	Identifier used in an external system.
INCIDENT_STATUS	Defines the current status of an incident report.
INFERRED_DATA_TYPE	Inferred data type based on the data values.
INFERRED_FORMAT	Inferred data format based on the data values.
INFERRED_LENGTH	Inferred data field length based on the data values.
INFERRED_PRECISION	Inferred precision of the data based on the data values.
INFERRED_SCALE	Inferred scale applied to the data based on the data values.
INFORMAL_CATEGORY	Suggested category based on the analysis.
INFORMAL_TERM	Suggested term based on the analysis.
INTRODUCTION_DATE	Date that the product was made available.
IS_PUBLIC	Is this element visible to all, or only the author?
JSON_PROPERTIES	Additional properties used in the request.
KEY_PATTERN	Type of identifier that identifies its lifecycle, for example, its scope and whether the value is reused.
KEYWORD	Name of the keyword.
LAST_SYNCHRONIZED	Timestamp documenting the last time the metadata in the external metadata source was synchronized with open metadata element.
LATEST_CHANGE	Description of the last change to the asset's metadata.
LENGTH	Length of the data field.
LINK_TYPE_NAME	Unique name of the link type that connects the edge to the vertex.
MAPPING_PROPERTIES	Additional properties to aid the mapping to the the element in an external metadata source.
MATCHING_VALUES	Number of values that match the data class specification.
MATURITY	Level of maturity for the product.
MAX_CARDINALITY	Maximum number of allowed instances.
MAXIMUM_INSTANCES	Maximum number of running asset instances controlled by the software capability.
MEMBERSHIP_RATIONALE	Description of how the member is used, or why it is useful in this collection.
MEMBERSHIP_STATUS	Defines the provenance and confidence that a member belongs in a collection.
MIN_CARDINALITY	Minimum number of allowed instances.
MINIMUM_INSTANCES	Minimum number of running asset instances controlled by the software capability.
NAME	Unique identifier for the entity.
NEXT_VERSION_DATE	Date when is the next version is expected to be released.
NON_MATCHING_VALUES	Number of values that do not match the data class specification.
NOTES	Notes on why decision were made relating to this element, and other useful information.
OPERATIONAL_STATUS	The operational status of the software server capability on this software server.
ORDER_BY_PROPERTY_NAME	Name of property to use for ordering.
OWNER	Identifier of the person or process who is accountable for the proper management of the element or related resource.
OWNER_TYPE	Deprecated.
PATCH_LEVEL	Patch level of the software server capability.
PATH_NAME	The fully qualified physical location of the data store.
PERMITTED_SYNCHRONIZATION	Defines the permitted directions of flow of metadata updates between open metadata and a third party technology.
PLANNED_END_DATE	Date/time that work is expected to be complete for this element.
POSITION	Position of the element in a collection of relationships.
PRIORITY	An indication of the relative position in which this work item should be tackled compared to others in the overall work list.
PROCESS_NAME	Unique name of the process that initiated this request (if applicable).
PROCESS_STEP_GUID	Unique identifier of the governance action process step that initiated this request (if applicable).
PROCESS_STEP_NAME	Unique name of the governance action process step that initiated this request (if applicable).
PRODUCT_NAME	Display name of the product.
PRODUCT_STATUS	Display name of the product.
PRODUCT_TYPE	Type or category of the product.
PROFILE_COUNTS	Additional counts discovered during the analysis.
PROFILE_FLAGS	Additional flags (booleans) discovered during the analysis.
PROFILE_PROPERTIES	Additional profile properties discovered during the analysis.
PROJECT_HEALTH	Indicator on how well the project is tracking to plan.
PROJECT_PHASE	The phase in the lifecycle of the project.
PROJECT_STATUS	Short description on current status of the project.
PROPERTY_TYPE	The type of property that the valid value represents.
PUBLISH_VERSION_ID	Visible version identifier.
PURPOSE	Provides additional reasons, or expectations from the results.
QUALIFIED_NAME	Unique identifier for the entity.
QUALITY_DIMENSION	Type of quality calculation.
QUALITY_SCORE	Calculated quality value.
RELATED_ENTITY_GUID	Entity that should be linked to the asset being analyzed.
RELATIONSHIP_END	If the end of a relationship is significant, set to 1 or 2 to indicate the desired end; otherwise use 0.
RELATIONSHIP_END_NAME	Display name for the relationship end.
RELATIONSHIP_PROPERTIES	Properties to add to the relationship.
RELATIONSHIP_TYPE	If an attached entity or relationship to changed, this is its unique type name of the relationship.
RELATIONSHIP_TYPE_NAME	Type name of the potential relationship.
REQUEST_PARAMETER_FILTER	Lists the names of the request parameters to remove from the requestParameters supplied by the caller.
REQUEST_PARAMETER_MAP	Provides a translation map between the supplied name of the requestParameters and the names supported by the implementation of the governance service.
REQUEST_PARAMETERS	Properties that configure the governance service for this type of request.
REQUEST_TYPE	The request type used to call the service.
REQUESTER_USER_ID	The request type used to call the service.
REQUIRED	Is this value required?
RESOURCE_CREATE_TIME	Creation time of the data store.
RESOURCE_LAST_ACCESSED_TIME	Last known modification time.
RESOURCE_PROPERTIES	Discovered properties of the data source.
RESOURCE_UPDATE_TIME	Last known modification time.
RESOURCE_USE	Identifier that describes the type of resource use.
RESOURCE_USE_DESCRIPTION	Description of how the resource is used, or why it is useful.
RESOURCE_USE_PROPERTIES	Additional properties that explains how to use the resource.
RETENTION_BASIS_IDENTIFIER	Defines the retention requirements associated with a data item.
REVIEW_DATE	Date of the review.
SAMPLING_METHOD	Description of the technique used to create the sample.
SCHEMA_NAME	Display name for the discovered schema.
SCHEMA_TYPE	Type name for the discovered schema.
SCHEMA_TYPE_NAME	Open metadata type name for the associated schema type.
SERVICE_LIFE	Length of time that the product is expected to be in service.
SERVICE_REQUEST_TYPE	Request type supported by the governance service (overrides requestType on call to governance service if specified)
SEVERITY_IDENTIFIER	Defines the severity of the impact that a situation has.
SIZE	Size of the data source.
SORT_ORDER	Defines the suggested order that data values in this data item should be sorted by.
SOURCE	Details of where the element was sourced from.
SOURCE_VERSION_NUMBER	The version number of the template element when the copy was created.
START_DATE	Date/time that work started on this element.
STATUS_IDENTIFIER	Defines how important a data item is to the organization.
STEWARD	User identifier for the steward performing the review.
STEWARD_PROPERTY_NAME	Property name for the steward's unique identifier (typically guid or qualifiedName).
STEWARD_TYPE_NAME	Type name of the Actor entity identifying the steward.
STORE_CREATE_TIME	Creation time of the data store.
STORE_UPDATE_TIME	Last known modification time.
SUMMARY	Short description for summary tables.
TARGET_FOR_ACTION_STATUS	Defines the current execution status of an engine action.
TERM_ASSIGNMENT_STATUS	Defines the provenance and confidence of a term assignment.
TERM_RELATIONSHIP_STATUS	Defines the confidence in the assigned relationship.
TO_DO_STATUS	The status of the work on this element.
TOPIC_NAME	Full name of the topic as used by programs to access its contents
TOPIC_TYPE	Type of topic.
TYPE	Deprecated.
TYPE_NAME	Unique identifier of an open metadata entity, classification or relationship.
UPDATE_TIME	Last time that an instance was updated.
USAGE	Guidance on how the element should be used.
USE_TYPE	Describes how the software capability uses the asset.
USER	The user identifier for the person/system executing the request.
USER_ID	The user identifier for the person/system executing the request.
USES_BLOCKING_CALLS	The integration connector needs to use blocking calls to a third party technology and so needs to run in its own thread.
VALUE_COUNT	Count of individual values in the data.
VALUE_LIST	List of individual values in the data.
VALUE_RANGE_FROM	Lowest value in the data.
VALUE_RANGE_TO	Highest value in the data.
VERSION_IDENTIFIER	Version identifier to allow different versions of the same resource to appear in the catalog as separate assets.
WATCH_RESOURCE	Indicator whether the anchor should receive notifications of changes to the resource.
WITHDRAW_DATE	Date when the product is expected to be (or has been) withdrawn, preventing new consumers from subscribing.
ZONE_MEMBERSHIP	The list of governance zones that this asset belongs to.

Field Summary

Fields

Modifier and Type	Field	Description
final String	description	Description
final String	descriptionGUID	Unique identifier of description valid value.
final String	example	Example of a value for this property.
final String	name	Name
final String	type	Type

Method Summary

Modifier and Type	Method	Description
static OpenMetadataProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenMetadataProperty[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GUID

public static final OpenMetadataProperty GUID

Unique identifier of an open metadata entity or relationship.

TYPE_NAME

public static final OpenMetadataProperty TYPE_NAME

Unique identifier of an open metadata entity, classification or relationship.

CREATE_TIME

public static final OpenMetadataProperty CREATE_TIME

Time that an instance was created.

UPDATE_TIME

public static final OpenMetadataProperty UPDATE_TIME

Last time that an instance was updated.

ARCHIVE_DATE

public static final OpenMetadataProperty ARCHIVE_DATE

Timestamp when the archive occurred or was detected.

ARCHIVE_USER

public static final OpenMetadataProperty ARCHIVE_USER

Name of user that performed the archive - or detected the archive.

ARCHIVE_PROCESS

public static final OpenMetadataProperty ARCHIVE_PROCESS

Name of process that performed the archive - or detected the archive.

ARCHIVE_SERVICE

public static final OpenMetadataProperty ARCHIVE_SERVICE

Name of service that created this classification.

ARCHIVE_METHOD

public static final OpenMetadataProperty ARCHIVE_METHOD

Name of method that created this classification.

ARCHIVE_PROPERTIES

public static final OpenMetadataProperty ARCHIVE_PROPERTIES

Properties to locate the real-world counterpart in the archive.

ANCHOR_GUID

public static final OpenMetadataProperty ANCHOR_GUID

The unique identifier of the referenceable that this element is directly or indirectly anchored to.

ANCHOR_TYPE_NAME

public static final OpenMetadataProperty ANCHOR_TYPE_NAME

Unique name of the type of the anchor.

QUALIFIED_NAME

public static final OpenMetadataProperty QUALIFIED_NAME

Unique identifier for the entity.

ADDITIONAL_PROPERTIES

public static final OpenMetadataProperty ADDITIONAL_PROPERTIES

Additional properties for the element.

NAME

public static final OpenMetadataProperty NAME

Unique identifier for the entity.

DISPLAY_NAME

public static final OpenMetadataProperty DISPLAY_NAME

Display name of the element used for summary tables and titles

DESCRIPTION

public static final OpenMetadataProperty DESCRIPTION

Description of the element or associated resource in free-text.

VERSION_IDENTIFIER

public static final OpenMetadataProperty VERSION_IDENTIFIER

Version identifier to allow different versions of the same resource to appear in the catalog as separate assets.

DEPLOYED_IMPLEMENTATION_TYPE

public static final OpenMetadataProperty DEPLOYED_IMPLEMENTATION_TYPE

Name of a particular type of technology. It is more specific than the open metadata types and increases the precision in which technology is catalogued. This helps human understanding and enables connectors and other actions to be targeted to the right technology.

TYPE

@Deprecated
public static final OpenMetadataProperty TYPE

Deprecated.

Name of a particular type of technology. It is more specific than the open metadata types and increases the precision in which technology is catalogued. This helps human understanding and enables connectors and other actions to be targeted to the right technology.

OWNER

public static final OpenMetadataProperty OWNER

Identifier of the person or process who is accountable for the proper management of the element or related resource.

OWNER_TYPE

@Deprecated
public static final OpenMetadataProperty OWNER_TYPE

Deprecated.

Type of identifier used for owner property.

ZONE_MEMBERSHIP

public static final OpenMetadataProperty ZONE_MEMBERSHIP

The list of governance zones that this asset belongs to.

LATEST_CHANGE

public static final OpenMetadataProperty LATEST_CHANGE

Description of the last change to the asset's metadata.

FORMULA

public static final OpenMetadataProperty FORMULA

Formula that describes the behaviour of the element. May include placeholders for queryIds

FORMULA_TYPE

public static final OpenMetadataProperty FORMULA_TYPE

Format of the expression provided in the formula attribute.

IS_PUBLIC

public static final OpenMetadataProperty IS_PUBLIC

Is this element visible to all, or only the author?

SAMPLING_METHOD

public static final OpenMetadataProperty SAMPLING_METHOD

Description of the technique used to create the sample.

CHANGE_TARGET

public static final OpenMetadataProperty CHANGE_TARGET

The relationship of element that has been changed to the anchor.

CHANGE_ACTION

public static final OpenMetadataProperty CHANGE_ACTION

The type of change.

CLASSIFICATION_NAME

public static final OpenMetadataProperty CLASSIFICATION_NAME

The name of the associated classification.

CLASSIFICATION_PROPERTY_NAME

public static final OpenMetadataProperty CLASSIFICATION_PROPERTY_NAME

Name of the property in the classification where this value is used.

ATTACHMENT_GUID

public static final OpenMetadataProperty ATTACHMENT_GUID

If an attached entity or relationship to it changed, this is its unique identifier.

ATTACHMENT_TYPE

public static final OpenMetadataProperty ATTACHMENT_TYPE

If an attached entity or relationship to changed, this is its unique type name.

RELATIONSHIP_TYPE

public static final OpenMetadataProperty RELATIONSHIP_TYPE

If an attached entity or relationship to changed, this is its unique type name of the relationship.

USER

public static final OpenMetadataProperty USER

The user identifier for the person/system executing the request.

USER_ID

public static final OpenMetadataProperty USER_ID

The user identifier for the person/system executing the request.

ENGINE_ACTION_GUID

public static final OpenMetadataProperty ENGINE_ACTION_GUID

The unique identifier of the engine action that initiated the governance service that created this element.

ASSET_GUID

public static final OpenMetadataProperty ASSET_GUID

The unique identifier of the associated asset.

ACTION_DESCRIPTION

public static final OpenMetadataProperty ACTION_DESCRIPTION

Description of the activity.

SOURCE_VERSION_NUMBER

public static final OpenMetadataProperty SOURCE_VERSION_NUMBER

The version number of the template element when the copy was created.

PATH_NAME

public static final OpenMetadataProperty PATH_NAME

The fully qualified physical location of the data store.

FILE_TYPE

public static final OpenMetadataProperty FILE_TYPE

File type descriptor (or logical file type) typically extracted from the file name.

FILE_NAME

public static final OpenMetadataProperty FILE_NAME

The name of the file with extension.

FILE_EXTENSION

public static final OpenMetadataProperty FILE_EXTENSION

The file extension used at the end of the file's name. This identifies the format of the file.

REQUEST_TYPE

public static final OpenMetadataProperty REQUEST_TYPE

The request type used to call the service.

REQUESTER_USER_ID

public static final OpenMetadataProperty REQUESTER_USER_ID

The request type used to call the service.

REQUEST_PARAMETERS

public static final OpenMetadataProperty REQUEST_PARAMETERS

Properties that configure the governance service for this type of request.

REQUEST_PARAMETER_FILTER

public static final OpenMetadataProperty REQUEST_PARAMETER_FILTER

Lists the names of the request parameters to remove from the requestParameters supplied by the caller.

REQUEST_PARAMETER_MAP

public static final OpenMetadataProperty REQUEST_PARAMETER_MAP

Provides a translation map between the supplied name of the requestParameters and the names supported by the implementation of the governance service.

ACTION_TARGET_FILTER

public static final OpenMetadataProperty ACTION_TARGET_FILTER

Lists the names of the action targets to remove from the supplied action targets.

ACTION_TARGET_MAP

public static final OpenMetadataProperty ACTION_TARGET_MAP

Provides a translation map between the supplied name of an action target and the name supported by the implementation of the governance service.

SERVICE_REQUEST_TYPE

public static final OpenMetadataProperty SERVICE_REQUEST_TYPE

Request type supported by the governance service (overrides requestType on call to governance service if specified)

LINK_TYPE_NAME

public static final OpenMetadataProperty LINK_TYPE_NAME

Unique name of the link type that connects the edge to the vertex.

RELATIONSHIP_END

public static final OpenMetadataProperty RELATIONSHIP_END

If the end of a relationship is significant, set to 1 or 2 to indicate the desired end; otherwise use 0.

RELATIONSHIP_END_NAME

public static final OpenMetadataProperty RELATIONSHIP_END_NAME

Display name for the relationship end.

SCHEMA_TYPE_NAME

public static final OpenMetadataProperty SCHEMA_TYPE_NAME

Open metadata type name for the associated schema type.

DATA_TYPE

public static final OpenMetadataProperty DATA_TYPE

The name of a primitive data type.

POSITION

public static final OpenMetadataProperty POSITION

Position of the element in a collection of relationships.

MIN_CARDINALITY

public static final OpenMetadataProperty MIN_CARDINALITY

Minimum number of allowed instances.

MAX_CARDINALITY

public static final OpenMetadataProperty MAX_CARDINALITY

Maximum number of allowed instances.

PURPOSE

public static final OpenMetadataProperty PURPOSE

Provides additional reasons, or expectations from the results.

ANNOTATION_TYPE

public static final OpenMetadataProperty ANNOTATION_TYPE

Name of the type of annotation.

SUMMARY

public static final OpenMetadataProperty SUMMARY

Short description for summary tables.

CONFIDENCE_LEVEL

public static final OpenMetadataProperty CONFIDENCE_LEVEL

Level of certainty in the accuracy of the results.

EXPRESSION

public static final OpenMetadataProperty EXPRESSION

Expression used to create the annotation.

EXPLANATION

public static final OpenMetadataProperty EXPLANATION

Explanation of the analysis.

ANALYSIS_PARAMETERS

public static final OpenMetadataProperty ANALYSIS_PARAMETERS

Additional request parameters passed to the service.

ANALYSIS_STEP

public static final OpenMetadataProperty ANALYSIS_STEP

The step in the analysis that produced the annotation.

JSON_PROPERTIES

public static final OpenMetadataProperty JSON_PROPERTIES

Additional properties used in the request.

REVIEW_DATE

public static final OpenMetadataProperty REVIEW_DATE

Date of the review.

STEWARD

public static final OpenMetadataProperty STEWARD

User identifier for the steward performing the review.

STEWARD_TYPE_NAME

public static final OpenMetadataProperty STEWARD_TYPE_NAME

Type name of the Actor entity identifying the steward.

STEWARD_PROPERTY_NAME

public static final OpenMetadataProperty STEWARD_PROPERTY_NAME

Property name for the steward's unique identifier (typically guid or qualifiedName).

NOTES

public static final OpenMetadataProperty NOTES

Notes on why decision were made relating to this element, and other useful information.

COMMENT

public static final OpenMetadataProperty COMMENT

Notes provided by the steward.

ANNOTATION_STATUS

public static final OpenMetadataProperty ANNOTATION_STATUS

Status of the processing as a result of the annotation.

TO_DO_STATUS

public static final OpenMetadataProperty TO_DO_STATUS

The status of the work on this element.

START_DATE

public static final OpenMetadataProperty START_DATE

Date/time that work started on this element.

PLANNED_END_DATE

public static final OpenMetadataProperty PLANNED_END_DATE

Date/time that work is expected to be complete for this element.

COMPLETION_DATE

public static final OpenMetadataProperty COMPLETION_DATE

Date/time that work stopped on this element.

ACTION_TARGET_NAME

public static final OpenMetadataProperty ACTION_TARGET_NAME

The name to identify the action target to the actor that processes it.

EXAMPLE

public static final OpenMetadataProperty EXAMPLE

An example of the described concept, element or value.

EXAMPLES

public static final OpenMetadataProperty EXAMPLES

An example of the described concept, element or value.

ABBREVIATION

public static final OpenMetadataProperty ABBREVIATION

How this concept name is abbreviated.

PUBLISH_VERSION_ID

public static final OpenMetadataProperty PUBLISH_VERSION_ID

Visible version identifier.

REQUIRED

public static final OpenMetadataProperty REQUIRED

Is this value required?

COMPLETION_MESSAGE

public static final OpenMetadataProperty COMPLETION_MESSAGE

Message to provide additional information on the results of acting on the target by the actor or the reasons for any failures.

KEYWORD

public static final OpenMetadataProperty KEYWORD

Name of the keyword.

PROCESS_NAME

public static final OpenMetadataProperty PROCESS_NAME

Unique name of the process that initiated this request (if applicable).

PROCESS_STEP_GUID

public static final OpenMetadataProperty PROCESS_STEP_GUID

Unique identifier of the governance action process step that initiated this request (if applicable).

PROCESS_STEP_NAME

public static final OpenMetadataProperty PROCESS_STEP_NAME

Unique name of the governance action process step that initiated this request (if applicable).

GOVERNANCE_ACTION_TYPE_GUID

public static final OpenMetadataProperty GOVERNANCE_ACTION_TYPE_GUID

Unique identifier of the governance action type that initiated this request (if applicable).

GOVERNANCE_ACTION_TYPE_NAME

public static final OpenMetadataProperty GOVERNANCE_ACTION_TYPE_NAME

Unique name of the governance action type that initiated this request (if applicable).

SCHEMA_NAME

public static final OpenMetadataProperty SCHEMA_NAME

Display name for the discovered schema.

SCHEMA_TYPE

public static final OpenMetadataProperty SCHEMA_TYPE

Type name for the discovered schema.

LENGTH

public static final OpenMetadataProperty LENGTH

Length of the data field.

CANDIDATE_CLASSIFICATIONS

public static final OpenMetadataProperty CANDIDATE_CLASSIFICATIONS

Potential classification names and properties as JSON.

INFERRED_DATA_TYPE

public static final OpenMetadataProperty INFERRED_DATA_TYPE

Inferred data type based on the data values.

INFERRED_FORMAT

public static final OpenMetadataProperty INFERRED_FORMAT

Inferred data format based on the data values.

INFERRED_LENGTH

public static final OpenMetadataProperty INFERRED_LENGTH

Inferred data field length based on the data values.

INFERRED_PRECISION

public static final OpenMetadataProperty INFERRED_PRECISION

Inferred precision of the data based on the data values.

INFERRED_SCALE

public static final OpenMetadataProperty INFERRED_SCALE

Inferred scale applied to the data based on the data values.

PROFILE_PROPERTIES

public static final OpenMetadataProperty PROFILE_PROPERTIES

Additional profile properties discovered during the analysis.

PROFILE_FLAGS

public static final OpenMetadataProperty PROFILE_FLAGS

Additional flags (booleans) discovered during the analysis.

PROFILE_COUNTS

public static final OpenMetadataProperty PROFILE_COUNTS

Additional counts discovered during the analysis.

VALUE_LIST

public static final OpenMetadataProperty VALUE_LIST

List of individual values in the data.

VALUE_COUNT

public static final OpenMetadataProperty VALUE_COUNT

Count of individual values in the data.

VALUE_RANGE_FROM

public static final OpenMetadataProperty VALUE_RANGE_FROM

Lowest value in the data.

VALUE_RANGE_TO

public static final OpenMetadataProperty VALUE_RANGE_TO

Highest value in the data.

AVERAGE_VALUE

public static final OpenMetadataProperty AVERAGE_VALUE

Typical value in the data.

CANDIDATE_DATA_CLASS_GUIDS

public static final OpenMetadataProperty CANDIDATE_DATA_CLASS_GUIDS

List of possible matching data classes.

MATCHING_VALUES

public static final OpenMetadataProperty MATCHING_VALUES

Number of values that match the data class specification.

NON_MATCHING_VALUES

public static final OpenMetadataProperty NON_MATCHING_VALUES

Number of values that do not match the data class specification.

INFORMAL_TERM

public static final OpenMetadataProperty INFORMAL_TERM

Suggested term based on the analysis.

CANDIDATE_GLOSSARY_TERM_GUIDS

public static final OpenMetadataProperty CANDIDATE_GLOSSARY_TERM_GUIDS

List of potentially matching glossary terms.

INFORMAL_CATEGORY

public static final OpenMetadataProperty INFORMAL_CATEGORY

Suggested category based on the analysis.

CANDIDATE_GLOSSARY_CATEGORY_GUIDS

public static final OpenMetadataProperty CANDIDATE_GLOSSARY_CATEGORY_GUIDS

List of potentially matching glossary categories.

QUALITY_DIMENSION

public static final OpenMetadataProperty QUALITY_DIMENSION

Type of quality calculation.

QUALITY_SCORE

public static final OpenMetadataProperty QUALITY_SCORE

Calculated quality value.

RELATIONSHIP_TYPE_NAME

public static final OpenMetadataProperty RELATIONSHIP_TYPE_NAME

Type name of the potential relationship.

RELATED_ENTITY_GUID

public static final OpenMetadataProperty RELATED_ENTITY_GUID

Entity that should be linked to the asset being analyzed.

RELATIONSHIP_PROPERTIES

public static final OpenMetadataProperty RELATIONSHIP_PROPERTIES

Properties to add to the relationship.

RESOURCE_PROPERTIES

public static final OpenMetadataProperty RESOURCE_PROPERTIES

Discovered properties of the data source.

ACTION_SOURCE_NAME

public static final OpenMetadataProperty ACTION_SOURCE_NAME

Name of the activity that revealed the need for action.

ACTION_REQUESTED

public static final OpenMetadataProperty ACTION_REQUESTED

What needs to be done.

ACTION_PROPERTIES

public static final OpenMetadataProperty ACTION_PROPERTIES

Additional information for use during action processing.

RESOURCE_CREATE_TIME

public static final OpenMetadataProperty RESOURCE_CREATE_TIME

Creation time of the data store.

RESOURCE_UPDATE_TIME

public static final OpenMetadataProperty RESOURCE_UPDATE_TIME

Last known modification time.

RESOURCE_LAST_ACCESSED_TIME

public static final OpenMetadataProperty RESOURCE_LAST_ACCESSED_TIME

Last known modification time.

STORE_CREATE_TIME

public static final OpenMetadataProperty STORE_CREATE_TIME

Creation time of the data store.

STORE_UPDATE_TIME

public static final OpenMetadataProperty STORE_UPDATE_TIME

Last known modification time.

SIZE

public static final OpenMetadataProperty SIZE

Size of the data source.

ENCODING

public static final OpenMetadataProperty ENCODING

Encoding scheme used on the data.

ENCODING_LANGUAGE

public static final OpenMetadataProperty ENCODING_LANGUAGE

Language used in the encoding.

ENCODING_DESCRIPTION

public static final OpenMetadataProperty ENCODING_DESCRIPTION

Description of the encoding.

ENCODING_PROPERTIES

public static final OpenMetadataProperty ENCODING_PROPERTIES

Additional properties describing the encoding.

RESOURCE_USE

public static final OpenMetadataProperty RESOURCE_USE

Identifier that describes the type of resource use.

RESOURCE_USE_DESCRIPTION

public static final OpenMetadataProperty RESOURCE_USE_DESCRIPTION

Description of how the resource is used, or why it is useful.

RESOURCE_USE_PROPERTIES

public static final OpenMetadataProperty RESOURCE_USE_PROPERTIES

Additional properties that explains how to use the resource.

WATCH_RESOURCE

public static final OpenMetadataProperty WATCH_RESOURCE

Indicator whether the anchor should receive notifications of changes to the resource.

DEPLOYMENT_TIME

public static final OpenMetadataProperty DEPLOYMENT_TIME

"Time that the IT Infrastructure was deployed."

DEPLOYER_TYPE_NAME

public static final OpenMetadataProperty DEPLOYER_TYPE_NAME

Type name of deployer.

DEPLOYER_PROPERTY_NAME

public static final OpenMetadataProperty DEPLOYER_PROPERTY_NAME

Identifying property name of deployer.

DEPLOYER

public static final OpenMetadataProperty DEPLOYER

Person, organization or engine that deployed the IT Infrastructure.

OPERATIONAL_STATUS

public static final OpenMetadataProperty OPERATIONAL_STATUS

The operational status of the software server capability on this software server.

CAPABILITY_TYPE

public static final OpenMetadataProperty CAPABILITY_TYPE

Type of the software capability.

CAPABILITY_VERSION

public static final OpenMetadataProperty CAPABILITY_VERSION

Version number of the software capability.

PATCH_LEVEL

public static final OpenMetadataProperty PATCH_LEVEL

Patch level of the software server capability.

USE_TYPE

public static final OpenMetadataProperty USE_TYPE

Describes how the software capability uses the asset.

MAXIMUM_INSTANCES

public static final OpenMetadataProperty MAXIMUM_INSTANCES

Maximum number of running asset instances controlled by the software capability.

MINIMUM_INSTANCES

public static final OpenMetadataProperty MINIMUM_INSTANCES

Minimum number of running asset instances controlled by the software capability.

IDENTIFIER

public static final OpenMetadataProperty IDENTIFIER

Identifier used in an external system.

EXT_INSTANCE_CREATED_BY

public static final OpenMetadataProperty EXT_INSTANCE_CREATED_BY

The username of the person or process that created the instance in the external system.

EXT_INSTANCE_CREATION_TIME

public static final OpenMetadataProperty EXT_INSTANCE_CREATION_TIME

The date/time when the instance in the external system was created.

EXT_INSTANCE_LAST_UPDATED_BY

public static final OpenMetadataProperty EXT_INSTANCE_LAST_UPDATED_BY

The username of the person or process that last updated the instance in the external system.

EXT_INSTANCE_LAST_UPDATE_TIME

public static final OpenMetadataProperty EXT_INSTANCE_LAST_UPDATE_TIME

The date/time when the instance in the external system was last updated.

EXT_INSTANCE_VERSION

public static final OpenMetadataProperty EXT_INSTANCE_VERSION

The latest version of the element in the external system.

MAPPING_PROPERTIES

public static final OpenMetadataProperty MAPPING_PROPERTIES

Additional properties to aid the mapping to the the element in an external metadata source.

LAST_SYNCHRONIZED

public static final OpenMetadataProperty LAST_SYNCHRONIZED

Timestamp documenting the last time the metadata in the external metadata source was synchronized with open metadata element.

PERMITTED_SYNCHRONIZATION

public static final OpenMetadataProperty PERMITTED_SYNCHRONIZATION

Defines the permitted directions of flow of metadata updates between open metadata and a third party technology.

KEY_PATTERN

public static final OpenMetadataProperty KEY_PATTERN

Type of identifier that identifies its lifecycle, for example, its scope and whether the value is reused.

USAGE

public static final OpenMetadataProperty USAGE

Guidance on how the element should be used.

SOURCE

public static final OpenMetadataProperty SOURCE

Details of where the element was sourced from.

CONFIDENCE

public static final OpenMetadataProperty CONFIDENCE

Level of confidence in the correctness of the element.

USES_BLOCKING_CALLS

public static final OpenMetadataProperty USES_BLOCKING_CALLS

The integration connector needs to use blocking calls to a third party technology and so needs to run in its own thread.

TOPIC_NAME

public static final OpenMetadataProperty TOPIC_NAME

Full name of the topic as used by programs to access its contents

TOPIC_TYPE

public static final OpenMetadataProperty TOPIC_TYPE

Type of topic.

PROPERTY_TYPE

public static final OpenMetadataProperty PROPERTY_TYPE

The type of property that the valid value represents.

PROJECT_PHASE

public static final OpenMetadataProperty PROJECT_PHASE

The phase in the lifecycle of the project.

PROJECT_HEALTH

public static final OpenMetadataProperty PROJECT_HEALTH

Indicator on how well the project is tracking to plan.

PROJECT_STATUS

public static final OpenMetadataProperty PROJECT_STATUS

Short description on current status of the project.

COLLECTION_TYPE

public static final OpenMetadataProperty COLLECTION_TYPE

Descriptive name of the concept that this collection represents.

PRODUCT_STATUS

public static final OpenMetadataProperty PRODUCT_STATUS

Display name of the product.

PRODUCT_NAME

public static final OpenMetadataProperty PRODUCT_NAME

Display name of the product.

PRODUCT_TYPE

public static final OpenMetadataProperty PRODUCT_TYPE

Type or category of the product.

INTRODUCTION_DATE

public static final OpenMetadataProperty INTRODUCTION_DATE

Date that the product was made available.

NEXT_VERSION_DATE

public static final OpenMetadataProperty NEXT_VERSION_DATE

Date when is the next version is expected to be released.

WITHDRAW_DATE

public static final OpenMetadataProperty WITHDRAW_DATE

Date when the product is expected to be (or has been) withdrawn, preventing new consumers from subscribing.

MATURITY

public static final OpenMetadataProperty MATURITY

Level of maturity for the product.

SERVICE_LIFE

public static final OpenMetadataProperty SERVICE_LIFE

Length of time that the product is expected to be in service.

CURRENT_VERSION

public static final OpenMetadataProperty CURRENT_VERSION

Which is the current supported version that is recommended for consumers. Specified as a versionIdentifier from the asset.

MEMBERSHIP_STATUS

public static final OpenMetadataProperty MEMBERSHIP_STATUS

Defines the provenance and confidence that a member belongs in a collection.

MEMBERSHIP_RATIONALE

public static final OpenMetadataProperty MEMBERSHIP_RATIONALE

Description of how the member is used, or why it is useful in this collection.

COLLECTION_ORDER

public static final OpenMetadataProperty COLLECTION_ORDER

Defines the sequencing for a collection.

ORDER_BY_PROPERTY_NAME

public static final OpenMetadataProperty ORDER_BY_PROPERTY_NAME

Name of property to use for ordering.

BYTE_ORDERING

public static final OpenMetadataProperty BYTE_ORDERING

Defines the sequential order in which bytes are arranged into larger numerical values when stored in memory or when transmitted over digital links.

COMMENT_TYPE

public static final OpenMetadataProperty COMMENT_TYPE

Descriptor for a comment that indicated its intent.

CONTACT_METHOD_TYPE

public static final OpenMetadataProperty CONTACT_METHOD_TYPE

Type of mechanism to contact an actor.

CONTACT_TYPE

public static final OpenMetadataProperty CONTACT_TYPE

Type of contact - such as home address, work mobile, emergency contact ...

CONTACT_METHOD_VALUE

public static final OpenMetadataProperty CONTACT_METHOD_VALUE

Details of the contact method

CONTACT_METHOD_SERVICE

public static final OpenMetadataProperty CONTACT_METHOD_SERVICE

Details of the service supporting the contact method.

CONFIDENCE_LEVEL_IDENTIFIER

public static final OpenMetadataProperty CONFIDENCE_LEVEL_IDENTIFIER

Defines the level of confidence to place in the accuracy of a data item.

CRITICALITY_LEVEL_IDENTIFIER

public static final OpenMetadataProperty CRITICALITY_LEVEL_IDENTIFIER

Defines how important a data item is to the organization.

CONFIDENTIALITY_LEVEL_IDENTIFIER

public static final OpenMetadataProperty CONFIDENTIALITY_LEVEL_IDENTIFIER

Defines how confidential a data item is.

RETENTION_BASIS_IDENTIFIER

public static final OpenMetadataProperty RETENTION_BASIS_IDENTIFIER

Defines the retention requirements associated with a data item.

SEVERITY_IDENTIFIER

public static final OpenMetadataProperty SEVERITY_IDENTIFIER

Defines the severity of the impact that a situation has.

STATUS_IDENTIFIER

public static final OpenMetadataProperty STATUS_IDENTIFIER

Defines how important a data item is to the organization.

SORT_ORDER

public static final OpenMetadataProperty SORT_ORDER

Defines the suggested order that data values in this data item should be sorted by.

DATA_FIELD_SORT_ORDER

public static final OpenMetadataProperty DATA_FIELD_SORT_ORDER

Defines the suggested order that data values in this data item should be sorted by.

INCIDENT_STATUS

public static final OpenMetadataProperty INCIDENT_STATUS

Defines the current status of an incident report.

ACTION_STATUS

public static final OpenMetadataProperty ACTION_STATUS

Defines the current execution status of an engine action.

TARGET_FOR_ACTION_STATUS

public static final OpenMetadataProperty TARGET_FOR_ACTION_STATUS

Defines the current execution status of an engine action.

ACTIVITY_TYPE

public static final OpenMetadataProperty ACTIVITY_TYPE

Different types of activities.

TERM_RELATIONSHIP_STATUS

public static final OpenMetadataProperty TERM_RELATIONSHIP_STATUS

Defines the confidence in the assigned relationship.

TERM_ASSIGNMENT_STATUS

public static final OpenMetadataProperty TERM_ASSIGNMENT_STATUS

Defines the provenance and confidence of a term assignment.

DATA_CLASS_ASSIGNMENT_STATUS

public static final OpenMetadataProperty DATA_CLASS_ASSIGNMENT_STATUS

Defines the provenance and confidence of a data class assignment.

PRIORITY

public static final OpenMetadataProperty PRIORITY

An indication of the relative position in which this work item should be tackled compared to others in the overall work list.

EMBEDDED_METADATA

public static final OpenMetadataProperty EMBEDDED_METADATA

Metadata properties embedded in the media file.

Field Details

name

public final String name

Name

type

public final String type

Type

description

public final String description

Description

example

public final String example

Example of a value for this property.

descriptionGUID

public final String descriptionGUID

Unique identifier of description valid value.

Method Details

values

public static OpenMetadataProperty[] 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 OpenMetadataProperty 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