oci-filestorage 2.5.2 → 2.8.0

package/lib/client.d.ts

@@ -18,6 +18,9 @@ import * as responses from "./response";
 import { FileStorageWaiter } from "./filestorage-waiter";
 export declare enum FileStorageApiKeys {
 }
+/**
+ * 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 FileStorageClient {
     protected static serviceEndpointTemplate: string;
     protected "_endpoint": string;
@@ -68,29 +71,32 @@ export declare class FileStorageClient {
     /**
      * Moves a file system and its associated snapshots into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ChangeFileSystemCompartmentRequest
      * @return ChangeFileSystemCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/ChangeFileSystemCompartment.ts.html |here} to see how to use ChangeFileSystemCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/ChangeFileSystemCompartment.ts.html |here} to see how to use ChangeFileSystemCompartment API.
      */
     changeFileSystemCompartment(changeFileSystemCompartmentRequest: requests.ChangeFileSystemCompartmentRequest): Promise<responses.ChangeFileSystemCompartmentResponse>;
     /**
      * Moves a mount target and its associated export set into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ChangeMountTargetCompartmentRequest
      * @return ChangeMountTargetCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/ChangeMountTargetCompartment.ts.html |here} to see how to use ChangeMountTargetCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/ChangeMountTargetCompartment.ts.html |here} to see how to use ChangeMountTargetCompartment API.
      */
     changeMountTargetCompartment(changeMountTargetCompartmentRequest: requests.ChangeMountTargetCompartmentRequest): Promise<responses.ChangeMountTargetCompartmentResponse>;
     /**
      * Creates a new export in the specified export set, path, and
      * file system.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateExportRequest
      * @return CreateExportResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/CreateExport.ts.html |here} to see how to use CreateExport API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/CreateExport.ts.html |here} to see how to use CreateExport API.
      */
     createExport(createExportRequest: requests.CreateExportRequest): Promise<responses.CreateExportResponse>;
     /**
@@ -124,10 +130,11 @@ export declare class FileStorageClient {
   * You can also retrieve a resource's OCID by using a List API operation on that resource
   * type or by viewing the resource in the Console.
   *
+       * This operation does not retry by default if the user has not defined a retry configuration.
        * @param CreateFileSystemRequest
        * @return CreateFileSystemResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/CreateFileSystem.ts.html |here} to see how to use CreateFileSystem API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/CreateFileSystem.ts.html |here} to see how to use CreateFileSystem API.
        */
     createFileSystem(createFileSystemRequest: requests.CreateFileSystemRequest): Promise<responses.CreateFileSystemResponse>;
     /**
@@ -164,29 +171,32 @@ export declare class FileStorageClient {
   * You can also retrieve a resource's OCID by using a List API operation on that resource
   * type, or by viewing the resource in the Console.
   *
+       * This operation does not retry by default if the user has not defined a retry configuration.
        * @param CreateMountTargetRequest
        * @return CreateMountTargetResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/CreateMountTarget.ts.html |here} to see how to use CreateMountTarget API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/CreateMountTarget.ts.html |here} to see how to use CreateMountTarget API.
        */
     createMountTarget(createMountTargetRequest: requests.CreateMountTargetRequest): Promise<responses.CreateMountTargetResponse>;
     /**
      * Creates a new snapshot of the specified file system. You
      * can access the snapshot at `.snapshot/<name>`.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateSnapshotRequest
      * @return CreateSnapshotResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/CreateSnapshot.ts.html |here} to see how to use CreateSnapshot API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/CreateSnapshot.ts.html |here} to see how to use CreateSnapshot API.
      */
     createSnapshot(createSnapshotRequest: requests.CreateSnapshotRequest): Promise<responses.CreateSnapshotResponse>;
     /**
      * Deletes the specified export.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteExportRequest
      * @return DeleteExportResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/DeleteExport.ts.html |here} to see how to use DeleteExport API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/DeleteExport.ts.html |here} to see how to use DeleteExport API.
      */
     deleteExport(deleteExportRequest: requests.DeleteExportRequest): Promise<responses.DeleteExportResponse>;
     /**
@@ -194,78 +204,87 @@ export declare class FileStorageClient {
      * verify that no remaining export resources still reference it. Deleting a
      * file system also deletes all of its snapshots.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteFileSystemRequest
      * @return DeleteFileSystemResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/DeleteFileSystem.ts.html |here} to see how to use DeleteFileSystem API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/DeleteFileSystem.ts.html |here} to see how to use DeleteFileSystem API.
      */
     deleteFileSystem(deleteFileSystemRequest: requests.DeleteFileSystemRequest): Promise<responses.DeleteFileSystemResponse>;
     /**
      * Deletes the specified mount target. This operation also deletes the
      * mount target's VNICs.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteMountTargetRequest
      * @return DeleteMountTargetResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/DeleteMountTarget.ts.html |here} to see how to use DeleteMountTarget API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/DeleteMountTarget.ts.html |here} to see how to use DeleteMountTarget API.
      */
     deleteMountTarget(deleteMountTargetRequest: requests.DeleteMountTargetRequest): Promise<responses.DeleteMountTargetResponse>;
     /**
      * Deletes the specified snapshot.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteSnapshotRequest
      * @return DeleteSnapshotResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/DeleteSnapshot.ts.html |here} to see how to use DeleteSnapshot API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/DeleteSnapshot.ts.html |here} to see how to use DeleteSnapshot API.
      */
     deleteSnapshot(deleteSnapshotRequest: requests.DeleteSnapshotRequest): Promise<responses.DeleteSnapshotResponse>;
     /**
      * Gets the specified export's information.
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetExportRequest
      * @return GetExportResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/GetExport.ts.html |here} to see how to use GetExport API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/GetExport.ts.html |here} to see how to use GetExport API.
      */
     getExport(getExportRequest: requests.GetExportRequest): Promise<responses.GetExportResponse>;
     /**
      * Gets the specified export set's information.
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetExportSetRequest
      * @return GetExportSetResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/GetExportSet.ts.html |here} to see how to use GetExportSet API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/GetExportSet.ts.html |here} to see how to use GetExportSet API.
      */
     getExportSet(getExportSetRequest: requests.GetExportSetRequest): Promise<responses.GetExportSetResponse>;
     /**
      * Gets the specified file system's information.
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetFileSystemRequest
      * @return GetFileSystemResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/GetFileSystem.ts.html |here} to see how to use GetFileSystem API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/GetFileSystem.ts.html |here} to see how to use GetFileSystem API.
      */
     getFileSystem(getFileSystemRequest: requests.GetFileSystemRequest): Promise<responses.GetFileSystemResponse>;
     /**
      * Gets the specified mount target's information.
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetMountTargetRequest
      * @return GetMountTargetResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/GetMountTarget.ts.html |here} to see how to use GetMountTarget API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/GetMountTarget.ts.html |here} to see how to use GetMountTarget API.
      */
     getMountTarget(getMountTargetRequest: requests.GetMountTargetRequest): Promise<responses.GetMountTargetResponse>;
     /**
      * Gets the specified snapshot's information.
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetSnapshotRequest
      * @return GetSnapshotResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/GetSnapshot.ts.html |here} to see how to use GetSnapshot API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/GetSnapshot.ts.html |here} to see how to use GetSnapshot API.
      */
     getSnapshot(getSnapshotRequest: requests.GetSnapshotRequest): Promise<responses.GetSnapshotResponse>;
     /**
      * Lists the export set resources in the specified compartment.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListExportSetsRequest
      * @return ListExportSetsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/ListExportSets.ts.html |here} to see how to use ListExportSets API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/ListExportSets.ts.html |here} to see how to use ListExportSets API.
      */
     listExportSets(listExportSetsRequest: requests.ListExportSetsRequest): Promise<responses.ListExportSetsResponse>;
     /**
@@ -305,10 +324,11 @@ export declare class FileStorageClient {
      * set. You must specify an export set ID, a file system ID, and
      * / or a compartment ID.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListExportsRequest
      * @return ListExportsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/ListExports.ts.html |here} to see how to use ListExports API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/ListExports.ts.html |here} to see how to use ListExports API.
      */
     listExports(listExportsRequest: requests.ListExportsRequest): Promise<responses.ListExportsResponse>;
     /**
@@ -346,10 +366,11 @@ export declare class FileStorageClient {
     /**
      * Lists the file system resources in the specified compartment.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListFileSystemsRequest
      * @return ListFileSystemsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/ListFileSystems.ts.html |here} to see how to use ListFileSystems API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/ListFileSystems.ts.html |here} to see how to use ListFileSystems API.
      */
     listFileSystems(listFileSystemsRequest: requests.ListFileSystemsRequest): Promise<responses.ListFileSystemsResponse>;
     /**
@@ -387,10 +408,11 @@ export declare class FileStorageClient {
     /**
      * Lists the mount target resources in the specified compartment.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListMountTargetsRequest
      * @return ListMountTargetsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/ListMountTargets.ts.html |here} to see how to use ListMountTargets API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/ListMountTargets.ts.html |here} to see how to use ListMountTargets API.
      */
     listMountTargets(listMountTargetsRequest: requests.ListMountTargetsRequest): Promise<responses.ListMountTargetsResponse>;
     /**
@@ -428,10 +450,11 @@ export declare class FileStorageClient {
     /**
      * Lists snapshots of the specified file system.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListSnapshotsRequest
      * @return ListSnapshotsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/ListSnapshots.ts.html |here} to see how to use ListSnapshots API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/ListSnapshots.ts.html |here} to see how to use ListSnapshots API.
      */
     listSnapshots(listSnapshotsRequest: requests.ListSnapshotsRequest): Promise<responses.ListSnapshotsResponse>;
     /**
@@ -468,44 +491,49 @@ export declare class FileStorageClient {
     listSnapshotsResponseIterator(request: requests.ListSnapshotsRequest): AsyncIterableIterator<responses.ListSnapshotsResponse>;
     /**
      * Updates the specified export's information.
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateExportRequest
      * @return UpdateExportResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/UpdateExport.ts.html |here} to see how to use UpdateExport API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/UpdateExport.ts.html |here} to see how to use UpdateExport API.
      */
     updateExport(updateExportRequest: requests.UpdateExportRequest): Promise<responses.UpdateExportResponse>;
     /**
      * Updates the specified export set's information.
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateExportSetRequest
      * @return UpdateExportSetResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/UpdateExportSet.ts.html |here} to see how to use UpdateExportSet API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/UpdateExportSet.ts.html |here} to see how to use UpdateExportSet API.
      */
     updateExportSet(updateExportSetRequest: requests.UpdateExportSetRequest): Promise<responses.UpdateExportSetResponse>;
     /**
      * Updates the specified file system's information.
      * You can use this operation to rename a file system.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateFileSystemRequest
      * @return UpdateFileSystemResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/UpdateFileSystem.ts.html |here} to see how to use UpdateFileSystem API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/UpdateFileSystem.ts.html |here} to see how to use UpdateFileSystem API.
      */
     updateFileSystem(updateFileSystemRequest: requests.UpdateFileSystemRequest): Promise<responses.UpdateFileSystemResponse>;
     /**
      * Updates the specified mount target's information.
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateMountTargetRequest
      * @return UpdateMountTargetResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/UpdateMountTarget.ts.html |here} to see how to use UpdateMountTarget API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/UpdateMountTarget.ts.html |here} to see how to use UpdateMountTarget API.
      */
     updateMountTarget(updateMountTargetRequest: requests.UpdateMountTargetRequest): Promise<responses.UpdateMountTargetResponse>;
     /**
      * Updates the specified snapshot's information.
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateSnapshotRequest
      * @return UpdateSnapshotResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/filestorage/UpdateSnapshot.ts.html |here} to see how to use UpdateSnapshot API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/filestorage/UpdateSnapshot.ts.html |here} to see how to use UpdateSnapshot API.
      */
     updateSnapshot(updateSnapshotRequest: requests.UpdateSnapshotRequest): Promise<responses.UpdateSnapshotResponse>;
 }