oci-redis 2.125.3 → 2.126.1

package/index.d.ts

@@ -25,6 +25,7 @@ export import OciCacheConfigSetClient = client.OciCacheConfigSetClient;
 export import OciCacheConfigSetWaiter = ocicacheconfigset_waiter.OciCacheConfigSetWaiter;
 export import OciCacheDefaultConfigSetClient = client.OciCacheDefaultConfigSetClient;
 export import OciCacheDefaultConfigSetWaiter = ocicachedefaultconfigset_waiter.OciCacheDefaultConfigSetWaiter;
+export import OciCacheEngineOptionsClient = client.OciCacheEngineOptionsClient;
 export import OciCacheUserClient = client.OciCacheUserClient;
 export import OciCacheUserWaiter = ocicacheuser_waiter.OciCacheUserWaiter;
 export import RedisClusterClient = client.RedisClusterClient;

package/index.js

@@ -31,7 +31,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisIdentityClient = exports.RedisClusterWaiter = exports.RedisClusterClient = exports.OciCacheUserWaiter = exports.OciCacheUserClient = exports.OciCacheDefaultConfigSetWaiter = exports.OciCacheDefaultConfigSetClient = exports.OciCacheConfigSetWaiter = exports.OciCacheConfigSetClient = exports.responses = exports.requests = exports.models = void 0;
+exports.RedisIdentityClient = exports.RedisClusterWaiter = exports.RedisClusterClient = exports.OciCacheUserWaiter = exports.OciCacheUserClient = exports.OciCacheEngineOptionsClient = exports.OciCacheDefaultConfigSetWaiter = exports.OciCacheDefaultConfigSetClient = exports.OciCacheConfigSetWaiter = exports.OciCacheConfigSetClient = exports.responses = exports.requests = exports.models = void 0;
 const requests = __importStar(require("./lib/request"));
 exports.requests = requests;
 const models = __importStar(require("./lib/model"));
@@ -47,6 +47,7 @@ exports.OciCacheConfigSetClient = client.OciCacheConfigSetClient;
 exports.OciCacheConfigSetWaiter = ocicacheconfigset_waiter.OciCacheConfigSetWaiter;
 exports.OciCacheDefaultConfigSetClient = client.OciCacheDefaultConfigSetClient;
 exports.OciCacheDefaultConfigSetWaiter = ocicachedefaultconfigset_waiter.OciCacheDefaultConfigSetWaiter;
+exports.OciCacheEngineOptionsClient = client.OciCacheEngineOptionsClient;
 exports.OciCacheUserClient = client.OciCacheUserClient;
 exports.OciCacheUserWaiter = ocicacheuser_waiter.OciCacheUserWaiter;
 exports.RedisClusterClient = client.RedisClusterClient;

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/redis/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAUjC,4BAAQ;AATjB,oDAAsC;AAQ7B,wBAAM;AAPf,0DAA4C;AASnC,8BAAS;AARlB,qDAAuC;AACvC,yFAA2E;AAC3E,uGAAyF;AACzF,+EAAiE;AACjE,+EAAiE;AAKnD,QAAA,uBAAuB,GAAG,MAAM,CAAC,uBAAuB,CAAC;AACzD,QAAA,uBAAuB,GAAG,wBAAwB,CAAC,uBAAuB,CAAC;AAC3E,QAAA,8BAA8B,GAAG,MAAM,CAAC,8BAA8B,CAAC;AACvE,QAAA,8BAA8B,GAAG,+BAA+B,CAAC,8BAA8B,CAAC;AAChG,QAAA,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,QAAA,kBAAkB,GAAG,mBAAmB,CAAC,kBAAkB,CAAC;AAC5D,QAAA,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,QAAA,kBAAkB,GAAG,mBAAmB,CAAC,kBAAkB,CAAC;AAC5D,QAAA,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/redis/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAUjC,4BAAQ;AATjB,oDAAsC;AAQ7B,wBAAM;AAPf,0DAA4C;AASnC,8BAAS;AARlB,qDAAuC;AACvC,yFAA2E;AAC3E,uGAAyF;AACzF,+EAAiE;AACjE,+EAAiE;AAKnD,QAAA,uBAAuB,GAAG,MAAM,CAAC,uBAAuB,CAAC;AACzD,QAAA,uBAAuB,GAAG,wBAAwB,CAAC,uBAAuB,CAAC;AAC3E,QAAA,8BAA8B,GAAG,MAAM,CAAC,8BAA8B,CAAC;AACvE,QAAA,8BAA8B,GAAG,+BAA+B,CAAC,8BAA8B,CAAC;AAChG,QAAA,2BAA2B,GAAG,MAAM,CAAC,2BAA2B,CAAC;AACjE,QAAA,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,QAAA,kBAAkB,GAAG,mBAAmB,CAAC,kBAAkB,CAAC;AAC5D,QAAA,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,QAAA,kBAAkB,GAAG,mBAAmB,CAAC,kBAAkB,CAAC;AAC5D,QAAA,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC"}

package/lib/client.d.ts

@@ -263,6 +263,82 @@ export declare class OciCacheDefaultConfigSetClient {
      */
     listOciCacheDefaultConfigSets(listOciCacheDefaultConfigSetsRequest: requests.ListOciCacheDefaultConfigSetsRequest): Promise<responses.ListOciCacheDefaultConfigSetsResponse>;
 }
+export declare enum OciCacheEngineOptionsApiKeys {
+}
+/**
+ * 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 OciCacheEngineOptionsClient {
+    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;
+    /**
+     * Lists OCI Cache Engine options
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListOciCacheEngineOptionsRequest
+     * @return ListOciCacheEngineOptionsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/ListOciCacheEngineOptions.ts.html |here} to see how to use ListOciCacheEngineOptions API.
+     */
+    listOciCacheEngineOptions(listOciCacheEngineOptionsRequest: requests.ListOciCacheEngineOptionsRequest): Promise<responses.ListOciCacheEngineOptionsResponse>;
+}
 export declare enum OciCacheUserApiKeys {
 }
 /**

package/lib/client.js

@@ -40,7 +40,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisIdentityClient = exports.RedisIdentityApiKeys = exports.RedisClusterClient = exports.RedisClusterApiKeys = exports.OciCacheUserClient = exports.OciCacheUserApiKeys = exports.OciCacheDefaultConfigSetClient = exports.OciCacheDefaultConfigSetApiKeys = exports.OciCacheConfigSetClient = exports.OciCacheConfigSetApiKeys = void 0;
+exports.RedisIdentityClient = exports.RedisIdentityApiKeys = exports.RedisClusterClient = exports.RedisClusterApiKeys = exports.OciCacheUserClient = exports.OciCacheUserApiKeys = exports.OciCacheEngineOptionsClient = exports.OciCacheEngineOptionsApiKeys = exports.OciCacheDefaultConfigSetClient = exports.OciCacheDefaultConfigSetApiKeys = exports.OciCacheConfigSetClient = exports.OciCacheConfigSetApiKeys = void 0;
 const common = require("oci-common");
 const model = __importStar(require("./model"));
 const oci_common_1 = require("oci-common");
@@ -969,6 +969,215 @@ class OciCacheDefaultConfigSetClient {
 exports.OciCacheDefaultConfigSetClient = OciCacheDefaultConfigSetClient;
 OciCacheDefaultConfigSetClient.serviceEndpointTemplate = "https://redis.{region}.oci.{secondLevelDomain}";
 OciCacheDefaultConfigSetClient.endpointServiceName = "";
+var OciCacheEngineOptionsApiKeys;
+(function (OciCacheEngineOptionsApiKeys) {
+})(OciCacheEngineOptionsApiKeys = exports.OciCacheEngineOptionsApiKeys || (exports.OciCacheEngineOptionsApiKeys = {}));
+/**
+ * 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 OciCacheEngineOptionsClient {
+    constructor(params, clientConfiguration) {
+        this["_realmSpecificEndpointTemplateEnabled"] = undefined;
+        this["_endpoint"] = "";
+        this["_defaultHeaders"] = {};
+        this._circuitBreaker = null;
+        this._httpOptions = undefined;
+        this._bodyDuplexMode = undefined;
+        this.targetService = "OciCacheEngineOptions";
+        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_2.developerToolConfiguration.isServiceEnabled("redis")) {
+            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("redis");
+        }
+        // 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 + "/20220315";
+        if (this.logger)
+            this.logger.info(`OciCacheEngineOptionsClient 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(OciCacheEngineOptionsClient.serviceEndpointTemplate, this._region, OciCacheEngineOptionsClient.endpointServiceName);
+        }
+        else if (this._lastSetRegionOrRegionId === common.Region.REGION_ID_STRING) {
+            this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(OciCacheEngineOptionsClient.serviceEndpointTemplate, this._regionId, OciCacheEngineOptionsClient.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(OciCacheEngineOptionsClient.serviceEndpointTemplate, region, OciCacheEngineOptionsClient.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(OciCacheEngineOptionsClient.serviceEndpointTemplate, regionId, OciCacheEngineOptionsClient.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();
+    }
+    /**
+     * Lists OCI Cache Engine options
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListOciCacheEngineOptionsRequest
+     * @return ListOciCacheEngineOptionsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/ListOciCacheEngineOptions.ts.html |here} to see how to use ListOciCacheEngineOptions API.
+     */
+    listOciCacheEngineOptions(listOciCacheEngineOptionsRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation OciCacheEngineOptionsClient#listOciCacheEngineOptions.");
+            const operationName = "listOciCacheEngineOptions";
+            const apiReferenceLink = "";
+            const pathParams = {};
+            const queryParams = {
+                "compartmentId": listOciCacheEngineOptionsRequest.compartmentId,
+                "limit": listOciCacheEngineOptionsRequest.limit,
+                "page": listOciCacheEngineOptionsRequest.page,
+                "sortOrder": listOciCacheEngineOptionsRequest.sortOrder,
+                "sortBy": listOciCacheEngineOptionsRequest.sortBy
+            };
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": listOciCacheEngineOptionsRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
+            const retrier = oci_common_2.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, listOciCacheEngineOptionsRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_2.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/ociCacheEngineOptions",
+                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_2.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "ociCacheEngineOptionsCollection",
+                    bodyModel: model.OciCacheEngineOptionsCollection,
+                    type: "model.OciCacheEngineOptionsCollection",
+                    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.OciCacheEngineOptionsClient = OciCacheEngineOptionsClient;
+OciCacheEngineOptionsClient.serviceEndpointTemplate = "https://redis.{region}.oci.{secondLevelDomain}";
+OciCacheEngineOptionsClient.endpointServiceName = "";
 var OciCacheUserApiKeys;
 (function (OciCacheUserApiKeys) {
 })(OciCacheUserApiKeys = exports.OciCacheUserApiKeys || (exports.OciCacheUserApiKeys = {}));