oci-filestorage 2.4.0 → 2.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +6 -0
- package/lib/client.d.ts +138 -25
- package/lib/client.js +215 -50
- package/lib/client.js.map +1 -1
- package/lib/request/change-file-system-compartment-request.d.ts +1 -1
- package/lib/request/change-mount-target-compartment-request.d.ts +1 -1
- package/lib/request/create-export-request.d.ts +1 -1
- package/lib/request/create-file-system-request.d.ts +1 -1
- package/lib/request/create-mount-target-request.d.ts +1 -1
- package/lib/request/create-snapshot-request.d.ts +1 -1
- package/lib/request/delete-export-request.d.ts +1 -1
- package/lib/request/delete-file-system-request.d.ts +1 -1
- package/lib/request/delete-mount-target-request.d.ts +1 -1
- package/lib/request/delete-snapshot-request.d.ts +1 -1
- package/lib/request/get-export-request.d.ts +1 -1
- package/lib/request/get-export-set-request.d.ts +1 -1
- package/lib/request/get-file-system-request.d.ts +1 -1
- package/lib/request/get-mount-target-request.d.ts +1 -1
- package/lib/request/get-snapshot-request.d.ts +1 -1
- package/lib/request/list-export-sets-request.d.ts +1 -1
- package/lib/request/list-exports-request.d.ts +1 -1
- package/lib/request/list-file-systems-request.d.ts +1 -1
- package/lib/request/list-mount-targets-request.d.ts +1 -1
- package/lib/request/list-snapshots-request.d.ts +1 -1
- package/lib/request/update-export-request.d.ts +1 -1
- package/lib/request/update-export-set-request.d.ts +1 -1
- package/lib/request/update-file-system-request.d.ts +1 -1
- package/lib/request/update-mount-target-request.d.ts +1 -1
- package/lib/request/update-snapshot-request.d.ts +1 -1
- package/package.json +3 -3
package/LICENSE.txt
CHANGED
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
|
|
2
|
+
|
|
3
|
+
This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 or Apache License 2.0. See below for license terms. You may choose either license.
|
|
4
|
+
|
|
5
|
+
____________________________
|
|
6
|
+
|
|
1
7
|
The Universal Permissive License (UPL), Version 1.0
|
|
2
8
|
|
|
3
9
|
Subject to the condition set forth below, permission is hereby granted to any
|
package/lib/client.d.ts
CHANGED
|
@@ -18,6 +18,9 @@ import * as responses from "./response";
|
|
|
18
18
|
import { FileStorageWaiter } from "./filestorage-waiter";
|
|
19
19
|
export declare enum FileStorageApiKeys {
|
|
20
20
|
}
|
|
21
|
+
/**
|
|
22
|
+
* This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
|
|
23
|
+
*/
|
|
21
24
|
export declare class FileStorageClient {
|
|
22
25
|
protected static serviceEndpointTemplate: string;
|
|
23
26
|
protected "_endpoint": string;
|
|
@@ -68,29 +71,32 @@ export declare class FileStorageClient {
|
|
|
68
71
|
/**
|
|
69
72
|
* 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)
|
|
70
73
|
*
|
|
74
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
71
75
|
* @param ChangeFileSystemCompartmentRequest
|
|
72
76
|
* @return ChangeFileSystemCompartmentResponse
|
|
73
77
|
* @throws OciError when an error occurs
|
|
74
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
78
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/ChangeFileSystemCompartment.ts.html |here} to see how to use ChangeFileSystemCompartment API.
|
|
75
79
|
*/
|
|
76
80
|
changeFileSystemCompartment(changeFileSystemCompartmentRequest: requests.ChangeFileSystemCompartmentRequest): Promise<responses.ChangeFileSystemCompartmentResponse>;
|
|
77
81
|
/**
|
|
78
82
|
* 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)
|
|
79
83
|
*
|
|
84
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
80
85
|
* @param ChangeMountTargetCompartmentRequest
|
|
81
86
|
* @return ChangeMountTargetCompartmentResponse
|
|
82
87
|
* @throws OciError when an error occurs
|
|
83
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
88
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/ChangeMountTargetCompartment.ts.html |here} to see how to use ChangeMountTargetCompartment API.
|
|
84
89
|
*/
|
|
85
90
|
changeMountTargetCompartment(changeMountTargetCompartmentRequest: requests.ChangeMountTargetCompartmentRequest): Promise<responses.ChangeMountTargetCompartmentResponse>;
|
|
86
91
|
/**
|
|
87
92
|
* Creates a new export in the specified export set, path, and
|
|
88
93
|
* file system.
|
|
89
94
|
*
|
|
95
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
90
96
|
* @param CreateExportRequest
|
|
91
97
|
* @return CreateExportResponse
|
|
92
98
|
* @throws OciError when an error occurs
|
|
93
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
99
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/CreateExport.ts.html |here} to see how to use CreateExport API.
|
|
94
100
|
*/
|
|
95
101
|
createExport(createExportRequest: requests.CreateExportRequest): Promise<responses.CreateExportResponse>;
|
|
96
102
|
/**
|
|
@@ -124,10 +130,11 @@ export declare class FileStorageClient {
|
|
|
124
130
|
* You can also retrieve a resource's OCID by using a List API operation on that resource
|
|
125
131
|
* type or by viewing the resource in the Console.
|
|
126
132
|
*
|
|
133
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
127
134
|
* @param CreateFileSystemRequest
|
|
128
135
|
* @return CreateFileSystemResponse
|
|
129
136
|
* @throws OciError when an error occurs
|
|
130
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
137
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/CreateFileSystem.ts.html |here} to see how to use CreateFileSystem API.
|
|
131
138
|
*/
|
|
132
139
|
createFileSystem(createFileSystemRequest: requests.CreateFileSystemRequest): Promise<responses.CreateFileSystemResponse>;
|
|
133
140
|
/**
|
|
@@ -164,29 +171,32 @@ export declare class FileStorageClient {
|
|
|
164
171
|
* You can also retrieve a resource's OCID by using a List API operation on that resource
|
|
165
172
|
* type, or by viewing the resource in the Console.
|
|
166
173
|
*
|
|
174
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
167
175
|
* @param CreateMountTargetRequest
|
|
168
176
|
* @return CreateMountTargetResponse
|
|
169
177
|
* @throws OciError when an error occurs
|
|
170
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
178
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/CreateMountTarget.ts.html |here} to see how to use CreateMountTarget API.
|
|
171
179
|
*/
|
|
172
180
|
createMountTarget(createMountTargetRequest: requests.CreateMountTargetRequest): Promise<responses.CreateMountTargetResponse>;
|
|
173
181
|
/**
|
|
174
182
|
* Creates a new snapshot of the specified file system. You
|
|
175
183
|
* can access the snapshot at `.snapshot/<name>`.
|
|
176
184
|
*
|
|
185
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
177
186
|
* @param CreateSnapshotRequest
|
|
178
187
|
* @return CreateSnapshotResponse
|
|
179
188
|
* @throws OciError when an error occurs
|
|
180
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
189
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/CreateSnapshot.ts.html |here} to see how to use CreateSnapshot API.
|
|
181
190
|
*/
|
|
182
191
|
createSnapshot(createSnapshotRequest: requests.CreateSnapshotRequest): Promise<responses.CreateSnapshotResponse>;
|
|
183
192
|
/**
|
|
184
193
|
* Deletes the specified export.
|
|
185
194
|
*
|
|
195
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
186
196
|
* @param DeleteExportRequest
|
|
187
197
|
* @return DeleteExportResponse
|
|
188
198
|
* @throws OciError when an error occurs
|
|
189
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
199
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/DeleteExport.ts.html |here} to see how to use DeleteExport API.
|
|
190
200
|
*/
|
|
191
201
|
deleteExport(deleteExportRequest: requests.DeleteExportRequest): Promise<responses.DeleteExportResponse>;
|
|
192
202
|
/**
|
|
@@ -194,81 +204,91 @@ export declare class FileStorageClient {
|
|
|
194
204
|
* verify that no remaining export resources still reference it. Deleting a
|
|
195
205
|
* file system also deletes all of its snapshots.
|
|
196
206
|
*
|
|
207
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
197
208
|
* @param DeleteFileSystemRequest
|
|
198
209
|
* @return DeleteFileSystemResponse
|
|
199
210
|
* @throws OciError when an error occurs
|
|
200
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
211
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/DeleteFileSystem.ts.html |here} to see how to use DeleteFileSystem API.
|
|
201
212
|
*/
|
|
202
213
|
deleteFileSystem(deleteFileSystemRequest: requests.DeleteFileSystemRequest): Promise<responses.DeleteFileSystemResponse>;
|
|
203
214
|
/**
|
|
204
215
|
* Deletes the specified mount target. This operation also deletes the
|
|
205
216
|
* mount target's VNICs.
|
|
206
217
|
*
|
|
218
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
207
219
|
* @param DeleteMountTargetRequest
|
|
208
220
|
* @return DeleteMountTargetResponse
|
|
209
221
|
* @throws OciError when an error occurs
|
|
210
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
222
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/DeleteMountTarget.ts.html |here} to see how to use DeleteMountTarget API.
|
|
211
223
|
*/
|
|
212
224
|
deleteMountTarget(deleteMountTargetRequest: requests.DeleteMountTargetRequest): Promise<responses.DeleteMountTargetResponse>;
|
|
213
225
|
/**
|
|
214
226
|
* Deletes the specified snapshot.
|
|
215
227
|
*
|
|
228
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
216
229
|
* @param DeleteSnapshotRequest
|
|
217
230
|
* @return DeleteSnapshotResponse
|
|
218
231
|
* @throws OciError when an error occurs
|
|
219
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
232
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/DeleteSnapshot.ts.html |here} to see how to use DeleteSnapshot API.
|
|
220
233
|
*/
|
|
221
234
|
deleteSnapshot(deleteSnapshotRequest: requests.DeleteSnapshotRequest): Promise<responses.DeleteSnapshotResponse>;
|
|
222
235
|
/**
|
|
223
236
|
* Gets the specified export's information.
|
|
237
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
224
238
|
* @param GetExportRequest
|
|
225
239
|
* @return GetExportResponse
|
|
226
240
|
* @throws OciError when an error occurs
|
|
227
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
241
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/GetExport.ts.html |here} to see how to use GetExport API.
|
|
228
242
|
*/
|
|
229
243
|
getExport(getExportRequest: requests.GetExportRequest): Promise<responses.GetExportResponse>;
|
|
230
244
|
/**
|
|
231
245
|
* Gets the specified export set's information.
|
|
246
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
232
247
|
* @param GetExportSetRequest
|
|
233
248
|
* @return GetExportSetResponse
|
|
234
249
|
* @throws OciError when an error occurs
|
|
235
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
250
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/GetExportSet.ts.html |here} to see how to use GetExportSet API.
|
|
236
251
|
*/
|
|
237
252
|
getExportSet(getExportSetRequest: requests.GetExportSetRequest): Promise<responses.GetExportSetResponse>;
|
|
238
253
|
/**
|
|
239
254
|
* Gets the specified file system's information.
|
|
255
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
240
256
|
* @param GetFileSystemRequest
|
|
241
257
|
* @return GetFileSystemResponse
|
|
242
258
|
* @throws OciError when an error occurs
|
|
243
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
259
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/GetFileSystem.ts.html |here} to see how to use GetFileSystem API.
|
|
244
260
|
*/
|
|
245
261
|
getFileSystem(getFileSystemRequest: requests.GetFileSystemRequest): Promise<responses.GetFileSystemResponse>;
|
|
246
262
|
/**
|
|
247
263
|
* Gets the specified mount target's information.
|
|
264
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
248
265
|
* @param GetMountTargetRequest
|
|
249
266
|
* @return GetMountTargetResponse
|
|
250
267
|
* @throws OciError when an error occurs
|
|
251
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
268
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/GetMountTarget.ts.html |here} to see how to use GetMountTarget API.
|
|
252
269
|
*/
|
|
253
270
|
getMountTarget(getMountTargetRequest: requests.GetMountTargetRequest): Promise<responses.GetMountTargetResponse>;
|
|
254
271
|
/**
|
|
255
272
|
* Gets the specified snapshot's information.
|
|
273
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
256
274
|
* @param GetSnapshotRequest
|
|
257
275
|
* @return GetSnapshotResponse
|
|
258
276
|
* @throws OciError when an error occurs
|
|
259
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
277
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/GetSnapshot.ts.html |here} to see how to use GetSnapshot API.
|
|
260
278
|
*/
|
|
261
279
|
getSnapshot(getSnapshotRequest: requests.GetSnapshotRequest): Promise<responses.GetSnapshotResponse>;
|
|
262
280
|
/**
|
|
263
281
|
* Lists the export set resources in the specified compartment.
|
|
264
282
|
*
|
|
283
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
265
284
|
* @param ListExportSetsRequest
|
|
266
285
|
* @return ListExportSetsResponse
|
|
267
286
|
* @throws OciError when an error occurs
|
|
268
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
287
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/ListExportSets.ts.html |here} to see how to use ListExportSets API.
|
|
269
288
|
*/
|
|
270
289
|
listExportSets(listExportSetsRequest: requests.ListExportSetsRequest): Promise<responses.ListExportSetsResponse>;
|
|
271
290
|
/**
|
|
291
|
+
* NOTE: This function is deprecated in favor of listExportSetsRecordIterator function.
|
|
272
292
|
* Creates a new async iterator which will iterate over the models.ExportSetSummary objects
|
|
273
293
|
* contained in responses from the listExportSets operation. This iterator will fetch more data from the
|
|
274
294
|
* server as needed.
|
|
@@ -277,24 +297,42 @@ export declare class FileStorageClient {
|
|
|
277
297
|
*/
|
|
278
298
|
listAllExportSets(request: requests.ListExportSetsRequest): AsyncIterableIterator<model.ExportSetSummary>;
|
|
279
299
|
/**
|
|
300
|
+
* NOTE: This function is deprecated in favor of listExportSetsResponseIterator function.
|
|
280
301
|
* Creates a new async iterator which will iterate over the responses received from the listExportSets operation. This iterator
|
|
281
302
|
* will fetch more data from the server as needed.
|
|
282
303
|
*
|
|
283
304
|
* @param request a request which can be sent to the service operation
|
|
284
305
|
*/
|
|
285
306
|
listAllExportSetsResponses(request: requests.ListExportSetsRequest): AsyncIterableIterator<responses.ListExportSetsResponse>;
|
|
307
|
+
/**
|
|
308
|
+
* Creates a new async iterator which will iterate over the models.ExportSetSummary objects
|
|
309
|
+
* contained in responses from the listExportSets operation. This iterator will fetch more data from the
|
|
310
|
+
* server as needed.
|
|
311
|
+
*
|
|
312
|
+
* @param request a request which can be sent to the service operation
|
|
313
|
+
*/
|
|
314
|
+
listExportSetsRecordIterator(request: requests.ListExportSetsRequest): AsyncIterableIterator<model.ExportSetSummary>;
|
|
315
|
+
/**
|
|
316
|
+
* Creates a new async iterator which will iterate over the responses received from the listExportSets operation. This iterator
|
|
317
|
+
* will fetch more data from the server as needed.
|
|
318
|
+
*
|
|
319
|
+
* @param request a request which can be sent to the service operation
|
|
320
|
+
*/
|
|
321
|
+
listExportSetsResponseIterator(request: requests.ListExportSetsRequest): AsyncIterableIterator<responses.ListExportSetsResponse>;
|
|
286
322
|
/**
|
|
287
323
|
* Lists export resources by compartment, file system, or export
|
|
288
324
|
* set. You must specify an export set ID, a file system ID, and
|
|
289
325
|
* / or a compartment ID.
|
|
290
326
|
*
|
|
327
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
291
328
|
* @param ListExportsRequest
|
|
292
329
|
* @return ListExportsResponse
|
|
293
330
|
* @throws OciError when an error occurs
|
|
294
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
331
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/ListExports.ts.html |here} to see how to use ListExports API.
|
|
295
332
|
*/
|
|
296
333
|
listExports(listExportsRequest: requests.ListExportsRequest): Promise<responses.ListExportsResponse>;
|
|
297
334
|
/**
|
|
335
|
+
* NOTE: This function is deprecated in favor of listExportsRecordIterator function.
|
|
298
336
|
* Creates a new async iterator which will iterate over the models.ExportSummary objects
|
|
299
337
|
* contained in responses from the listExports operation. This iterator will fetch more data from the
|
|
300
338
|
* server as needed.
|
|
@@ -303,22 +341,40 @@ export declare class FileStorageClient {
|
|
|
303
341
|
*/
|
|
304
342
|
listAllExports(request: requests.ListExportsRequest): AsyncIterableIterator<model.ExportSummary>;
|
|
305
343
|
/**
|
|
344
|
+
* NOTE: This function is deprecated in favor of listExportsResponseIterator function.
|
|
306
345
|
* Creates a new async iterator which will iterate over the responses received from the listExports operation. This iterator
|
|
307
346
|
* will fetch more data from the server as needed.
|
|
308
347
|
*
|
|
309
348
|
* @param request a request which can be sent to the service operation
|
|
310
349
|
*/
|
|
311
350
|
listAllExportsResponses(request: requests.ListExportsRequest): AsyncIterableIterator<responses.ListExportsResponse>;
|
|
351
|
+
/**
|
|
352
|
+
* Creates a new async iterator which will iterate over the models.ExportSummary objects
|
|
353
|
+
* contained in responses from the listExports operation. This iterator will fetch more data from the
|
|
354
|
+
* server as needed.
|
|
355
|
+
*
|
|
356
|
+
* @param request a request which can be sent to the service operation
|
|
357
|
+
*/
|
|
358
|
+
listExportsRecordIterator(request: requests.ListExportsRequest): AsyncIterableIterator<model.ExportSummary>;
|
|
359
|
+
/**
|
|
360
|
+
* Creates a new async iterator which will iterate over the responses received from the listExports operation. This iterator
|
|
361
|
+
* will fetch more data from the server as needed.
|
|
362
|
+
*
|
|
363
|
+
* @param request a request which can be sent to the service operation
|
|
364
|
+
*/
|
|
365
|
+
listExportsResponseIterator(request: requests.ListExportsRequest): AsyncIterableIterator<responses.ListExportsResponse>;
|
|
312
366
|
/**
|
|
313
367
|
* Lists the file system resources in the specified compartment.
|
|
314
368
|
*
|
|
369
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
315
370
|
* @param ListFileSystemsRequest
|
|
316
371
|
* @return ListFileSystemsResponse
|
|
317
372
|
* @throws OciError when an error occurs
|
|
318
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
373
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/ListFileSystems.ts.html |here} to see how to use ListFileSystems API.
|
|
319
374
|
*/
|
|
320
375
|
listFileSystems(listFileSystemsRequest: requests.ListFileSystemsRequest): Promise<responses.ListFileSystemsResponse>;
|
|
321
376
|
/**
|
|
377
|
+
* NOTE: This function is deprecated in favor of listFileSystemsRecordIterator function.
|
|
322
378
|
* Creates a new async iterator which will iterate over the models.FileSystemSummary objects
|
|
323
379
|
* contained in responses from the listFileSystems operation. This iterator will fetch more data from the
|
|
324
380
|
* server as needed.
|
|
@@ -327,22 +383,40 @@ export declare class FileStorageClient {
|
|
|
327
383
|
*/
|
|
328
384
|
listAllFileSystems(request: requests.ListFileSystemsRequest): AsyncIterableIterator<model.FileSystemSummary>;
|
|
329
385
|
/**
|
|
386
|
+
* NOTE: This function is deprecated in favor of listFileSystemsResponseIterator function.
|
|
330
387
|
* Creates a new async iterator which will iterate over the responses received from the listFileSystems operation. This iterator
|
|
331
388
|
* will fetch more data from the server as needed.
|
|
332
389
|
*
|
|
333
390
|
* @param request a request which can be sent to the service operation
|
|
334
391
|
*/
|
|
335
392
|
listAllFileSystemsResponses(request: requests.ListFileSystemsRequest): AsyncIterableIterator<responses.ListFileSystemsResponse>;
|
|
393
|
+
/**
|
|
394
|
+
* Creates a new async iterator which will iterate over the models.FileSystemSummary objects
|
|
395
|
+
* contained in responses from the listFileSystems operation. This iterator will fetch more data from the
|
|
396
|
+
* server as needed.
|
|
397
|
+
*
|
|
398
|
+
* @param request a request which can be sent to the service operation
|
|
399
|
+
*/
|
|
400
|
+
listFileSystemsRecordIterator(request: requests.ListFileSystemsRequest): AsyncIterableIterator<model.FileSystemSummary>;
|
|
401
|
+
/**
|
|
402
|
+
* Creates a new async iterator which will iterate over the responses received from the listFileSystems operation. This iterator
|
|
403
|
+
* will fetch more data from the server as needed.
|
|
404
|
+
*
|
|
405
|
+
* @param request a request which can be sent to the service operation
|
|
406
|
+
*/
|
|
407
|
+
listFileSystemsResponseIterator(request: requests.ListFileSystemsRequest): AsyncIterableIterator<responses.ListFileSystemsResponse>;
|
|
336
408
|
/**
|
|
337
409
|
* Lists the mount target resources in the specified compartment.
|
|
338
410
|
*
|
|
411
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
339
412
|
* @param ListMountTargetsRequest
|
|
340
413
|
* @return ListMountTargetsResponse
|
|
341
414
|
* @throws OciError when an error occurs
|
|
342
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
415
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/ListMountTargets.ts.html |here} to see how to use ListMountTargets API.
|
|
343
416
|
*/
|
|
344
417
|
listMountTargets(listMountTargetsRequest: requests.ListMountTargetsRequest): Promise<responses.ListMountTargetsResponse>;
|
|
345
418
|
/**
|
|
419
|
+
* NOTE: This function is deprecated in favor of listMountTargetsRecordIterator function.
|
|
346
420
|
* Creates a new async iterator which will iterate over the models.MountTargetSummary objects
|
|
347
421
|
* contained in responses from the listMountTargets operation. This iterator will fetch more data from the
|
|
348
422
|
* server as needed.
|
|
@@ -351,22 +425,40 @@ export declare class FileStorageClient {
|
|
|
351
425
|
*/
|
|
352
426
|
listAllMountTargets(request: requests.ListMountTargetsRequest): AsyncIterableIterator<model.MountTargetSummary>;
|
|
353
427
|
/**
|
|
428
|
+
* NOTE: This function is deprecated in favor of listMountTargetsResponseIterator function.
|
|
354
429
|
* Creates a new async iterator which will iterate over the responses received from the listMountTargets operation. This iterator
|
|
355
430
|
* will fetch more data from the server as needed.
|
|
356
431
|
*
|
|
357
432
|
* @param request a request which can be sent to the service operation
|
|
358
433
|
*/
|
|
359
434
|
listAllMountTargetsResponses(request: requests.ListMountTargetsRequest): AsyncIterableIterator<responses.ListMountTargetsResponse>;
|
|
435
|
+
/**
|
|
436
|
+
* Creates a new async iterator which will iterate over the models.MountTargetSummary objects
|
|
437
|
+
* contained in responses from the listMountTargets operation. This iterator will fetch more data from the
|
|
438
|
+
* server as needed.
|
|
439
|
+
*
|
|
440
|
+
* @param request a request which can be sent to the service operation
|
|
441
|
+
*/
|
|
442
|
+
listMountTargetsRecordIterator(request: requests.ListMountTargetsRequest): AsyncIterableIterator<model.MountTargetSummary>;
|
|
443
|
+
/**
|
|
444
|
+
* Creates a new async iterator which will iterate over the responses received from the listMountTargets operation. This iterator
|
|
445
|
+
* will fetch more data from the server as needed.
|
|
446
|
+
*
|
|
447
|
+
* @param request a request which can be sent to the service operation
|
|
448
|
+
*/
|
|
449
|
+
listMountTargetsResponseIterator(request: requests.ListMountTargetsRequest): AsyncIterableIterator<responses.ListMountTargetsResponse>;
|
|
360
450
|
/**
|
|
361
451
|
* Lists snapshots of the specified file system.
|
|
362
452
|
*
|
|
453
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
363
454
|
* @param ListSnapshotsRequest
|
|
364
455
|
* @return ListSnapshotsResponse
|
|
365
456
|
* @throws OciError when an error occurs
|
|
366
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
457
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/ListSnapshots.ts.html |here} to see how to use ListSnapshots API.
|
|
367
458
|
*/
|
|
368
459
|
listSnapshots(listSnapshotsRequest: requests.ListSnapshotsRequest): Promise<responses.ListSnapshotsResponse>;
|
|
369
460
|
/**
|
|
461
|
+
* NOTE: This function is deprecated in favor of listSnapshotsRecordIterator function.
|
|
370
462
|
* Creates a new async iterator which will iterate over the models.SnapshotSummary objects
|
|
371
463
|
* contained in responses from the listSnapshots operation. This iterator will fetch more data from the
|
|
372
464
|
* server as needed.
|
|
@@ -375,52 +467,73 @@ export declare class FileStorageClient {
|
|
|
375
467
|
*/
|
|
376
468
|
listAllSnapshots(request: requests.ListSnapshotsRequest): AsyncIterableIterator<model.SnapshotSummary>;
|
|
377
469
|
/**
|
|
470
|
+
* NOTE: This function is deprecated in favor of listSnapshotsResponseIterator function.
|
|
378
471
|
* Creates a new async iterator which will iterate over the responses received from the listSnapshots operation. This iterator
|
|
379
472
|
* will fetch more data from the server as needed.
|
|
380
473
|
*
|
|
381
474
|
* @param request a request which can be sent to the service operation
|
|
382
475
|
*/
|
|
383
476
|
listAllSnapshotsResponses(request: requests.ListSnapshotsRequest): AsyncIterableIterator<responses.ListSnapshotsResponse>;
|
|
477
|
+
/**
|
|
478
|
+
* Creates a new async iterator which will iterate over the models.SnapshotSummary objects
|
|
479
|
+
* contained in responses from the listSnapshots operation. This iterator will fetch more data from the
|
|
480
|
+
* server as needed.
|
|
481
|
+
*
|
|
482
|
+
* @param request a request which can be sent to the service operation
|
|
483
|
+
*/
|
|
484
|
+
listSnapshotsRecordIterator(request: requests.ListSnapshotsRequest): AsyncIterableIterator<model.SnapshotSummary>;
|
|
485
|
+
/**
|
|
486
|
+
* Creates a new async iterator which will iterate over the responses received from the listSnapshots operation. This iterator
|
|
487
|
+
* will fetch more data from the server as needed.
|
|
488
|
+
*
|
|
489
|
+
* @param request a request which can be sent to the service operation
|
|
490
|
+
*/
|
|
491
|
+
listSnapshotsResponseIterator(request: requests.ListSnapshotsRequest): AsyncIterableIterator<responses.ListSnapshotsResponse>;
|
|
384
492
|
/**
|
|
385
493
|
* Updates the specified export's information.
|
|
494
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
386
495
|
* @param UpdateExportRequest
|
|
387
496
|
* @return UpdateExportResponse
|
|
388
497
|
* @throws OciError when an error occurs
|
|
389
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
498
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/UpdateExport.ts.html |here} to see how to use UpdateExport API.
|
|
390
499
|
*/
|
|
391
500
|
updateExport(updateExportRequest: requests.UpdateExportRequest): Promise<responses.UpdateExportResponse>;
|
|
392
501
|
/**
|
|
393
502
|
* Updates the specified export set's information.
|
|
503
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
394
504
|
* @param UpdateExportSetRequest
|
|
395
505
|
* @return UpdateExportSetResponse
|
|
396
506
|
* @throws OciError when an error occurs
|
|
397
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
507
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/UpdateExportSet.ts.html |here} to see how to use UpdateExportSet API.
|
|
398
508
|
*/
|
|
399
509
|
updateExportSet(updateExportSetRequest: requests.UpdateExportSetRequest): Promise<responses.UpdateExportSetResponse>;
|
|
400
510
|
/**
|
|
401
511
|
* Updates the specified file system's information.
|
|
402
512
|
* You can use this operation to rename a file system.
|
|
403
513
|
*
|
|
514
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
404
515
|
* @param UpdateFileSystemRequest
|
|
405
516
|
* @return UpdateFileSystemResponse
|
|
406
517
|
* @throws OciError when an error occurs
|
|
407
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
518
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/UpdateFileSystem.ts.html |here} to see how to use UpdateFileSystem API.
|
|
408
519
|
*/
|
|
409
520
|
updateFileSystem(updateFileSystemRequest: requests.UpdateFileSystemRequest): Promise<responses.UpdateFileSystemResponse>;
|
|
410
521
|
/**
|
|
411
522
|
* Updates the specified mount target's information.
|
|
523
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
412
524
|
* @param UpdateMountTargetRequest
|
|
413
525
|
* @return UpdateMountTargetResponse
|
|
414
526
|
* @throws OciError when an error occurs
|
|
415
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
527
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/UpdateMountTarget.ts.html |here} to see how to use UpdateMountTarget API.
|
|
416
528
|
*/
|
|
417
529
|
updateMountTarget(updateMountTargetRequest: requests.UpdateMountTargetRequest): Promise<responses.UpdateMountTargetResponse>;
|
|
418
530
|
/**
|
|
419
531
|
* Updates the specified snapshot's information.
|
|
532
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
420
533
|
* @param UpdateSnapshotRequest
|
|
421
534
|
* @return UpdateSnapshotResponse
|
|
422
535
|
* @throws OciError when an error occurs
|
|
423
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
536
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/filestorage/UpdateSnapshot.ts.html |here} to see how to use UpdateSnapshot API.
|
|
424
537
|
*/
|
|
425
538
|
updateSnapshot(updateSnapshotRequest: requests.UpdateSnapshotRequest): Promise<responses.UpdateSnapshotResponse>;
|
|
426
539
|
}
|