oci-redis 2.130.0 → 2.131.0

package/index.d.ts

@@ -14,6 +14,7 @@ import * as requests from "./lib/request";
 import * as models from "./lib/model";
 import * as responses from "./lib/response";
 import * as client from "./lib/client";
+import * as ocicachebackup_waiter from "./lib/ocicachebackup-waiter";
 import * as ocicacheconfigset_waiter from "./lib/ocicacheconfigset-waiter";
 import * as ocicachedefaultconfigset_waiter from "./lib/ocicachedefaultconfigset-waiter";
 import * as ocicacheuser_waiter from "./lib/ocicacheuser-waiter";
@@ -21,6 +22,8 @@ import * as rediscluster_waiter from "./lib/rediscluster-waiter";
 export { models };
 export { requests };
 export { responses };
+export import OciCacheBackupClient = client.OciCacheBackupClient;
+export import OciCacheBackupWaiter = ocicachebackup_waiter.OciCacheBackupWaiter;
 export import OciCacheConfigSetClient = client.OciCacheConfigSetClient;
 export import OciCacheConfigSetWaiter = ocicacheconfigset_waiter.OciCacheConfigSetWaiter;
 export import OciCacheDefaultConfigSetClient = client.OciCacheDefaultConfigSetClient;

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.OciCacheEngineOptionsClient = 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.OciCacheBackupWaiter = exports.OciCacheBackupClient = exports.responses = exports.requests = exports.models = void 0;
 const requests = __importStar(require("./lib/request"));
 exports.requests = requests;
 const models = __importStar(require("./lib/model"));
@@ -39,10 +39,13 @@ exports.models = models;
 const responses = __importStar(require("./lib/response"));
 exports.responses = responses;
 const client = __importStar(require("./lib/client"));
+const ocicachebackup_waiter = __importStar(require("./lib/ocicachebackup-waiter"));
 const ocicacheconfigset_waiter = __importStar(require("./lib/ocicacheconfigset-waiter"));
 const ocicachedefaultconfigset_waiter = __importStar(require("./lib/ocicachedefaultconfigset-waiter"));
 const ocicacheuser_waiter = __importStar(require("./lib/ocicacheuser-waiter"));
 const rediscluster_waiter = __importStar(require("./lib/rediscluster-waiter"));
+exports.OciCacheBackupClient = client.OciCacheBackupClient;
+exports.OciCacheBackupWaiter = ocicachebackup_waiter.OciCacheBackupWaiter;
 exports.OciCacheConfigSetClient = client.OciCacheConfigSetClient;
 exports.OciCacheConfigSetWaiter = ocicacheconfigset_waiter.OciCacheConfigSetWaiter;
 exports.OciCacheDefaultConfigSetClient = client.OciCacheDefaultConfigSetClient;

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,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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/redis/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAWjC,4BAAQ;AAVjB,oDAAsC;AAS7B,wBAAM;AARf,0DAA4C;AAUnC,8BAAS;AATlB,qDAAuC;AACvC,mFAAqE;AACrE,yFAA2E;AAC3E,uGAAyF;AACzF,+EAAiE;AACjE,+EAAiE;AAKnD,QAAA,oBAAoB,GAAG,MAAM,CAAC,oBAAoB,CAAC;AACnD,QAAA,oBAAoB,GAAG,qBAAqB,CAAC,oBAAoB,CAAC;AAClE,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

@@ -14,11 +14,156 @@ import common = require("oci-common");
 import * as requests from "./request";
 import * as model from "./model";
 import * as responses from "./response";
+import { OciCacheBackupWaiter } from "./ocicachebackup-waiter";
 import { OciCacheConfigSetWaiter } from "./ocicacheconfigset-waiter";
 import { OciCacheDefaultConfigSetWaiter } from "./ocicachedefaultconfigset-waiter";
 import { OciCacheUserWaiter } from "./ocicacheuser-waiter";
 import { RedisClusterWaiter } from "./rediscluster-waiter";
 declare const Breaker: any;
+export declare enum OciCacheBackupApiKeys {
+}
+/**
+ * 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 OciCacheBackupClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": OciCacheBackupWaiter;
+    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);
+    /**
+     * Creates a new OciCacheBackupWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): OciCacheBackupWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): OciCacheBackupWaiter;
+    /**
+     * 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;
+    /**
+     * Moves an OCI Cache Backup resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ChangeOciCacheBackupCompartmentRequest
+     * @return ChangeOciCacheBackupCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/ChangeOciCacheBackupCompartment.ts.html |here} to see how to use ChangeOciCacheBackupCompartment API.
+     */
+    changeOciCacheBackupCompartment(changeOciCacheBackupCompartmentRequest: requests.ChangeOciCacheBackupCompartmentRequest): Promise<responses.ChangeOciCacheBackupCompartmentResponse>;
+    /**
+     * Creates a new OCI Cache Backup.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateOciCacheBackupRequest
+     * @return CreateOciCacheBackupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/CreateOciCacheBackup.ts.html |here} to see how to use CreateOciCacheBackup API.
+     */
+    createOciCacheBackup(createOciCacheBackupRequest: requests.CreateOciCacheBackupRequest): Promise<responses.CreateOciCacheBackupResponse>;
+    /**
+     * Deletes an OCI Cache Backup resource by identifier
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteOciCacheBackupRequest
+     * @return DeleteOciCacheBackupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/DeleteOciCacheBackup.ts.html |here} to see how to use DeleteOciCacheBackup API.
+     */
+    deleteOciCacheBackup(deleteOciCacheBackupRequest: requests.DeleteOciCacheBackupRequest): Promise<responses.DeleteOciCacheBackupResponse>;
+    /**
+     * Initiates an asynchronous export of the backup\u2019s RDB file(s) to the specified Object Storage bucket. The service generates the object names. For sharded backups, one object is written per shard under the optional prefix.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ExportOciCacheBackupToObjectStorageRequest
+     * @return ExportOciCacheBackupToObjectStorageResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/ExportOciCacheBackupToObjectStorage.ts.html |here} to see how to use ExportOciCacheBackupToObjectStorage API.
+     */
+    exportOciCacheBackupToObjectStorage(exportOciCacheBackupToObjectStorageRequest: requests.ExportOciCacheBackupToObjectStorageRequest): Promise<responses.ExportOciCacheBackupToObjectStorageResponse>;
+    /**
+     * Gets an OCI Cache Backup by identifier
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetOciCacheBackupRequest
+     * @return GetOciCacheBackupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/GetOciCacheBackup.ts.html |here} to see how to use GetOciCacheBackup API.
+     */
+    getOciCacheBackup(getOciCacheBackupRequest: requests.GetOciCacheBackupRequest): Promise<responses.GetOciCacheBackupResponse>;
+    /**
+     * Returns a list of OCI Cache Backups.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListOciCacheBackupsRequest
+     * @return ListOciCacheBackupsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/ListOciCacheBackups.ts.html |here} to see how to use ListOciCacheBackups API.
+     */
+    listOciCacheBackups(listOciCacheBackupsRequest: requests.ListOciCacheBackupsRequest): Promise<responses.ListOciCacheBackupsResponse>;
+    /**
+     * Updates the OCI Cache Backup
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateOciCacheBackupRequest
+     * @return UpdateOciCacheBackupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/redis/UpdateOciCacheBackup.ts.html |here} to see how to use UpdateOciCacheBackup API.
+     */
+    updateOciCacheBackup(updateOciCacheBackupRequest: requests.UpdateOciCacheBackupRequest): Promise<responses.UpdateOciCacheBackupResponse>;
+}
 export declare enum OciCacheConfigSetApiKeys {
 }
 /**
@@ -621,7 +766,9 @@ export declare class RedisClusterClient {
      */
     changeRedisClusterCompartment(changeRedisClusterCompartmentRequest: requests.ChangeRedisClusterCompartmentRequest): Promise<responses.ChangeRedisClusterCompartmentResponse>;
     /**
-     * Creates a new OCI Cache cluster. A cluster is a memory-based storage solution. For more information, see [OCI Cache](https://docs.oracle.com/iaas/Content/ocicache/home.htm).
+     * Creates a new OCI Cache cluster. A cluster is a memory-based storage solution.
+     * You can optionally initialize the cluster data by restoring from an OCI Cache Backup (backupId) or by importing from Object Storage RDB file(s) (importFromObjectStorageDetails).
+     * For more information, see [OCI Cache](https://docs.oracle.com/iaas/Content/ocicache/home.htm).
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param CreateRedisClusterRequest