@googleapis/storagetransfer 4.0.0 → 4.0.2

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/v1.ts CHANGED
@@ -203,6 +203,10 @@ export namespace storagetransfer_v1 {
203
203
  * Required. S3 Bucket name (see [Creating a bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).
204
204
  */
205
205
  bucketName?: string | null;
206
+ /**
207
+ * Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" \} GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. If `credentials_secret` is specified, do not specify azure_credentials. This feature is in [preview](https://cloud.google.com/terms/service-terms#1). Format: `projects/{project_number\}/secrets/{secret_name\}`
208
+ */
209
+ credentialsSecret?: string | null;
206
210
  /**
207
211
  * Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.
208
212
  */
@@ -224,6 +228,10 @@ export namespace storagetransfer_v1 {
224
228
  * Required. The container to transfer from the Azure Storage account.
225
229
  */
226
230
  container?: string | null;
231
+ /**
232
+ * Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" \} GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. If `credentials_secret` is specified, do not specify azure_credentials. This feature is in [preview](https://cloud.google.com/terms/service-terms#1). Format: `projects/{project_number\}/secrets/{secret_name\}`
233
+ */
234
+ credentialsSecret?: string | null;
227
235
  /**
228
236
  * Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.
229
237
  */
@@ -306,6 +314,23 @@ export namespace storagetransfer_v1 {
306
314
  */
307
315
  errorLogEntries?: Schema$ErrorLogEntry[];
308
316
  }
317
+ /**
318
+ * Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.
319
+ */
320
+ export interface Schema$EventStream {
321
+ /**
322
+ * Specifies the data and time at which Storage Transfer Service stops listening for events from this stream. After this time, any transfers in progress will complete, but no new transfers are initiated.
323
+ */
324
+ eventStreamExpirationTime?: string | null;
325
+ /**
326
+ * Specifies the date and time that Storage Transfer Service starts listening for events from this stream. If no start time is specified or start time is in the past, Storage Transfer Service starts listening immediately.
327
+ */
328
+ eventStreamStartTime?: string | null;
329
+ /**
330
+ * Required. Specifies a unique name of the resource such as AWS SQS ARN in the form 'arn:aws:sqs:region:account_id:queue_name', or Pub/Sub subscription resource name in the form 'projects/{project\}/subscriptions/{sub\}'.
331
+ */
332
+ name?: string | null;
333
+ }
309
334
  /**
310
335
  * In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated.
311
336
  */
@@ -505,7 +530,7 @@ export namespace storagetransfer_v1 {
505
530
  */
506
531
  name?: string | null;
507
532
  /**
508
- * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
533
+ * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
509
534
  */
510
535
  response?: {[key: string]: any} | null;
511
536
  }
@@ -724,6 +749,10 @@ export namespace storagetransfer_v1 {
724
749
  * A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
725
750
  */
726
751
  description?: string | null;
752
+ /**
753
+ * Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
754
+ */
755
+ eventStream?: Schema$EventStream;
727
756
  /**
728
757
  * Output only. The time that the transfer job was last modified.
729
758
  */
@@ -786,6 +815,10 @@ export namespace storagetransfer_v1 {
786
815
  * Summarizes errors encountered with sample error log entries.
787
816
  */
788
817
  errorBreakdowns?: Schema$ErrorSummary[];
818
+ /**
819
+ * Cloud Logging configuration.
820
+ */
821
+ loggingConfig?: Schema$LoggingConfig;
789
822
  /**
790
823
  * A globally unique ID assigned by the system.
791
824
  */
@@ -865,7 +898,7 @@ export namespace storagetransfer_v1 {
865
898
  */
866
899
  gcsDataSource?: Schema$GcsData;
867
900
  /**
868
- * Cloud Storage intermediate data location.
901
+ * For transfers between file systems, specifies a Cloud Storage bucket to be used as an intermediate location through which to transfer data. See [Transfer data between file systems](https://cloud.google.com/storage-transfer/docs/file-to-file) for more information.
869
902
  */
870
903
  gcsIntermediateDataLocation?: Schema$GcsData;
871
904
  /**
@@ -927,49 +960,6 @@ export namespace storagetransfer_v1 {
927
960
 
928
961
  /**
929
962
  * Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Cloud project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.
930
- * @example
931
- * ```js
932
- * // Before running the sample:
933
- * // - Enable the API at:
934
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
935
- * // - Login into gcloud by running:
936
- * // `$ gcloud auth application-default login`
937
- * // - Install the npm module by running:
938
- * // `$ npm install googleapis`
939
- *
940
- * const {google} = require('googleapis');
941
- * const storagetransfer = google.storagetransfer('v1');
942
- *
943
- * async function main() {
944
- * const auth = new google.auth.GoogleAuth({
945
- * // Scopes can be specified either as an array or as a single, space-delimited string.
946
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
947
- * });
948
- *
949
- * // Acquire an auth client, and bind it to all future calls
950
- * const authClient = await auth.getClient();
951
- * google.options({auth: authClient});
952
- *
953
- * // Do the magic
954
- * const res = await storagetransfer.googleServiceAccounts.get({
955
- * // Required. The ID of the Google Cloud project that the Google service account is associated with.
956
- * projectId: 'placeholder-value',
957
- * });
958
- * console.log(res.data);
959
- *
960
- * // Example response
961
- * // {
962
- * // "accountEmail": "my_accountEmail",
963
- * // "subjectId": "my_subjectId"
964
- * // }
965
- * }
966
- *
967
- * main().catch(e => {
968
- * console.error(e);
969
- * throw e;
970
- * });
971
- *
972
- * ```
973
963
  *
974
964
  * @param params - Parameters for request
975
965
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1087,64 +1077,6 @@ export namespace storagetransfer_v1 {
1087
1077
 
1088
1078
  /**
1089
1079
  * Creates an agent pool resource.
1090
- * @example
1091
- * ```js
1092
- * // Before running the sample:
1093
- * // - Enable the API at:
1094
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
1095
- * // - Login into gcloud by running:
1096
- * // `$ gcloud auth application-default login`
1097
- * // - Install the npm module by running:
1098
- * // `$ npm install googleapis`
1099
- *
1100
- * const {google} = require('googleapis');
1101
- * const storagetransfer = google.storagetransfer('v1');
1102
- *
1103
- * async function main() {
1104
- * const auth = new google.auth.GoogleAuth({
1105
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1106
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1107
- * });
1108
- *
1109
- * // Acquire an auth client, and bind it to all future calls
1110
- * const authClient = await auth.getClient();
1111
- * google.options({auth: authClient});
1112
- *
1113
- * // Do the magic
1114
- * const res = await storagetransfer.projects.agentPools.create({
1115
- * // Required. The ID of the agent pool to create. The `agent_pool_id` must meet the following requirements: * Length of 128 characters or less. * Not start with the string `goog`. * Start with a lowercase ASCII character, followed by: * Zero or more: lowercase Latin alphabet characters, numerals, hyphens (`-`), periods (`.`), underscores (`_`), or tildes (`~`). * One or more numerals or lowercase ASCII characters. As expressed by the regular expression: `^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$`.
1116
- * agentPoolId: 'placeholder-value',
1117
- * // Required. The ID of the Google Cloud project that owns the agent pool.
1118
- * projectId: '[^/]+',
1119
- *
1120
- * // Request body metadata
1121
- * requestBody: {
1122
- * // request body parameters
1123
- * // {
1124
- * // "bandwidthLimit": {},
1125
- * // "displayName": "my_displayName",
1126
- * // "name": "my_name",
1127
- * // "state": "my_state"
1128
- * // }
1129
- * },
1130
- * });
1131
- * console.log(res.data);
1132
- *
1133
- * // Example response
1134
- * // {
1135
- * // "bandwidthLimit": {},
1136
- * // "displayName": "my_displayName",
1137
- * // "name": "my_name",
1138
- * // "state": "my_state"
1139
- * // }
1140
- * }
1141
- *
1142
- * main().catch(e => {
1143
- * console.error(e);
1144
- * throw e;
1145
- * });
1146
- *
1147
- * ```
1148
1080
  *
1149
1081
  * @param params - Parameters for request
1150
1082
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1233,46 +1165,6 @@ export namespace storagetransfer_v1 {
1233
1165
 
1234
1166
  /**
1235
1167
  * Deletes an agent pool.
1236
- * @example
1237
- * ```js
1238
- * // Before running the sample:
1239
- * // - Enable the API at:
1240
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
1241
- * // - Login into gcloud by running:
1242
- * // `$ gcloud auth application-default login`
1243
- * // - Install the npm module by running:
1244
- * // `$ npm install googleapis`
1245
- *
1246
- * const {google} = require('googleapis');
1247
- * const storagetransfer = google.storagetransfer('v1');
1248
- *
1249
- * async function main() {
1250
- * const auth = new google.auth.GoogleAuth({
1251
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1252
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1253
- * });
1254
- *
1255
- * // Acquire an auth client, and bind it to all future calls
1256
- * const authClient = await auth.getClient();
1257
- * google.options({auth: authClient});
1258
- *
1259
- * // Do the magic
1260
- * const res = await storagetransfer.projects.agentPools.delete({
1261
- * // Required. The name of the agent pool to delete.
1262
- * name: 'projects/my-project/agentPools/my-agentPool',
1263
- * });
1264
- * console.log(res.data);
1265
- *
1266
- * // Example response
1267
- * // {}
1268
- * }
1269
- *
1270
- * main().catch(e => {
1271
- * console.error(e);
1272
- * throw e;
1273
- * });
1274
- *
1275
- * ```
1276
1168
  *
1277
1169
  * @param params - Parameters for request
1278
1170
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1358,51 +1250,6 @@ export namespace storagetransfer_v1 {
1358
1250
 
1359
1251
  /**
1360
1252
  * Gets an agent pool.
1361
- * @example
1362
- * ```js
1363
- * // Before running the sample:
1364
- * // - Enable the API at:
1365
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
1366
- * // - Login into gcloud by running:
1367
- * // `$ gcloud auth application-default login`
1368
- * // - Install the npm module by running:
1369
- * // `$ npm install googleapis`
1370
- *
1371
- * const {google} = require('googleapis');
1372
- * const storagetransfer = google.storagetransfer('v1');
1373
- *
1374
- * async function main() {
1375
- * const auth = new google.auth.GoogleAuth({
1376
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1377
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1378
- * });
1379
- *
1380
- * // Acquire an auth client, and bind it to all future calls
1381
- * const authClient = await auth.getClient();
1382
- * google.options({auth: authClient});
1383
- *
1384
- * // Do the magic
1385
- * const res = await storagetransfer.projects.agentPools.get({
1386
- * // Required. The name of the agent pool to get.
1387
- * name: 'projects/my-project/agentPools/my-agentPool',
1388
- * });
1389
- * console.log(res.data);
1390
- *
1391
- * // Example response
1392
- * // {
1393
- * // "bandwidthLimit": {},
1394
- * // "displayName": "my_displayName",
1395
- * // "name": "my_name",
1396
- * // "state": "my_state"
1397
- * // }
1398
- * }
1399
- *
1400
- * main().catch(e => {
1401
- * console.error(e);
1402
- * throw e;
1403
- * });
1404
- *
1405
- * ```
1406
1253
  *
1407
1254
  * @param params - Parameters for request
1408
1255
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1488,55 +1335,6 @@ export namespace storagetransfer_v1 {
1488
1335
 
1489
1336
  /**
1490
1337
  * Lists agent pools.
1491
- * @example
1492
- * ```js
1493
- * // Before running the sample:
1494
- * // - Enable the API at:
1495
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
1496
- * // - Login into gcloud by running:
1497
- * // `$ gcloud auth application-default login`
1498
- * // - Install the npm module by running:
1499
- * // `$ npm install googleapis`
1500
- *
1501
- * const {google} = require('googleapis');
1502
- * const storagetransfer = google.storagetransfer('v1');
1503
- *
1504
- * async function main() {
1505
- * const auth = new google.auth.GoogleAuth({
1506
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1507
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1508
- * });
1509
- *
1510
- * // Acquire an auth client, and bind it to all future calls
1511
- * const authClient = await auth.getClient();
1512
- * google.options({auth: authClient});
1513
- *
1514
- * // Do the magic
1515
- * const res = await storagetransfer.projects.agentPools.list({
1516
- * // An optional list of query parameters specified as JSON text in the form of: `{"agentPoolNames":["agentpool1","agentpool2",...]\}` Since `agentPoolNames` support multiple values, its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project.
1517
- * filter: 'placeholder-value',
1518
- * // The list page size. The max allowed value is `256`.
1519
- * pageSize: 'placeholder-value',
1520
- * // The list page token.
1521
- * pageToken: 'placeholder-value',
1522
- * // Required. The ID of the Google Cloud project that owns the job.
1523
- * projectId: '[^/]+',
1524
- * });
1525
- * console.log(res.data);
1526
- *
1527
- * // Example response
1528
- * // {
1529
- * // "agentPools": [],
1530
- * // "nextPageToken": "my_nextPageToken"
1531
- * // }
1532
- * }
1533
- *
1534
- * main().catch(e => {
1535
- * console.error(e);
1536
- * throw e;
1537
- * });
1538
- *
1539
- * ```
1540
1338
  *
1541
1339
  * @param params - Parameters for request
1542
1340
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1630,64 +1428,6 @@ export namespace storagetransfer_v1 {
1630
1428
 
1631
1429
  /**
1632
1430
  * Updates an existing agent pool resource.
1633
- * @example
1634
- * ```js
1635
- * // Before running the sample:
1636
- * // - Enable the API at:
1637
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
1638
- * // - Login into gcloud by running:
1639
- * // `$ gcloud auth application-default login`
1640
- * // - Install the npm module by running:
1641
- * // `$ npm install googleapis`
1642
- *
1643
- * const {google} = require('googleapis');
1644
- * const storagetransfer = google.storagetransfer('v1');
1645
- *
1646
- * async function main() {
1647
- * const auth = new google.auth.GoogleAuth({
1648
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1649
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1650
- * });
1651
- *
1652
- * // Acquire an auth client, and bind it to all future calls
1653
- * const authClient = await auth.getClient();
1654
- * google.options({auth: authClient});
1655
- *
1656
- * // Do the magic
1657
- * const res = await storagetransfer.projects.agentPools.patch({
1658
- * // Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id\}/agentPools/{agent_pool_id\}`
1659
- * name: 'projects/my-project/agentPools/my-agentPool',
1660
- * // The [field mask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) of the fields in `agentPool` to update in this request. The following `agentPool` fields can be updated: * display_name * bandwidth_limit
1661
- * updateMask: 'placeholder-value',
1662
- *
1663
- * // Request body metadata
1664
- * requestBody: {
1665
- * // request body parameters
1666
- * // {
1667
- * // "bandwidthLimit": {},
1668
- * // "displayName": "my_displayName",
1669
- * // "name": "my_name",
1670
- * // "state": "my_state"
1671
- * // }
1672
- * },
1673
- * });
1674
- * console.log(res.data);
1675
- *
1676
- * // Example response
1677
- * // {
1678
- * // "bandwidthLimit": {},
1679
- * // "displayName": "my_displayName",
1680
- * // "name": "my_name",
1681
- * // "state": "my_state"
1682
- * // }
1683
- * }
1684
- *
1685
- * main().catch(e => {
1686
- * console.error(e);
1687
- * throw e;
1688
- * });
1689
- *
1690
- * ```
1691
1431
  *
1692
1432
  * @param params - Parameters for request
1693
1433
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1846,75 +1586,6 @@ export namespace storagetransfer_v1 {
1846
1586
 
1847
1587
  /**
1848
1588
  * Creates a transfer job that runs periodically.
1849
- * @example
1850
- * ```js
1851
- * // Before running the sample:
1852
- * // - Enable the API at:
1853
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
1854
- * // - Login into gcloud by running:
1855
- * // `$ gcloud auth application-default login`
1856
- * // - Install the npm module by running:
1857
- * // `$ npm install googleapis`
1858
- *
1859
- * const {google} = require('googleapis');
1860
- * const storagetransfer = google.storagetransfer('v1');
1861
- *
1862
- * async function main() {
1863
- * const auth = new google.auth.GoogleAuth({
1864
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1865
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1866
- * });
1867
- *
1868
- * // Acquire an auth client, and bind it to all future calls
1869
- * const authClient = await auth.getClient();
1870
- * google.options({auth: authClient});
1871
- *
1872
- * // Do the magic
1873
- * const res = await storagetransfer.transferJobs.create({
1874
- * // Request body metadata
1875
- * requestBody: {
1876
- * // request body parameters
1877
- * // {
1878
- * // "creationTime": "my_creationTime",
1879
- * // "deletionTime": "my_deletionTime",
1880
- * // "description": "my_description",
1881
- * // "lastModificationTime": "my_lastModificationTime",
1882
- * // "latestOperationName": "my_latestOperationName",
1883
- * // "loggingConfig": {},
1884
- * // "name": "my_name",
1885
- * // "notificationConfig": {},
1886
- * // "projectId": "my_projectId",
1887
- * // "schedule": {},
1888
- * // "status": "my_status",
1889
- * // "transferSpec": {}
1890
- * // }
1891
- * },
1892
- * });
1893
- * console.log(res.data);
1894
- *
1895
- * // Example response
1896
- * // {
1897
- * // "creationTime": "my_creationTime",
1898
- * // "deletionTime": "my_deletionTime",
1899
- * // "description": "my_description",
1900
- * // "lastModificationTime": "my_lastModificationTime",
1901
- * // "latestOperationName": "my_latestOperationName",
1902
- * // "loggingConfig": {},
1903
- * // "name": "my_name",
1904
- * // "notificationConfig": {},
1905
- * // "projectId": "my_projectId",
1906
- * // "schedule": {},
1907
- * // "status": "my_status",
1908
- * // "transferSpec": {}
1909
- * // }
1910
- * }
1911
- *
1912
- * main().catch(e => {
1913
- * console.error(e);
1914
- * throw e;
1915
- * });
1916
- *
1917
- * ```
1918
1589
  *
1919
1590
  * @param params - Parameters for request
1920
1591
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2000,48 +1671,6 @@ export namespace storagetransfer_v1 {
2000
1671
 
2001
1672
  /**
2002
1673
  * Deletes a transfer job. Deleting a transfer job sets its status to DELETED.
2003
- * @example
2004
- * ```js
2005
- * // Before running the sample:
2006
- * // - Enable the API at:
2007
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
2008
- * // - Login into gcloud by running:
2009
- * // `$ gcloud auth application-default login`
2010
- * // - Install the npm module by running:
2011
- * // `$ npm install googleapis`
2012
- *
2013
- * const {google} = require('googleapis');
2014
- * const storagetransfer = google.storagetransfer('v1');
2015
- *
2016
- * async function main() {
2017
- * const auth = new google.auth.GoogleAuth({
2018
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2019
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2020
- * });
2021
- *
2022
- * // Acquire an auth client, and bind it to all future calls
2023
- * const authClient = await auth.getClient();
2024
- * google.options({auth: authClient});
2025
- *
2026
- * // Do the magic
2027
- * const res = await storagetransfer.transferJobs.delete({
2028
- * // Required. The job to delete.
2029
- * jobName: 'transferJobs/.*',
2030
- * // Required. The ID of the Google Cloud project that owns the job.
2031
- * projectId: 'placeholder-value',
2032
- * });
2033
- * console.log(res.data);
2034
- *
2035
- * // Example response
2036
- * // {}
2037
- * }
2038
- *
2039
- * main().catch(e => {
2040
- * console.error(e);
2041
- * throw e;
2042
- * });
2043
- *
2044
- * ```
2045
1674
  *
2046
1675
  * @param params - Parameters for request
2047
1676
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2127,61 +1756,6 @@ export namespace storagetransfer_v1 {
2127
1756
 
2128
1757
  /**
2129
1758
  * Gets a transfer job.
2130
- * @example
2131
- * ```js
2132
- * // Before running the sample:
2133
- * // - Enable the API at:
2134
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
2135
- * // - Login into gcloud by running:
2136
- * // `$ gcloud auth application-default login`
2137
- * // - Install the npm module by running:
2138
- * // `$ npm install googleapis`
2139
- *
2140
- * const {google} = require('googleapis');
2141
- * const storagetransfer = google.storagetransfer('v1');
2142
- *
2143
- * async function main() {
2144
- * const auth = new google.auth.GoogleAuth({
2145
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2146
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2147
- * });
2148
- *
2149
- * // Acquire an auth client, and bind it to all future calls
2150
- * const authClient = await auth.getClient();
2151
- * google.options({auth: authClient});
2152
- *
2153
- * // Do the magic
2154
- * const res = await storagetransfer.transferJobs.get({
2155
- * // Required. The job to get.
2156
- * jobName: 'transferJobs/.*',
2157
- * // Required. The ID of the Google Cloud project that owns the job.
2158
- * projectId: 'placeholder-value',
2159
- * });
2160
- * console.log(res.data);
2161
- *
2162
- * // Example response
2163
- * // {
2164
- * // "creationTime": "my_creationTime",
2165
- * // "deletionTime": "my_deletionTime",
2166
- * // "description": "my_description",
2167
- * // "lastModificationTime": "my_lastModificationTime",
2168
- * // "latestOperationName": "my_latestOperationName",
2169
- * // "loggingConfig": {},
2170
- * // "name": "my_name",
2171
- * // "notificationConfig": {},
2172
- * // "projectId": "my_projectId",
2173
- * // "schedule": {},
2174
- * // "status": "my_status",
2175
- * // "transferSpec": {}
2176
- * // }
2177
- * }
2178
- *
2179
- * main().catch(e => {
2180
- * console.error(e);
2181
- * throw e;
2182
- * });
2183
- *
2184
- * ```
2185
1759
  *
2186
1760
  * @param params - Parameters for request
2187
1761
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2266,53 +1840,6 @@ export namespace storagetransfer_v1 {
2266
1840
 
2267
1841
  /**
2268
1842
  * Lists transfer jobs.
2269
- * @example
2270
- * ```js
2271
- * // Before running the sample:
2272
- * // - Enable the API at:
2273
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
2274
- * // - Login into gcloud by running:
2275
- * // `$ gcloud auth application-default login`
2276
- * // - Install the npm module by running:
2277
- * // `$ npm install googleapis`
2278
- *
2279
- * const {google} = require('googleapis');
2280
- * const storagetransfer = google.storagetransfer('v1');
2281
- *
2282
- * async function main() {
2283
- * const auth = new google.auth.GoogleAuth({
2284
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2285
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2286
- * });
2287
- *
2288
- * // Acquire an auth client, and bind it to all future calls
2289
- * const authClient = await auth.getClient();
2290
- * google.options({auth: authClient});
2291
- *
2292
- * // Do the magic
2293
- * const res = await storagetransfer.transferJobs.list({
2294
- * // Required. A list of query parameters specified as JSON text in the form of: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...]\}` Since `jobNames` and `jobStatuses` support multiple values, their values must be specified with array notation. `projectId` is required. `jobNames` and `jobStatuses` are optional. The valid values for `jobStatuses` are case-insensitive: ENABLED, DISABLED, and DELETED.
2295
- * filter: 'placeholder-value',
2296
- * // The list page size. The max allowed value is 256.
2297
- * pageSize: 'placeholder-value',
2298
- * // The list page token.
2299
- * pageToken: 'placeholder-value',
2300
- * });
2301
- * console.log(res.data);
2302
- *
2303
- * // Example response
2304
- * // {
2305
- * // "nextPageToken": "my_nextPageToken",
2306
- * // "transferJobs": []
2307
- * // }
2308
- * }
2309
- *
2310
- * main().catch(e => {
2311
- * console.error(e);
2312
- * throw e;
2313
- * });
2314
- *
2315
- * ```
2316
1843
  *
2317
1844
  * @param params - Parameters for request
2318
1845
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2403,69 +1930,6 @@ export namespace storagetransfer_v1 {
2403
1930
 
2404
1931
  /**
2405
1932
  * Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. **Note:** The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED).
2406
- * @example
2407
- * ```js
2408
- * // Before running the sample:
2409
- * // - Enable the API at:
2410
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
2411
- * // - Login into gcloud by running:
2412
- * // `$ gcloud auth application-default login`
2413
- * // - Install the npm module by running:
2414
- * // `$ npm install googleapis`
2415
- *
2416
- * const {google} = require('googleapis');
2417
- * const storagetransfer = google.storagetransfer('v1');
2418
- *
2419
- * async function main() {
2420
- * const auth = new google.auth.GoogleAuth({
2421
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2422
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2423
- * });
2424
- *
2425
- * // Acquire an auth client, and bind it to all future calls
2426
- * const authClient = await auth.getClient();
2427
- * google.options({auth: authClient});
2428
- *
2429
- * // Do the magic
2430
- * const res = await storagetransfer.transferJobs.patch({
2431
- * // Required. The name of job to update.
2432
- * jobName: 'transferJobs/.*',
2433
- *
2434
- * // Request body metadata
2435
- * requestBody: {
2436
- * // request body parameters
2437
- * // {
2438
- * // "projectId": "my_projectId",
2439
- * // "transferJob": {},
2440
- * // "updateTransferJobFieldMask": "my_updateTransferJobFieldMask"
2441
- * // }
2442
- * },
2443
- * });
2444
- * console.log(res.data);
2445
- *
2446
- * // Example response
2447
- * // {
2448
- * // "creationTime": "my_creationTime",
2449
- * // "deletionTime": "my_deletionTime",
2450
- * // "description": "my_description",
2451
- * // "lastModificationTime": "my_lastModificationTime",
2452
- * // "latestOperationName": "my_latestOperationName",
2453
- * // "loggingConfig": {},
2454
- * // "name": "my_name",
2455
- * // "notificationConfig": {},
2456
- * // "projectId": "my_projectId",
2457
- * // "schedule": {},
2458
- * // "status": "my_status",
2459
- * // "transferSpec": {}
2460
- * // }
2461
- * }
2462
- *
2463
- * main().catch(e => {
2464
- * console.error(e);
2465
- * throw e;
2466
- * });
2467
- *
2468
- * ```
2469
1933
  *
2470
1934
  * @param params - Parameters for request
2471
1935
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2551,60 +2015,6 @@ export namespace storagetransfer_v1 {
2551
2015
 
2552
2016
  /**
2553
2017
  * Starts a new operation for the specified transfer job. A `TransferJob` has a maximum of one active `TransferOperation`. If this method is called while a `TransferOperation` is active, an error is returned.
2554
- * @example
2555
- * ```js
2556
- * // Before running the sample:
2557
- * // - Enable the API at:
2558
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
2559
- * // - Login into gcloud by running:
2560
- * // `$ gcloud auth application-default login`
2561
- * // - Install the npm module by running:
2562
- * // `$ npm install googleapis`
2563
- *
2564
- * const {google} = require('googleapis');
2565
- * const storagetransfer = google.storagetransfer('v1');
2566
- *
2567
- * async function main() {
2568
- * const auth = new google.auth.GoogleAuth({
2569
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2570
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2571
- * });
2572
- *
2573
- * // Acquire an auth client, and bind it to all future calls
2574
- * const authClient = await auth.getClient();
2575
- * google.options({auth: authClient});
2576
- *
2577
- * // Do the magic
2578
- * const res = await storagetransfer.transferJobs.run({
2579
- * // Required. The name of the transfer job.
2580
- * jobName: 'transferJobs/.*',
2581
- *
2582
- * // Request body metadata
2583
- * requestBody: {
2584
- * // request body parameters
2585
- * // {
2586
- * // "projectId": "my_projectId"
2587
- * // }
2588
- * },
2589
- * });
2590
- * console.log(res.data);
2591
- *
2592
- * // Example response
2593
- * // {
2594
- * // "done": false,
2595
- * // "error": {},
2596
- * // "metadata": {},
2597
- * // "name": "my_name",
2598
- * // "response": {}
2599
- * // }
2600
- * }
2601
- *
2602
- * main().catch(e => {
2603
- * console.error(e);
2604
- * throw e;
2605
- * });
2606
- *
2607
- * ```
2608
2018
  *
2609
2019
  * @param params - Parameters for request
2610
2020
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2763,52 +2173,6 @@ export namespace storagetransfer_v1 {
2763
2173
 
2764
2174
  /**
2765
2175
  * Cancels a transfer. Use the transferOperations.get method to check if the cancellation succeeded or if the operation completed despite the `cancel` request. When you cancel an operation, the currently running transfer is interrupted. For recurring transfer jobs, the next instance of the transfer job will still run. For example, if your job is configured to run every day at 1pm and you cancel Monday's operation at 1:05pm, Monday's transfer will stop. However, a transfer job will still be attempted on Tuesday. This applies only to currently running operations. If an operation is not currently running, `cancel` does nothing. *Caution:* Canceling a transfer job can leave your data in an unknown state. We recommend that you restore the state at both the destination and the source after the `cancel` request completes so that your data is in a consistent state. When you cancel a job, the next job computes a delta of files and may repair any inconsistent state. For instance, if you run a job every day, and today's job found 10 new files and transferred five files before you canceled the job, tomorrow's transfer operation will compute a new delta with the five files that were not copied today plus any new files discovered tomorrow.
2766
- * @example
2767
- * ```js
2768
- * // Before running the sample:
2769
- * // - Enable the API at:
2770
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
2771
- * // - Login into gcloud by running:
2772
- * // `$ gcloud auth application-default login`
2773
- * // - Install the npm module by running:
2774
- * // `$ npm install googleapis`
2775
- *
2776
- * const {google} = require('googleapis');
2777
- * const storagetransfer = google.storagetransfer('v1');
2778
- *
2779
- * async function main() {
2780
- * const auth = new google.auth.GoogleAuth({
2781
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2782
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2783
- * });
2784
- *
2785
- * // Acquire an auth client, and bind it to all future calls
2786
- * const authClient = await auth.getClient();
2787
- * google.options({auth: authClient});
2788
- *
2789
- * // Do the magic
2790
- * const res = await storagetransfer.transferOperations.cancel({
2791
- * // The name of the operation resource to be cancelled.
2792
- * name: 'transferOperations/.*',
2793
- *
2794
- * // Request body metadata
2795
- * requestBody: {
2796
- * // request body parameters
2797
- * // {}
2798
- * },
2799
- * });
2800
- * console.log(res.data);
2801
- *
2802
- * // Example response
2803
- * // {}
2804
- * }
2805
- *
2806
- * main().catch(e => {
2807
- * console.error(e);
2808
- * throw e;
2809
- * });
2810
- *
2811
- * ```
2812
2176
  *
2813
2177
  * @param params - Parameters for request
2814
2178
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2894,52 +2258,6 @@ export namespace storagetransfer_v1 {
2894
2258
 
2895
2259
  /**
2896
2260
  * 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.
2897
- * @example
2898
- * ```js
2899
- * // Before running the sample:
2900
- * // - Enable the API at:
2901
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
2902
- * // - Login into gcloud by running:
2903
- * // `$ gcloud auth application-default login`
2904
- * // - Install the npm module by running:
2905
- * // `$ npm install googleapis`
2906
- *
2907
- * const {google} = require('googleapis');
2908
- * const storagetransfer = google.storagetransfer('v1');
2909
- *
2910
- * async function main() {
2911
- * const auth = new google.auth.GoogleAuth({
2912
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2913
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2914
- * });
2915
- *
2916
- * // Acquire an auth client, and bind it to all future calls
2917
- * const authClient = await auth.getClient();
2918
- * google.options({auth: authClient});
2919
- *
2920
- * // Do the magic
2921
- * const res = await storagetransfer.transferOperations.get({
2922
- * // The name of the operation resource.
2923
- * name: 'transferOperations/.*',
2924
- * });
2925
- * console.log(res.data);
2926
- *
2927
- * // Example response
2928
- * // {
2929
- * // "done": false,
2930
- * // "error": {},
2931
- * // "metadata": {},
2932
- * // "name": "my_name",
2933
- * // "response": {}
2934
- * // }
2935
- * }
2936
- *
2937
- * main().catch(e => {
2938
- * console.error(e);
2939
- * throw e;
2940
- * });
2941
- *
2942
- * ```
2943
2261
  *
2944
2262
  * @param params - Parameters for request
2945
2263
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3025,55 +2343,6 @@ export namespace storagetransfer_v1 {
3025
2343
 
3026
2344
  /**
3027
2345
  * Lists transfer operations. Operations are ordered by their creation time in reverse chronological order.
3028
- * @example
3029
- * ```js
3030
- * // Before running the sample:
3031
- * // - Enable the API at:
3032
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
3033
- * // - Login into gcloud by running:
3034
- * // `$ gcloud auth application-default login`
3035
- * // - Install the npm module by running:
3036
- * // `$ npm install googleapis`
3037
- *
3038
- * const {google} = require('googleapis');
3039
- * const storagetransfer = google.storagetransfer('v1');
3040
- *
3041
- * async function main() {
3042
- * const auth = new google.auth.GoogleAuth({
3043
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3044
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3045
- * });
3046
- *
3047
- * // Acquire an auth client, and bind it to all future calls
3048
- * const authClient = await auth.getClient();
3049
- * google.options({auth: authClient});
3050
- *
3051
- * // Do the magic
3052
- * const res = await storagetransfer.transferOperations.list({
3053
- * // Required. A list of query parameters specified as JSON text in the form of: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "operationNames":["opid1","opid2",...], "transferStatuses":["status1","status2",...]\}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they must be specified with array notation. `projectId` is required. `jobNames`, `operationNames`, and `transferStatuses` are optional. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.
3054
- * filter: 'placeholder-value',
3055
- * // Required. The name of the type being listed; must be `transferOperations`.
3056
- * name: 'transferOperations',
3057
- * // The list page size. The max allowed value is 256.
3058
- * pageSize: 'placeholder-value',
3059
- * // The list page token.
3060
- * pageToken: 'placeholder-value',
3061
- * });
3062
- * console.log(res.data);
3063
- *
3064
- * // Example response
3065
- * // {
3066
- * // "nextPageToken": "my_nextPageToken",
3067
- * // "operations": []
3068
- * // }
3069
- * }
3070
- *
3071
- * main().catch(e => {
3072
- * console.error(e);
3073
- * throw e;
3074
- * });
3075
- *
3076
- * ```
3077
2346
  *
3078
2347
  * @param params - Parameters for request
3079
2348
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3164,52 +2433,6 @@ export namespace storagetransfer_v1 {
3164
2433
 
3165
2434
  /**
3166
2435
  * Pauses a transfer operation.
3167
- * @example
3168
- * ```js
3169
- * // Before running the sample:
3170
- * // - Enable the API at:
3171
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
3172
- * // - Login into gcloud by running:
3173
- * // `$ gcloud auth application-default login`
3174
- * // - Install the npm module by running:
3175
- * // `$ npm install googleapis`
3176
- *
3177
- * const {google} = require('googleapis');
3178
- * const storagetransfer = google.storagetransfer('v1');
3179
- *
3180
- * async function main() {
3181
- * const auth = new google.auth.GoogleAuth({
3182
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3183
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3184
- * });
3185
- *
3186
- * // Acquire an auth client, and bind it to all future calls
3187
- * const authClient = await auth.getClient();
3188
- * google.options({auth: authClient});
3189
- *
3190
- * // Do the magic
3191
- * const res = await storagetransfer.transferOperations.pause({
3192
- * // Required. The name of the transfer operation.
3193
- * name: 'transferOperations/.*',
3194
- *
3195
- * // Request body metadata
3196
- * requestBody: {
3197
- * // request body parameters
3198
- * // {}
3199
- * },
3200
- * });
3201
- * console.log(res.data);
3202
- *
3203
- * // Example response
3204
- * // {}
3205
- * }
3206
- *
3207
- * main().catch(e => {
3208
- * console.error(e);
3209
- * throw e;
3210
- * });
3211
- *
3212
- * ```
3213
2436
  *
3214
2437
  * @param params - Parameters for request
3215
2438
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3295,52 +2518,6 @@ export namespace storagetransfer_v1 {
3295
2518
 
3296
2519
  /**
3297
2520
  * Resumes a transfer operation that is paused.
3298
- * @example
3299
- * ```js
3300
- * // Before running the sample:
3301
- * // - Enable the API at:
3302
- * // https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
3303
- * // - Login into gcloud by running:
3304
- * // `$ gcloud auth application-default login`
3305
- * // - Install the npm module by running:
3306
- * // `$ npm install googleapis`
3307
- *
3308
- * const {google} = require('googleapis');
3309
- * const storagetransfer = google.storagetransfer('v1');
3310
- *
3311
- * async function main() {
3312
- * const auth = new google.auth.GoogleAuth({
3313
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3314
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3315
- * });
3316
- *
3317
- * // Acquire an auth client, and bind it to all future calls
3318
- * const authClient = await auth.getClient();
3319
- * google.options({auth: authClient});
3320
- *
3321
- * // Do the magic
3322
- * const res = await storagetransfer.transferOperations.resume({
3323
- * // Required. The name of the transfer operation.
3324
- * name: 'transferOperations/.*',
3325
- *
3326
- * // Request body metadata
3327
- * requestBody: {
3328
- * // request body parameters
3329
- * // {}
3330
- * },
3331
- * });
3332
- * console.log(res.data);
3333
- *
3334
- * // Example response
3335
- * // {}
3336
- * }
3337
- *
3338
- * main().catch(e => {
3339
- * console.error(e);
3340
- * throw e;
3341
- * });
3342
- *
3343
- * ```
3344
2521
  *
3345
2522
  * @param params - Parameters for request
3346
2523
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.