All Classes and Interfaces
Class
Description
ActionTargetElement describes an element that a governance action service should process.
ActivityDescriptionProperties is used to classify a glossary that describes an activity.
ArchiveProperties defined the properties that are stored when a data source is archived or deleted.
ArchiveRequestBody describes the request body used to create/update connection properties.
AssetConnectionProperties describes the properties used when creating an AssetConnection relationship.
AssetElement contains the properties and header for an asset retrieved from the metadata repository.
DataAssetElementsResponse is a response object for passing back a a list of assets
or an exception if the request failed.
The AssetManagerAuditCode is used to define the message content for the OMRS Audit Log.
AssetManagerElement contains the properties and header for a software server capabilities entity retrieved from the metadata
repository that represents the asset manager that is using the Asset Manager OMAS.
The AssetManagerErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with
the Asset Manager OMAS Services.
AssetManagerEventInterface defines how a client gets access to the
configuration events produced by the Asset Manager OMAS.
AssetManagerEventListener is the interface that a client implements to
register to receive the events from the Asset Manager OMAS's out topic.
AssetManagerEventType describes the different types of events produced by the Asset Manager OMAS.
AssetManagerIdentifiersRequestBody provides the identifiers for an asset manager.
AssetManagerOMASAPIResponse provides a common header for Asset Manager OMAS managed rest to its REST API.
AssetManagerOutTopicEvent provides the structure of the Asset Manager OMAS's OutTopic events.
AssetManagerProperties describes the properties of an external asset manager.
AssetOriginProperties provides a structure for passing information about an asset's origin.
DataAssetProperties is a java bean used to create assets associated with the external asset manager.
CalculatedValueClassificationRequestBody is used to identify the schema elements that are calculated (derived)
rather than stored.
CanonicalVocabularyProperties is used to classify a glossary that has no term definitions with
the same name.
CapabilityDeploymentProperties describes the properties for the SupportedSoftwareCapability relationship between a ITInfrastructure asset
and a Software Capability.
ClassificationProperties provides the base class for classification items.
ClassificationRequestBody describes the request body used when classifying/reclassifying elements.
The CollaborationExchangeInterface supports the exchange of comments, likes, reviews/ratings and informal tags.
The CollaborationManagementInterface supports the exchange of comments, likes, reviews/ratings and
informal tags.
CommentElement contains the properties and header for a Comment entity retrieved from the metadata repository.
CommentElementResponse is the response structure used on the OMAS REST API calls that return the properties for an element.
CommentElementsResponse is a response object for passing back a list of elements or an exception if the request failed.
The CommentProperties bean stores information about a comment connected to an asset.
The CommentType allows comments to be used to ask and answer questions as well as make suggestions and
provide useful information to other users.
CommentTypeListResponse is a response object for passing back a list of enum values or an exception if the request failed.
ComplexSchemaTypeProperties describes a schema with multiple attributes.
ConnectionElement contains the properties and header for a connection retrieved from the metadata repository.
ConnectionExchangeInterface provides methods to define connections and their supporting objects
The interface supports the following types of objects
Connections - the connections used to create connector instances that can access the connection.
ConnectorTypes - description of a specific that can be used to access the connection.
ConnectorCategories - the network information needed to access the connection.
Endpoints - the network information needed to access the connection.
The connection is an object that contains the properties needed to create and initialise a connector to access a
specific data assets.
ConnectionRequestBody describes the request body used to create/update connection properties.
ConnectionResponse is a response object for passing back a single connection object.
ConnectionsResponse is a response object for passing back a list of connection objects.
ConnectorTypeElement contains the properties and header for a connector type retrieved from the metadata repository.
The ConnectorTypeProperties describe the implementation details of a particular type of connector.
ConnectorTypeRequestBody describes the request body used to create/update connector type properties.
ConnectorReportResponse is a response object for passing back a single connector type object.
ConnectorTypesResponse is a response object for passing back a list of connector type objects.
ControlFlowElement contains the properties and header for a control flow relationship retrieved from the metadata repository.
ControlFlowElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a element.
ControlFlowElementsResponse is a response object for passing back a list of control flow relationships
or an exception if the request failed.
ControlFlowProperties describe the properties for a control flow relationship.
ControlFlowRequestBody describes the request body used when linking elements within processes.
ControlledGlossaryTermRequestBody describes the request body used to create/update controlled glossary term properties.
CyberLocation indicates that a location is a cyber location rather than a physical location.
DataAssetElement contains the properties and header for an asset retrieved from the metadata repository.
DataAssetElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a element.
DataAssetElementsResponse is a response object for passing back a a list of assets
or an exception if the request failed.
DataAssetExchangeInterface provides methods to define data assets, their schemas and connections, along with supporting objects,
and lineage.
DataAssetProperties is a java bean used to create assets associated with the external asset manager.
DataAssetRequestBody describes the request body used to create/update asset properties.
DataContentForDataSetProperties defines a query on an asset that returns all or part of the values for a dataset.
DataFieldQueryProperties is used to provide the properties that can be used to extract an element by the data values classification.
DataFieldValuesProperties is used to provide the characterizations of the data values stored in a data field
described by the attached element.
DataFlowElement contains the properties and header for a data flow relationship retrieved from the metadata repository.
DataFlowElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a relationship.
DataFlowElementsResponse is a response object for passing back a list of relationships
or an exception if the request failed.
DataFlowProperties describe the properties for a data flow relationship.
DataFlowRequestBody describes the request body used when linking elements within processes.
DataItemSortOrder is used for schema attributes that may have multiple instances.
DataSetProperties is a class for representing a generic data set.
DataStoreProperties is a class for representing a generic data store.
DeploymentProperties describes the properties for the DeployedOn relationship between an IT Infrastructure asset
and a destination asset.
EditingGlossaryProperties is used to provide the properties for an EditingGlossary classification.
EffectiveTimeQueryRequestBody carries the date/time for a query.
ElementHeaderResponse is the response structure used on the OMAS REST API calls that return the header
for a element.
ElementHeadersResponse is a response object for passing back a list of element headers
or an exception if the request failed.
ElementStubsResponse is a response object for passing back a list of element stubs
or an exception if the request failed.
The EmbeddedConnection is used within a VirtualConnection to link to the embedded connections.
The EmbeddedConnectionProperties is used within a VirtualConnection to link to the embedded connections.
EndpointElement contains the properties and header for an endpoint retrieved from the metadata repository.
EndpointProperties describes the properties of a server endpoint.
EndpointRequestBody describes the request body used to create/update endpoint properties.
EndpointResponse is a response object for passing back a single endpoint object.
EndpointsResponse is a response object for passing back a list of endpoint objects.
EnumSchemaTypeProperties carries the specialized parameters for creating or updating enum schema types.
ExternalAssetManagerInterface provides the interface for retrieving the identity of an external asset manager.
ExternalGlossaryElementLinkElement contains the properties and header for a link to a equivalent external glossary category
retrieved from the metadata repository.
ExternalGlossaryLinkProperties describes the properties of URL link to a remote glossary.
ExternalGlossaryElementLinkRequestBody describes the request body used to create/update links to external glossary elements.
ExternalGlossaryLinkElement contains the properties and header for a link to a equivalent external glossary
retrieved from the metadata repository.
ExternalGlossaryLinkElementsResponse is a response object for passing back a a list of external glossary
links or an exception if the request failed.
ExternalGlossaryLinkProperties describes the properties of URL link to a remote glossary.
ExternalGlossaryLinkRequestBody describes the request body used to create/update links to external glossary elements.
ExternalIdentifierProperties describes the properties used to pass information about an external identifier.
ExternalReferenceElement stores information about an link to an external resource that is relevant to this element.
ExternalReferenceElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a element.
ExternalReferenceElementsResponse is a response object for passing back a a list of glossaries
or an exception if the request failed.
ExternalReferenceLinkElement stores information about an link to an external resource that is relevant to this element.
ExternalReferenceElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a element.
ExternalReferenceLinkElementsResponse is a response object for passing back a a list of glossaries
or an exception if the request failed.
ExternalReferenceLinkProperties provides a structure for the properties that link an external reference to an object.
ExternalGlossaryLinkRequestBody describes the request body used to create/update links to external glossary elements.
ExternalReferenceProperties describes the properties of URL link to a remote source of information.
ExternalReferenceRequestBody describes the request body used to create/update external reference properties.
The ExternalReferencesInterface is used by the governance team to define external references to elements within the governance program.
ExternalSchemaTypeProperties carries the unique identifier and properties of a reusable schema type.
FeedbackProperties provides a base class for passing feedback objects as a request body over a REST API.
FeedbackTargetElement contains the properties and header for a relationship retrieved from the metadata repository along with the stub
of the related element.
AssetOriginProperties provides a structure for passing information about an asset's origin.
FindByPropertiesRequestBody is the request body structure used on OMAG REST API calls that passes a name that is used to retrieve
an element by name.
FindNameProperties is the request body structure used on OMAG REST API calls that passes a name that is used to retrieve
an element by name.
FindProperties provides the base class for find by property requests.
FixedLocation describes a specific fixed physical location.
ForeignKeyProperties describes a foreign key relationship between two columns in different
tables in a database.
ForeignKeyRequestBody describes the request body used when creating a foreign key relationship.
GlossaryCategoryElement contains the properties and header for a deployed glossary schema asset entity
retrieved from the metadata repository.
GlossaryElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a element.
GlossaryCategoryElementsResponse is a response object for passing back a a list of glossaries
or an exception if the request failed.
GlossaryCategoryProperties describes grouping of glossary terms that have similar characteristics.
GlossaryElement contains the properties and header for a glossary entity retrieved from the metadata repository.
GlossaryElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a element.
GlossaryElementsResponse is a response object for passing back a list of glossaries
or an exception if the request failed.
GlossaryExchangeInterface defines the client side interface for the Asset Manager OMAS that is
relevant for managing glossaries.
GlossaryManagementInterface defines the client side interface for the Asset Manager OMAS that is
relevant for managing glossaries.
GlossaryNameRequestBody is the request body structure used on Glossary REST API calls that passes a name that is used to retrieve
an element by name.
GlossaryProperties is a class for representing a generic glossary.
GlossarySearchStringRequestBody is the request body structure used on GlossaryCategory/Term REST API calls that passes a regular expression
to use as a search string and the scope of the results can be optionally restricted by glossary.
GlossaryTemplateRequestBody describes the request body used to create a new glossary term from a template.
A GlossaryTermActivityType defines the type of activity described by a glossary term.
GlossaryTermCategorization describes a type of relationship between a glossary term and a glossary category in a glossary.
GlossaryTermContextDefinition describes a type of context that a glossary term represents.
GlossaryTermElement contains the properties and header for a glossary term entity
retrieved from the metadata repository.
GlossaryTermElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a element.
GlossaryTermElementsResponse is a response object for passing back a a list of glossaries
or an exception if the request failed.
GlossaryTermProperties contains the semantic definition (meaning) of a word or phrase
(term - collectively called terminology).
GlossaryTermRelationship describes a type of relationship between two glossary terms in a glossary.
GlossaryTermRelationshipRequestBody is the request body structure used on Glossary REST API calls that
request the retrieval of glossary term relationships.
A GlossaryTermRelationshipStatus defines the status of a relationship with a glossary term.
The GlossaryTermStatus defines the status of a glossary term.
GlossaryTermStatusRequestBody describes the request body used to update a glossary term's status.
GovernanceActionTypeElement contains the properties and header for an entity retrieved from the metadata
repository that represents a governance action type (plus relevant relationships and properties).
GovernanceActionElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a
GovernanceAction element object as a response.
GovernanceActionElementsResponse is the response structure used on REST API calls that returns a
list of GovernanceActionElement objects as a response.
GovernanceActionProcessElement contains the properties and header for a governance action process entity retrieved from the metadata repository.
GovernanceActionProcessElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a
GovernanceActionProcess element object as a response.
GovernanceActionProcessElementsResponse is the response structure used on REST API calls that returns a
list of GovernanceActionProcessElement objects as a response.
Process properties defines the properties of a process.
GovernanceActionProperties provides a structure for carrying the properties for a governance action.
GovernanceActionStatus defines the current status for a governance action.
GovernanceActionTypesElement contains the properties and header for a governance action type entity retrieved from the metadata repository.
GovernanceActionTypeElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a
GovernanceActionType element object as a response.
GovernanceActionTypeElementsResponse is the response structure used on REST API calls that returns a
list of GovernanceActionTypeElement objects as a response.
GovernanceActionTypeProperties provides a structure for carrying the properties for a governance action type.
GovernanceClassificationBase defines the common properties for the governance action classifications.
GovernanceClassificationProperties defines the properties for a Confidentiality, Confidence, Criticality
Governance Action Classifications.
GovernanceClassificationStatus identifies the status of one of the governance action classification.
GovernanceDefinitionElement is the superclass used to return the common properties of a governance definition stored in the
open metadata repositories.
GovernanceDefinitionProperties provides the base class for many of the definitions that define the data strategy
and governance program.
GovernanceDefinitionsResponse is the response structure used on the OMAS REST API calls that return a
list of governance definitions as a response.
GovernanceDefinitionStatus indicates whether the definition is complete and operational or in a state that means
it is either under development or obsolete.
The GovernanceExchangeInterface enables the exchange of governance definitions between an external asset manager and open metadata.
HistoryRequestBody describes the start and stop time of the historical query.
InformalTagElement contains the properties and header for a InformalTag entity retrieved from the metadata repository.
InformalTagProperties stores information about a tag connected to an asset.
InformalTagResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns a
Tag object as a response.
InformalTagsResponse returns a list of tags from the server.
InformalTagProperties stores information about a tag connected to an asset.
The InfrastructureExchangeInterface supports the exchange of metadata about Hosts, SoftwareServerPlatforms, SoftwareServers
and SoftwareServerCapabilities such as Applications.
A KeyPattern defines the type of External Identifier in use for an asset, or the type of Primary Key used within an
asset.
LevelIdentifierProperties describes the properties for searching for a governance action classification by its level.
LikeElement contains the properties and header for a Like entity retrieved from the metadata repository.
LikeElementResponse is the response structure used on the OMAS REST API calls that return the properties for an element.
LikeElementsResponse is a response object for passing back a list of elements or an exception if the request failed.
The LikeProperties object records a single user's "like" of an element.
The LineageExchangeInterface supports the exchange of process definitions and lineage linkage.
LineageMappingElement contains the properties and header for a lineage mapping relationship retrieved from the metadata repository.
DataFlowElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a relationship.
LineageMappingElementsResponse is a response object for passing back a a list of lineage mapping relationships
or an exception if the request failed.
LineageMappingProperties describe the properties for a lineage mapping relationship.
LiteralSchemaTypeProperties carries the specialized parameters for creating or updating literal schema types.
LocationProperties is a class for representing a physical or digital location.
MapSchemaType describes a schema element of type map.
MetadataCorrelationHeader provides details of the external identifier(s) and other correlation
properties to help the connector/client work out the correlation between the open metadata elements
and the third party technology elements.
MetadataCorrelationProperties describes the common properties used to pass the properties of metadata elements
to the metadata repositories (aka properties server).
MetadataElement is the common interface for all metadata elements.
NameRequestBody is the request body structure used on OMAG REST API calls that passes a name that is used to retrieve
an element by name.
NextGovernanceActionTypeElement contains the properties and header for a governance action type entity plus the
properties of a NextGovernanceActionType relationship retrieved from the metadata repository.
NextGovernanceActionTypeElementsResponse is the response structure used on REST API calls that returns a
list of NextGovernanceActionTypeElement objects as a response.
NoteElement contains the properties and header for a Note entity retrieved from the metadata repository.
NoteElementResponse is the response structure used on the OMAS REST API calls that return the properties for an element.
NoteElementsResponse is a response object for passing back a list of elements or an exception if the request failed.
NoteLogElement contains the properties and header for a NoteLog entity retrieved from the metadata repository.
NoteLogElementResponse is the response structure used on the OMAS REST API calls that return the properties for an element.
NoteLogElementsResponse is a response object for passing back a list of elements or an exception if the request failed.
NoteLogHeader manages a list of notes for an asset
Note defines the properties of a single note in a note log.
OperationalStatus defines whether a component is usable.
OwnerProperties describes the properties that identifies the owner of an attached element (or the resource it represents).
PortElement contains the properties and header for a port entity retrieved from the metadata repository.
PortElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a element.
PortElementsResponse is a response object for passing back a a list of glossaries
or an exception if the request failed.
PortProperties is a class for representing a generic port for a process.
PortRequestBody describes the request body used to create/update port properties.
PortType defines the different port types used for open metadata.
PrimaryKeyClassificationRequestBody is used to classify a schema attribute as a primary key.
PrimaryKeyProperties describes the properties of a primary key.
PrimitiveSchemaTypeProperties is a class for representing a primitive value.
ProcessCallElement contains the properties and header for a process call relationship retrieved from the metadata repository.
ProcessCallElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a element.
ProcessCallElementsResponse is a response object for passing back a a list of process call relationships
or an exception if the request failed.
ProcessCallProperties describe the properties for a process call relationship.
ProcessCallRequestBody describes the request body used when linking elements within processes.
ProcessContainmentProperties when linking processes in a parent-child hierarchy.
ProcessContainmentType defines the ownership of a process withing a sub process.
ProcessElement contains the properties and header for a process entity retrieved from the metadata repository.
ProcessElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a element.
ProcessElementsResponse is a response object for passing back a a list of glossaries
or an exception if the request failed.
Process properties defines the properties of a process.
ProcessRequestBody describes the request body used to create/update process properties.
The ProcessStatus defines the status of a process.
ProcessStatusRequestBody describes the request body used to update a process's status.
QueryTargetProperties defines a query on a schema element that returns all or part of the value for a
derived schema type.
RatingElement contains the properties and header for a Rating entity retrieved from the metadata repository.
RatingElementResponse is the response structure used on the OMAS REST API calls that return the properties for an element.
RatingElementsResponse is a response object for passing back a list of elements or an exception if the request failed.
RatingProperties stores information about a rating connected to an asset.
Many open metadata entities are referenceable.
ReferenceableRequestBody describes the request body used to create/update properties in referenceables.
ReferenceableUpdateRequestBody carries the correlation properties, readVersionIdentifier and effective time for a create (with parent),
update or delete requests.
RelatedElement contains the properties and header for a relationship retrieved from the metadata repository along with the stub
of the related element.
RelatedElementElementsResponse is a response object for passing back a list of relationships
or an exception if the request failed.
RelationshipElement contains the properties and header for a relationship retrieved from the metadata repository.
RelationshipElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a relationship.
RelationshipElementsResponse is a response object for passing back a list of relationships
or an exception if the request failed.
RelationshipProperties provides the base class for relationships items.
RelationshipRequestBody describes the request body used when linking elements together.
RequestSourceElement describes the element that triggered the request to the governance action service.
RetentionClassificationProperties defines the retention requirements for related data items.
SchemaTypeElement contains the properties and header for a reference data asset retrieved from the metadata repository.
SchemaAttributeElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a element.
SchemaAttributeElementsResponse is a response object for passing back a a list of glossaries
or an exception if the request failed.
SchemaAttributeProperties represents an attribute that is part of a complex schema type.
SchemaAttributeRequestBody describes the request body used to create/update schema attribute properties.
SchemaExchangeInterface defines the common methods for managing schemas.
SchemaProperties is a bean containing the common attributes for schema types and schema attributes.
SchemaTypeChoiceProperties carries the specialized parameters for creating or updating a choice of schema types.
SchemaTypeElement contains the properties and header for a reference data asset retrieved from the metadata repository.
SchemaTypeElementResponse is the response structure used on the OMAS REST API calls that return the properties for an element.
SchemaTypeElementsResponse is a response object for passing back a list of elements or an exception if the request failed.
SchemaTypeProperties carries the common parameters for creating or updating schema types.
SchemaTypeRequestBody describes the request body used to create/update schema type properties.
SearchStringRequestBody is the request body structure used on OMAG REST API calls that passes a regular expression
to use as a search string.
SecureLocation defines that a location is secure.
SecurityTagsProperties provides a structure for passing information about the security tags that should be
attached to an asset or one of its fields.
SemanticAssignmentProperties links an element to a glossary term to indicate that the glossary term describes its meaning.
ServerAssetUseProperties describes the properties for the ServerAssetUse relationship between a software
server capability and an asset.
ProcessContainmentType defines the ownership of a process withing a sub process.
SimpleSchemaTypeProperties describes the properties of type that has a single value.
SoftwareCapabilitiesProperties describes a functional capability of a
software server.
SoftwareCapabilityElement contains the properties and header for a software capability entity retrieved from the metadata
repository.
StagingGlossaryProperties is used to provide the properties for an EditingGlossary classification.
A StarRating defines the rating that a user has placed against an asset.
The StewardshipExchangeInterface supports the exchange of relationships (such as SemanticAssignment)
and classifications that are added by stewards (or automated stewardship processes) such as Confidentiality.
The StewardshipManagementInterface supports the exchange of relationships (such as SemanticAssignment)
and classifications that are added by stewards (or automated stewardship processes) such as Confidentiality.
A subject area defines a group of definitions for governing assets related to a specific topic.
SupplementaryProperties describe additional information about a technical element (typically assets and schemas)
that has been added as part of a governance process.
SynchronizationDirection defines the permitted directions of flow of metadata updates between open metadata and a third party
technology.
InformalTagProperties stores information about a tag connected to an asset.
TaxonomyProperties is used to classify a glossary that has the terms organized in a taxonomy.
TemplateProperties defined the properties that can be overridden from the template object
when creating an object from a template.
TemplateRequestBody describes the request body used to create/update elements from templates.
The TermAssignmentStatus defines the status of the relationship between a glossary term and an element that represents data.
TermAssignmentStatusListResponse is a response object for passing back a list of enum values or an exception if the request failed.
TermRelationshipRequestBody describes the request body used when linking two terms together.
UpdateRequestBody carries the correlation properties and effective time for a create, update or delete request.
ValidValueElement contains the properties and header for a valid value entity retrieved from the metadata repository.
ValidValueProperties provides the common super class for ValidValueSet and ValidValueDefinition.
The ValidValuesExchangeInterface supports the exchanges of valid values and reference data.