Serialized Form

Package org.odpi.openmetadata.accessservices.dataengine.event

Class org.odpi.openmetadata.accessservices.dataengine.event.DatabaseEvent

class DatabaseEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

database

Database database

The database to be created

Class org.odpi.openmetadata.accessservices.dataengine.event.DatabaseSchemaEvent

class DatabaseSchemaEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

databaseQualifiedName

String databaseQualifiedName

The database qualified name to which the database schema will be linked, if it exists

databaseSchema

DatabaseSchema databaseSchema

The database schema to be created

Class org.odpi.openmetadata.accessservices.dataengine.event.DataEngineEventHeader

class DataEngineEventHeader extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

dataEngineEventType

DataEngineEventType dataEngineEventType

The Data Engine event type

externalSourceName

String externalSourceName

The external source type unique name

userId

String userId

Producer user ID

Class org.odpi.openmetadata.accessservices.dataengine.event.DataEngineRegistrationEvent

class DataEngineRegistrationEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

engine

Engine engine

Engine

Class org.odpi.openmetadata.accessservices.dataengine.event.DataFileEvent

class DataFileEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

dataFile

DataFile dataFile

The data file to be created

Class org.odpi.openmetadata.accessservices.dataengine.event.DataFlowsEvent

class DataFlowsEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

dataFlows

List<DataFlow> dataFlows

The data flows

Class org.odpi.openmetadata.accessservices.dataengine.event.DeleteEvent

class DeleteEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

deleteSemantic

DeleteSemantic deleteSemantic

The delete semantic

guid

String guid

The unique identifier of the entity

qualifiedName

String qualifiedName

The qualified name of the entity

Class org.odpi.openmetadata.accessservices.dataengine.event.EventTypeEvent

class EventTypeEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

eventType

EventType eventType

The event type to be created

topicQualifiedName

String topicQualifiedName

The topic qualified name to which the event type will be linked

Class org.odpi.openmetadata.accessservices.dataengine.event.FindEvent

class FindEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

findRequestBody

FindRequestBody findRequestBody

The find request body

Class org.odpi.openmetadata.accessservices.dataengine.event.PortImplementationEvent

class PortImplementationEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

portImplementation

PortImplementation portImplementation

The port implementation

processQualifiedName

String processQualifiedName

The process qualified name

Class org.odpi.openmetadata.accessservices.dataengine.event.ProcessEvent

class ProcessEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

process

Process process

The process

Class org.odpi.openmetadata.accessservices.dataengine.event.ProcessHierarchyEvent

class ProcessHierarchyEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

processHierarchy

ProcessHierarchy processHierarchy

The process hierarchy

Class org.odpi.openmetadata.accessservices.dataengine.event.ProcessingStateEvent

class ProcessingStateEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

processingState

ProcessingState processingState

The processing state.

Class org.odpi.openmetadata.accessservices.dataengine.event.ProcessListEvent

class ProcessListEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

failedGUIDs

List<String> failedGUIDs

The failed GUIDs

Class org.odpi.openmetadata.accessservices.dataengine.event.RelationalTableEvent

class RelationalTableEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

databaseSchemaQualifiedName

String databaseSchemaQualifiedName

The qualified name of the database schema

relationalTable

RelationalTable relationalTable

The relational table to be created

Class org.odpi.openmetadata.accessservices.dataengine.event.SchemaTypeEvent

class SchemaTypeEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

portQualifiedName

String portQualifiedName

The port qualified name

schemaType

SchemaType schemaType

The schema type

Class org.odpi.openmetadata.accessservices.dataengine.event.TopicEvent

class TopicEvent extends DataEngineEventHeader implements Serializable

serialVersionUID:

1L

Serialized Fields

topic

Topic topic

The topic to be created

Package org.odpi.openmetadata.accessservices.dataengine.ffdc

Exception org.odpi.openmetadata.accessservices.dataengine.ffdc.DataEngineException

class DataEngineException extends org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase implements Serializable

Package org.odpi.openmetadata.accessservices.dataengine.model

Class org.odpi.openmetadata.accessservices.dataengine.model.Asset

class Asset extends Referenceable implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

The stored description property associated with the asset

displayName

String displayName

The stored display name property for the asset

originBusinessCapabilityGUID

String originBusinessCapabilityGUID

The unique identifier of the business capability that originated this asset

originOrganizationGUID

String originOrganizationGUID

The unique identifier for the organization that originated this asset

otherOriginValues

Map<String,String> otherOriginValues

The properties that characterize where this asset is from

owner

String owner

The name of the owner for this asset

ownerType

OwnerType ownerType

The owner type for this asset

zoneMembership

List<String> zoneMembership

The names of the zones that this asset is a member of

Class org.odpi.openmetadata.accessservices.dataengine.model.Attribute

class Attribute extends Referenceable implements Serializable

Serialized Fields

aliases

List<String> aliases

A list of alternative names for the attribute

allowsDuplicateValues

boolean allowsDuplicateValues

Indicates whether the same value can be used by more than one instance of this attribute

dataType

String dataType

The data type for this element

defaultValue

String defaultValue

The default value for the element

defaultValueOverride

String defaultValueOverride

Default value override

description

String description

The stored description property for the schema element

displayName

String displayName

The simple name of the schema element

externalTypeGUID

String externalTypeGUID

The unique identifier of this column's type

fixedValue

String fixedValue

A fixed literal value - an alternative to default value

isDeprecated

boolean isDeprecated

Indicates if the schema element is deprecated

isNullable

boolean isNullable

Indicates whether the field is nullable or not

length

int length

The length of the data field

maxCardinality

int maxCardinality

The maximum number of instances allowed for this attribute

minCardinality

int minCardinality

This minimum number of instances allowed for this attribute

minimumLength

int minimumLength

The minimum length of the data

nativeClass

String nativeClass

The name of the Java class to use to represent this type

orderedValues

boolean orderedValues

Indicates whether the attribute instances are arranged in an order

position

int position

The position of this schema attribute in its parent schema

precision

int precision

The number of significant digits to the right of decimal point

sortOrder

DataItemSortOrder sortOrder

The order that the attribute instances are arranged in

typeGuid

String typeGuid

Unique identifier of the type for this schema element

typeName

String typeName

The name of the type for this schema element

validValuesSetGUID

String validValuesSetGUID

The set of valid values for this column

Class org.odpi.openmetadata.accessservices.dataengine.model.Collection

class Collection extends Referenceable implements Serializable

Serialized Fields

name

String name

The name of the collection

Class org.odpi.openmetadata.accessservices.dataengine.model.Connection

class Connection extends Referenceable implements Serializable

Serialized Fields

assetSummary

String assetSummary

The asset summary

clearPassword

String clearPassword

The clear password

configurationProperties

Map<String,String> configurationProperties

The configuration properties

connectorType

ConnectorType connectorType

The connector type

description

String description

The description

displayName

String displayName

The display name

encryptedPassword

String encryptedPassword

The encrypted password

endpoint

Endpoint endpoint

The endpoint

securedProperties

Map<String,String> securedProperties

The secured properties

userId

String userId

The user id

Class org.odpi.openmetadata.accessservices.dataengine.model.ConnectorType

class ConnectorType extends org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable implements Serializable

serialVersionUID:

1L

Serialized Fields

connectorFrameworkName

String connectorFrameworkName

connectorInterfaceLanguage

String connectorInterfaceLanguage

connectorInterfaces

List<String> connectorInterfaces

connectorProviderClassName

String connectorProviderClassName

description

String description

displayName

String displayName

expectedDataFormat

String expectedDataFormat

recognizedAdditionalProperties

List<String> recognizedAdditionalProperties

recognizedConfigurationProperties

List<String> recognizedConfigurationProperties

recognizedSecuredProperties

List<String> recognizedSecuredProperties

supportedAssetTypeName

String supportedAssetTypeName

targetTechnologyInterfaces

List<String> targetTechnologyInterfaces

targetTechnologyName

String targetTechnologyName

targetTechnologySource

String targetTechnologySource

targetTechnologyVersions

List<String> targetTechnologyVersions

Class org.odpi.openmetadata.accessservices.dataengine.model.CSVFile

class CSVFile extends DataFile implements Serializable

Serialized Fields

delimiterCharacter

String delimiterCharacter

The delimited character

quoteCharacter

String quoteCharacter

The quote character

Class org.odpi.openmetadata.accessservices.dataengine.model.Database

class Database extends DataStore implements Serializable

Serialized Fields

databaseImportedFrom

String databaseImportedFrom

The source (typically connection name) of the database information

databaseInstance

String databaseInstance

The name of this database instance

databaseSchema

DatabaseSchema databaseSchema

The database schema

databaseType

String databaseType

The description of the database type

databaseVersion

String databaseVersion

The version of the database

incomplete

boolean incomplete

Determines if the database is incomplete

networkAddress

String networkAddress

The Endpoint network address

protocol

String protocol

The Endpoint protocol

tables

List<RelationalTable> tables

The relational tables inside the database

Class org.odpi.openmetadata.accessservices.dataengine.model.DatabaseSchema

class DatabaseSchema extends Asset implements Serializable

serialVersionUID:

1L

Serialized Fields

incomplete

boolean incomplete

Determines if the database schema is incomplete

Class org.odpi.openmetadata.accessservices.dataengine.model.DataFile

class DataFile extends DataStore implements Serializable

Serialized Fields

columns

List<Attribute> columns

The file columns

fileType

String fileType

The file type

incomplete

boolean incomplete

Determines if the file is incomplete

networkAddress

String networkAddress

The network address

protocol

String protocol

The Endpoint protocol

schema

SchemaType schema

The file schema

Class org.odpi.openmetadata.accessservices.dataengine.model.DataFlow

class DataFlow extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

dataConsumer

String dataConsumer

The data consumer

dataSupplier

String dataSupplier

The data supplier

description

String description

formula

String formula

Class org.odpi.openmetadata.accessservices.dataengine.model.DataStore

class DataStore extends Asset implements Serializable

Serialized Fields

createTime

Date createTime

The time that the data store was created

encodingDescription

String encodingDescription

The description of the encoding used in the data store

encodingLanguage

String encodingLanguage

The name of the natural language used for text strings within the data store

encodingProperties

Map<String,String> encodingProperties

The additional properties associated with the encoding process

encodingType

String encodingType

The name of the encoding style used in the data store

modifiedTime

Date modifiedTime

The last known time the data store was modified

pathName

String pathName

The fully qualified physical location of the data store

Class org.odpi.openmetadata.accessservices.dataengine.model.Endpoint

class Endpoint extends Referenceable implements Serializable

Serialized Fields

description

String description

The description of the endpoint

displayName

String displayName

The display name of the endpoint

encryptionMethod

String encryptionMethod

The encryption method of the endpoint

name

String name

The name of the endpoint

networkAddress

String networkAddress

The network address of the endpoint

protocol

String protocol

The protocol of the endpoint

Class org.odpi.openmetadata.accessservices.dataengine.model.Engine

class Engine extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

additionalProperties

Map<String,String> additionalProperties

Additional properties

description

String description

The description

engineType

String engineType

The engine type

engineVersion

String engineVersion

The engine version

name

String name

The display name

patchLevel

String patchLevel

The patch level

qualifiedName

String qualifiedName

The qualified name

source

String source

The source

Class org.odpi.openmetadata.accessservices.dataengine.model.EventType

class EventType extends SchemaType implements Serializable

serialVersionUID:

1L

Serialized Fields

attributeList

List<Attribute> attributeList

The attribute list

Class org.odpi.openmetadata.accessservices.dataengine.model.FileFolder

class FileFolder extends DataStore implements Serializable

Class org.odpi.openmetadata.accessservices.dataengine.model.ParentProcess

class ParentProcess extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

processContainmentType

ProcessContainmentType processContainmentType

The process containment type

qualifiedName

String qualifiedName

The qualified name

Class org.odpi.openmetadata.accessservices.dataengine.model.Port

class Port extends Referenceable implements Serializable

serialVersionUID:

1L

Serialized Fields

displayName

String displayName

The display name

portType

PortType portType

The port type

updateSemantic

UpdateSemantic updateSemantic

The update semantic

Class org.odpi.openmetadata.accessservices.dataengine.model.PortImplementation

class PortImplementation extends Port implements Serializable

serialVersionUID:

1L

Serialized Fields

schemaType

SchemaType schemaType

The schema type

Class org.odpi.openmetadata.accessservices.dataengine.model.Process

class Process extends Asset implements Serializable

Serialized Fields

collection

Collection collection

The collection to which the process belongs

dataFlows

List<DataFlow> dataFlows

The data flows

formula

String formula

The description of the processing performed by this process

implementationLanguage

String implementationLanguage

The name of the programming language that this process is implemented in

name

String name

The process name

parentProcesses

List<ParentProcess> parentProcesses

The parent processes

portImplementations

List<PortImplementation> portImplementations

The port implementations

updateSemantic

UpdateSemantic updateSemantic

The update semantic

Class org.odpi.openmetadata.accessservices.dataengine.model.ProcessHierarchy

class ProcessHierarchy extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

childProcess

String childProcess

The child process

parentProcess

String parentProcess

The parent process

processContainmentType

ProcessContainmentType processContainmentType

The process containment type

Class org.odpi.openmetadata.accessservices.dataengine.model.ProcessingState

class ProcessingState extends Referenceable implements Serializable

serialVersionUID:

1L

Serialized Fields

syncDatesByKey

Map<String,Long> syncDatesByKey

The Sync Dates map of critical elements and sync status

Class org.odpi.openmetadata.accessservices.dataengine.model.Referenceable

class Referenceable extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

additionalProperties

Map<String,String> additionalProperties

A copy of the additional properties

qualifiedName

String qualifiedName

The stored qualified name property for the metadata entity

Class org.odpi.openmetadata.accessservices.dataengine.model.RelationalColumn

class RelationalColumn extends Attribute implements Serializable

Serialized Fields

formula

String formula

The name of the formula

Class org.odpi.openmetadata.accessservices.dataengine.model.RelationalTable

class RelationalTable extends Referenceable implements Serializable

serialVersionUID:

1L

Serialized Fields

aliases

List<String> aliases

The list of aliases of the relational table

columns

List<RelationalColumn> columns

The list of columns of the relational table

description

String description

The description of the relational table

displayName

String displayName

The display name of the relational table

incomplete

boolean incomplete

Determines if the table is incomplete

isDeprecated

boolean isDeprecated

Determines if the relational table if deprecated

type

String type

The type of the relational table

Class org.odpi.openmetadata.accessservices.dataengine.model.SchemaType

class SchemaType extends Referenceable implements Serializable

serialVersionUID:

1L

Serialized Fields

attributeList

List<Attribute> attributeList

The attribute list

author

String author

The author

description

String description

The stored description property associated with the schema type

displayName

String displayName

The display name

encodingStandard

String encodingStandard

The encoding standard

isDeprecated

boolean isDeprecated

Determines if the schema type is deprecated

namespace

String namespace

The he name of the namespace that this schema type belongs to

type

String type

The type

usage

String usage

The usage

versionNumber

String versionNumber

The version number

Class org.odpi.openmetadata.accessservices.dataengine.model.Topic

class Topic extends Asset implements Serializable

Serialized Fields

eventTypes

List<EventType> eventTypes

The list of event types

topicType

String topicType

The description of the topic type

Package org.odpi.openmetadata.accessservices.dataengine.rest

Class org.odpi.openmetadata.accessservices.dataengine.rest.DatabaseRequestBody

class DatabaseRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

database

Database database

The database to be created

Class org.odpi.openmetadata.accessservices.dataengine.rest.DatabaseSchemaRequestBody

class DatabaseSchemaRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

databaseQualifiedName

String databaseQualifiedName

The database qualified name to which the database schema will be linked, if it exists

databaseSchema

DatabaseSchema databaseSchema

The database schema to be created

Class org.odpi.openmetadata.accessservices.dataengine.rest.DataEngineOMASAPIRequestBody

class DataEngineOMASAPIRequestBody extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

externalSourceName

String externalSourceName

The unique name of the external source

Class org.odpi.openmetadata.accessservices.dataengine.rest.DataEngineRegistrationRequestBody

class DataEngineRegistrationRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

engine

Engine engine

Engine

Class org.odpi.openmetadata.accessservices.dataengine.rest.DataFileRequestBody

class DataFileRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

dataFile

DataFile dataFile

The data file to be created

Class org.odpi.openmetadata.accessservices.dataengine.rest.DataFlowsRequestBody

class DataFlowsRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

dataFlows

List<DataFlow> dataFlows

The data flows

Class org.odpi.openmetadata.accessservices.dataengine.rest.DeleteRequestBody

class DeleteRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

deleteSemantic

DeleteSemantic deleteSemantic

The delete semantic

guid

String guid

The unique identifier of the entity

qualifiedName

String qualifiedName

The qualified name of the entity

Class org.odpi.openmetadata.accessservices.dataengine.rest.EventTypeRequestBody

class EventTypeRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

eventType

EventType eventType

The event type to be created

topicQualifiedName

String topicQualifiedName

The qualified name of the topic

Class org.odpi.openmetadata.accessservices.dataengine.rest.FindRequestBody

class FindRequestBody extends Object implements Serializable

Serialized Fields

externalSourceName

String externalSourceName

The externalSourceName of the entity

identifiers

Identifiers identifiers

The identifiers name of the entity

type

String type

The type of the entity

Class org.odpi.openmetadata.accessservices.dataengine.rest.PortImplementationRequestBody

class PortImplementationRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

portImplementation

PortImplementation portImplementation

The port implementation

processQualifiedName

String processQualifiedName

The process qualified name

Class org.odpi.openmetadata.accessservices.dataengine.rest.PortListRequestBody

class PortListRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

ports

List<String> ports

The ports

Class org.odpi.openmetadata.accessservices.dataengine.rest.ProcessHierarchyRequestBody

class ProcessHierarchyRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

processHierarchy

ProcessHierarchy processHierarchy

The process hierarchy

Class org.odpi.openmetadata.accessservices.dataengine.rest.ProcessingStateRequestBody

class ProcessingStateRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

serialVersionUID:

1L

Serialized Fields

processingState

ProcessingState processingState

The sync state to be created

Class org.odpi.openmetadata.accessservices.dataengine.rest.ProcessRequestBody

class ProcessRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

process

Process process

The process

Class org.odpi.openmetadata.accessservices.dataengine.rest.RelationalTableRequestBody

class RelationalTableRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

databaseSchemaQualifiedName

String databaseSchemaQualifiedName

The qualified name of the database schema

relationalTable

RelationalTable relationalTable

The relational table to be created

Class org.odpi.openmetadata.accessservices.dataengine.rest.SchemaTypeRequestBody

class SchemaTypeRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

schemaType

SchemaType schemaType

The schema type

Class org.odpi.openmetadata.accessservices.dataengine.rest.TopicRequestBody

class TopicRequestBody extends DataEngineOMASAPIRequestBody implements Serializable

Serialized Fields

topic

Topic topic

The topic to be created