Index (Files Integrator OMIS API 2.9 API)

A C D F G O R S T U V

A

addDataFileToCatalog(DataFileProperties, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Creates a new file asset and links it to the folder structure implied in the path name.
addDataFileToCatalogFromTemplate(String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Add an asset description a file based on the content of a template object.
addDataFolderToCatalog(FileFolderProperties, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Creates a new folder asset that is identified as a data asset.
addDataFolderToCatalogFromTemplate(String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Add an asset description a file based on the content of a template object.
archiveDataFileInCatalog(String, ArchiveProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Mark the file asset description in the catalog as archived.
archiveDataFolderInCatalog(String, ArchiveProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Mark the data folder asset description in the catalog as archived.
attachDataFileAssetToFolder(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Link an existing file asset to a folder.
attachTopLevelFolder(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Links a folder to a file system.

C

createNestedFolders(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Creates a new folder asset for each element in the pathName.

D

deleteDataFileFromCatalog(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove the file asset description from the catalog.
detachDataFileAssetFromFolder(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove a link between a file asset and a folder.
detachTopLevelFolder(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Removed the link between a folder and a file system.

F

FilesIntegratorAPI - Interface in org.odpi.openmetadata.integrationservices.files.api: FilesIntegratorAPI is the interface to validate that a connector is suitable to run in the Files Integrator OMIS.
FilesIntegratorAuditCode - Enum in org.odpi.openmetadata.integrationservices.files.ffdc: The FilesIntegratorAuditCode is used to define the message content for the OMRS Audit Log.
FilesIntegratorConnector - Class in org.odpi.openmetadata.integrationservices.files.connector: FilesIntegratorConnector is the base class for an integration connector that is managed by the Files Integrator OMIS.
FilesIntegratorConnector() - Constructor for class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorConnector
FilesIntegratorContext - Class in org.odpi.openmetadata.integrationservices.files.connector: FilesIntegratorContext provides a wrapper around the Data Manager OMAS clients.
FilesIntegratorContext(FilesAndFoldersClient, DataManagerEventClient, String, String, String) - Constructor for class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new client with no authentication embedded in the HTTP request.
FilesIntegratorErrorCode - Enum in org.odpi.openmetadata.integrationservices.files.ffdc: The FilesIntegratorErrorCode error code is used to define first failure data capture (FFDC) for errors that occur when working with the Integration Services.

G

getContext() - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorConnector: Return the context for this connector.
getFileByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve a FolderProperties asset by its unique identifier (GUID).
getFileByPathName(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve a folder by its fully qualified path name.
getFolderByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve a FolderProperties asset by its unique identifier (GUID).
getFolderByPathName(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve a folder by its fully qualified path name.
getFolderFiles(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Get the data files inside a folder - both those that are nested and those that are linked.
getMessageDefinition() - Method in enum org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode: Retrieve a message definition object for logging.
getMessageDefinition(String...) - Method in enum org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode: Retrieve a message definition object for logging.
getMessageDefinition() - Method in enum org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorErrorCode: Retrieve a message definition object for an exception.
getMessageDefinition(String...) - Method in enum org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorErrorCode: Retrieve a message definition object for an exception.
getNestedFolders(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Return the list of folders nested inside a folder.
getTopLevelDataFiles(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Return the list of folders nested inside a folder.
getTopLevelFolders(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Return the list of folders linked to the file server capability.

O

org.odpi.openmetadata.integrationservices.files.api - package org.odpi.openmetadata.integrationservices.files.api
org.odpi.openmetadata.integrationservices.files.connector - package org.odpi.openmetadata.integrationservices.files.connector
org.odpi.openmetadata.integrationservices.files.ffdc - package org.odpi.openmetadata.integrationservices.files.ffdc

R

registerListener(DataManagerEventListener) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Register a listener object that will be passed each of the events published by the Data Manager OMAS.

S

setContext(FilesIntegratorContext) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorConnector: Set up the context for this connector.

T

toString() - Method in enum org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode: toString() JSON-style
toString() - Method in enum org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorErrorCode: JSON-style toString

U

updateDataFileInCatalog(String, boolean, DataFileProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Update the file asset description in the catalog.
updateDataFolderInCatalog(String, boolean, FileFolderProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Update the data folder asset description in the catalog.

V

validateConnector(String, String) - Method in interface org.odpi.openmetadata.integrationservices.files.api.FilesIntegratorAPI: Validate the connector and return its connector type.
valueOf(String) - Static method in enum org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorErrorCode: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorErrorCode: Returns an array containing the constants of this enum type, in the order they are declared.

A C D F G O R S T U V