aidp-typescript-client 1.0.2 → 4.1.0

package/lib/model/external-catalog-source-type.ts

@@ -13,6 +13,10 @@ export enum ExternalCatalogSourceType {
     Atp = "ATP",
     Oracle = "ORACLE",
     Exadata = "EXADATA",
+    Mysql = "MYSQL",
+    AzureSqlserver = "AZURE_SQLSERVER",
+    Snowflake = "SNOWFLAKE",
+    GoogleBigquery = "GOOGLE_BIGQUERY",
     OracleAnalytics = "ORACLE_ANALYTICS",
     
     /**

package/lib/model/fetch-entity-lineage-details.ts

@@ -0,0 +1,93 @@
+// Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+import * as model from '../model';
+import common = require("oci-common");
+
+
+/**
+* The information needed to obtain desired lineage.
+*/
+export interface FetchEntityLineageDetails {
+    /**
+    * Root entity node from with the lineage is to be fetched.
+* 
+    */
+    'anchorNode': string;
+    /**
+    * Maximum depth to traverse in lineage graph. Depth is measured as number of links from anchor node to matching nodes.
+*  Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+    */
+    'maxDepth': number;
+    /**
+    * Indicates the level for lineage fetch. It is one of ENTITY/COLUMN
+* 
+    */
+    'level': model.LineageLevel;
+    /**
+    * Direction of the lineage returned.
+    */
+    'direction': model.LineageDirection;
+    'nodeFilters'?: model.NodeFilterObject;
+    'pathFilters'?: model.PathFilterObject;
+    /**
+    * Controls if the edges will be returned with vertices.
+    */
+    'shouldIncludeEdges'?: boolean;
+
+}
+
+export namespace FetchEntityLineageDetails {
+
+
+
+
+
+
+
+
+    export function getJsonObj(obj: FetchEntityLineageDetails): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+
+
+                'nodeFilters': obj.nodeFilters ?
+                
+                
+                model.NodeFilterObject.getJsonObj(obj.nodeFilters) : undefined,
+                'pathFilters': obj.pathFilters ?
+                
+                
+                model.PathFilterObject.getJsonObj(obj.pathFilters) : undefined,
+
+        }};
+
+        
+        
+        return jsonObj;
+    }
+    ;
+    export function getDeserializedJsonObj(obj: FetchEntityLineageDetails): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+
+
+                    'nodeFilters': obj.nodeFilters ?
+                
+                
+                model.NodeFilterObject.getDeserializedJsonObj(obj.nodeFilters) : undefined,
+                    'pathFilters': obj.pathFilters ?
+                
+                
+                model.PathFilterObject.getDeserializedJsonObj(obj.pathFilters) : undefined,
+
+         }};
+
+        
+        
+        return jsonObj;
+    }
+}

package/lib/model/fetch-lineage-graph-node-neighbors-details.ts

@@ -0,0 +1,76 @@
+// Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+import * as model from '../model';
+import common = require("oci-common");
+
+
+/**
+* The information needed to obtain neighbors for the node.
+*/
+export interface FetchLineageGraphNodeNeighborsDetails {
+    /**
+    * ID of the node to fetch the details
+* 
+    */
+    'nodeId': string;
+    /**
+    * Direction of the lineage returned.
+    */
+    'direction': model.LineageDirection;
+    /**
+    * The flag to indicate whether columns also to be included while fetching neighbors. Default is false.
+* 
+    */
+    'isWithColumns'?: boolean;
+    /**
+    * List of scoped column names for fetching the Graph Node Neighbors. Applicable only when isWithColumns is true.
+* 
+    */
+    'scopedColumns'?: Array<string>;
+    'filter'?: model.LineageGraphNodeNeighborsFilter;
+
+}
+
+export namespace FetchLineageGraphNodeNeighborsDetails {
+
+
+
+
+
+
+    export function getJsonObj(obj: FetchLineageGraphNodeNeighborsDetails): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+
+
+                'filter': obj.filter ?
+                
+                
+                model.LineageGraphNodeNeighborsFilter.getJsonObj(obj.filter) : undefined,
+        }};
+
+        
+        
+        return jsonObj;
+    }
+    ;
+    export function getDeserializedJsonObj(obj: FetchLineageGraphNodeNeighborsDetails): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+
+
+                    'filter': obj.filter ?
+                
+                
+                model.LineageGraphNodeNeighborsFilter.getDeserializedJsonObj(obj.filter) : undefined,
+         }};
+
+        
+        
+        return jsonObj;
+    }
+}

package/lib/model/fetch-lineage-graph-node-references-details.ts

@@ -0,0 +1,50 @@
+// Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+import * as model from '../model';
+import common = require("oci-common");
+
+
+/**
+* The information needed to fetch child/parent nodes of desired lineage node details.
+*/
+export interface FetchLineageGraphNodeReferencesDetails {
+    /**
+    * ID of the node to fetch the details:
+* 
+    */
+    'nodeId': string;
+    /**
+    * referenceType of the node
+    */
+    'referenceType': model.ReferenceType;
+
+}
+
+export namespace FetchLineageGraphNodeReferencesDetails {
+
+
+
+    export function getJsonObj(obj: FetchLineageGraphNodeReferencesDetails): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+        }};
+
+        
+        
+        return jsonObj;
+    }
+    ;
+    export function getDeserializedJsonObj(obj: FetchLineageGraphNodeReferencesDetails): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+         }};
+
+        
+        
+        return jsonObj;
+    }
+}

package/lib/model/fetch-process-node-column-links-details.ts

@@ -0,0 +1,76 @@
+// Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+import * as model from '../model';
+import common = require("oci-common");
+
+
+/**
+* The information needed to obtain column transformations done by a process.
+*/
+export interface FetchProcessNodeColumnLinksDetails {
+    /**
+    * ID of the lineage anchor node from which the traversal context is derived.
+* 
+    */
+    'anchorNodeId': string;
+    /**
+    * ID of process node for which column transformation links are requested.
+* 
+    */
+    'processNodeId': string;
+    /**
+    * Depth of the process node relative to the anchor node within the lineage traversal.
+*  Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+    */
+    'processDepth': number;
+    /**
+    * Direction of the process node with respect to Anchor node.
+    */
+    'direction': model.LineageDirection;
+    'filter'?: model.ProcessNodeColumnLinksFilter;
+
+}
+
+export namespace FetchProcessNodeColumnLinksDetails {
+
+
+
+
+
+
+    export function getJsonObj(obj: FetchProcessNodeColumnLinksDetails): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+
+
+                'filter': obj.filter ?
+                
+                
+                model.ProcessNodeColumnLinksFilter.getJsonObj(obj.filter) : undefined,
+        }};
+
+        
+        
+        return jsonObj;
+    }
+    ;
+    export function getDeserializedJsonObj(obj: FetchProcessNodeColumnLinksDetails): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+
+
+                    'filter': obj.filter ?
+                
+                
+                model.ProcessNodeColumnLinksFilter.getDeserializedJsonObj(obj.filter) : undefined,
+         }};
+
+        
+        
+        return jsonObj;
+    }
+}

package/lib/model/file-allowed-file-type.ts

@@ -0,0 +1,34 @@
+// Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+import * as model from '../model';
+import common = require("oci-common");
+
+/**
+ * File type values accepted by the session file read/write configuration.
+**/
+export enum FileAllowedFileType {
+    Pdf = "pdf",
+    Txt = "txt",
+    Csv = "csv",
+    Json = "json",
+    Ndjson = "ndjson",
+    Png = "png",
+    Jpg = "jpg",
+    Jpeg = "jpeg",
+    
+    /**
+     * This value is used if a service returns a value for this enum that is not recognized by this
+     * version of the SDK.
+     */
+    UnknownValue = "UNKNOWN_VALUE"
+}
+
+export namespace FileAllowedFileType {
+    export function getJsonObj(obj: FileAllowedFileType): FileAllowedFileType {
+        return obj;
+    }
+    export function getDeserializedJsonObj(obj: FileAllowedFileType): FileAllowedFileType {
+        return obj;
+    }
+}
+

package/lib/model/file-configuration.ts

@@ -0,0 +1,66 @@
+// Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+import * as model from '../model';
+import common = require("oci-common");
+
+
+/**
+* File read/write configuration for an agent flow session. DataHub owns this
+* as Agent Flow authoring metadata and passes it to downstream runtime
+* components as structured JSON. Runtime and gateway components enforce
+* file policy during session execution.
+* 
+*/
+export interface FileConfiguration {
+    /**
+    * Overall preview/codegen gate for runtime session-file helper tools.
+    */
+    'isEnabled'?: boolean;
+    'read'?: model.FileReadConfiguration;
+    'write'?: model.FileWriteConfiguration;
+
+}
+
+export namespace FileConfiguration {
+
+
+
+
+    export function getJsonObj(obj: FileConfiguration): object {
+        const jsonObj = {...obj, ...{
+            
+
+                'read': obj.read ?
+                
+                
+                model.FileReadConfiguration.getJsonObj(obj.read) : undefined,
+                'write': obj.write ?
+                
+                
+                model.FileWriteConfiguration.getJsonObj(obj.write) : undefined,
+        }};
+
+        
+        
+        return jsonObj;
+    }
+    ;
+    export function getDeserializedJsonObj(obj: FileConfiguration): object {
+        const jsonObj = {...obj, ...{
+            
+
+                    'read': obj.read ?
+                
+                
+                model.FileReadConfiguration.getDeserializedJsonObj(obj.read) : undefined,
+                    'write': obj.write ?
+                
+                
+                model.FileWriteConfiguration.getDeserializedJsonObj(obj.write) : undefined,
+         }};
+
+        
+        
+        return jsonObj;
+    }
+}

package/lib/model/file-read-configuration.ts

@@ -0,0 +1,104 @@
+// Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+import * as model from '../model';
+import common = require("oci-common");
+
+
+/**
+* File read/upload settings collected by the UI and persisted as Agent Flow
+* session configuration. DataHub stores and forwards these settings;
+* runtime and gateway components enforce file policy during execution.
+* 
+*/
+export interface FileReadConfiguration {
+    /**
+    * Whether file read/upload configuration is enabled.
+    */
+    'isEnabled'?: boolean;
+    /**
+    * File type enum values accepted by the UI/runtime contract.
+    */
+    'allowedFileTypes'?: Array<FileReadConfiguration.AllowedFileTypes>;
+    /**
+    * Maximum uploaded file size in megabytes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+    */
+    'maxFileSizeMb'?: number;
+    /**
+    * Maximum number of files allowed in a request/session. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+    */
+    'maxFileCount'?: number;
+    /**
+    * Strict relative workspace folder or volumeRef/workspaceFolder path where uploaded/readable files are stored or located for later runtime access. Path segments must not be empty, absolute, traversal segments, backslash-separated, contain control characters, or contain malformed dot-separated volume refs.
+    */
+    'targetPath'?: string;
+    /**
+    * Whether uploaded files should be retained beyond the current request/session intent.
+    */
+    'isPersistenceEnabled'?: boolean;
+    /**
+    * Retention period in days for persisted files. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+    */
+    'retentionDays'?: number;
+
+}
+
+export namespace FileReadConfiguration {
+
+
+    export enum AllowedFileTypes {
+    
+    Pdf = "pdf",
+    Txt = "txt",
+    Csv = "csv",
+    Json = "json",
+    Ndjson = "ndjson",
+    Png = "png",
+    Jpg = "jpg",
+    Jpeg = "jpeg",
+    /**
+    * This value is used if a service returns a value for this enum that is not recognized by this
+    * version of the SDK.
+    */
+    UnknownValue = "UNKNOWN_VALUE"
+}
+
+
+
+
+
+
+
+    export function getJsonObj(obj: FileReadConfiguration): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+
+
+
+
+
+        }};
+
+        
+        
+        return jsonObj;
+    }
+    ;
+    export function getDeserializedJsonObj(obj: FileReadConfiguration): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+
+
+
+
+
+         }};
+
+        
+        
+        return jsonObj;
+    }
+}

package/lib/model/file-write-configuration.ts

@@ -0,0 +1,140 @@
+// Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+import * as model from '../model';
+import common = require("oci-common");
+
+
+/**
+* File write/download settings collected by the UI and persisted as Agent Flow
+* session configuration. DataHub stores and forwards these settings;
+* runtime and gateway components enforce file policy during execution.
+* 
+*/
+export interface FileWriteConfiguration {
+    /**
+    * Whether file write/download configuration is enabled.
+    */
+    'isEnabled'?: boolean;
+    /**
+    * Whether generated/downloadable files should be written to AIDP Catalog or a configured volume.
+    */
+    'isDownloadToCatalogEnabled'?: boolean;
+    /**
+    * File type enum values allowed for generated/downloadable files.
+    */
+    'allowedFileTypes'?: Array<FileWriteConfiguration.AllowedFileTypes>;
+    /**
+    * Maximum generated/downloadable file size in megabytes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+    */
+    'maxFileSizeMb'?: number;
+    /**
+    * Strict relative workspace folder or volumeRef/workspaceFolder path where generated/downloadable files should be stored for retention or delivery. Path segments must not be empty, absolute, traversal segments, backslash-separated, contain control characters, or contain malformed dot-separated volume refs.
+    */
+    'targetPath'?: string;
+    /**
+    * Whether generated/downloadable files should be retained beyond the current request/session intent.
+    */
+    'isPersistenceEnabled'?: boolean;
+    /**
+    * Retention period in days for generated/downloadable files. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+    */
+    'retentionDays'?: number;
+    /**
+    * Intended file visibility for generated/downloadable files.
+    */
+    'visibility'?: FileWriteConfiguration.Visibility;
+    /**
+    * Intended download link expiry behavior, for example session duration.
+    */
+    'downloadLinkExpiry'?: FileWriteConfiguration.DownloadLinkExpiry;
+
+}
+
+export namespace FileWriteConfiguration {
+
+
+
+    export enum AllowedFileTypes {
+    
+    Pdf = "pdf",
+    Txt = "txt",
+    Csv = "csv",
+    Json = "json",
+    Ndjson = "ndjson",
+    Png = "png",
+    Jpg = "jpg",
+    Jpeg = "jpeg",
+    /**
+    * This value is used if a service returns a value for this enum that is not recognized by this
+    * version of the SDK.
+    */
+    UnknownValue = "UNKNOWN_VALUE"
+}
+
+
+
+
+
+
+    export enum Visibility {
+    
+    EndUserOnly = "END_USER_ONLY",
+    DeveloperOnly = "DEVELOPER_ONLY",
+    EndUserAndDeveloper = "END_USER_AND_DEVELOPER",
+    /**
+    * This value is used if a service returns a value for this enum that is not recognized by this
+    * version of the SDK.
+    */
+    UnknownValue = "UNKNOWN_VALUE"
+}
+
+
+    export enum DownloadLinkExpiry {
+    
+    SessionDuration = "SESSION_DURATION",
+    /**
+    * This value is used if a service returns a value for this enum that is not recognized by this
+    * version of the SDK.
+    */
+    UnknownValue = "UNKNOWN_VALUE"
+}
+
+
+    export function getJsonObj(obj: FileWriteConfiguration): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+
+
+
+
+
+
+
+        }};
+
+        
+        
+        return jsonObj;
+    }
+    ;
+    export function getDeserializedJsonObj(obj: FileWriteConfiguration): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+
+
+
+
+
+
+
+         }};
+
+        
+        
+        return jsonObj;
+    }
+}

package/lib/model/find-ontology-graph-paths-details.ts

@@ -0,0 +1,56 @@
+// Copyright (c) 2026, Oracle and/or its affiliates.  All rights reserved.
+
+import * as model from '../model';
+import common = require("oci-common");
+
+
+export interface FindOntologyGraphPathsDetails {
+    'projectId': string;
+    'sourceNodeId': string;
+    'targetNodeId': string;
+    'maxDepth'?: number;
+    'relationshipTypes'?: Array<string>;
+    'limit'?: number;
+
+}
+
+export namespace FindOntologyGraphPathsDetails {
+
+
+
+
+
+
+
+    export function getJsonObj(obj: FindOntologyGraphPathsDetails): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+
+
+
+
+        }};
+
+        
+        
+        return jsonObj;
+    }
+    ;
+    export function getDeserializedJsonObj(obj: FindOntologyGraphPathsDetails): object {
+        const jsonObj = {...obj, ...{
+            
+
+
+
+
+
+
+         }};
+
+        
+        
+        return jsonObj;
+    }
+}