@googleapis/vault 5.0.1 → 6.1.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/CHANGELOG.md +31 -0
- package/build/v1.d.ts +1847 -0
- package/build/v1.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +1847 -0
package/build/v1.d.ts
CHANGED
|
@@ -365,6 +365,10 @@ export declare namespace vault_v1 {
|
|
|
365
365
|
* Set to true to include Team Drive.
|
|
366
366
|
*/
|
|
367
367
|
includeTeamDrives?: boolean | null;
|
|
368
|
+
/**
|
|
369
|
+
* Optional. Options to include or exclude documents in shared drives. We recommend using this field over include_shared_drives. This field overrides include_shared_drives and include_team_drives when set.
|
|
370
|
+
*/
|
|
371
|
+
sharedDrivesOption?: string | null;
|
|
368
372
|
/**
|
|
369
373
|
* Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
|
|
370
374
|
*/
|
|
@@ -1152,6 +1156,63 @@ export declare namespace vault_v1 {
|
|
|
1152
1156
|
constructor(context: APIRequestContext);
|
|
1153
1157
|
/**
|
|
1154
1158
|
* Adds an account as a matter collaborator.
|
|
1159
|
+
* @example
|
|
1160
|
+
* ```js
|
|
1161
|
+
* // Before running the sample:
|
|
1162
|
+
* // - Enable the API at:
|
|
1163
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
1164
|
+
* // - Login into gcloud by running:
|
|
1165
|
+
* // ```sh
|
|
1166
|
+
* // $ gcloud auth application-default login
|
|
1167
|
+
* // ```
|
|
1168
|
+
* // - Install the npm module by running:
|
|
1169
|
+
* // ```sh
|
|
1170
|
+
* // $ npm install googleapis
|
|
1171
|
+
* // ```
|
|
1172
|
+
*
|
|
1173
|
+
* const {google} = require('googleapis');
|
|
1174
|
+
* const vault = google.vault('v1');
|
|
1175
|
+
*
|
|
1176
|
+
* async function main() {
|
|
1177
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1178
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1179
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
1180
|
+
* });
|
|
1181
|
+
*
|
|
1182
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1183
|
+
* const authClient = await auth.getClient();
|
|
1184
|
+
* google.options({auth: authClient});
|
|
1185
|
+
*
|
|
1186
|
+
* // Do the magic
|
|
1187
|
+
* const res = await vault.matters.addPermissions({
|
|
1188
|
+
* // The matter ID.
|
|
1189
|
+
* matterId: 'placeholder-value',
|
|
1190
|
+
*
|
|
1191
|
+
* // Request body metadata
|
|
1192
|
+
* requestBody: {
|
|
1193
|
+
* // request body parameters
|
|
1194
|
+
* // {
|
|
1195
|
+
* // "ccMe": false,
|
|
1196
|
+
* // "matterPermission": {},
|
|
1197
|
+
* // "sendEmails": false
|
|
1198
|
+
* // }
|
|
1199
|
+
* },
|
|
1200
|
+
* });
|
|
1201
|
+
* console.log(res.data);
|
|
1202
|
+
*
|
|
1203
|
+
* // Example response
|
|
1204
|
+
* // {
|
|
1205
|
+
* // "accountId": "my_accountId",
|
|
1206
|
+
* // "role": "my_role"
|
|
1207
|
+
* // }
|
|
1208
|
+
* }
|
|
1209
|
+
*
|
|
1210
|
+
* main().catch(e => {
|
|
1211
|
+
* console.error(e);
|
|
1212
|
+
* throw e;
|
|
1213
|
+
* });
|
|
1214
|
+
*
|
|
1215
|
+
* ```
|
|
1155
1216
|
*
|
|
1156
1217
|
* @param params - Parameters for request
|
|
1157
1218
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1166,6 +1227,58 @@ export declare namespace vault_v1 {
|
|
|
1166
1227
|
addPermissions(callback: BodyResponseCallback<Schema$MatterPermission>): void;
|
|
1167
1228
|
/**
|
|
1168
1229
|
* Closes the specified matter. Returns the matter with updated state.
|
|
1230
|
+
* @example
|
|
1231
|
+
* ```js
|
|
1232
|
+
* // Before running the sample:
|
|
1233
|
+
* // - Enable the API at:
|
|
1234
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
1235
|
+
* // - Login into gcloud by running:
|
|
1236
|
+
* // ```sh
|
|
1237
|
+
* // $ gcloud auth application-default login
|
|
1238
|
+
* // ```
|
|
1239
|
+
* // - Install the npm module by running:
|
|
1240
|
+
* // ```sh
|
|
1241
|
+
* // $ npm install googleapis
|
|
1242
|
+
* // ```
|
|
1243
|
+
*
|
|
1244
|
+
* const {google} = require('googleapis');
|
|
1245
|
+
* const vault = google.vault('v1');
|
|
1246
|
+
*
|
|
1247
|
+
* async function main() {
|
|
1248
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1249
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1250
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
1251
|
+
* });
|
|
1252
|
+
*
|
|
1253
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1254
|
+
* const authClient = await auth.getClient();
|
|
1255
|
+
* google.options({auth: authClient});
|
|
1256
|
+
*
|
|
1257
|
+
* // Do the magic
|
|
1258
|
+
* const res = await vault.matters.close({
|
|
1259
|
+
* // The matter ID.
|
|
1260
|
+
* matterId: 'placeholder-value',
|
|
1261
|
+
*
|
|
1262
|
+
* // Request body metadata
|
|
1263
|
+
* requestBody: {
|
|
1264
|
+
* // request body parameters
|
|
1265
|
+
* // {}
|
|
1266
|
+
* },
|
|
1267
|
+
* });
|
|
1268
|
+
* console.log(res.data);
|
|
1269
|
+
*
|
|
1270
|
+
* // Example response
|
|
1271
|
+
* // {
|
|
1272
|
+
* // "matter": {}
|
|
1273
|
+
* // }
|
|
1274
|
+
* }
|
|
1275
|
+
*
|
|
1276
|
+
* main().catch(e => {
|
|
1277
|
+
* console.error(e);
|
|
1278
|
+
* throw e;
|
|
1279
|
+
* });
|
|
1280
|
+
*
|
|
1281
|
+
* ```
|
|
1169
1282
|
*
|
|
1170
1283
|
* @param params - Parameters for request
|
|
1171
1284
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1180,6 +1293,65 @@ export declare namespace vault_v1 {
|
|
|
1180
1293
|
close(callback: BodyResponseCallback<Schema$CloseMatterResponse>): void;
|
|
1181
1294
|
/**
|
|
1182
1295
|
* Counts the accounts processed by the specified query.
|
|
1296
|
+
* @example
|
|
1297
|
+
* ```js
|
|
1298
|
+
* // Before running the sample:
|
|
1299
|
+
* // - Enable the API at:
|
|
1300
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
1301
|
+
* // - Login into gcloud by running:
|
|
1302
|
+
* // ```sh
|
|
1303
|
+
* // $ gcloud auth application-default login
|
|
1304
|
+
* // ```
|
|
1305
|
+
* // - Install the npm module by running:
|
|
1306
|
+
* // ```sh
|
|
1307
|
+
* // $ npm install googleapis
|
|
1308
|
+
* // ```
|
|
1309
|
+
*
|
|
1310
|
+
* const {google} = require('googleapis');
|
|
1311
|
+
* const vault = google.vault('v1');
|
|
1312
|
+
*
|
|
1313
|
+
* async function main() {
|
|
1314
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1315
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1316
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
1317
|
+
* });
|
|
1318
|
+
*
|
|
1319
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1320
|
+
* const authClient = await auth.getClient();
|
|
1321
|
+
* google.options({auth: authClient});
|
|
1322
|
+
*
|
|
1323
|
+
* // Do the magic
|
|
1324
|
+
* const res = await vault.matters.count({
|
|
1325
|
+
* // The matter ID.
|
|
1326
|
+
* matterId: 'placeholder-value',
|
|
1327
|
+
*
|
|
1328
|
+
* // Request body metadata
|
|
1329
|
+
* requestBody: {
|
|
1330
|
+
* // request body parameters
|
|
1331
|
+
* // {
|
|
1332
|
+
* // "query": {},
|
|
1333
|
+
* // "view": "my_view"
|
|
1334
|
+
* // }
|
|
1335
|
+
* },
|
|
1336
|
+
* });
|
|
1337
|
+
* console.log(res.data);
|
|
1338
|
+
*
|
|
1339
|
+
* // Example response
|
|
1340
|
+
* // {
|
|
1341
|
+
* // "done": false,
|
|
1342
|
+
* // "error": {},
|
|
1343
|
+
* // "metadata": {},
|
|
1344
|
+
* // "name": "my_name",
|
|
1345
|
+
* // "response": {}
|
|
1346
|
+
* // }
|
|
1347
|
+
* }
|
|
1348
|
+
*
|
|
1349
|
+
* main().catch(e => {
|
|
1350
|
+
* console.error(e);
|
|
1351
|
+
* throw e;
|
|
1352
|
+
* });
|
|
1353
|
+
*
|
|
1354
|
+
* ```
|
|
1183
1355
|
*
|
|
1184
1356
|
* @param params - Parameters for request
|
|
1185
1357
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1194,6 +1366,67 @@ export declare namespace vault_v1 {
|
|
|
1194
1366
|
count(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
1195
1367
|
/**
|
|
1196
1368
|
* Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.
|
|
1369
|
+
* @example
|
|
1370
|
+
* ```js
|
|
1371
|
+
* // Before running the sample:
|
|
1372
|
+
* // - Enable the API at:
|
|
1373
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
1374
|
+
* // - Login into gcloud by running:
|
|
1375
|
+
* // ```sh
|
|
1376
|
+
* // $ gcloud auth application-default login
|
|
1377
|
+
* // ```
|
|
1378
|
+
* // - Install the npm module by running:
|
|
1379
|
+
* // ```sh
|
|
1380
|
+
* // $ npm install googleapis
|
|
1381
|
+
* // ```
|
|
1382
|
+
*
|
|
1383
|
+
* const {google} = require('googleapis');
|
|
1384
|
+
* const vault = google.vault('v1');
|
|
1385
|
+
*
|
|
1386
|
+
* async function main() {
|
|
1387
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1388
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1389
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
1390
|
+
* });
|
|
1391
|
+
*
|
|
1392
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1393
|
+
* const authClient = await auth.getClient();
|
|
1394
|
+
* google.options({auth: authClient});
|
|
1395
|
+
*
|
|
1396
|
+
* // Do the magic
|
|
1397
|
+
* const res = await vault.matters.create({
|
|
1398
|
+
* // Request body metadata
|
|
1399
|
+
* requestBody: {
|
|
1400
|
+
* // request body parameters
|
|
1401
|
+
* // {
|
|
1402
|
+
* // "description": "my_description",
|
|
1403
|
+
* // "matterId": "my_matterId",
|
|
1404
|
+
* // "matterPermissions": [],
|
|
1405
|
+
* // "matterRegion": "my_matterRegion",
|
|
1406
|
+
* // "name": "my_name",
|
|
1407
|
+
* // "state": "my_state"
|
|
1408
|
+
* // }
|
|
1409
|
+
* },
|
|
1410
|
+
* });
|
|
1411
|
+
* console.log(res.data);
|
|
1412
|
+
*
|
|
1413
|
+
* // Example response
|
|
1414
|
+
* // {
|
|
1415
|
+
* // "description": "my_description",
|
|
1416
|
+
* // "matterId": "my_matterId",
|
|
1417
|
+
* // "matterPermissions": [],
|
|
1418
|
+
* // "matterRegion": "my_matterRegion",
|
|
1419
|
+
* // "name": "my_name",
|
|
1420
|
+
* // "state": "my_state"
|
|
1421
|
+
* // }
|
|
1422
|
+
* }
|
|
1423
|
+
*
|
|
1424
|
+
* main().catch(e => {
|
|
1425
|
+
* console.error(e);
|
|
1426
|
+
* throw e;
|
|
1427
|
+
* });
|
|
1428
|
+
*
|
|
1429
|
+
* ```
|
|
1197
1430
|
*
|
|
1198
1431
|
* @param params - Parameters for request
|
|
1199
1432
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1208,6 +1441,57 @@ export declare namespace vault_v1 {
|
|
|
1208
1441
|
create(callback: BodyResponseCallback<Schema$Matter>): void;
|
|
1209
1442
|
/**
|
|
1210
1443
|
* Deletes the specified matter. Returns the matter with updated state.
|
|
1444
|
+
* @example
|
|
1445
|
+
* ```js
|
|
1446
|
+
* // Before running the sample:
|
|
1447
|
+
* // - Enable the API at:
|
|
1448
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
1449
|
+
* // - Login into gcloud by running:
|
|
1450
|
+
* // ```sh
|
|
1451
|
+
* // $ gcloud auth application-default login
|
|
1452
|
+
* // ```
|
|
1453
|
+
* // - Install the npm module by running:
|
|
1454
|
+
* // ```sh
|
|
1455
|
+
* // $ npm install googleapis
|
|
1456
|
+
* // ```
|
|
1457
|
+
*
|
|
1458
|
+
* const {google} = require('googleapis');
|
|
1459
|
+
* const vault = google.vault('v1');
|
|
1460
|
+
*
|
|
1461
|
+
* async function main() {
|
|
1462
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1463
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1464
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
1465
|
+
* });
|
|
1466
|
+
*
|
|
1467
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1468
|
+
* const authClient = await auth.getClient();
|
|
1469
|
+
* google.options({auth: authClient});
|
|
1470
|
+
*
|
|
1471
|
+
* // Do the magic
|
|
1472
|
+
* const res = await vault.matters.delete({
|
|
1473
|
+
* // The matter ID
|
|
1474
|
+
* matterId: 'placeholder-value',
|
|
1475
|
+
* });
|
|
1476
|
+
* console.log(res.data);
|
|
1477
|
+
*
|
|
1478
|
+
* // Example response
|
|
1479
|
+
* // {
|
|
1480
|
+
* // "description": "my_description",
|
|
1481
|
+
* // "matterId": "my_matterId",
|
|
1482
|
+
* // "matterPermissions": [],
|
|
1483
|
+
* // "matterRegion": "my_matterRegion",
|
|
1484
|
+
* // "name": "my_name",
|
|
1485
|
+
* // "state": "my_state"
|
|
1486
|
+
* // }
|
|
1487
|
+
* }
|
|
1488
|
+
*
|
|
1489
|
+
* main().catch(e => {
|
|
1490
|
+
* console.error(e);
|
|
1491
|
+
* throw e;
|
|
1492
|
+
* });
|
|
1493
|
+
*
|
|
1494
|
+
* ```
|
|
1211
1495
|
*
|
|
1212
1496
|
* @param params - Parameters for request
|
|
1213
1497
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1222,6 +1506,62 @@ export declare namespace vault_v1 {
|
|
|
1222
1506
|
delete(callback: BodyResponseCallback<Schema$Matter>): void;
|
|
1223
1507
|
/**
|
|
1224
1508
|
* Gets the specified matter.
|
|
1509
|
+
* @example
|
|
1510
|
+
* ```js
|
|
1511
|
+
* // Before running the sample:
|
|
1512
|
+
* // - Enable the API at:
|
|
1513
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
1514
|
+
* // - Login into gcloud by running:
|
|
1515
|
+
* // ```sh
|
|
1516
|
+
* // $ gcloud auth application-default login
|
|
1517
|
+
* // ```
|
|
1518
|
+
* // - Install the npm module by running:
|
|
1519
|
+
* // ```sh
|
|
1520
|
+
* // $ npm install googleapis
|
|
1521
|
+
* // ```
|
|
1522
|
+
*
|
|
1523
|
+
* const {google} = require('googleapis');
|
|
1524
|
+
* const vault = google.vault('v1');
|
|
1525
|
+
*
|
|
1526
|
+
* async function main() {
|
|
1527
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1528
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1529
|
+
* scopes: [
|
|
1530
|
+
* 'https://www.googleapis.com/auth/ediscovery',
|
|
1531
|
+
* 'https://www.googleapis.com/auth/ediscovery.readonly',
|
|
1532
|
+
* ],
|
|
1533
|
+
* });
|
|
1534
|
+
*
|
|
1535
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1536
|
+
* const authClient = await auth.getClient();
|
|
1537
|
+
* google.options({auth: authClient});
|
|
1538
|
+
*
|
|
1539
|
+
* // Do the magic
|
|
1540
|
+
* const res = await vault.matters.get({
|
|
1541
|
+
* // The matter ID.
|
|
1542
|
+
* matterId: 'placeholder-value',
|
|
1543
|
+
* // Specifies how much information about the matter to return in the response.
|
|
1544
|
+
* view: 'placeholder-value',
|
|
1545
|
+
* });
|
|
1546
|
+
* console.log(res.data);
|
|
1547
|
+
*
|
|
1548
|
+
* // Example response
|
|
1549
|
+
* // {
|
|
1550
|
+
* // "description": "my_description",
|
|
1551
|
+
* // "matterId": "my_matterId",
|
|
1552
|
+
* // "matterPermissions": [],
|
|
1553
|
+
* // "matterRegion": "my_matterRegion",
|
|
1554
|
+
* // "name": "my_name",
|
|
1555
|
+
* // "state": "my_state"
|
|
1556
|
+
* // }
|
|
1557
|
+
* }
|
|
1558
|
+
*
|
|
1559
|
+
* main().catch(e => {
|
|
1560
|
+
* console.error(e);
|
|
1561
|
+
* throw e;
|
|
1562
|
+
* });
|
|
1563
|
+
*
|
|
1564
|
+
* ```
|
|
1225
1565
|
*
|
|
1226
1566
|
* @param params - Parameters for request
|
|
1227
1567
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1236,6 +1576,62 @@ export declare namespace vault_v1 {
|
|
|
1236
1576
|
get(callback: BodyResponseCallback<Schema$Matter>): void;
|
|
1237
1577
|
/**
|
|
1238
1578
|
* Lists matters the requestor has access to.
|
|
1579
|
+
* @example
|
|
1580
|
+
* ```js
|
|
1581
|
+
* // Before running the sample:
|
|
1582
|
+
* // - Enable the API at:
|
|
1583
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
1584
|
+
* // - Login into gcloud by running:
|
|
1585
|
+
* // ```sh
|
|
1586
|
+
* // $ gcloud auth application-default login
|
|
1587
|
+
* // ```
|
|
1588
|
+
* // - Install the npm module by running:
|
|
1589
|
+
* // ```sh
|
|
1590
|
+
* // $ npm install googleapis
|
|
1591
|
+
* // ```
|
|
1592
|
+
*
|
|
1593
|
+
* const {google} = require('googleapis');
|
|
1594
|
+
* const vault = google.vault('v1');
|
|
1595
|
+
*
|
|
1596
|
+
* async function main() {
|
|
1597
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1598
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1599
|
+
* scopes: [
|
|
1600
|
+
* 'https://www.googleapis.com/auth/ediscovery',
|
|
1601
|
+
* 'https://www.googleapis.com/auth/ediscovery.readonly',
|
|
1602
|
+
* ],
|
|
1603
|
+
* });
|
|
1604
|
+
*
|
|
1605
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1606
|
+
* const authClient = await auth.getClient();
|
|
1607
|
+
* google.options({auth: authClient});
|
|
1608
|
+
*
|
|
1609
|
+
* // Do the magic
|
|
1610
|
+
* const res = await vault.matters.list({
|
|
1611
|
+
* // The number of matters to return in the response. Default and maximum are 100.
|
|
1612
|
+
* pageSize: 'placeholder-value',
|
|
1613
|
+
* // The pagination token as returned in the response.
|
|
1614
|
+
* pageToken: 'placeholder-value',
|
|
1615
|
+
* // If set, lists only matters with the specified state. The default lists matters of all states.
|
|
1616
|
+
* state: 'placeholder-value',
|
|
1617
|
+
* // Specifies how much information about the matter to return in response.
|
|
1618
|
+
* view: 'placeholder-value',
|
|
1619
|
+
* });
|
|
1620
|
+
* console.log(res.data);
|
|
1621
|
+
*
|
|
1622
|
+
* // Example response
|
|
1623
|
+
* // {
|
|
1624
|
+
* // "matters": [],
|
|
1625
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
1626
|
+
* // }
|
|
1627
|
+
* }
|
|
1628
|
+
*
|
|
1629
|
+
* main().catch(e => {
|
|
1630
|
+
* console.error(e);
|
|
1631
|
+
* throw e;
|
|
1632
|
+
* });
|
|
1633
|
+
*
|
|
1634
|
+
* ```
|
|
1239
1635
|
*
|
|
1240
1636
|
* @param params - Parameters for request
|
|
1241
1637
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1250,6 +1646,58 @@ export declare namespace vault_v1 {
|
|
|
1250
1646
|
list(callback: BodyResponseCallback<Schema$ListMattersResponse>): void;
|
|
1251
1647
|
/**
|
|
1252
1648
|
* Removes an account as a matter collaborator.
|
|
1649
|
+
* @example
|
|
1650
|
+
* ```js
|
|
1651
|
+
* // Before running the sample:
|
|
1652
|
+
* // - Enable the API at:
|
|
1653
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
1654
|
+
* // - Login into gcloud by running:
|
|
1655
|
+
* // ```sh
|
|
1656
|
+
* // $ gcloud auth application-default login
|
|
1657
|
+
* // ```
|
|
1658
|
+
* // - Install the npm module by running:
|
|
1659
|
+
* // ```sh
|
|
1660
|
+
* // $ npm install googleapis
|
|
1661
|
+
* // ```
|
|
1662
|
+
*
|
|
1663
|
+
* const {google} = require('googleapis');
|
|
1664
|
+
* const vault = google.vault('v1');
|
|
1665
|
+
*
|
|
1666
|
+
* async function main() {
|
|
1667
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1668
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1669
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
1670
|
+
* });
|
|
1671
|
+
*
|
|
1672
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1673
|
+
* const authClient = await auth.getClient();
|
|
1674
|
+
* google.options({auth: authClient});
|
|
1675
|
+
*
|
|
1676
|
+
* // Do the magic
|
|
1677
|
+
* const res = await vault.matters.removePermissions({
|
|
1678
|
+
* // The matter ID.
|
|
1679
|
+
* matterId: 'placeholder-value',
|
|
1680
|
+
*
|
|
1681
|
+
* // Request body metadata
|
|
1682
|
+
* requestBody: {
|
|
1683
|
+
* // request body parameters
|
|
1684
|
+
* // {
|
|
1685
|
+
* // "accountId": "my_accountId"
|
|
1686
|
+
* // }
|
|
1687
|
+
* },
|
|
1688
|
+
* });
|
|
1689
|
+
* console.log(res.data);
|
|
1690
|
+
*
|
|
1691
|
+
* // Example response
|
|
1692
|
+
* // {}
|
|
1693
|
+
* }
|
|
1694
|
+
*
|
|
1695
|
+
* main().catch(e => {
|
|
1696
|
+
* console.error(e);
|
|
1697
|
+
* throw e;
|
|
1698
|
+
* });
|
|
1699
|
+
*
|
|
1700
|
+
* ```
|
|
1253
1701
|
*
|
|
1254
1702
|
* @param params - Parameters for request
|
|
1255
1703
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1264,6 +1712,58 @@ export declare namespace vault_v1 {
|
|
|
1264
1712
|
removePermissions(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
1265
1713
|
/**
|
|
1266
1714
|
* Reopens the specified matter. Returns the matter with updated state.
|
|
1715
|
+
* @example
|
|
1716
|
+
* ```js
|
|
1717
|
+
* // Before running the sample:
|
|
1718
|
+
* // - Enable the API at:
|
|
1719
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
1720
|
+
* // - Login into gcloud by running:
|
|
1721
|
+
* // ```sh
|
|
1722
|
+
* // $ gcloud auth application-default login
|
|
1723
|
+
* // ```
|
|
1724
|
+
* // - Install the npm module by running:
|
|
1725
|
+
* // ```sh
|
|
1726
|
+
* // $ npm install googleapis
|
|
1727
|
+
* // ```
|
|
1728
|
+
*
|
|
1729
|
+
* const {google} = require('googleapis');
|
|
1730
|
+
* const vault = google.vault('v1');
|
|
1731
|
+
*
|
|
1732
|
+
* async function main() {
|
|
1733
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1734
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1735
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
1736
|
+
* });
|
|
1737
|
+
*
|
|
1738
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1739
|
+
* const authClient = await auth.getClient();
|
|
1740
|
+
* google.options({auth: authClient});
|
|
1741
|
+
*
|
|
1742
|
+
* // Do the magic
|
|
1743
|
+
* const res = await vault.matters.reopen({
|
|
1744
|
+
* // The matter ID.
|
|
1745
|
+
* matterId: 'placeholder-value',
|
|
1746
|
+
*
|
|
1747
|
+
* // Request body metadata
|
|
1748
|
+
* requestBody: {
|
|
1749
|
+
* // request body parameters
|
|
1750
|
+
* // {}
|
|
1751
|
+
* },
|
|
1752
|
+
* });
|
|
1753
|
+
* console.log(res.data);
|
|
1754
|
+
*
|
|
1755
|
+
* // Example response
|
|
1756
|
+
* // {
|
|
1757
|
+
* // "matter": {}
|
|
1758
|
+
* // }
|
|
1759
|
+
* }
|
|
1760
|
+
*
|
|
1761
|
+
* main().catch(e => {
|
|
1762
|
+
* console.error(e);
|
|
1763
|
+
* throw e;
|
|
1764
|
+
* });
|
|
1765
|
+
*
|
|
1766
|
+
* ```
|
|
1267
1767
|
*
|
|
1268
1768
|
* @param params - Parameters for request
|
|
1269
1769
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1278,6 +1778,63 @@ export declare namespace vault_v1 {
|
|
|
1278
1778
|
reopen(callback: BodyResponseCallback<Schema$ReopenMatterResponse>): void;
|
|
1279
1779
|
/**
|
|
1280
1780
|
* Undeletes the specified matter. Returns the matter with updated state.
|
|
1781
|
+
* @example
|
|
1782
|
+
* ```js
|
|
1783
|
+
* // Before running the sample:
|
|
1784
|
+
* // - Enable the API at:
|
|
1785
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
1786
|
+
* // - Login into gcloud by running:
|
|
1787
|
+
* // ```sh
|
|
1788
|
+
* // $ gcloud auth application-default login
|
|
1789
|
+
* // ```
|
|
1790
|
+
* // - Install the npm module by running:
|
|
1791
|
+
* // ```sh
|
|
1792
|
+
* // $ npm install googleapis
|
|
1793
|
+
* // ```
|
|
1794
|
+
*
|
|
1795
|
+
* const {google} = require('googleapis');
|
|
1796
|
+
* const vault = google.vault('v1');
|
|
1797
|
+
*
|
|
1798
|
+
* async function main() {
|
|
1799
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1800
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1801
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
1802
|
+
* });
|
|
1803
|
+
*
|
|
1804
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1805
|
+
* const authClient = await auth.getClient();
|
|
1806
|
+
* google.options({auth: authClient});
|
|
1807
|
+
*
|
|
1808
|
+
* // Do the magic
|
|
1809
|
+
* const res = await vault.matters.undelete({
|
|
1810
|
+
* // The matter ID.
|
|
1811
|
+
* matterId: 'placeholder-value',
|
|
1812
|
+
*
|
|
1813
|
+
* // Request body metadata
|
|
1814
|
+
* requestBody: {
|
|
1815
|
+
* // request body parameters
|
|
1816
|
+
* // {}
|
|
1817
|
+
* },
|
|
1818
|
+
* });
|
|
1819
|
+
* console.log(res.data);
|
|
1820
|
+
*
|
|
1821
|
+
* // Example response
|
|
1822
|
+
* // {
|
|
1823
|
+
* // "description": "my_description",
|
|
1824
|
+
* // "matterId": "my_matterId",
|
|
1825
|
+
* // "matterPermissions": [],
|
|
1826
|
+
* // "matterRegion": "my_matterRegion",
|
|
1827
|
+
* // "name": "my_name",
|
|
1828
|
+
* // "state": "my_state"
|
|
1829
|
+
* // }
|
|
1830
|
+
* }
|
|
1831
|
+
*
|
|
1832
|
+
* main().catch(e => {
|
|
1833
|
+
* console.error(e);
|
|
1834
|
+
* throw e;
|
|
1835
|
+
* });
|
|
1836
|
+
*
|
|
1837
|
+
* ```
|
|
1281
1838
|
*
|
|
1282
1839
|
* @param params - Parameters for request
|
|
1283
1840
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1292,6 +1849,70 @@ export declare namespace vault_v1 {
|
|
|
1292
1849
|
undelete(callback: BodyResponseCallback<Schema$Matter>): void;
|
|
1293
1850
|
/**
|
|
1294
1851
|
* Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.
|
|
1852
|
+
* @example
|
|
1853
|
+
* ```js
|
|
1854
|
+
* // Before running the sample:
|
|
1855
|
+
* // - Enable the API at:
|
|
1856
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
1857
|
+
* // - Login into gcloud by running:
|
|
1858
|
+
* // ```sh
|
|
1859
|
+
* // $ gcloud auth application-default login
|
|
1860
|
+
* // ```
|
|
1861
|
+
* // - Install the npm module by running:
|
|
1862
|
+
* // ```sh
|
|
1863
|
+
* // $ npm install googleapis
|
|
1864
|
+
* // ```
|
|
1865
|
+
*
|
|
1866
|
+
* const {google} = require('googleapis');
|
|
1867
|
+
* const vault = google.vault('v1');
|
|
1868
|
+
*
|
|
1869
|
+
* async function main() {
|
|
1870
|
+
* const auth = new google.auth.GoogleAuth({
|
|
1871
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
1872
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
1873
|
+
* });
|
|
1874
|
+
*
|
|
1875
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
1876
|
+
* const authClient = await auth.getClient();
|
|
1877
|
+
* google.options({auth: authClient});
|
|
1878
|
+
*
|
|
1879
|
+
* // Do the magic
|
|
1880
|
+
* const res = await vault.matters.update({
|
|
1881
|
+
* // The matter ID.
|
|
1882
|
+
* matterId: 'placeholder-value',
|
|
1883
|
+
*
|
|
1884
|
+
* // Request body metadata
|
|
1885
|
+
* requestBody: {
|
|
1886
|
+
* // request body parameters
|
|
1887
|
+
* // {
|
|
1888
|
+
* // "description": "my_description",
|
|
1889
|
+
* // "matterId": "my_matterId",
|
|
1890
|
+
* // "matterPermissions": [],
|
|
1891
|
+
* // "matterRegion": "my_matterRegion",
|
|
1892
|
+
* // "name": "my_name",
|
|
1893
|
+
* // "state": "my_state"
|
|
1894
|
+
* // }
|
|
1895
|
+
* },
|
|
1896
|
+
* });
|
|
1897
|
+
* console.log(res.data);
|
|
1898
|
+
*
|
|
1899
|
+
* // Example response
|
|
1900
|
+
* // {
|
|
1901
|
+
* // "description": "my_description",
|
|
1902
|
+
* // "matterId": "my_matterId",
|
|
1903
|
+
* // "matterPermissions": [],
|
|
1904
|
+
* // "matterRegion": "my_matterRegion",
|
|
1905
|
+
* // "name": "my_name",
|
|
1906
|
+
* // "state": "my_state"
|
|
1907
|
+
* // }
|
|
1908
|
+
* }
|
|
1909
|
+
*
|
|
1910
|
+
* main().catch(e => {
|
|
1911
|
+
* console.error(e);
|
|
1912
|
+
* throw e;
|
|
1913
|
+
* });
|
|
1914
|
+
*
|
|
1915
|
+
* ```
|
|
1295
1916
|
*
|
|
1296
1917
|
* @param params - Parameters for request
|
|
1297
1918
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1420,6 +2041,80 @@ export declare namespace vault_v1 {
|
|
|
1420
2041
|
constructor(context: APIRequestContext);
|
|
1421
2042
|
/**
|
|
1422
2043
|
* Creates an export.
|
|
2044
|
+
* @example
|
|
2045
|
+
* ```js
|
|
2046
|
+
* // Before running the sample:
|
|
2047
|
+
* // - Enable the API at:
|
|
2048
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
2049
|
+
* // - Login into gcloud by running:
|
|
2050
|
+
* // ```sh
|
|
2051
|
+
* // $ gcloud auth application-default login
|
|
2052
|
+
* // ```
|
|
2053
|
+
* // - Install the npm module by running:
|
|
2054
|
+
* // ```sh
|
|
2055
|
+
* // $ npm install googleapis
|
|
2056
|
+
* // ```
|
|
2057
|
+
*
|
|
2058
|
+
* const {google} = require('googleapis');
|
|
2059
|
+
* const vault = google.vault('v1');
|
|
2060
|
+
*
|
|
2061
|
+
* async function main() {
|
|
2062
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2063
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2064
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
2065
|
+
* });
|
|
2066
|
+
*
|
|
2067
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2068
|
+
* const authClient = await auth.getClient();
|
|
2069
|
+
* google.options({auth: authClient});
|
|
2070
|
+
*
|
|
2071
|
+
* // Do the magic
|
|
2072
|
+
* const res = await vault.matters.exports.create({
|
|
2073
|
+
* // The matter ID.
|
|
2074
|
+
* matterId: 'placeholder-value',
|
|
2075
|
+
*
|
|
2076
|
+
* // Request body metadata
|
|
2077
|
+
* requestBody: {
|
|
2078
|
+
* // request body parameters
|
|
2079
|
+
* // {
|
|
2080
|
+
* // "cloudStorageSink": {},
|
|
2081
|
+
* // "createTime": "my_createTime",
|
|
2082
|
+
* // "exportOptions": {},
|
|
2083
|
+
* // "id": "my_id",
|
|
2084
|
+
* // "matterId": "my_matterId",
|
|
2085
|
+
* // "name": "my_name",
|
|
2086
|
+
* // "parentExportId": "my_parentExportId",
|
|
2087
|
+
* // "query": {},
|
|
2088
|
+
* // "requester": {},
|
|
2089
|
+
* // "stats": {},
|
|
2090
|
+
* // "status": "my_status"
|
|
2091
|
+
* // }
|
|
2092
|
+
* },
|
|
2093
|
+
* });
|
|
2094
|
+
* console.log(res.data);
|
|
2095
|
+
*
|
|
2096
|
+
* // Example response
|
|
2097
|
+
* // {
|
|
2098
|
+
* // "cloudStorageSink": {},
|
|
2099
|
+
* // "createTime": "my_createTime",
|
|
2100
|
+
* // "exportOptions": {},
|
|
2101
|
+
* // "id": "my_id",
|
|
2102
|
+
* // "matterId": "my_matterId",
|
|
2103
|
+
* // "name": "my_name",
|
|
2104
|
+
* // "parentExportId": "my_parentExportId",
|
|
2105
|
+
* // "query": {},
|
|
2106
|
+
* // "requester": {},
|
|
2107
|
+
* // "stats": {},
|
|
2108
|
+
* // "status": "my_status"
|
|
2109
|
+
* // }
|
|
2110
|
+
* }
|
|
2111
|
+
*
|
|
2112
|
+
* main().catch(e => {
|
|
2113
|
+
* console.error(e);
|
|
2114
|
+
* throw e;
|
|
2115
|
+
* });
|
|
2116
|
+
*
|
|
2117
|
+
* ```
|
|
1423
2118
|
*
|
|
1424
2119
|
* @param params - Parameters for request
|
|
1425
2120
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1434,6 +2129,52 @@ export declare namespace vault_v1 {
|
|
|
1434
2129
|
create(callback: BodyResponseCallback<Schema$Export>): void;
|
|
1435
2130
|
/**
|
|
1436
2131
|
* Deletes an export.
|
|
2132
|
+
* @example
|
|
2133
|
+
* ```js
|
|
2134
|
+
* // Before running the sample:
|
|
2135
|
+
* // - Enable the API at:
|
|
2136
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
2137
|
+
* // - Login into gcloud by running:
|
|
2138
|
+
* // ```sh
|
|
2139
|
+
* // $ gcloud auth application-default login
|
|
2140
|
+
* // ```
|
|
2141
|
+
* // - Install the npm module by running:
|
|
2142
|
+
* // ```sh
|
|
2143
|
+
* // $ npm install googleapis
|
|
2144
|
+
* // ```
|
|
2145
|
+
*
|
|
2146
|
+
* const {google} = require('googleapis');
|
|
2147
|
+
* const vault = google.vault('v1');
|
|
2148
|
+
*
|
|
2149
|
+
* async function main() {
|
|
2150
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2151
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2152
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
2153
|
+
* });
|
|
2154
|
+
*
|
|
2155
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2156
|
+
* const authClient = await auth.getClient();
|
|
2157
|
+
* google.options({auth: authClient});
|
|
2158
|
+
*
|
|
2159
|
+
* // Do the magic
|
|
2160
|
+
* const res = await vault.matters.exports.delete({
|
|
2161
|
+
* // The export ID.
|
|
2162
|
+
* exportId: 'placeholder-value',
|
|
2163
|
+
* // The matter ID.
|
|
2164
|
+
* matterId: 'placeholder-value',
|
|
2165
|
+
* });
|
|
2166
|
+
* console.log(res.data);
|
|
2167
|
+
*
|
|
2168
|
+
* // Example response
|
|
2169
|
+
* // {}
|
|
2170
|
+
* }
|
|
2171
|
+
*
|
|
2172
|
+
* main().catch(e => {
|
|
2173
|
+
* console.error(e);
|
|
2174
|
+
* throw e;
|
|
2175
|
+
* });
|
|
2176
|
+
*
|
|
2177
|
+
* ```
|
|
1437
2178
|
*
|
|
1438
2179
|
* @param params - Parameters for request
|
|
1439
2180
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1448,6 +2189,67 @@ export declare namespace vault_v1 {
|
|
|
1448
2189
|
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
1449
2190
|
/**
|
|
1450
2191
|
* Gets an export.
|
|
2192
|
+
* @example
|
|
2193
|
+
* ```js
|
|
2194
|
+
* // Before running the sample:
|
|
2195
|
+
* // - Enable the API at:
|
|
2196
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
2197
|
+
* // - Login into gcloud by running:
|
|
2198
|
+
* // ```sh
|
|
2199
|
+
* // $ gcloud auth application-default login
|
|
2200
|
+
* // ```
|
|
2201
|
+
* // - Install the npm module by running:
|
|
2202
|
+
* // ```sh
|
|
2203
|
+
* // $ npm install googleapis
|
|
2204
|
+
* // ```
|
|
2205
|
+
*
|
|
2206
|
+
* const {google} = require('googleapis');
|
|
2207
|
+
* const vault = google.vault('v1');
|
|
2208
|
+
*
|
|
2209
|
+
* async function main() {
|
|
2210
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2211
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2212
|
+
* scopes: [
|
|
2213
|
+
* 'https://www.googleapis.com/auth/ediscovery',
|
|
2214
|
+
* 'https://www.googleapis.com/auth/ediscovery.readonly',
|
|
2215
|
+
* ],
|
|
2216
|
+
* });
|
|
2217
|
+
*
|
|
2218
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2219
|
+
* const authClient = await auth.getClient();
|
|
2220
|
+
* google.options({auth: authClient});
|
|
2221
|
+
*
|
|
2222
|
+
* // Do the magic
|
|
2223
|
+
* const res = await vault.matters.exports.get({
|
|
2224
|
+
* // The export ID.
|
|
2225
|
+
* exportId: 'placeholder-value',
|
|
2226
|
+
* // The matter ID.
|
|
2227
|
+
* matterId: 'placeholder-value',
|
|
2228
|
+
* });
|
|
2229
|
+
* console.log(res.data);
|
|
2230
|
+
*
|
|
2231
|
+
* // Example response
|
|
2232
|
+
* // {
|
|
2233
|
+
* // "cloudStorageSink": {},
|
|
2234
|
+
* // "createTime": "my_createTime",
|
|
2235
|
+
* // "exportOptions": {},
|
|
2236
|
+
* // "id": "my_id",
|
|
2237
|
+
* // "matterId": "my_matterId",
|
|
2238
|
+
* // "name": "my_name",
|
|
2239
|
+
* // "parentExportId": "my_parentExportId",
|
|
2240
|
+
* // "query": {},
|
|
2241
|
+
* // "requester": {},
|
|
2242
|
+
* // "stats": {},
|
|
2243
|
+
* // "status": "my_status"
|
|
2244
|
+
* // }
|
|
2245
|
+
* }
|
|
2246
|
+
*
|
|
2247
|
+
* main().catch(e => {
|
|
2248
|
+
* console.error(e);
|
|
2249
|
+
* throw e;
|
|
2250
|
+
* });
|
|
2251
|
+
*
|
|
2252
|
+
* ```
|
|
1451
2253
|
*
|
|
1452
2254
|
* @param params - Parameters for request
|
|
1453
2255
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1462,6 +2264,60 @@ export declare namespace vault_v1 {
|
|
|
1462
2264
|
get(callback: BodyResponseCallback<Schema$Export>): void;
|
|
1463
2265
|
/**
|
|
1464
2266
|
* Lists details about the exports in the specified matter.
|
|
2267
|
+
* @example
|
|
2268
|
+
* ```js
|
|
2269
|
+
* // Before running the sample:
|
|
2270
|
+
* // - Enable the API at:
|
|
2271
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
2272
|
+
* // - Login into gcloud by running:
|
|
2273
|
+
* // ```sh
|
|
2274
|
+
* // $ gcloud auth application-default login
|
|
2275
|
+
* // ```
|
|
2276
|
+
* // - Install the npm module by running:
|
|
2277
|
+
* // ```sh
|
|
2278
|
+
* // $ npm install googleapis
|
|
2279
|
+
* // ```
|
|
2280
|
+
*
|
|
2281
|
+
* const {google} = require('googleapis');
|
|
2282
|
+
* const vault = google.vault('v1');
|
|
2283
|
+
*
|
|
2284
|
+
* async function main() {
|
|
2285
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2286
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2287
|
+
* scopes: [
|
|
2288
|
+
* 'https://www.googleapis.com/auth/ediscovery',
|
|
2289
|
+
* 'https://www.googleapis.com/auth/ediscovery.readonly',
|
|
2290
|
+
* ],
|
|
2291
|
+
* });
|
|
2292
|
+
*
|
|
2293
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2294
|
+
* const authClient = await auth.getClient();
|
|
2295
|
+
* google.options({auth: authClient});
|
|
2296
|
+
*
|
|
2297
|
+
* // Do the magic
|
|
2298
|
+
* const res = await vault.matters.exports.list({
|
|
2299
|
+
* // The matter ID.
|
|
2300
|
+
* matterId: 'placeholder-value',
|
|
2301
|
+
* // The number of exports to return in the response.
|
|
2302
|
+
* pageSize: 'placeholder-value',
|
|
2303
|
+
* // The pagination token as returned in the response.
|
|
2304
|
+
* pageToken: 'placeholder-value',
|
|
2305
|
+
* });
|
|
2306
|
+
* console.log(res.data);
|
|
2307
|
+
*
|
|
2308
|
+
* // Example response
|
|
2309
|
+
* // {
|
|
2310
|
+
* // "exports": [],
|
|
2311
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
2312
|
+
* // }
|
|
2313
|
+
* }
|
|
2314
|
+
*
|
|
2315
|
+
* main().catch(e => {
|
|
2316
|
+
* console.error(e);
|
|
2317
|
+
* throw e;
|
|
2318
|
+
* });
|
|
2319
|
+
*
|
|
2320
|
+
* ```
|
|
1465
2321
|
*
|
|
1466
2322
|
* @param params - Parameters for request
|
|
1467
2323
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1525,6 +2381,63 @@ export declare namespace vault_v1 {
|
|
|
1525
2381
|
constructor(context: APIRequestContext);
|
|
1526
2382
|
/**
|
|
1527
2383
|
* Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.
|
|
2384
|
+
* @example
|
|
2385
|
+
* ```js
|
|
2386
|
+
* // Before running the sample:
|
|
2387
|
+
* // - Enable the API at:
|
|
2388
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
2389
|
+
* // - Login into gcloud by running:
|
|
2390
|
+
* // ```sh
|
|
2391
|
+
* // $ gcloud auth application-default login
|
|
2392
|
+
* // ```
|
|
2393
|
+
* // - Install the npm module by running:
|
|
2394
|
+
* // ```sh
|
|
2395
|
+
* // $ npm install googleapis
|
|
2396
|
+
* // ```
|
|
2397
|
+
*
|
|
2398
|
+
* const {google} = require('googleapis');
|
|
2399
|
+
* const vault = google.vault('v1');
|
|
2400
|
+
*
|
|
2401
|
+
* async function main() {
|
|
2402
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2403
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2404
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
2405
|
+
* });
|
|
2406
|
+
*
|
|
2407
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2408
|
+
* const authClient = await auth.getClient();
|
|
2409
|
+
* google.options({auth: authClient});
|
|
2410
|
+
*
|
|
2411
|
+
* // Do the magic
|
|
2412
|
+
* const res = await vault.matters.holds.addHeldAccounts({
|
|
2413
|
+
* // The hold ID.
|
|
2414
|
+
* holdId: 'placeholder-value',
|
|
2415
|
+
* // The matter ID.
|
|
2416
|
+
* matterId: 'placeholder-value',
|
|
2417
|
+
*
|
|
2418
|
+
* // Request body metadata
|
|
2419
|
+
* requestBody: {
|
|
2420
|
+
* // request body parameters
|
|
2421
|
+
* // {
|
|
2422
|
+
* // "accountIds": [],
|
|
2423
|
+
* // "emails": []
|
|
2424
|
+
* // }
|
|
2425
|
+
* },
|
|
2426
|
+
* });
|
|
2427
|
+
* console.log(res.data);
|
|
2428
|
+
*
|
|
2429
|
+
* // Example response
|
|
2430
|
+
* // {
|
|
2431
|
+
* // "responses": []
|
|
2432
|
+
* // }
|
|
2433
|
+
* }
|
|
2434
|
+
*
|
|
2435
|
+
* main().catch(e => {
|
|
2436
|
+
* console.error(e);
|
|
2437
|
+
* throw e;
|
|
2438
|
+
* });
|
|
2439
|
+
*
|
|
2440
|
+
* ```
|
|
1528
2441
|
*
|
|
1529
2442
|
* @param params - Parameters for request
|
|
1530
2443
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1539,6 +2452,72 @@ export declare namespace vault_v1 {
|
|
|
1539
2452
|
addHeldAccounts(callback: BodyResponseCallback<Schema$AddHeldAccountsResponse>): void;
|
|
1540
2453
|
/**
|
|
1541
2454
|
* Creates a hold in the specified matter.
|
|
2455
|
+
* @example
|
|
2456
|
+
* ```js
|
|
2457
|
+
* // Before running the sample:
|
|
2458
|
+
* // - Enable the API at:
|
|
2459
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
2460
|
+
* // - Login into gcloud by running:
|
|
2461
|
+
* // ```sh
|
|
2462
|
+
* // $ gcloud auth application-default login
|
|
2463
|
+
* // ```
|
|
2464
|
+
* // - Install the npm module by running:
|
|
2465
|
+
* // ```sh
|
|
2466
|
+
* // $ npm install googleapis
|
|
2467
|
+
* // ```
|
|
2468
|
+
*
|
|
2469
|
+
* const {google} = require('googleapis');
|
|
2470
|
+
* const vault = google.vault('v1');
|
|
2471
|
+
*
|
|
2472
|
+
* async function main() {
|
|
2473
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2474
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2475
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
2476
|
+
* });
|
|
2477
|
+
*
|
|
2478
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2479
|
+
* const authClient = await auth.getClient();
|
|
2480
|
+
* google.options({auth: authClient});
|
|
2481
|
+
*
|
|
2482
|
+
* // Do the magic
|
|
2483
|
+
* const res = await vault.matters.holds.create({
|
|
2484
|
+
* // The matter ID.
|
|
2485
|
+
* matterId: 'placeholder-value',
|
|
2486
|
+
*
|
|
2487
|
+
* // Request body metadata
|
|
2488
|
+
* requestBody: {
|
|
2489
|
+
* // request body parameters
|
|
2490
|
+
* // {
|
|
2491
|
+
* // "accounts": [],
|
|
2492
|
+
* // "corpus": "my_corpus",
|
|
2493
|
+
* // "holdId": "my_holdId",
|
|
2494
|
+
* // "name": "my_name",
|
|
2495
|
+
* // "orgUnit": {},
|
|
2496
|
+
* // "query": {},
|
|
2497
|
+
* // "updateTime": "my_updateTime"
|
|
2498
|
+
* // }
|
|
2499
|
+
* },
|
|
2500
|
+
* });
|
|
2501
|
+
* console.log(res.data);
|
|
2502
|
+
*
|
|
2503
|
+
* // Example response
|
|
2504
|
+
* // {
|
|
2505
|
+
* // "accounts": [],
|
|
2506
|
+
* // "corpus": "my_corpus",
|
|
2507
|
+
* // "holdId": "my_holdId",
|
|
2508
|
+
* // "name": "my_name",
|
|
2509
|
+
* // "orgUnit": {},
|
|
2510
|
+
* // "query": {},
|
|
2511
|
+
* // "updateTime": "my_updateTime"
|
|
2512
|
+
* // }
|
|
2513
|
+
* }
|
|
2514
|
+
*
|
|
2515
|
+
* main().catch(e => {
|
|
2516
|
+
* console.error(e);
|
|
2517
|
+
* throw e;
|
|
2518
|
+
* });
|
|
2519
|
+
*
|
|
2520
|
+
* ```
|
|
1542
2521
|
*
|
|
1543
2522
|
* @param params - Parameters for request
|
|
1544
2523
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1553,6 +2532,52 @@ export declare namespace vault_v1 {
|
|
|
1553
2532
|
create(callback: BodyResponseCallback<Schema$Hold>): void;
|
|
1554
2533
|
/**
|
|
1555
2534
|
* Removes the specified hold and releases the accounts or organizational unit covered by the hold. If the data is not preserved by another hold or retention rule, it might be purged.
|
|
2535
|
+
* @example
|
|
2536
|
+
* ```js
|
|
2537
|
+
* // Before running the sample:
|
|
2538
|
+
* // - Enable the API at:
|
|
2539
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
2540
|
+
* // - Login into gcloud by running:
|
|
2541
|
+
* // ```sh
|
|
2542
|
+
* // $ gcloud auth application-default login
|
|
2543
|
+
* // ```
|
|
2544
|
+
* // - Install the npm module by running:
|
|
2545
|
+
* // ```sh
|
|
2546
|
+
* // $ npm install googleapis
|
|
2547
|
+
* // ```
|
|
2548
|
+
*
|
|
2549
|
+
* const {google} = require('googleapis');
|
|
2550
|
+
* const vault = google.vault('v1');
|
|
2551
|
+
*
|
|
2552
|
+
* async function main() {
|
|
2553
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2554
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2555
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
2556
|
+
* });
|
|
2557
|
+
*
|
|
2558
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2559
|
+
* const authClient = await auth.getClient();
|
|
2560
|
+
* google.options({auth: authClient});
|
|
2561
|
+
*
|
|
2562
|
+
* // Do the magic
|
|
2563
|
+
* const res = await vault.matters.holds.delete({
|
|
2564
|
+
* // The hold ID.
|
|
2565
|
+
* holdId: 'placeholder-value',
|
|
2566
|
+
* // The matter ID.
|
|
2567
|
+
* matterId: 'placeholder-value',
|
|
2568
|
+
* });
|
|
2569
|
+
* console.log(res.data);
|
|
2570
|
+
*
|
|
2571
|
+
* // Example response
|
|
2572
|
+
* // {}
|
|
2573
|
+
* }
|
|
2574
|
+
*
|
|
2575
|
+
* main().catch(e => {
|
|
2576
|
+
* console.error(e);
|
|
2577
|
+
* throw e;
|
|
2578
|
+
* });
|
|
2579
|
+
*
|
|
2580
|
+
* ```
|
|
1556
2581
|
*
|
|
1557
2582
|
* @param params - Parameters for request
|
|
1558
2583
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1567,6 +2592,65 @@ export declare namespace vault_v1 {
|
|
|
1567
2592
|
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
1568
2593
|
/**
|
|
1569
2594
|
* Gets the specified hold.
|
|
2595
|
+
* @example
|
|
2596
|
+
* ```js
|
|
2597
|
+
* // Before running the sample:
|
|
2598
|
+
* // - Enable the API at:
|
|
2599
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
2600
|
+
* // - Login into gcloud by running:
|
|
2601
|
+
* // ```sh
|
|
2602
|
+
* // $ gcloud auth application-default login
|
|
2603
|
+
* // ```
|
|
2604
|
+
* // - Install the npm module by running:
|
|
2605
|
+
* // ```sh
|
|
2606
|
+
* // $ npm install googleapis
|
|
2607
|
+
* // ```
|
|
2608
|
+
*
|
|
2609
|
+
* const {google} = require('googleapis');
|
|
2610
|
+
* const vault = google.vault('v1');
|
|
2611
|
+
*
|
|
2612
|
+
* async function main() {
|
|
2613
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2614
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2615
|
+
* scopes: [
|
|
2616
|
+
* 'https://www.googleapis.com/auth/ediscovery',
|
|
2617
|
+
* 'https://www.googleapis.com/auth/ediscovery.readonly',
|
|
2618
|
+
* ],
|
|
2619
|
+
* });
|
|
2620
|
+
*
|
|
2621
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2622
|
+
* const authClient = await auth.getClient();
|
|
2623
|
+
* google.options({auth: authClient});
|
|
2624
|
+
*
|
|
2625
|
+
* // Do the magic
|
|
2626
|
+
* const res = await vault.matters.holds.get({
|
|
2627
|
+
* // The hold ID.
|
|
2628
|
+
* holdId: 'placeholder-value',
|
|
2629
|
+
* // The matter ID.
|
|
2630
|
+
* matterId: 'placeholder-value',
|
|
2631
|
+
* // The amount of detail to return for a hold.
|
|
2632
|
+
* view: 'placeholder-value',
|
|
2633
|
+
* });
|
|
2634
|
+
* console.log(res.data);
|
|
2635
|
+
*
|
|
2636
|
+
* // Example response
|
|
2637
|
+
* // {
|
|
2638
|
+
* // "accounts": [],
|
|
2639
|
+
* // "corpus": "my_corpus",
|
|
2640
|
+
* // "holdId": "my_holdId",
|
|
2641
|
+
* // "name": "my_name",
|
|
2642
|
+
* // "orgUnit": {},
|
|
2643
|
+
* // "query": {},
|
|
2644
|
+
* // "updateTime": "my_updateTime"
|
|
2645
|
+
* // }
|
|
2646
|
+
* }
|
|
2647
|
+
*
|
|
2648
|
+
* main().catch(e => {
|
|
2649
|
+
* console.error(e);
|
|
2650
|
+
* throw e;
|
|
2651
|
+
* });
|
|
2652
|
+
*
|
|
2653
|
+
* ```
|
|
1570
2654
|
*
|
|
1571
2655
|
* @param params - Parameters for request
|
|
1572
2656
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1581,6 +2665,62 @@ export declare namespace vault_v1 {
|
|
|
1581
2665
|
get(callback: BodyResponseCallback<Schema$Hold>): void;
|
|
1582
2666
|
/**
|
|
1583
2667
|
* Lists the holds in a matter.
|
|
2668
|
+
* @example
|
|
2669
|
+
* ```js
|
|
2670
|
+
* // Before running the sample:
|
|
2671
|
+
* // - Enable the API at:
|
|
2672
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
2673
|
+
* // - Login into gcloud by running:
|
|
2674
|
+
* // ```sh
|
|
2675
|
+
* // $ gcloud auth application-default login
|
|
2676
|
+
* // ```
|
|
2677
|
+
* // - Install the npm module by running:
|
|
2678
|
+
* // ```sh
|
|
2679
|
+
* // $ npm install googleapis
|
|
2680
|
+
* // ```
|
|
2681
|
+
*
|
|
2682
|
+
* const {google} = require('googleapis');
|
|
2683
|
+
* const vault = google.vault('v1');
|
|
2684
|
+
*
|
|
2685
|
+
* async function main() {
|
|
2686
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2687
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2688
|
+
* scopes: [
|
|
2689
|
+
* 'https://www.googleapis.com/auth/ediscovery',
|
|
2690
|
+
* 'https://www.googleapis.com/auth/ediscovery.readonly',
|
|
2691
|
+
* ],
|
|
2692
|
+
* });
|
|
2693
|
+
*
|
|
2694
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2695
|
+
* const authClient = await auth.getClient();
|
|
2696
|
+
* google.options({auth: authClient});
|
|
2697
|
+
*
|
|
2698
|
+
* // Do the magic
|
|
2699
|
+
* const res = await vault.matters.holds.list({
|
|
2700
|
+
* // The matter ID.
|
|
2701
|
+
* matterId: 'placeholder-value',
|
|
2702
|
+
* // The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **page_size** = 100.
|
|
2703
|
+
* pageSize: 'placeholder-value',
|
|
2704
|
+
* // The pagination token as returned in the response. An empty token means start from the beginning.
|
|
2705
|
+
* pageToken: 'placeholder-value',
|
|
2706
|
+
* // The amount of detail to return for a hold.
|
|
2707
|
+
* view: 'placeholder-value',
|
|
2708
|
+
* });
|
|
2709
|
+
* console.log(res.data);
|
|
2710
|
+
*
|
|
2711
|
+
* // Example response
|
|
2712
|
+
* // {
|
|
2713
|
+
* // "holds": [],
|
|
2714
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
2715
|
+
* // }
|
|
2716
|
+
* }
|
|
2717
|
+
*
|
|
2718
|
+
* main().catch(e => {
|
|
2719
|
+
* console.error(e);
|
|
2720
|
+
* throw e;
|
|
2721
|
+
* });
|
|
2722
|
+
*
|
|
2723
|
+
* ```
|
|
1584
2724
|
*
|
|
1585
2725
|
* @param params - Parameters for request
|
|
1586
2726
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1595,6 +2735,62 @@ export declare namespace vault_v1 {
|
|
|
1595
2735
|
list(callback: BodyResponseCallback<Schema$ListHoldsResponse>): void;
|
|
1596
2736
|
/**
|
|
1597
2737
|
* Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.
|
|
2738
|
+
* @example
|
|
2739
|
+
* ```js
|
|
2740
|
+
* // Before running the sample:
|
|
2741
|
+
* // - Enable the API at:
|
|
2742
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
2743
|
+
* // - Login into gcloud by running:
|
|
2744
|
+
* // ```sh
|
|
2745
|
+
* // $ gcloud auth application-default login
|
|
2746
|
+
* // ```
|
|
2747
|
+
* // - Install the npm module by running:
|
|
2748
|
+
* // ```sh
|
|
2749
|
+
* // $ npm install googleapis
|
|
2750
|
+
* // ```
|
|
2751
|
+
*
|
|
2752
|
+
* const {google} = require('googleapis');
|
|
2753
|
+
* const vault = google.vault('v1');
|
|
2754
|
+
*
|
|
2755
|
+
* async function main() {
|
|
2756
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2757
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2758
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
2759
|
+
* });
|
|
2760
|
+
*
|
|
2761
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2762
|
+
* const authClient = await auth.getClient();
|
|
2763
|
+
* google.options({auth: authClient});
|
|
2764
|
+
*
|
|
2765
|
+
* // Do the magic
|
|
2766
|
+
* const res = await vault.matters.holds.removeHeldAccounts({
|
|
2767
|
+
* // The hold ID.
|
|
2768
|
+
* holdId: 'placeholder-value',
|
|
2769
|
+
* // The matter ID.
|
|
2770
|
+
* matterId: 'placeholder-value',
|
|
2771
|
+
*
|
|
2772
|
+
* // Request body metadata
|
|
2773
|
+
* requestBody: {
|
|
2774
|
+
* // request body parameters
|
|
2775
|
+
* // {
|
|
2776
|
+
* // "accountIds": []
|
|
2777
|
+
* // }
|
|
2778
|
+
* },
|
|
2779
|
+
* });
|
|
2780
|
+
* console.log(res.data);
|
|
2781
|
+
*
|
|
2782
|
+
* // Example response
|
|
2783
|
+
* // {
|
|
2784
|
+
* // "statuses": []
|
|
2785
|
+
* // }
|
|
2786
|
+
* }
|
|
2787
|
+
*
|
|
2788
|
+
* main().catch(e => {
|
|
2789
|
+
* console.error(e);
|
|
2790
|
+
* throw e;
|
|
2791
|
+
* });
|
|
2792
|
+
*
|
|
2793
|
+
* ```
|
|
1598
2794
|
*
|
|
1599
2795
|
* @param params - Parameters for request
|
|
1600
2796
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1609,6 +2805,74 @@ export declare namespace vault_v1 {
|
|
|
1609
2805
|
removeHeldAccounts(callback: BodyResponseCallback<Schema$RemoveHeldAccountsResponse>): void;
|
|
1610
2806
|
/**
|
|
1611
2807
|
* Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored.
|
|
2808
|
+
* @example
|
|
2809
|
+
* ```js
|
|
2810
|
+
* // Before running the sample:
|
|
2811
|
+
* // - Enable the API at:
|
|
2812
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
2813
|
+
* // - Login into gcloud by running:
|
|
2814
|
+
* // ```sh
|
|
2815
|
+
* // $ gcloud auth application-default login
|
|
2816
|
+
* // ```
|
|
2817
|
+
* // - Install the npm module by running:
|
|
2818
|
+
* // ```sh
|
|
2819
|
+
* // $ npm install googleapis
|
|
2820
|
+
* // ```
|
|
2821
|
+
*
|
|
2822
|
+
* const {google} = require('googleapis');
|
|
2823
|
+
* const vault = google.vault('v1');
|
|
2824
|
+
*
|
|
2825
|
+
* async function main() {
|
|
2826
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2827
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2828
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
2829
|
+
* });
|
|
2830
|
+
*
|
|
2831
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2832
|
+
* const authClient = await auth.getClient();
|
|
2833
|
+
* google.options({auth: authClient});
|
|
2834
|
+
*
|
|
2835
|
+
* // Do the magic
|
|
2836
|
+
* const res = await vault.matters.holds.update({
|
|
2837
|
+
* // The ID of the hold.
|
|
2838
|
+
* holdId: 'placeholder-value',
|
|
2839
|
+
* // The matter ID.
|
|
2840
|
+
* matterId: 'placeholder-value',
|
|
2841
|
+
*
|
|
2842
|
+
* // Request body metadata
|
|
2843
|
+
* requestBody: {
|
|
2844
|
+
* // request body parameters
|
|
2845
|
+
* // {
|
|
2846
|
+
* // "accounts": [],
|
|
2847
|
+
* // "corpus": "my_corpus",
|
|
2848
|
+
* // "holdId": "my_holdId",
|
|
2849
|
+
* // "name": "my_name",
|
|
2850
|
+
* // "orgUnit": {},
|
|
2851
|
+
* // "query": {},
|
|
2852
|
+
* // "updateTime": "my_updateTime"
|
|
2853
|
+
* // }
|
|
2854
|
+
* },
|
|
2855
|
+
* });
|
|
2856
|
+
* console.log(res.data);
|
|
2857
|
+
*
|
|
2858
|
+
* // Example response
|
|
2859
|
+
* // {
|
|
2860
|
+
* // "accounts": [],
|
|
2861
|
+
* // "corpus": "my_corpus",
|
|
2862
|
+
* // "holdId": "my_holdId",
|
|
2863
|
+
* // "name": "my_name",
|
|
2864
|
+
* // "orgUnit": {},
|
|
2865
|
+
* // "query": {},
|
|
2866
|
+
* // "updateTime": "my_updateTime"
|
|
2867
|
+
* // }
|
|
2868
|
+
* }
|
|
2869
|
+
*
|
|
2870
|
+
* main().catch(e => {
|
|
2871
|
+
* console.error(e);
|
|
2872
|
+
* throw e;
|
|
2873
|
+
* });
|
|
2874
|
+
*
|
|
2875
|
+
* ```
|
|
1612
2876
|
*
|
|
1613
2877
|
* @param params - Parameters for request
|
|
1614
2878
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1721,6 +2985,70 @@ export declare namespace vault_v1 {
|
|
|
1721
2985
|
constructor(context: APIRequestContext);
|
|
1722
2986
|
/**
|
|
1723
2987
|
* Adds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned.
|
|
2988
|
+
* @example
|
|
2989
|
+
* ```js
|
|
2990
|
+
* // Before running the sample:
|
|
2991
|
+
* // - Enable the API at:
|
|
2992
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
2993
|
+
* // - Login into gcloud by running:
|
|
2994
|
+
* // ```sh
|
|
2995
|
+
* // $ gcloud auth application-default login
|
|
2996
|
+
* // ```
|
|
2997
|
+
* // - Install the npm module by running:
|
|
2998
|
+
* // ```sh
|
|
2999
|
+
* // $ npm install googleapis
|
|
3000
|
+
* // ```
|
|
3001
|
+
*
|
|
3002
|
+
* const {google} = require('googleapis');
|
|
3003
|
+
* const vault = google.vault('v1');
|
|
3004
|
+
*
|
|
3005
|
+
* async function main() {
|
|
3006
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3007
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3008
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
3009
|
+
* });
|
|
3010
|
+
*
|
|
3011
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3012
|
+
* const authClient = await auth.getClient();
|
|
3013
|
+
* google.options({auth: authClient});
|
|
3014
|
+
*
|
|
3015
|
+
* // Do the magic
|
|
3016
|
+
* const res = await vault.matters.holds.accounts.create({
|
|
3017
|
+
* // The hold ID.
|
|
3018
|
+
* holdId: 'placeholder-value',
|
|
3019
|
+
* // The matter ID.
|
|
3020
|
+
* matterId: 'placeholder-value',
|
|
3021
|
+
*
|
|
3022
|
+
* // Request body metadata
|
|
3023
|
+
* requestBody: {
|
|
3024
|
+
* // request body parameters
|
|
3025
|
+
* // {
|
|
3026
|
+
* // "accountId": "my_accountId",
|
|
3027
|
+
* // "email": "my_email",
|
|
3028
|
+
* // "firstName": "my_firstName",
|
|
3029
|
+
* // "holdTime": "my_holdTime",
|
|
3030
|
+
* // "lastName": "my_lastName"
|
|
3031
|
+
* // }
|
|
3032
|
+
* },
|
|
3033
|
+
* });
|
|
3034
|
+
* console.log(res.data);
|
|
3035
|
+
*
|
|
3036
|
+
* // Example response
|
|
3037
|
+
* // {
|
|
3038
|
+
* // "accountId": "my_accountId",
|
|
3039
|
+
* // "email": "my_email",
|
|
3040
|
+
* // "firstName": "my_firstName",
|
|
3041
|
+
* // "holdTime": "my_holdTime",
|
|
3042
|
+
* // "lastName": "my_lastName"
|
|
3043
|
+
* // }
|
|
3044
|
+
* }
|
|
3045
|
+
*
|
|
3046
|
+
* main().catch(e => {
|
|
3047
|
+
* console.error(e);
|
|
3048
|
+
* throw e;
|
|
3049
|
+
* });
|
|
3050
|
+
*
|
|
3051
|
+
* ```
|
|
1724
3052
|
*
|
|
1725
3053
|
* @param params - Parameters for request
|
|
1726
3054
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1735,6 +3063,54 @@ export declare namespace vault_v1 {
|
|
|
1735
3063
|
create(callback: BodyResponseCallback<Schema$HeldAccount>): void;
|
|
1736
3064
|
/**
|
|
1737
3065
|
* Removes an account from a hold.
|
|
3066
|
+
* @example
|
|
3067
|
+
* ```js
|
|
3068
|
+
* // Before running the sample:
|
|
3069
|
+
* // - Enable the API at:
|
|
3070
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
3071
|
+
* // - Login into gcloud by running:
|
|
3072
|
+
* // ```sh
|
|
3073
|
+
* // $ gcloud auth application-default login
|
|
3074
|
+
* // ```
|
|
3075
|
+
* // - Install the npm module by running:
|
|
3076
|
+
* // ```sh
|
|
3077
|
+
* // $ npm install googleapis
|
|
3078
|
+
* // ```
|
|
3079
|
+
*
|
|
3080
|
+
* const {google} = require('googleapis');
|
|
3081
|
+
* const vault = google.vault('v1');
|
|
3082
|
+
*
|
|
3083
|
+
* async function main() {
|
|
3084
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3085
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3086
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
3087
|
+
* });
|
|
3088
|
+
*
|
|
3089
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3090
|
+
* const authClient = await auth.getClient();
|
|
3091
|
+
* google.options({auth: authClient});
|
|
3092
|
+
*
|
|
3093
|
+
* // Do the magic
|
|
3094
|
+
* const res = await vault.matters.holds.accounts.delete({
|
|
3095
|
+
* // The ID of the account to remove from the hold.
|
|
3096
|
+
* accountId: 'placeholder-value',
|
|
3097
|
+
* // The hold ID.
|
|
3098
|
+
* holdId: 'placeholder-value',
|
|
3099
|
+
* // The matter ID.
|
|
3100
|
+
* matterId: 'placeholder-value',
|
|
3101
|
+
* });
|
|
3102
|
+
* console.log(res.data);
|
|
3103
|
+
*
|
|
3104
|
+
* // Example response
|
|
3105
|
+
* // {}
|
|
3106
|
+
* }
|
|
3107
|
+
*
|
|
3108
|
+
* main().catch(e => {
|
|
3109
|
+
* console.error(e);
|
|
3110
|
+
* throw e;
|
|
3111
|
+
* });
|
|
3112
|
+
*
|
|
3113
|
+
* ```
|
|
1738
3114
|
*
|
|
1739
3115
|
* @param params - Parameters for request
|
|
1740
3116
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1749,6 +3125,57 @@ export declare namespace vault_v1 {
|
|
|
1749
3125
|
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
1750
3126
|
/**
|
|
1751
3127
|
* Lists the accounts covered by a hold. This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the [Admin SDK](https://developers.google.com/admin-sdk/). to list the members of the organizational unit on hold.
|
|
3128
|
+
* @example
|
|
3129
|
+
* ```js
|
|
3130
|
+
* // Before running the sample:
|
|
3131
|
+
* // - Enable the API at:
|
|
3132
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
3133
|
+
* // - Login into gcloud by running:
|
|
3134
|
+
* // ```sh
|
|
3135
|
+
* // $ gcloud auth application-default login
|
|
3136
|
+
* // ```
|
|
3137
|
+
* // - Install the npm module by running:
|
|
3138
|
+
* // ```sh
|
|
3139
|
+
* // $ npm install googleapis
|
|
3140
|
+
* // ```
|
|
3141
|
+
*
|
|
3142
|
+
* const {google} = require('googleapis');
|
|
3143
|
+
* const vault = google.vault('v1');
|
|
3144
|
+
*
|
|
3145
|
+
* async function main() {
|
|
3146
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3147
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3148
|
+
* scopes: [
|
|
3149
|
+
* 'https://www.googleapis.com/auth/ediscovery',
|
|
3150
|
+
* 'https://www.googleapis.com/auth/ediscovery.readonly',
|
|
3151
|
+
* ],
|
|
3152
|
+
* });
|
|
3153
|
+
*
|
|
3154
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3155
|
+
* const authClient = await auth.getClient();
|
|
3156
|
+
* google.options({auth: authClient});
|
|
3157
|
+
*
|
|
3158
|
+
* // Do the magic
|
|
3159
|
+
* const res = await vault.matters.holds.accounts.list({
|
|
3160
|
+
* // The hold ID.
|
|
3161
|
+
* holdId: 'placeholder-value',
|
|
3162
|
+
* // The matter ID.
|
|
3163
|
+
* matterId: 'placeholder-value',
|
|
3164
|
+
* });
|
|
3165
|
+
* console.log(res.data);
|
|
3166
|
+
*
|
|
3167
|
+
* // Example response
|
|
3168
|
+
* // {
|
|
3169
|
+
* // "accounts": []
|
|
3170
|
+
* // }
|
|
3171
|
+
* }
|
|
3172
|
+
*
|
|
3173
|
+
* main().catch(e => {
|
|
3174
|
+
* console.error(e);
|
|
3175
|
+
* throw e;
|
|
3176
|
+
* });
|
|
3177
|
+
*
|
|
3178
|
+
* ```
|
|
1752
3179
|
*
|
|
1753
3180
|
* @param params - Parameters for request
|
|
1754
3181
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1805,6 +3232,68 @@ export declare namespace vault_v1 {
|
|
|
1805
3232
|
constructor(context: APIRequestContext);
|
|
1806
3233
|
/**
|
|
1807
3234
|
* Creates a saved query.
|
|
3235
|
+
* @example
|
|
3236
|
+
* ```js
|
|
3237
|
+
* // Before running the sample:
|
|
3238
|
+
* // - Enable the API at:
|
|
3239
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
3240
|
+
* // - Login into gcloud by running:
|
|
3241
|
+
* // ```sh
|
|
3242
|
+
* // $ gcloud auth application-default login
|
|
3243
|
+
* // ```
|
|
3244
|
+
* // - Install the npm module by running:
|
|
3245
|
+
* // ```sh
|
|
3246
|
+
* // $ npm install googleapis
|
|
3247
|
+
* // ```
|
|
3248
|
+
*
|
|
3249
|
+
* const {google} = require('googleapis');
|
|
3250
|
+
* const vault = google.vault('v1');
|
|
3251
|
+
*
|
|
3252
|
+
* async function main() {
|
|
3253
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3254
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3255
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
3256
|
+
* });
|
|
3257
|
+
*
|
|
3258
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3259
|
+
* const authClient = await auth.getClient();
|
|
3260
|
+
* google.options({auth: authClient});
|
|
3261
|
+
*
|
|
3262
|
+
* // Do the magic
|
|
3263
|
+
* const res = await vault.matters.savedQueries.create({
|
|
3264
|
+
* // The ID of the matter to create the saved query in.
|
|
3265
|
+
* matterId: 'placeholder-value',
|
|
3266
|
+
*
|
|
3267
|
+
* // Request body metadata
|
|
3268
|
+
* requestBody: {
|
|
3269
|
+
* // request body parameters
|
|
3270
|
+
* // {
|
|
3271
|
+
* // "createTime": "my_createTime",
|
|
3272
|
+
* // "displayName": "my_displayName",
|
|
3273
|
+
* // "matterId": "my_matterId",
|
|
3274
|
+
* // "query": {},
|
|
3275
|
+
* // "savedQueryId": "my_savedQueryId"
|
|
3276
|
+
* // }
|
|
3277
|
+
* },
|
|
3278
|
+
* });
|
|
3279
|
+
* console.log(res.data);
|
|
3280
|
+
*
|
|
3281
|
+
* // Example response
|
|
3282
|
+
* // {
|
|
3283
|
+
* // "createTime": "my_createTime",
|
|
3284
|
+
* // "displayName": "my_displayName",
|
|
3285
|
+
* // "matterId": "my_matterId",
|
|
3286
|
+
* // "query": {},
|
|
3287
|
+
* // "savedQueryId": "my_savedQueryId"
|
|
3288
|
+
* // }
|
|
3289
|
+
* }
|
|
3290
|
+
*
|
|
3291
|
+
* main().catch(e => {
|
|
3292
|
+
* console.error(e);
|
|
3293
|
+
* throw e;
|
|
3294
|
+
* });
|
|
3295
|
+
*
|
|
3296
|
+
* ```
|
|
1808
3297
|
*
|
|
1809
3298
|
* @param params - Parameters for request
|
|
1810
3299
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1819,6 +3308,52 @@ export declare namespace vault_v1 {
|
|
|
1819
3308
|
create(callback: BodyResponseCallback<Schema$SavedQuery>): void;
|
|
1820
3309
|
/**
|
|
1821
3310
|
* Deletes the specified saved query.
|
|
3311
|
+
* @example
|
|
3312
|
+
* ```js
|
|
3313
|
+
* // Before running the sample:
|
|
3314
|
+
* // - Enable the API at:
|
|
3315
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
3316
|
+
* // - Login into gcloud by running:
|
|
3317
|
+
* // ```sh
|
|
3318
|
+
* // $ gcloud auth application-default login
|
|
3319
|
+
* // ```
|
|
3320
|
+
* // - Install the npm module by running:
|
|
3321
|
+
* // ```sh
|
|
3322
|
+
* // $ npm install googleapis
|
|
3323
|
+
* // ```
|
|
3324
|
+
*
|
|
3325
|
+
* const {google} = require('googleapis');
|
|
3326
|
+
* const vault = google.vault('v1');
|
|
3327
|
+
*
|
|
3328
|
+
* async function main() {
|
|
3329
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3330
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3331
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
3332
|
+
* });
|
|
3333
|
+
*
|
|
3334
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3335
|
+
* const authClient = await auth.getClient();
|
|
3336
|
+
* google.options({auth: authClient});
|
|
3337
|
+
*
|
|
3338
|
+
* // Do the magic
|
|
3339
|
+
* const res = await vault.matters.savedQueries.delete({
|
|
3340
|
+
* // The ID of the matter to delete the saved query from.
|
|
3341
|
+
* matterId: 'placeholder-value',
|
|
3342
|
+
* // ID of the saved query to delete.
|
|
3343
|
+
* savedQueryId: 'placeholder-value',
|
|
3344
|
+
* });
|
|
3345
|
+
* console.log(res.data);
|
|
3346
|
+
*
|
|
3347
|
+
* // Example response
|
|
3348
|
+
* // {}
|
|
3349
|
+
* }
|
|
3350
|
+
*
|
|
3351
|
+
* main().catch(e => {
|
|
3352
|
+
* console.error(e);
|
|
3353
|
+
* throw e;
|
|
3354
|
+
* });
|
|
3355
|
+
*
|
|
3356
|
+
* ```
|
|
1822
3357
|
*
|
|
1823
3358
|
* @param params - Parameters for request
|
|
1824
3359
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1833,6 +3368,61 @@ export declare namespace vault_v1 {
|
|
|
1833
3368
|
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
1834
3369
|
/**
|
|
1835
3370
|
* Retrieves the specified saved query.
|
|
3371
|
+
* @example
|
|
3372
|
+
* ```js
|
|
3373
|
+
* // Before running the sample:
|
|
3374
|
+
* // - Enable the API at:
|
|
3375
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
3376
|
+
* // - Login into gcloud by running:
|
|
3377
|
+
* // ```sh
|
|
3378
|
+
* // $ gcloud auth application-default login
|
|
3379
|
+
* // ```
|
|
3380
|
+
* // - Install the npm module by running:
|
|
3381
|
+
* // ```sh
|
|
3382
|
+
* // $ npm install googleapis
|
|
3383
|
+
* // ```
|
|
3384
|
+
*
|
|
3385
|
+
* const {google} = require('googleapis');
|
|
3386
|
+
* const vault = google.vault('v1');
|
|
3387
|
+
*
|
|
3388
|
+
* async function main() {
|
|
3389
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3390
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3391
|
+
* scopes: [
|
|
3392
|
+
* 'https://www.googleapis.com/auth/ediscovery',
|
|
3393
|
+
* 'https://www.googleapis.com/auth/ediscovery.readonly',
|
|
3394
|
+
* ],
|
|
3395
|
+
* });
|
|
3396
|
+
*
|
|
3397
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3398
|
+
* const authClient = await auth.getClient();
|
|
3399
|
+
* google.options({auth: authClient});
|
|
3400
|
+
*
|
|
3401
|
+
* // Do the magic
|
|
3402
|
+
* const res = await vault.matters.savedQueries.get({
|
|
3403
|
+
* // The ID of the matter to get the saved query from.
|
|
3404
|
+
* matterId: 'placeholder-value',
|
|
3405
|
+
* // ID of the saved query to retrieve.
|
|
3406
|
+
* savedQueryId: 'placeholder-value',
|
|
3407
|
+
* });
|
|
3408
|
+
* console.log(res.data);
|
|
3409
|
+
*
|
|
3410
|
+
* // Example response
|
|
3411
|
+
* // {
|
|
3412
|
+
* // "createTime": "my_createTime",
|
|
3413
|
+
* // "displayName": "my_displayName",
|
|
3414
|
+
* // "matterId": "my_matterId",
|
|
3415
|
+
* // "query": {},
|
|
3416
|
+
* // "savedQueryId": "my_savedQueryId"
|
|
3417
|
+
* // }
|
|
3418
|
+
* }
|
|
3419
|
+
*
|
|
3420
|
+
* main().catch(e => {
|
|
3421
|
+
* console.error(e);
|
|
3422
|
+
* throw e;
|
|
3423
|
+
* });
|
|
3424
|
+
*
|
|
3425
|
+
* ```
|
|
1836
3426
|
*
|
|
1837
3427
|
* @param params - Parameters for request
|
|
1838
3428
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1847,6 +3437,60 @@ export declare namespace vault_v1 {
|
|
|
1847
3437
|
get(callback: BodyResponseCallback<Schema$SavedQuery>): void;
|
|
1848
3438
|
/**
|
|
1849
3439
|
* Lists the saved queries in a matter.
|
|
3440
|
+
* @example
|
|
3441
|
+
* ```js
|
|
3442
|
+
* // Before running the sample:
|
|
3443
|
+
* // - Enable the API at:
|
|
3444
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
3445
|
+
* // - Login into gcloud by running:
|
|
3446
|
+
* // ```sh
|
|
3447
|
+
* // $ gcloud auth application-default login
|
|
3448
|
+
* // ```
|
|
3449
|
+
* // - Install the npm module by running:
|
|
3450
|
+
* // ```sh
|
|
3451
|
+
* // $ npm install googleapis
|
|
3452
|
+
* // ```
|
|
3453
|
+
*
|
|
3454
|
+
* const {google} = require('googleapis');
|
|
3455
|
+
* const vault = google.vault('v1');
|
|
3456
|
+
*
|
|
3457
|
+
* async function main() {
|
|
3458
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3459
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3460
|
+
* scopes: [
|
|
3461
|
+
* 'https://www.googleapis.com/auth/ediscovery',
|
|
3462
|
+
* 'https://www.googleapis.com/auth/ediscovery.readonly',
|
|
3463
|
+
* ],
|
|
3464
|
+
* });
|
|
3465
|
+
*
|
|
3466
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3467
|
+
* const authClient = await auth.getClient();
|
|
3468
|
+
* google.options({auth: authClient});
|
|
3469
|
+
*
|
|
3470
|
+
* // Do the magic
|
|
3471
|
+
* const res = await vault.matters.savedQueries.list({
|
|
3472
|
+
* // The ID of the matter to get the saved queries for.
|
|
3473
|
+
* matterId: 'placeholder-value',
|
|
3474
|
+
* // The maximum number of saved queries to return.
|
|
3475
|
+
* pageSize: 'placeholder-value',
|
|
3476
|
+
* // The pagination token as returned in the previous response. An empty token means start from the beginning.
|
|
3477
|
+
* pageToken: 'placeholder-value',
|
|
3478
|
+
* });
|
|
3479
|
+
* console.log(res.data);
|
|
3480
|
+
*
|
|
3481
|
+
* // Example response
|
|
3482
|
+
* // {
|
|
3483
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
3484
|
+
* // "savedQueries": []
|
|
3485
|
+
* // }
|
|
3486
|
+
* }
|
|
3487
|
+
*
|
|
3488
|
+
* main().catch(e => {
|
|
3489
|
+
* console.error(e);
|
|
3490
|
+
* throw e;
|
|
3491
|
+
* });
|
|
3492
|
+
*
|
|
3493
|
+
* ```
|
|
1850
3494
|
*
|
|
1851
3495
|
* @param params - Parameters for request
|
|
1852
3496
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1909,6 +3553,56 @@ export declare namespace vault_v1 {
|
|
|
1909
3553
|
constructor(context: APIRequestContext);
|
|
1910
3554
|
/**
|
|
1911
3555
|
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
|
|
3556
|
+
* @example
|
|
3557
|
+
* ```js
|
|
3558
|
+
* // Before running the sample:
|
|
3559
|
+
* // - Enable the API at:
|
|
3560
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
3561
|
+
* // - Login into gcloud by running:
|
|
3562
|
+
* // ```sh
|
|
3563
|
+
* // $ gcloud auth application-default login
|
|
3564
|
+
* // ```
|
|
3565
|
+
* // - Install the npm module by running:
|
|
3566
|
+
* // ```sh
|
|
3567
|
+
* // $ npm install googleapis
|
|
3568
|
+
* // ```
|
|
3569
|
+
*
|
|
3570
|
+
* const {google} = require('googleapis');
|
|
3571
|
+
* const vault = google.vault('v1');
|
|
3572
|
+
*
|
|
3573
|
+
* async function main() {
|
|
3574
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3575
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3576
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
3577
|
+
* });
|
|
3578
|
+
*
|
|
3579
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3580
|
+
* const authClient = await auth.getClient();
|
|
3581
|
+
* google.options({auth: authClient});
|
|
3582
|
+
*
|
|
3583
|
+
* // Do the magic
|
|
3584
|
+
* const res = await vault.operations.cancel({
|
|
3585
|
+
* // The name of the operation resource to be cancelled.
|
|
3586
|
+
* name: 'operations/.*',
|
|
3587
|
+
*
|
|
3588
|
+
* // Request body metadata
|
|
3589
|
+
* requestBody: {
|
|
3590
|
+
* // request body parameters
|
|
3591
|
+
* // {}
|
|
3592
|
+
* },
|
|
3593
|
+
* });
|
|
3594
|
+
* console.log(res.data);
|
|
3595
|
+
*
|
|
3596
|
+
* // Example response
|
|
3597
|
+
* // {}
|
|
3598
|
+
* }
|
|
3599
|
+
*
|
|
3600
|
+
* main().catch(e => {
|
|
3601
|
+
* console.error(e);
|
|
3602
|
+
* throw e;
|
|
3603
|
+
* });
|
|
3604
|
+
*
|
|
3605
|
+
* ```
|
|
1912
3606
|
*
|
|
1913
3607
|
* @param params - Parameters for request
|
|
1914
3608
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1923,6 +3617,50 @@ export declare namespace vault_v1 {
|
|
|
1923
3617
|
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
1924
3618
|
/**
|
|
1925
3619
|
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
3620
|
+
* @example
|
|
3621
|
+
* ```js
|
|
3622
|
+
* // Before running the sample:
|
|
3623
|
+
* // - Enable the API at:
|
|
3624
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
3625
|
+
* // - Login into gcloud by running:
|
|
3626
|
+
* // ```sh
|
|
3627
|
+
* // $ gcloud auth application-default login
|
|
3628
|
+
* // ```
|
|
3629
|
+
* // - Install the npm module by running:
|
|
3630
|
+
* // ```sh
|
|
3631
|
+
* // $ npm install googleapis
|
|
3632
|
+
* // ```
|
|
3633
|
+
*
|
|
3634
|
+
* const {google} = require('googleapis');
|
|
3635
|
+
* const vault = google.vault('v1');
|
|
3636
|
+
*
|
|
3637
|
+
* async function main() {
|
|
3638
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3639
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3640
|
+
* scopes: ['https://www.googleapis.com/auth/ediscovery'],
|
|
3641
|
+
* });
|
|
3642
|
+
*
|
|
3643
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3644
|
+
* const authClient = await auth.getClient();
|
|
3645
|
+
* google.options({auth: authClient});
|
|
3646
|
+
*
|
|
3647
|
+
* // Do the magic
|
|
3648
|
+
* const res = await vault.operations.delete({
|
|
3649
|
+
* // The name of the operation resource to be deleted.
|
|
3650
|
+
* name: 'operations/.*',
|
|
3651
|
+
* });
|
|
3652
|
+
* console.log(res.data);
|
|
3653
|
+
*
|
|
3654
|
+
* // Example response
|
|
3655
|
+
* // {}
|
|
3656
|
+
* }
|
|
3657
|
+
*
|
|
3658
|
+
* main().catch(e => {
|
|
3659
|
+
* console.error(e);
|
|
3660
|
+
* throw e;
|
|
3661
|
+
* });
|
|
3662
|
+
*
|
|
3663
|
+
* ```
|
|
1926
3664
|
*
|
|
1927
3665
|
* @param params - Parameters for request
|
|
1928
3666
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1937,6 +3675,59 @@ export declare namespace vault_v1 {
|
|
|
1937
3675
|
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
1938
3676
|
/**
|
|
1939
3677
|
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
3678
|
+
* @example
|
|
3679
|
+
* ```js
|
|
3680
|
+
* // Before running the sample:
|
|
3681
|
+
* // - Enable the API at:
|
|
3682
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
3683
|
+
* // - Login into gcloud by running:
|
|
3684
|
+
* // ```sh
|
|
3685
|
+
* // $ gcloud auth application-default login
|
|
3686
|
+
* // ```
|
|
3687
|
+
* // - Install the npm module by running:
|
|
3688
|
+
* // ```sh
|
|
3689
|
+
* // $ npm install googleapis
|
|
3690
|
+
* // ```
|
|
3691
|
+
*
|
|
3692
|
+
* const {google} = require('googleapis');
|
|
3693
|
+
* const vault = google.vault('v1');
|
|
3694
|
+
*
|
|
3695
|
+
* async function main() {
|
|
3696
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3697
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3698
|
+
* scopes: [
|
|
3699
|
+
* 'https://www.googleapis.com/auth/ediscovery',
|
|
3700
|
+
* 'https://www.googleapis.com/auth/ediscovery.readonly',
|
|
3701
|
+
* ],
|
|
3702
|
+
* });
|
|
3703
|
+
*
|
|
3704
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3705
|
+
* const authClient = await auth.getClient();
|
|
3706
|
+
* google.options({auth: authClient});
|
|
3707
|
+
*
|
|
3708
|
+
* // Do the magic
|
|
3709
|
+
* const res = await vault.operations.get({
|
|
3710
|
+
* // The name of the operation resource.
|
|
3711
|
+
* name: 'operations/.*',
|
|
3712
|
+
* });
|
|
3713
|
+
* console.log(res.data);
|
|
3714
|
+
*
|
|
3715
|
+
* // Example response
|
|
3716
|
+
* // {
|
|
3717
|
+
* // "done": false,
|
|
3718
|
+
* // "error": {},
|
|
3719
|
+
* // "metadata": {},
|
|
3720
|
+
* // "name": "my_name",
|
|
3721
|
+
* // "response": {}
|
|
3722
|
+
* // }
|
|
3723
|
+
* }
|
|
3724
|
+
*
|
|
3725
|
+
* main().catch(e => {
|
|
3726
|
+
* console.error(e);
|
|
3727
|
+
* throw e;
|
|
3728
|
+
* });
|
|
3729
|
+
*
|
|
3730
|
+
* ```
|
|
1940
3731
|
*
|
|
1941
3732
|
* @param params - Parameters for request
|
|
1942
3733
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -1951,6 +3742,62 @@ export declare namespace vault_v1 {
|
|
|
1951
3742
|
get(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
1952
3743
|
/**
|
|
1953
3744
|
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
3745
|
+
* @example
|
|
3746
|
+
* ```js
|
|
3747
|
+
* // Before running the sample:
|
|
3748
|
+
* // - Enable the API at:
|
|
3749
|
+
* // https://console.developers.google.com/apis/api/vault.googleapis.com
|
|
3750
|
+
* // - Login into gcloud by running:
|
|
3751
|
+
* // ```sh
|
|
3752
|
+
* // $ gcloud auth application-default login
|
|
3753
|
+
* // ```
|
|
3754
|
+
* // - Install the npm module by running:
|
|
3755
|
+
* // ```sh
|
|
3756
|
+
* // $ npm install googleapis
|
|
3757
|
+
* // ```
|
|
3758
|
+
*
|
|
3759
|
+
* const {google} = require('googleapis');
|
|
3760
|
+
* const vault = google.vault('v1');
|
|
3761
|
+
*
|
|
3762
|
+
* async function main() {
|
|
3763
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3764
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3765
|
+
* scopes: [
|
|
3766
|
+
* 'https://www.googleapis.com/auth/ediscovery',
|
|
3767
|
+
* 'https://www.googleapis.com/auth/ediscovery.readonly',
|
|
3768
|
+
* ],
|
|
3769
|
+
* });
|
|
3770
|
+
*
|
|
3771
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3772
|
+
* const authClient = await auth.getClient();
|
|
3773
|
+
* google.options({auth: authClient});
|
|
3774
|
+
*
|
|
3775
|
+
* // Do the magic
|
|
3776
|
+
* const res = await vault.operations.list({
|
|
3777
|
+
* // The standard list filter.
|
|
3778
|
+
* filter: 'placeholder-value',
|
|
3779
|
+
* // The name of the operation's parent resource.
|
|
3780
|
+
* name: 'operations',
|
|
3781
|
+
* // The standard list page size.
|
|
3782
|
+
* pageSize: 'placeholder-value',
|
|
3783
|
+
* // The standard list page token.
|
|
3784
|
+
* pageToken: 'placeholder-value',
|
|
3785
|
+
* });
|
|
3786
|
+
* console.log(res.data);
|
|
3787
|
+
*
|
|
3788
|
+
* // Example response
|
|
3789
|
+
* // {
|
|
3790
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
3791
|
+
* // "operations": []
|
|
3792
|
+
* // }
|
|
3793
|
+
* }
|
|
3794
|
+
*
|
|
3795
|
+
* main().catch(e => {
|
|
3796
|
+
* console.error(e);
|
|
3797
|
+
* throw e;
|
|
3798
|
+
* });
|
|
3799
|
+
*
|
|
3800
|
+
* ```
|
|
1954
3801
|
*
|
|
1955
3802
|
* @param params - Parameters for request
|
|
1956
3803
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|