All Classes and Interfaces
Class
Description
AnnotationListResponse is the response structure used on OMAS REST API calls that return a
list of Annotations objects as a response.
AnnotationResponse is the response structure used on the OMAS REST API calls that return a
Annotation object as a response.
The AssetCertificationInterface provides the ability to manage the certification types that can be associated with elements.
The AssetClassificationInterface is used by the asset owner to add classifications and detailed definitions
to the asset.
AssetCollaborationInterface defines the operations to manage comments snd note logs attached
to assets and their attachments.
The CollectionManagementInterface adds methods for managing collections that can be attached to assets
and their related elements.
ManageConnections 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 AssetDecommissioningInterface covers the steps that the asset owner needs to perform at the end of life of the
asset.
AssetElement contains the properties and header for an asset retrieved from the metadata repository.
AssetElementResponse is the response structure used on the OMAS REST API calls that return a
AssetElement bean object as a response.
AssetElementsResponse returns a list of assets from the server.
AssetKnowledgeInterface provides basic information about the types of access supported in the open metadata ecosystem
The AssetLicenseInterface supports the management of the types of licenses (terms and conditions) associated with elements.
AssetOnboardingAvroFileInterface provides the client-side interface for an asset owner to set up the metadata about
an Avro file asset.
AssetOnboardingCSVFileInterface provides the client-side interface for an asset owner to set up the metadata about
a CSV file asset.
AssetOnboardingFileSystem provides specialist methods for building up folder structures for a file system
and cataloguing the files within them.
AssetOnboardingInterface provides the client-side interface for an asset owner to set up the metadata about their
asset.
AssetOnboardingValidValues provides the API operations to create and maintain lists of valid
value definitions grouped into a valid value set.
The AssetOwnerAuditCode is used to define the message content for the OMRS Audit Log.
The AssetOwnerErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with
the Asset Owner OMAS Services.
AssetOwnerEventInterface defines how a client gets access to the
events produced by the Asset Owner OMAS
AssetOwnerEventListener is the interface that a client implements to
register to receive the events from the Asset Owner OMAS.
AssetOwnerEventType describes the different types of events produced by the Asset Owner OMAS.
AssetOwnerOMASAPIRequestBody provides a common header for Asset Owner OMAS request bodies for its REST API.
AssetOwnerOMASAPIResponse provides a common header for Asset Owner OMAS managed rest to its REST API.
AssetOwnerOutTopicEvent describes the structure of the events emitted by the Asset Owner OMAS that are about assets.
AssetProperties holds asset properties that are used for displaying details of
an asset in summary lists or hover text.
The AssetReviewInterface is used by the asset owner to review the state of the asset including any quality and usage
metrics associated with the asset.
CalculatedValueClassificationRequestBody is used to identify the schema elements that are calculated (derived)
rather than stored.
CertificateIdRequestBody provides a structure for the unique certificate identifier.
CertificationElement contains the properties and header for a certification for an element.
CertificationTypeListResponse is the response structure used on the OMAS REST API calls that return a
list of certifications as a response.
CertificationProperties describe the details of a certificate that shows that an element is certified with a particular certification type.
CertificationTypeElement contains the properties and header for a certification type retrieved from the metadata repository.
CertificationTypeListResponse is the response structure used on the OMAS REST API calls that return a
list of certification types as a response.
Many regulations and industry bodies define certifications that can confirm a level of support, capability
or competence in an aspect of a digital organization's operation.
CertificationTypeRequestBody provides a structure used when creating certification types.
CertificationTypeResponse is the response structure used on the OMAS REST API calls that returns a
certification type object as a response.
ClassificationProperties provides the base class for classifications items.
ClassificationRequestBody describes the request body used when attaching classification to elements.
CollectionElement contains the properties and header for a collection retrieved from the metadata repository.
CollectionFolderProperties defines the properties used to create a Folder classification for a collection.
CollectionMember describes a member of a collection.
CollectionMember describes a member of a collection.
CollectionProperties describes the core properties of a collection.
CombinedSchemaRequestBody carries the parameters for created a new schema to attach to
an asset.
CommentElement contains the properties and header for a Comment entity retrieved from the metadata repository.
The CommentProperties bean stores information about a comment connected to an asset.
ConnectionElement contains the properties and header for a connection retrieved from the metadata repository.
The connection is an object that contains the properties needed to create and initialise a connector to access a
specific data assets.
ConnectionRequestBody carries the parameters for created a new asset.
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.
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.
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.
DataStoreProperties provides the JavaBean for describing a data store.
DerivedSchemaTypeQueryTargetProperties defines a query on a schema element that returns all or part of the value for a
derived schema type.
DuplicatesRequestBody provides a structure for passing the properties associated with duplicates.
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.
ElementStubListResponse is the response structure used on the OMAS REST API calls that return a
list of element identifiers as a response.
The EmbeddedConnection is used within a VirtualConnection to link to the embedded connections.
The EmbeddedConnection 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.
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.
ExternalReferenceElement stores information about a link to an external resource that is relevant to this element.
ExternalReferenceIdRequestBody provides a structure for the unique external reference identifier.
ExternalReferenceLinkProperties provides a structure for the properties that link an external reference to an object.
ExternalReferenceListResponse is the response structure used on the OMAS REST API calls that return a
list of external references as a response.
ExternalReferenceProperties stores information about an link to an external resource that is relevant to this element.
ExternalReferenceRequestBody provides a structure for a new ExternalReference.
ExternalReferenceResponse is the response structure used on the OMAS REST API calls that returns a
external reference object as a response.
The ExternalReferencesInterface is used by the governance team to define external references to elements within the governance program.
ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
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.
FileElement contains the properties and header for a file retrieved from the metadata repository.
FileProperties describes the property of a single data file.
FileSystemElement contains the properties and header for a file system retrieved from the metadata repository.
FileSystemProperties describes the root node of a file system.
FileSystemResponse is the response structure used on the OMAS REST API calls that return the properties
for a file system.
AssetOriginProperties provides a structure for passing information about an asset's origin.
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.
FolderElement contains the properties and header for a Folder retrieved from the metadata repository.
FolderProperties defines an asset that is a folder.
FolderResponse is the response structure used on the OMAS REST API calls that return the properties
for a folder.
GlossaryTermElement contains the properties and header for a glossary term entity
retrieved from the metadata repository.
GlossaryTermProperties contains the semantic definition (meaning) of a word or phrase
(term - collectively called terminology).
The GlossaryTermStatus defines the status of a glossary term.
GovernanceClassificationBase defines the common properties for the governance action classifications.
GovernanceClassificationProperties defines the properties for a Confidentiality, Confidence, Criticality
Governance Action Classifications.
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.
GovernanceDefinitionStatus indicates whether the definition is complete and operational or in a state that means
it is either under development or obsolete.
LevelIdentifierProperties describes the properties for searching for a governance action classification by its level.
LicenseElement contains the properties and header for a license for an element.
LicenseIdRequestBody provides a structure for the unique certificate identifier.
LicenseListResponse is the response structure used on the OMAS REST API calls that return a
list of licenses as a response.
LicenseProperties describe the details of a license that shows that an element is licensed with a particular license type.
LicenseTypeElement contains the properties and header for a licence type retrieved from the metadata repository.
LicenseTypeListResponse is the response structure used on the OMAS REST API calls that return a
list of license types as a response.
LicenseTypeProperties defines a license that the organization recognizes and has governance
definitions to support it.
LicenseTypeRequestBody provides a structure used when creating license types.
LicenseTypeResponse is the response structure used on the OMAS REST API calls that returns a
license type object as a response.
MeaningProperties is a cut-down summary of a glossary term to aid the asset owner in understanding the content
of an asset.
MetadataElement is the common interface for all metadata elements.
NewCSVFileAssetRequestBody carries the parameters for creating a new CSV file asset.
NewFileAssetRequestBody carries the parameters for creating a new file asset.
NewFileSystemProperties describes the root node of a file system.
NoteElement contains the properties and header for a Note entity retrieved from the metadata repository.
NoteLogElement contains the properties and header for a NoteLog entity retrieved from the metadata repository.
NoteLogHeader manages a list of notes for an asset
Note defines the properties of a single note in a note log.
OriginRequestBody provides a structure for passing information about an asset's origin as
a request body over a REST API.
OwnerRequestBody provides a structure for passing information about an asset owner as a request body over a REST API.
PagedResponse is used for responses that can contain paged responses
PathNameRequestBody carries the parameters for creating a new FolderProperties asset.
ReferenceableElement contains the properties and header for a referenceable entity retrieved from the metadata repository.
ReferenceableProperties provides a structure for passing a referenceable element's properties over the Java API.
ReferenceableRequestBody provides a structure for passing a referenceables' properties as a request body over a REST API.
RelatedElement contains the properties and header for a relationship retrieved from the metadata repository along with the stub
of the related element.
RelatedElementListResponse is a response object for passing back a list of relatedElement objects.
Defines the interface that is common to multiple element types
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.
ResourceListProperties provides a details of why an element providing resources (such as a community) has been attached to an initiative
such as a governance domain.
RetentionClassificationProperties defines the retention requirements for related data items.
SchemaAttributeElement contains the properties and header for a schema attribute 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 carries the common parameters for creating or updating schema attributes.
SchemaAttributeRelationshipProperties defines a relationship between 2 SchemaAttributes.
SchemaElementProperties carries the common parameters for creating or updating schema elements such as schema types and attributes.
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.
SecurityTagsProperties holds the list of labels and properties used by a security enforcement engine to control access
and visibility to the contents of the real-world object described by the Referenceable.
SecurityTagsRequestBody 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.
SoftwareCapabilityProperties describe the properties needed to describe a specific software server's capability.
StakeholderProperties provides a details of a stakeholder for an initiative.
StatusRequestBody provides a structure for passing the annotation status of an Annotation.
SupplementaryProperties describe additional information about a technical element (typically assets and schemas)
that has been added as part of a governance process.
SurveyReportListResponse is the response structure used on OMAS REST API calls that return a
list of SurveyReport properties objects as a response.
TemplateClassificationRequestBody carries the parameters for classifying an element as suitable to use for a template.
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.
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 definition or set entity retrieved from the metadata repository.
ValidValueProperties provides the common super class for ValidValueSet and ValidValueDefinition.
ValidValueResponse is a response object for passing back a single valid value object.
ValidValuesRequestBody carries the parameters for created a new valid values element.
ValidValuesResponse is a response object for passing back a list of valid value objects.