oci-opensearch 2.104.0 → 2.105.0

package/lib/client.js

@@ -40,11 +40,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpensearchClusterBackupClient = exports.OpensearchClusterBackupApiKeys = exports.OpensearchClusterClient = exports.OpensearchClusterApiKeys = void 0;
+exports.OpensearchClusterPipelineClient = exports.OpensearchClusterPipelineApiKeys = exports.OpensearchClusterBackupClient = exports.OpensearchClusterBackupApiKeys = exports.OpensearchClusterClient = exports.OpensearchClusterApiKeys = void 0;
 const common = require("oci-common");
 const model = __importStar(require("./model"));
 const opensearchcluster_waiter_1 = require("./opensearchcluster-waiter");
 const opensearchclusterbackup_waiter_1 = require("./opensearchclusterbackup-waiter");
+const opensearchclusterpipeline_waiter_1 = require("./opensearchclusterpipeline-waiter");
 const oci_common_1 = require("oci-common");
 const Breaker = require("opossum");
 // ===============================================
@@ -1647,4 +1648,484 @@ class OpensearchClusterBackupClient {
 exports.OpensearchClusterBackupClient = OpensearchClusterBackupClient;
 OpensearchClusterBackupClient.serviceEndpointTemplate = "https://search-indexing.{region}.oci.{secondLevelDomain}";
 OpensearchClusterBackupClient.endpointServiceName = "";
+var OpensearchClusterPipelineApiKeys;
+(function (OpensearchClusterPipelineApiKeys) {
+})(OpensearchClusterPipelineApiKeys = exports.OpensearchClusterPipelineApiKeys || (exports.OpensearchClusterPipelineApiKeys = {}));
+/**
+ * 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 OpensearchClusterPipelineClient {
+    constructor(params, clientConfiguration) {
+        this["_realmSpecificEndpointTemplateEnabled"] = undefined;
+        this["_endpoint"] = "";
+        this["_defaultHeaders"] = {};
+        this._circuitBreaker = null;
+        this._httpOptions = undefined;
+        this._bodyDuplexMode = undefined;
+        this.targetService = "OpensearchClusterPipeline";
+        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("opensearch")) {
+            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("opensearch");
+        }
+        // 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 + "/20180828";
+        if (this.logger)
+            this.logger.info(`OpensearchClusterPipelineClient 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(OpensearchClusterPipelineClient.serviceEndpointTemplate, this._region, OpensearchClusterPipelineClient.endpointServiceName);
+        }
+        else if (this._lastSetRegionOrRegionId === common.Region.REGION_ID_STRING) {
+            this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(OpensearchClusterPipelineClient.serviceEndpointTemplate, this._regionId, OpensearchClusterPipelineClient.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(OpensearchClusterPipelineClient.serviceEndpointTemplate, region, OpensearchClusterPipelineClient.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(OpensearchClusterPipelineClient.serviceEndpointTemplate, regionId, OpensearchClusterPipelineClient.endpointServiceName);
+        this._lastSetRegionOrRegionId = common.Region.REGION_ID_STRING;
+    }
+    /**
+     * Creates a new OpensearchClusterPipelineWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config) {
+        this._waiters = new opensearchclusterpipeline_waiter_1.OpensearchClusterPipelineWaiter(this, config);
+        return this._waiters;
+    }
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters() {
+        if (this._waiters) {
+            return this._waiters;
+        }
+        throw Error("Waiters do not exist. Please create waiters.");
+    }
+    /**
+     * 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();
+    }
+    /**
+     * Creates a new OpensearchCluster Pipeline.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CreateOpensearchClusterPipelineRequest
+     * @return CreateOpensearchClusterPipelineResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/opensearch/CreateOpensearchClusterPipeline.ts.html |here} to see how to use CreateOpensearchClusterPipeline API.
+     */
+    createOpensearchClusterPipeline(createOpensearchClusterPipelineRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation OpensearchClusterPipelineClient#createOpensearchClusterPipeline.");
+            const operationName = "createOpensearchClusterPipeline";
+            const apiReferenceLink = "";
+            const pathParams = {};
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-retry-token": createOpensearchClusterPipelineRequest.opcRetryToken,
+                "opc-request-id": createOpensearchClusterPipelineRequest.opcRequestId,
+                "opc-dry-run": createOpensearchClusterPipelineRequest.opcDryRun
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, createOpensearchClusterPipelineRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/opensearchClusterPipelines",
+                method: "POST",
+                bodyContent: common.ObjectSerializer.serialize(createOpensearchClusterPipelineRequest.createOpensearchClusterPipelineDetails, "CreateOpensearchClusterPipelineDetails", model.CreateOpensearchClusterPipelineDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * Deletes a OpensearchCluster Pipeline resource by identifier
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteOpensearchClusterPipelineRequest
+     * @return DeleteOpensearchClusterPipelineResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/opensearch/DeleteOpensearchClusterPipeline.ts.html |here} to see how to use DeleteOpensearchClusterPipeline API.
+     */
+    deleteOpensearchClusterPipeline(deleteOpensearchClusterPipelineRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation OpensearchClusterPipelineClient#deleteOpensearchClusterPipeline.");
+            const operationName = "deleteOpensearchClusterPipeline";
+            const apiReferenceLink = "";
+            const pathParams = {
+                "{opensearchClusterPipelineId}": deleteOpensearchClusterPipelineRequest.opensearchClusterPipelineId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "if-match": deleteOpensearchClusterPipelineRequest.ifMatch,
+                "opc-request-id": deleteOpensearchClusterPipelineRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, deleteOpensearchClusterPipelineRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/opensearchClusterPipelines/{opensearchClusterPipelineId}",
+                method: "DELETE",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * Gets a OpensearchCluster Pipeline by identifier
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetOpensearchClusterPipelineRequest
+     * @return GetOpensearchClusterPipelineResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/opensearch/GetOpensearchClusterPipeline.ts.html |here} to see how to use GetOpensearchClusterPipeline API.
+     */
+    getOpensearchClusterPipeline(getOpensearchClusterPipelineRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation OpensearchClusterPipelineClient#getOpensearchClusterPipeline.");
+            const operationName = "getOpensearchClusterPipeline";
+            const apiReferenceLink = "";
+            const pathParams = {
+                "{opensearchClusterPipelineId}": getOpensearchClusterPipelineRequest.opensearchClusterPipelineId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": getOpensearchClusterPipelineRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, getOpensearchClusterPipelineRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/opensearchClusterPipelines/{opensearchClusterPipelineId}",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "opensearchClusterPipeline",
+                    bodyModel: model.OpensearchClusterPipeline,
+                    type: "model.OpensearchClusterPipeline",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * Returns a list of OpensearchClusterPipelines.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListOpensearchClusterPipelinesRequest
+     * @return ListOpensearchClusterPipelinesResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/opensearch/ListOpensearchClusterPipelines.ts.html |here} to see how to use ListOpensearchClusterPipelines API.
+     */
+    listOpensearchClusterPipelines(listOpensearchClusterPipelinesRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation OpensearchClusterPipelineClient#listOpensearchClusterPipelines.");
+            const operationName = "listOpensearchClusterPipelines";
+            const apiReferenceLink = "";
+            const pathParams = {};
+            const queryParams = {
+                "compartmentId": listOpensearchClusterPipelinesRequest.compartmentId,
+                "lifecycleState": listOpensearchClusterPipelinesRequest.lifecycleState,
+                "pipelineComponentId": listOpensearchClusterPipelinesRequest.pipelineComponentId,
+                "displayName": listOpensearchClusterPipelinesRequest.displayName,
+                "id": listOpensearchClusterPipelinesRequest.id,
+                "limit": listOpensearchClusterPipelinesRequest.limit,
+                "page": listOpensearchClusterPipelinesRequest.page,
+                "sortOrder": listOpensearchClusterPipelinesRequest.sortOrder,
+                "sortBy": listOpensearchClusterPipelinesRequest.sortBy
+            };
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": listOpensearchClusterPipelinesRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, listOpensearchClusterPipelinesRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/opensearchClusterPipelines",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "opensearchClusterPipelineCollection",
+                    bodyModel: model.OpensearchClusterPipelineCollection,
+                    type: "model.OpensearchClusterPipelineCollection",
+                    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;
+            }
+        });
+    }
+    /**
+     * Updates the OpensearchCluster Pipeline
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateOpensearchClusterPipelineRequest
+     * @return UpdateOpensearchClusterPipelineResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/opensearch/UpdateOpensearchClusterPipeline.ts.html |here} to see how to use UpdateOpensearchClusterPipeline API.
+     */
+    updateOpensearchClusterPipeline(updateOpensearchClusterPipelineRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation OpensearchClusterPipelineClient#updateOpensearchClusterPipeline.");
+            const operationName = "updateOpensearchClusterPipeline";
+            const apiReferenceLink = "";
+            const pathParams = {
+                "{opensearchClusterPipelineId}": updateOpensearchClusterPipelineRequest.opensearchClusterPipelineId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "if-match": updateOpensearchClusterPipelineRequest.ifMatch,
+                "opc-request-id": updateOpensearchClusterPipelineRequest.opcRequestId,
+                "opc-dry-run": updateOpensearchClusterPipelineRequest.opcDryRun
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, updateOpensearchClusterPipelineRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/opensearchClusterPipelines/{opensearchClusterPipelineId}",
+                method: "PUT",
+                bodyContent: common.ObjectSerializer.serialize(updateOpensearchClusterPipelineRequest.updateOpensearchClusterPipelineDetails, "UpdateOpensearchClusterPipelineDetails", model.UpdateOpensearchClusterPipelineDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-work-request-id"),
+                            key: "opcWorkRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+}
+exports.OpensearchClusterPipelineClient = OpensearchClusterPipelineClient;
+OpensearchClusterPipelineClient.serviceEndpointTemplate = "https://search-indexing.{region}.oci.{secondLevelDomain}";
+OpensearchClusterPipelineClient.endpointServiceName = "";
 //# sourceMappingURL=client.js.map