All Classes and Interfaces
Class
Description
APIElement contains the properties and header for a DeployedAPI entity retrieved from the metadata repository.
APIManagerInterface defines the client side interface for the Data Manager OMAS that is
relevant for API assets that provide call-based services.
APIManagerProperties describes the API managing capability of a server
APIManagerRequestBody describes the basic properties of an API manager's software server capability.
APIOperationElement contains the properties and header for an APIOperation entity retrieved from the metadata repository.
APIOperationProperties is a class for an operation within an API specification.
APIOperationRequestBody describes the properties of the API operation plus the optional identifiers for an
owning software server capability.
APIOperationResponse is a response object for passing back a single APIOperation
element or an exception if the request failed.
APIOperationsResponse is a response object for passing back a a list of APIOperations
or an exception if the request failed.
APIParameterElement contains the properties and header for a APIParameter entity
retrieved from the metadata repository.
APIParameterListElement contains the properties and header for an APIParameterList entity retrieved from the metadata repository.
APIParameterListProperties is a class for representing the list of parameters for an API
operation's header, request or response payload.
APIParameterListRequestBody describes the properties of the API parameter list plus the optional identifiers for an
owning software server capability.
APIParameterListResponse is a response object for passing back a single APIParameterList
element or an exception if the request failed.
APIParameterListsResponse is a response object for passing back a a list of APIParameterLists
or an exception if the request failed.
An APIParameterListType defines which parameter list relationship to use when attaching an APIParameterList to an operation.
APIParameterProperties is a class for representing a parameter in an API specification.
APIParameterResponse is a response object for passing back a single APIParameter
element or an exception if the request failed.
APIParametersResponse is a response object for passing back a a list of APIParameters
or an exception if the request failed.
APIProperties is a class for representing an API deployed to an API Gateway or supported by an application.
APIRequestBody describes the properties of the API plus the optional identifiers for an
owning software server capability.
APIResponse is a response object for passing back a single API
element or an exception if the request failed.
APIsResponse is a response object for passing back a a list of APIs
or an exception if the request failed.
ApplicationProperties describes an collection of processes (application) that implements support for the business.
ApplicationRequestBody describes the basic properties of an application's software server capability.
ArchiveProperties defined the properties that are stored when a data source is archived or deleted.
ArchiveRequestBody carries the parameters for marking an asset as archived (or deleted).
AssetConnectionRequestBody carries the parameters for creating a new relationship between an asset and a connection.
AssetProperties is a java bean used to create assets associated with the data manager.
ClassificationProperties provides the base class for classification items.
ClassificationRequestBody describes the request body used when attaching classification to elements.
ComplexSchemaTypeProperties describes a schema with multiple attributes.
ConnectionElement contains the properties and header for a connection retrieved from the metadata repository.
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 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 describing a connection.
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 carries the parameters for describing a connector type.
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.
DatabaseColumnElement contains the properties and header for a database column entity
retrieved from the metadata repository.
DatabaseColumnProperties describes the properties of a database column.
DatabaseColumnResponse is a response object for passing back a single database column
element or an exception if the request failed.
DatabaseColumnsResponse is a response object for passing back a a list of database columns
or an exception if the request failed.
DatabaseColumnTypeElement contains the properties and header for a database column type entity
retrieved from the metadata repository.
DatabaseElement contains the properties and header for a database entity retrieved from the metadata repository.
DatabaseForeignKeyProperties describes a foreign key relationship between two columns in different
tables in a database.
DatabaseManagerInterface defines the client side interface for the Data Manager OMAS that is
relevant for relational database assets.
DatabaseManagerProperties describes the DBMS capability of a database server
DatabaseManagerRequestBody describes the basic properties of a database manager's software server capability.
DatabasePrimaryKeyProperties describes the properties of a primary key.
DatabaseProperties is a class for representing a generic database.
DatabaseQueryProperties describes the properties of query that is used to derive a column in a database.
DatabaseResponse is a response object for passing back a single database
element or an exception if the request failed.
DatabaseSchemaElement contains the properties and header for a deployed database schema asset entity
retrieved from the metadata repository.
DatabaseSchemaProperties is a class for representing the top level database schema.
DatabaseSchemaResponse is a response object for passing back a single database schema
element or an exception if the request failed.
DatabaseSchemasResponse is a response object for passing back a a list of database schemas
or an exception if the request failed.
DatabaseSchemaTypeProperties is a java bean used to create the database schema type associated with the database.
DatabasesResponse is a response object for passing back a a list of databases
or an exception if the request failed.
DatabaseTableElement contains the properties and header for a database table entity
retrieved from the metadata repository.
DatabaseTableProperties is a class for representing a relational database table.
DatabaseTableResponse is a response object for passing back a single database table
element or an exception if the request failed.
DatabaseTablesResponse is a response object for passing back a a list of database tables
or an exception if the request failed.
DatabaseViewElement contains the properties and header for a database view entity
retrieved from the metadata repository.
DatabaseViewProperties is a class for representing a relational database view.
DatabaseViewResponse is a response object for passing back a single database view
element or an exception if the request failed.
DatabaseViewsResponse is a response object for passing back a a list of database views
or an exception if the request failed.
DataContainerElement contains the properties and header for a data container entity retrieved from the metadata repository.
SchemaAttributeProperties represents a data field that is part of a complex schema type.
DataContainerRequestBody describes the properties of the data container plus the optional identifiers for an
owning software server capability.
DataContainerResponse is a response object for passing back a single data container
element or an exception if the request failed.
DataContainersResponse is a response object for passing back a a list of data containers
or an exception if the request failed.
DataFieldElement contains the properties and header for a data field entity retrieved from the metadata repository.
DataFieldProperties is a class for representing a a data field within a Form, Report or Que
DataFieldRequestBody describes the properties of the data field plus the optional identifiers for an
owning software server capability.
DataFieldResponse is a response object for passing back a single data field
element or an exception if the request failed.
DataFieldsResponse is a response object for passing back a a list of data fields
or an exception if the request failed.
DataFileElement contains the properties and header for a data file retrieved from the metadata repository.
DataFileProperties describes the property of a single data file.
DataFileRequestBody carries the parameters for creating a new file asset.
DataFileResponse is the response structure used on the OMAS REST API calls that return the properties
for a file.
DataFilesResponse is a response object for passing back a a list of database views
or an exception if the request failed.
DataFileRequestBody carries the parameters for creating a new file asset.
DataItemSortOrder is used for schema attributes that may have multiple instances.
The DataManagerAuditCode is used to define the message content for the OMRS Audit Log.
The DataManagerErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with
the Data Manager OMAS Services.
DataManagerEventHeader provides a common base for all events from the access service.
DataManagerEventInterface defines how a client gets access to the
configuration events produced by the Data Manager OMAS.
DataManagerEventListener is the interface that a client implements to
register to receive the events from the Data Manager OMAS's out topic.
DataManagerInterface provides the interface for retrieving the identity of an external data manager.
DataManagerOMASAPIRequestBody provides a common header for Data Manager OMAS request bodies for its REST API.
DataManagerOMASAPIResponse provides a common header for Data Manager OMAS managed rest to its REST API.
DataManagerOutboundEvent describes the structure of the events emitted by the Data Manager OMAS.
DataManagerOutboundEventType describes the different types of events produced by the Data Manager OMAS.
DataProcessingEngineProperties describes an engine.
DataProcessingEngineRequestBody describes the basic properties of a data processing engine's software server capability.
DataSetProperties is a class for representing a generic data set.
DataStoreProperties is a class for representing a generic data store.
DerivedSchemaTypeQueryTargetProperties defines a query on a schema element that returns all or part of the value for a
derived schema type.
DerivedSchemaTypeQueryTargetRequestBody describes the properties of a query target plus the optional identifiers for an
owning software server capability.
ApplicationInterface defines the client side interface for the Data Manager OMAS that is
relevant for form assets that provide data displays and other business functions to an organization.
ElementStubResponse is a response object for passing back the header of a Referenceable
element or an exception if the request failed.
The EmbeddedConnection is used within a VirtualConnection to link to the embedded connections.
The EmbeddedConnectionRequestBody 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 carries the parameters for describing an 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.
EnumSchemaTypeProperties carries the specialized parameters for creating or updating enum schema types.
EnumSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an
owning software server capability.
EventBrokerInterface defines the client side interface for the Data Manager OMAS that is
relevant for topic assets that provide event-based services.
EventBrokerProperties describes the server than manages the exchange of events between independent services.
EventBrokerRequestBody describes the basic properties of a event broker's software server capability.
TabularColumnProperties is a class for representing a column within a table type structure.
EventTypeElement contains the properties and header for a EventType entity retrieved from the metadata repository.
EventTypeProperties is a class for representing the top-level element for an event.
EventTypeProperties is a class for representing the top-level element for an event's schema.
EventTypeRequestBody describes the properties of the event type plus the optional identifiers for an
owning software server capability.
EventTypeResponse is a response object for passing back a single EventType
element or an exception if the request failed.
EventTypesResponse is a response object for passing back a a list of EventTypes
or an exception if the request failed.
ExternalReferenceElement stores information about an link to an external resource that is relevant to this element.
ExternalReferenceRequestBody describes the properties of the external reference plus the optional identifiers for an
owning element.
ExternalReferenceManagerInterface defines the Java API for managing external references.
ExternalReferenceProperties stores information about an link to an external resource that is relevant to an Asset.
ExternalReferenceRequestBody describes the properties of the external reference plus the optional identifiers for an
owning element.
ExternalReferenceResponse is a response object for passing back a single external reference
element or an exception if the request failed.
ExternalReferencesResponse is a response object for passing back a a list of external references
or an exception if the request failed.
ExternalSchemaTypeProperties carries a reusable schema type.
ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
FileFolderElement contains the properties and header for a file folder entity retrieved from the metadata repository.
FileFolderProperties defines an asset that is a folder.
FileFolderResponse is the response structure used on the OMAS REST API calls that return the properties
for a folder.
FileFoldersResponse is a response object for passing back a a list of database views
or an exception if the request failed.
FileSystemProperties describes an application that manages a collection of files.
FileManagerProperties describes the root node of a file system.
FilesAndFoldersInterface is the interface used to record metadata about files and folders.
FileSystemElement contains the properties and header for a SoftwareCapability entity retrieved from the metadata repository.
FileSystemProperties describes the root node of a file system.
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.
FormElement contains the properties and header for a form entity retrieved from the metadata repository.
FormProperties is a class for representing a display of data fields for a user to supply data values.
FormRequestBody describes the properties of the form plus the optional identifiers for an
owning software server capability.
FormResponse is a response object for passing back a single form
element or an exception if the request failed.
FormsResponse is a response object for passing back a a list of forms
or an exception if the request failed.
FormulaRequestBody carries the parameters for creating a new CalculatedValue classification.
A KeyPattern defines the type of External Identifier in use for an asset, or the type of Primary Key used within an
asset.
LiteralSchemaTypeProperties carries the specialized parameters for creating or updating literal schema types.
LiteralSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an
owning software server capability.
MapSchemaType describes a schema element of type map.
MapSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an
owning software server capability.
MetadataElement is the common interface for all metadata elements.
MetadataSourceInterface is the interface used to define information about the third party technologies that
an integration daemon is extracting metadata from.
MetadataSourceRequestBody carries the parameters for marking an asset or schema as external.
PathNameRequestBody carries the parameters for creating a new FileFolder asset.
PrimitiveSchemaTypeProperties is a class for representing a primitive value.
PrimitiveSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an
owning software server capability.
QueriesResponse is a response object for passing back a a list of queries
or an exception if the request failed.
QueryElement contains the properties and header for a query entity retrieved from the metadata repository.
QueryProperties is a class for representing a query that supports the access of data for a report or form.
QueryRequestBody describes the properties of the query plus the optional identifiers for an
owning software server capability.
QueryResponse is a response object for passing back a single query
element or an exception if the request failed.
Many open metadata entities are referenceable.
ReferenceableRequestBody describes the request body used when working with referenceables.
ReferenceValueAssignmentProperties is a java bean used to create a link between a valid value and a referenceable item
to enable the valid value to be used as a semiformal tag/classifier.
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.
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.
ReportElement contains the properties and header for a report entity retrieved from the metadata repository.
ReportProperties is a class for representing a report for an application or reporting engine.
ReportRequestBody describes the properties of the report plus the optional identifiers for an
owning software server capability.
ReportResponse is a response object for passing back a single report
element or an exception if the request failed.
ReportsResponse is a response object for passing back a a list of reports
or an exception if the request failed.
SchemaAttributeElement contains the properties and header for a data field
retrieved from the metadata repository.
SchemaAttributeProperties represents a data field that is part of a complex schema type.
SchemaAttributeRequestBody describes the properties of the schema attribute plus the optional identifiers for an
owning software server capability.
SchemaAttributeResponse is a response object for passing back a single schema attribute
element or an exception if the request failed.
SchemaAttributesResponse is a response object for passing back a a list of schema attributes
or an exception if the request failed.
SchemaElementProperties is a bean containing the common attributes for schema types and schema attributes
SchemaManagerInterface defines the common methods for managing SchemaTypes and SchemaAttributes.
SchemaTypeChoiceProperties carries the specialized parameters for creating or updating a choice of schema types.
SchemaTypeChoiceRequestBody describes the properties of the schema type plus the optional identifiers for an
owning software server capability and the list of guids for the schema types that represent the choices.
SchemaTypeElement contains the properties and header for a reference data asset retrieved from the metadata repository.
SchemaTypeProperties carries the common parameters for creating or updating schema types.
SchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an
owning software server capability.
SchemaTypeResponse is a response object for passing back a single topic
element or an exception if the request failed.
SchemaTypesResponse is a response object for passing back a a list of schema types
or an exception if the request failed.
SimpleSchemaTypeProperties describes the properties of type that has a single value.
SoftwareCapabilitiesProperties describe the properties for a capability deployed to a software server.
SoftwareCapabilityElement contains the properties and header for a software server capabilities entity retrieved from the metadata
repository.
SoftwareCapabilityRequestBody describes the basic properties of a software server capability.
StructSchemaTypeProperties is a class for representing a set of schema attributes - also known as a structure, struct, group
or object in different programming languages.
StructSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an
owning software server capability.
TabularColumnElement contains the properties and header for a table column entity
retrieved from the metadata repository.
TabularColumnProperties is a class for representing a column within a table type structure.
TabularSchemaTypeProperties is a class for representing a tabular schema such as the
structure of a CSV file.
TemplateProperties defined the properties that can be overridden from the template object
when creating an object from a template.
TemplateRequestBody carries the parameters for creating a new asset using a template.
TopicElement contains the properties and header for a topic entity retrieved from the metadata repository.
TopicProperties is a class for representing a topic for an event broker or streaming service.
TopicRequestBody describes the properties of the topic plus the optional identifiers for an
owning software server capability.
TopicResponse is a response object for passing back a single topic
element or an exception if the request failed.
TopicSchemaElement contains the properties and header for a schema element entity retrieved from the metadata repository.
TopicsResponse is a response object for passing back a a list of topics
or an exception if the request failed.
ValidValueAssignmentProperties describes the properties between a referenceable and its valid values.
ValidValueElement contains the properties and header for a valid value definition or set entity retrieved from the metadata repository.
ValidValueListResponse is a response object for passing back a list of valid value objects.
The ValidValueManagementInterface provides methods for managing valid values.
ValidValueMembershipProperties provides a flag to indicate if this value is the default value for the set.
ValidValueProperties provides the common super class for ValidValueSet and ValidValueDefinition.
ValidValueResponse is a response object for passing back a single valid value object.
ValidValueElement contains the properties and header for a valid value set entity retrieved from the metadata repository.
ValidValueSetProperties provides the class for ValidValueSet.
ValidValueSetsResponse is a response object for passing back a a list of valid value sets
or an exception if the request failed.