aidp-typescript-client 2.0.1 → 4.1.1

package/dist/lib/client.d.ts

@@ -1398,6 +1398,91 @@ export declare class CredentialsClient {
      */
     updateCredential(updateCredentialRequest: requests.UpdateCredentialRequest): Promise<responses.UpdateCredentialResponse>;
 }
+export declare enum DataLineageApiKeys {
+}
+/**
+* This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+*/
+export declare class DataLineageClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: typeof Breaker | null;
+    protected _httpOptions: any;
+    protected _bodyDuplexMode: any;
+    targetService: string;
+    protected _regionId: string;
+    protected "_region": common.Region;
+    protected _lastSetRegionOrRegionId: string;
+    protected _httpClient: common.HttpClient;
+    protected _authProvider: common.AuthenticationDetailsProvider | undefined;
+    constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
+    /**
+      * Get the endpoint that is being used to call (ex, https://www.example.com).
+      */
+    get endpoint(): string;
+    /**
+      * Sets the endpoint to call (ex, https://www.example.com).
+      * @param endpoint The endpoint of the service.
+      */
+    set endpoint(endpoint: string);
+    get logger(): import("oci-common/lib/log").Logger;
+    /**
+      * Determines whether realm specific endpoint should be used or not.
+      * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
+      * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
+      */
+    set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean);
+    /**
+      * Sets the region to call (ex, Region.US_PHOENIX_1).
+      * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+      * @param region The region of the service.
+      */
+    set region(region: common.Region);
+    /**
+      * Sets the regionId to call (ex, 'us-phoenix-1').
+      *
+      * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
+      * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
+      * and then call {@link #endpoint(String) endpoint}.
+      * @param regionId The public region ID.
+      */
+    set regionId(regionId: string);
+    /**
+     * Shutdown the circuit breaker used by the client when it is no longer needed
+     */
+    shutdownCircuitBreaker(): void;
+    /**
+    * Close the provider if possible which in turn shuts down any associated circuit breaker
+    */
+    closeProvider(): void;
+    /**
+     * Close the client once it is no longer needed
+     */
+    close(): void;
+    /**
+     * (Preview) Returns complete lineage for the provided anchor node in CSV format.
+*
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ExportLineageRequest
+     * @return ExportLineageResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/aidp/ExportLineage.ts.html |here} to see how to use ExportLineage API.
+     */
+    exportLineage(exportLineageRequest: requests.ExportLineageRequest): Promise<responses.ExportLineageResponse>;
+    /**
+     * (Preview) Returns lineage for a given entity object.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param FetchEntityLineageRequest
+     * @return FetchEntityLineageResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/aidp/FetchEntityLineage.ts.html |here} to see how to use FetchEntityLineage API.
+     */
+    fetchEntityLineage(fetchEntityLineageRequest: requests.FetchEntityLineageRequest): Promise<responses.FetchEntityLineageResponse>;
+}
 export declare enum DeltaShareApiKeys {
 }
 /**

package/dist/lib/client.js

@@ -43,7 +43,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkspaceObjectClient = exports.WorkspaceObjectApiKeys = exports.WorkspaceClient = exports.WorkspaceApiKeys = exports.WorkflowClient = exports.WorkflowApiKeys = exports.VolumeClient = exports.VolumeApiKeys = exports.UserSettingClient = exports.UserSettingApiKeys = exports.SchemaClient = exports.SchemaApiKeys = exports.RoleClient = exports.RoleApiKeys = exports.NotebookClient = exports.NotebookApiKeys = exports.MLOpsClient = exports.MLOpsApiKeys = exports.GitClient = exports.GitApiKeys = exports.DeltaShareClient = exports.DeltaShareApiKeys = exports.CredentialsClient = exports.CredentialsApiKeys = exports.ClusterClient = exports.ClusterApiKeys = exports.CatalogClient = exports.CatalogApiKeys = exports.BundleClient = exports.BundleApiKeys = exports.AuditClient = exports.AuditApiKeys = exports.AsyncOperationsClient = exports.AsyncOperationsApiKeys = exports.AgentClient = exports.AgentApiKeys = void 0;
+exports.WorkspaceObjectClient = exports.WorkspaceObjectApiKeys = exports.WorkspaceClient = exports.WorkspaceApiKeys = exports.WorkflowClient = exports.WorkflowApiKeys = exports.VolumeClient = exports.VolumeApiKeys = exports.UserSettingClient = exports.UserSettingApiKeys = exports.SchemaClient = exports.SchemaApiKeys = exports.RoleClient = exports.RoleApiKeys = exports.NotebookClient = exports.NotebookApiKeys = exports.MLOpsClient = exports.MLOpsApiKeys = exports.GitClient = exports.GitApiKeys = exports.DeltaShareClient = exports.DeltaShareApiKeys = exports.DataLineageClient = exports.DataLineageApiKeys = exports.CredentialsClient = exports.CredentialsApiKeys = exports.ClusterClient = exports.ClusterApiKeys = exports.CatalogClient = exports.CatalogApiKeys = exports.BundleClient = exports.BundleApiKeys = exports.AuditClient = exports.AuditApiKeys = exports.AsyncOperationsClient = exports.AsyncOperationsApiKeys = exports.AgentClient = exports.AgentApiKeys = void 0;
 const common = require("oci-common");
 const model = __importStar(require("./model"));
 const oci_common_1 = require("oci-common");
@@ -5640,6 +5640,268 @@ class CredentialsClient {
 exports.CredentialsClient = CredentialsClient;
 CredentialsClient.serviceEndpointTemplate = 'https://datalake.{region}.oci.{secondLevelDomain}';
 CredentialsClient.endpointServiceName = '';
+var DataLineageApiKeys;
+(function (DataLineageApiKeys) {
+})(DataLineageApiKeys || (exports.DataLineageApiKeys = DataLineageApiKeys = {}));
+/**
+* This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+*/
+class DataLineageClient {
+    constructor(params, clientConfiguration) {
+        this["_realmSpecificEndpointTemplateEnabled"] = undefined;
+        this["_endpoint"] = '';
+        this["_defaultHeaders"] = {};
+        this._circuitBreaker = null;
+        this._httpOptions = undefined;
+        this._bodyDuplexMode = undefined;
+        this.targetService = "DataLineage";
+        this._regionId = '';
+        this._lastSetRegionOrRegionId = "";
+        const requestSigner = params.authenticationDetailsProvider
+            ? new common.DefaultRequestSigner(params.authenticationDetailsProvider)
+            : null;
+        this._authProvider = params.authenticationDetailsProvider;
+        if (clientConfiguration) {
+            this._clientConfiguration = clientConfiguration;
+            this._circuitBreaker = clientConfiguration.circuitBreaker ? clientConfiguration.circuitBreaker.circuit : null;
+            this._httpOptions = clientConfiguration.httpOptions ? clientConfiguration.httpOptions : undefined;
+            this._bodyDuplexMode = clientConfiguration.bodyDuplexMode ? clientConfiguration.bodyDuplexMode : undefined;
+        }
+        if (!oci_common_1.developerToolConfiguration.isServiceEnabled("aidp")) {
+            let errmsg = "The developerToolConfiguration configuration disabled this service, this behavior is controlled by developerToolConfiguration.ociEnabledServiceSet variable. Please check if your local developer_tool_configuration file has configured the service you're targeting or contact the cloud provider on the availability of this service : ";
+            throw errmsg.concat("aidp");
+        }
+        // if circuit breaker is not created, check if circuit breaker system is enabled to use default circuit breaker
+        const specCircuitBreakerEnabled = true;
+        if (!this._circuitBreaker && common.utils.isCircuitBreakerSystemEnabled(clientConfiguration) && (specCircuitBreakerEnabled || common.CircuitBreaker.DefaultCircuitBreakerOverriden)) {
+            this._circuitBreaker = new common.CircuitBreaker().circuit;
+        }
+        this._httpClient = params.httpClient || new common.FetchHttpClient(requestSigner, this._circuitBreaker, this._httpOptions, this._bodyDuplexMode);
+        if (params.authenticationDetailsProvider &&
+            common.isRegionProvider(params.authenticationDetailsProvider)) {
+            const provider = params.authenticationDetailsProvider;
+            if (provider.getRegion()) {
+                this.region = provider.getRegion();
+            }
+        }
+    }
+    /**
+      * Get the endpoint that is being used to call (ex, https://www.example.com).
+      */
+    get endpoint() {
+        return this._endpoint;
+    }
+    /**
+      * Sets the endpoint to call (ex, https://www.example.com).
+      * @param endpoint The endpoint of the service.
+      */
+    set endpoint(endpoint) {
+        this._endpoint = endpoint;
+        this._endpoint = this._endpoint + '/20260430';
+        if (this.logger)
+            this.logger.info(`DataLineageClient endpoint set to ${this._endpoint}`);
+    }
+    get logger() {
+        return common.LOG.logger;
+    }
+    /**
+      * Determines whether realm specific endpoint should be used or not.
+      * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
+      * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
+      */
+    set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled) {
+        this._realmSpecificEndpointTemplateEnabled = realmSpecificEndpointTemplateEnabled;
+        if (this.logger)
+            this.logger.info(`realmSpecificEndpointTemplateEnabled set to ${this._realmSpecificEndpointTemplateEnabled}`);
+        if (this._lastSetRegionOrRegionId === common.Region.REGION_STRING) {
+            this.endpoint = common.EndpointBuilder.createEndpointFromRegion(DataLineageClient.serviceEndpointTemplate, this._region, DataLineageClient.endpointServiceName);
+        }
+        else if (this._lastSetRegionOrRegionId === common.Region.REGION_ID_STRING) {
+            this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(DataLineageClient.serviceEndpointTemplate, this._regionId, DataLineageClient.endpointServiceName);
+        }
+    }
+    /**
+      * Sets the region to call (ex, Region.US_PHOENIX_1).
+      * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+      * @param region The region of the service.
+      */
+    set region(region) {
+        this._region = region;
+        this.endpoint = common.EndpointBuilder.createEndpointFromRegion(DataLineageClient.serviceEndpointTemplate, region, DataLineageClient.endpointServiceName);
+        this._lastSetRegionOrRegionId = common.Region.REGION_STRING;
+    }
+    /**
+      * Sets the regionId to call (ex, 'us-phoenix-1').
+      *
+      * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
+      * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
+      * and then call {@link #endpoint(String) endpoint}.
+      * @param regionId The public region ID.
+      */
+    set regionId(regionId) {
+        this._regionId = regionId;
+        this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(DataLineageClient.serviceEndpointTemplate, regionId, DataLineageClient.endpointServiceName);
+        this._lastSetRegionOrRegionId = common.Region.REGION_ID_STRING;
+    }
+    /**
+     * Shutdown the circuit breaker used by the client when it is no longer needed
+     */
+    shutdownCircuitBreaker() {
+        if (this._circuitBreaker) {
+            this._circuitBreaker.shutdown();
+        }
+    }
+    /**
+    * Close the provider if possible which in turn shuts down any associated circuit breaker
+    */
+    closeProvider() {
+        if (this._authProvider) {
+            if (this._authProvider instanceof common.AbstractRequestingAuthenticationDetailsProvider)
+                this._authProvider.closeProvider();
+        }
+    }
+    /**
+     * Close the client once it is no longer needed
+     */
+    close() {
+        this.shutdownCircuitBreaker();
+        this.closeProvider();
+    }
+    /**
+     * (Preview) Returns complete lineage for the provided anchor node in CSV format.
+*
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ExportLineageRequest
+     * @return ExportLineageResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/aidp/ExportLineage.ts.html |here} to see how to use ExportLineage API.
+     */
+    exportLineage(exportLineageRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DataLineageClient#exportLineage.");
+            const operationName = "exportLineage";
+            const apiReferenceLink = "";
+            const pathParams = {
+                "{aiDataPlatformId}": exportLineageRequest.aiDataPlatformId,
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                'opc-retry-token': exportLineageRequest.opcRetryToken, 'opc-request-id': exportLineageRequest.opcRequestId, 'if-match': exportLineageRequest.ifMatch,
+            };
+            const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, exportLineageRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield (0, oci_common_1.composeRequest)({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: '/aiDataPlatforms/{aiDataPlatformId}/actions/exportLineage',
+                method: 'POST',
+                bodyContent: common.ObjectSerializer.serialize(exportLineageRequest.exportLineageDetails, "ExportLineageDetails", model.ExportLineageDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = (0, oci_common_1.composeResponse)({
+                    responseObject: {},
+                    body: response.body,
+                    bodyKey: "value",
+                    bodyModel: "string",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("Content-Disposition"),
+                            key: "contentDisposition",
+                            dataType: "string"
+                        },
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * (Preview) Returns lineage for a given entity object.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param FetchEntityLineageRequest
+     * @return FetchEntityLineageResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/aidp/FetchEntityLineage.ts.html |here} to see how to use FetchEntityLineage API.
+     */
+    fetchEntityLineage(fetchEntityLineageRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DataLineageClient#fetchEntityLineage.");
+            const operationName = "fetchEntityLineage";
+            const apiReferenceLink = "";
+            const pathParams = {
+                "{aiDataPlatformId}": fetchEntityLineageRequest.aiDataPlatformId,
+            };
+            const queryParams = {
+                'limit': fetchEntityLineageRequest.limit,
+                'page': fetchEntityLineageRequest.page,
+            };
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                'opc-retry-token': fetchEntityLineageRequest.opcRetryToken, 'opc-request-id': fetchEntityLineageRequest.opcRequestId, 'if-match': fetchEntityLineageRequest.ifMatch,
+            };
+            const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, fetchEntityLineageRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield (0, oci_common_1.composeRequest)({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: '/aiDataPlatforms/{aiDataPlatformId}/actions/fetchLineage',
+                method: 'POST',
+                bodyContent: common.ObjectSerializer.serialize(fetchEntityLineageRequest.fetchEntityLineageDetails, "FetchEntityLineageDetails", model.FetchEntityLineageDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = (0, oci_common_1.composeResponse)({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "entityLineage",
+                    bodyModel: model.EntityLineage,
+                    type: "model.EntityLineage",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-next-page"),
+                            key: "opcNextPage",
+                            dataType: "string"
+                        },
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+}
+exports.DataLineageClient = DataLineageClient;
+DataLineageClient.serviceEndpointTemplate = 'https://datalake.{region}.oci.{secondLevelDomain}';
+DataLineageClient.endpointServiceName = '';
 var DeltaShareApiKeys;
 (function (DeltaShareApiKeys) {
 })(DeltaShareApiKeys || (exports.DeltaShareApiKeys = DeltaShareApiKeys = {}));
@@ -11860,6 +12122,10 @@ class NotebookClient {
                 'cluster_id': listSessionsRequest.clusterId,
                 'path': listSessionsRequest.path,
                 'agentFlowKey': listSessionsRequest.agentFlowKey,
+                'limit': listSessionsRequest.limit,
+                'page': listSessionsRequest.page,
+                'sortOrder': listSessionsRequest.sortOrder,
+                'sortBy': listSessionsRequest.sortBy,
             };
             let headerParams = {
                 "Content-Type": common.Constants.APPLICATION_JSON,
@@ -11888,13 +12154,13 @@ class NotebookClient {
                     type: "model.SessionCollection",
                     responseHeaders: [
                         {
-                            value: response.headers.get("etag"),
-                            key: "etag",
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
                             dataType: "string"
                         },
                         {
-                            value: response.headers.get("opc-request-id"),
-                            key: "opcRequestId",
+                            value: response.headers.get("opc-next-page"),
+                            key: "opcNextPage",
                             dataType: "string"
                         },
                     ]
@@ -16324,6 +16590,7 @@ class VolumeClient {
             const queryParams = {
                 'isOverwrite': uploadFileWithParRequest.isOverwrite,
                 'shouldGenerateNewPar': uploadFileWithParRequest.shouldGenerateNewPar,
+                'shouldCreateRecursively': uploadFileWithParRequest.shouldCreateRecursively,
             };
             let headerParams = {
                 "Content-Type": common.Constants.APPLICATION_JSON,
@@ -17142,7 +17409,9 @@ class WorkflowClient {
                 "{workspaceKey}": getJobRunRequest.workspaceKey,
                 "{jobRunKey}": getJobRunRequest.jobRunKey,
             };
-            const queryParams = {};
+            const queryParams = {
+                'shouldIncludeTaskRunSummaries': getJobRunRequest.shouldIncludeTaskRunSummaries,
+            };
             let headerParams = {
                 "Content-Type": common.Constants.APPLICATION_JSON,
                 'opc-request-id': getJobRunRequest.opcRequestId, 'should-update-recent': getJobRunRequest.shouldUpdateRecent,
@@ -17388,6 +17657,11 @@ class WorkflowClient {
                             key: "opcNextPage",
                             dataType: "string"
                         },
+                        {
+                            value: response.headers.get("opc-prev-page"),
+                            key: "opcPrevPage",
+                            dataType: "string"
+                        },
                     ]
                 });
                 return sdkResponse;
@@ -17618,6 +17892,11 @@ class WorkflowClient {
                             key: "opcNextPage",
                             dataType: "string"
                         },
+                        {
+                            value: response.headers.get("opc-prev-page"),
+                            key: "opcPrevPage",
+                            dataType: "string"
+                        },
                     ]
                 });
                 return sdkResponse;
@@ -19775,6 +20054,7 @@ class WorkspaceObjectClient {
             const queryParams = {
                 'isOverwrite': uploadWorkspaceObjectWithParRequest.isOverwrite,
                 'shouldGenerateNewPar': uploadWorkspaceObjectWithParRequest.shouldGenerateNewPar,
+                'shouldCreateRecursively': uploadWorkspaceObjectWithParRequest.shouldCreateRecursively,
                 'objectDescription': uploadWorkspaceObjectWithParRequest.objectDescription,
             };
             let headerParams = {