@googleapis/storagetransfer 4.0.0 → 4.0.2

package/build/v1.d.ts

@@ -145,6 +145,10 @@ export declare namespace storagetransfer_v1 {
          * Required. S3 Bucket name (see [Creating a bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).
          */
         bucketName?: string | null;
+        /**
+         * 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\}`
+         */
+        credentialsSecret?: string | null;
         /**
          * 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 '/'.
          */
@@ -166,6 +170,10 @@ export declare namespace storagetransfer_v1 {
          * Required. The container to transfer from the Azure Storage account.
          */
         container?: string | null;
+        /**
+         * 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\}`
+         */
+        credentialsSecret?: string | null;
         /**
          * 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 '/'.
          */
@@ -250,6 +258,23 @@ export declare namespace storagetransfer_v1 {
          */
         errorLogEntries?: Schema$ErrorLogEntry[];
     }
+    /**
+     * Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.
+     */
+    export interface Schema$EventStream {
+        /**
+         * 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.
+         */
+        eventStreamExpirationTime?: string | null;
+        /**
+         * 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.
+         */
+        eventStreamStartTime?: string | null;
+        /**
+         * 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\}'.
+         */
+        name?: string | null;
+    }
     /**
      * 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.
      */
@@ -451,7 +476,7 @@ export declare namespace storagetransfer_v1 {
          */
         name?: string | null;
         /**
-         * 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`.
+         * 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`.
          */
         response?: {
             [key: string]: any;
@@ -676,6 +701,10 @@ export declare namespace storagetransfer_v1 {
          * A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
          */
         description?: string | null;
+        /**
+         * Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
+         */
+        eventStream?: Schema$EventStream;
         /**
          * Output only. The time that the transfer job was last modified.
          */
@@ -738,6 +767,10 @@ export declare namespace storagetransfer_v1 {
          * Summarizes errors encountered with sample error log entries.
          */
         errorBreakdowns?: Schema$ErrorSummary[];
+        /**
+         * Cloud Logging configuration.
+         */
+        loggingConfig?: Schema$LoggingConfig;
         /**
          * A globally unique ID assigned by the system.
          */
@@ -817,7 +850,7 @@ export declare namespace storagetransfer_v1 {
          */
         gcsDataSource?: Schema$GcsData;
         /**
-         * Cloud Storage intermediate data location.
+         * 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.
          */
         gcsIntermediateDataLocation?: Schema$GcsData;
         /**
@@ -875,49 +908,6 @@ export declare namespace storagetransfer_v1 {
         constructor(context: APIRequestContext);
         /**
          * 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.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.googleServiceAccounts.get({
-         *     // Required. The ID of the Google Cloud project that the Google service account is associated with.
-         *     projectId: 'placeholder-value',
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "accountEmail": "my_accountEmail",
-         *   //   "subjectId": "my_subjectId"
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -947,64 +937,6 @@ export declare namespace storagetransfer_v1 {
         constructor(context: APIRequestContext);
         /**
          * Creates an agent pool resource.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.projects.agentPools.create({
-         *     // 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])?$`.
-         *     agentPoolId: 'placeholder-value',
-         *     // Required. The ID of the Google Cloud project that owns the agent pool.
-         *     projectId: '[^/]+',
-         *
-         *     // Request body metadata
-         *     requestBody: {
-         *       // request body parameters
-         *       // {
-         *       //   "bandwidthLimit": {},
-         *       //   "displayName": "my_displayName",
-         *       //   "name": "my_name",
-         *       //   "state": "my_state"
-         *       // }
-         *     },
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "bandwidthLimit": {},
-         *   //   "displayName": "my_displayName",
-         *   //   "name": "my_name",
-         *   //   "state": "my_state"
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1019,46 +951,6 @@ export declare namespace storagetransfer_v1 {
         create(callback: BodyResponseCallback<Schema$AgentPool>): void;
         /**
          * Deletes an agent pool.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.projects.agentPools.delete({
-         *     // Required. The name of the agent pool to delete.
-         *     name: 'projects/my-project/agentPools/my-agentPool',
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {}
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1073,51 +965,6 @@ export declare namespace storagetransfer_v1 {
         delete(callback: BodyResponseCallback<Schema$Empty>): void;
         /**
          * Gets an agent pool.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.projects.agentPools.get({
-         *     // Required. The name of the agent pool to get.
-         *     name: 'projects/my-project/agentPools/my-agentPool',
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "bandwidthLimit": {},
-         *   //   "displayName": "my_displayName",
-         *   //   "name": "my_name",
-         *   //   "state": "my_state"
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1132,55 +979,6 @@ export declare namespace storagetransfer_v1 {
         get(callback: BodyResponseCallback<Schema$AgentPool>): void;
         /**
          * Lists agent pools.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.projects.agentPools.list({
-         *     // 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.
-         *     filter: 'placeholder-value',
-         *     // The list page size. The max allowed value is `256`.
-         *     pageSize: 'placeholder-value',
-         *     // The list page token.
-         *     pageToken: 'placeholder-value',
-         *     // Required. The ID of the Google Cloud project that owns the job.
-         *     projectId: '[^/]+',
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "agentPools": [],
-         *   //   "nextPageToken": "my_nextPageToken"
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1195,64 +993,6 @@ export declare namespace storagetransfer_v1 {
         list(callback: BodyResponseCallback<Schema$ListAgentPoolsResponse>): void;
         /**
          * Updates an existing agent pool resource.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.projects.agentPools.patch({
-         *     // Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id\}/agentPools/{agent_pool_id\}`
-         *     name: 'projects/my-project/agentPools/my-agentPool',
-         *     // 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
-         *     updateMask: 'placeholder-value',
-         *
-         *     // Request body metadata
-         *     requestBody: {
-         *       // request body parameters
-         *       // {
-         *       //   "bandwidthLimit": {},
-         *       //   "displayName": "my_displayName",
-         *       //   "name": "my_name",
-         *       //   "state": "my_state"
-         *       // }
-         *     },
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "bandwidthLimit": {},
-         *   //   "displayName": "my_displayName",
-         *   //   "name": "my_name",
-         *   //   "state": "my_state"
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1329,75 +1069,6 @@ export declare namespace storagetransfer_v1 {
         constructor(context: APIRequestContext);
         /**
          * Creates a transfer job that runs periodically.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.transferJobs.create({
-         *     // Request body metadata
-         *     requestBody: {
-         *       // request body parameters
-         *       // {
-         *       //   "creationTime": "my_creationTime",
-         *       //   "deletionTime": "my_deletionTime",
-         *       //   "description": "my_description",
-         *       //   "lastModificationTime": "my_lastModificationTime",
-         *       //   "latestOperationName": "my_latestOperationName",
-         *       //   "loggingConfig": {},
-         *       //   "name": "my_name",
-         *       //   "notificationConfig": {},
-         *       //   "projectId": "my_projectId",
-         *       //   "schedule": {},
-         *       //   "status": "my_status",
-         *       //   "transferSpec": {}
-         *       // }
-         *     },
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "creationTime": "my_creationTime",
-         *   //   "deletionTime": "my_deletionTime",
-         *   //   "description": "my_description",
-         *   //   "lastModificationTime": "my_lastModificationTime",
-         *   //   "latestOperationName": "my_latestOperationName",
-         *   //   "loggingConfig": {},
-         *   //   "name": "my_name",
-         *   //   "notificationConfig": {},
-         *   //   "projectId": "my_projectId",
-         *   //   "schedule": {},
-         *   //   "status": "my_status",
-         *   //   "transferSpec": {}
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1412,48 +1083,6 @@ export declare namespace storagetransfer_v1 {
         create(callback: BodyResponseCallback<Schema$TransferJob>): void;
         /**
          * Deletes a transfer job. Deleting a transfer job sets its status to DELETED.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.transferJobs.delete({
-         *     // Required. The job to delete.
-         *     jobName: 'transferJobs/.*',
-         *     // Required. The ID of the Google Cloud project that owns the job.
-         *     projectId: 'placeholder-value',
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {}
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1468,61 +1097,6 @@ export declare namespace storagetransfer_v1 {
         delete(callback: BodyResponseCallback<Schema$Empty>): void;
         /**
          * Gets a transfer job.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.transferJobs.get({
-         *     // Required. The job to get.
-         *     jobName: 'transferJobs/.*',
-         *     // Required. The ID of the Google Cloud project that owns the job.
-         *     projectId: 'placeholder-value',
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "creationTime": "my_creationTime",
-         *   //   "deletionTime": "my_deletionTime",
-         *   //   "description": "my_description",
-         *   //   "lastModificationTime": "my_lastModificationTime",
-         *   //   "latestOperationName": "my_latestOperationName",
-         *   //   "loggingConfig": {},
-         *   //   "name": "my_name",
-         *   //   "notificationConfig": {},
-         *   //   "projectId": "my_projectId",
-         *   //   "schedule": {},
-         *   //   "status": "my_status",
-         *   //   "transferSpec": {}
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1537,53 +1111,6 @@ export declare namespace storagetransfer_v1 {
         get(callback: BodyResponseCallback<Schema$TransferJob>): void;
         /**
          * Lists transfer jobs.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.transferJobs.list({
-         *     // 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.
-         *     filter: 'placeholder-value',
-         *     // The list page size. The max allowed value is 256.
-         *     pageSize: 'placeholder-value',
-         *     // The list page token.
-         *     pageToken: 'placeholder-value',
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "nextPageToken": "my_nextPageToken",
-         *   //   "transferJobs": []
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1598,69 +1125,6 @@ export declare namespace storagetransfer_v1 {
         list(callback: BodyResponseCallback<Schema$ListTransferJobsResponse>): void;
         /**
          * 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).
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.transferJobs.patch({
-         *     // Required. The name of job to update.
-         *     jobName: 'transferJobs/.*',
-         *
-         *     // Request body metadata
-         *     requestBody: {
-         *       // request body parameters
-         *       // {
-         *       //   "projectId": "my_projectId",
-         *       //   "transferJob": {},
-         *       //   "updateTransferJobFieldMask": "my_updateTransferJobFieldMask"
-         *       // }
-         *     },
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "creationTime": "my_creationTime",
-         *   //   "deletionTime": "my_deletionTime",
-         *   //   "description": "my_description",
-         *   //   "lastModificationTime": "my_lastModificationTime",
-         *   //   "latestOperationName": "my_latestOperationName",
-         *   //   "loggingConfig": {},
-         *   //   "name": "my_name",
-         *   //   "notificationConfig": {},
-         *   //   "projectId": "my_projectId",
-         *   //   "schedule": {},
-         *   //   "status": "my_status",
-         *   //   "transferSpec": {}
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1675,60 +1139,6 @@ export declare namespace storagetransfer_v1 {
         patch(callback: BodyResponseCallback<Schema$TransferJob>): void;
         /**
          * 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.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.transferJobs.run({
-         *     // Required. The name of the transfer job.
-         *     jobName: 'transferJobs/.*',
-         *
-         *     // Request body metadata
-         *     requestBody: {
-         *       // request body parameters
-         *       // {
-         *       //   "projectId": "my_projectId"
-         *       // }
-         *     },
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "done": false,
-         *   //   "error": {},
-         *   //   "metadata": {},
-         *   //   "name": "my_name",
-         *   //   "response": {}
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1807,52 +1217,6 @@ export declare namespace storagetransfer_v1 {
         constructor(context: APIRequestContext);
         /**
          * 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.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.transferOperations.cancel({
-         *     // The name of the operation resource to be cancelled.
-         *     name: 'transferOperations/.*',
-         *
-         *     // Request body metadata
-         *     requestBody: {
-         *       // request body parameters
-         *       // {}
-         *     },
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {}
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1867,52 +1231,6 @@ export declare namespace storagetransfer_v1 {
         cancel(callback: BodyResponseCallback<Schema$Empty>): void;
         /**
          * 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.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.transferOperations.get({
-         *     // The name of the operation resource.
-         *     name: 'transferOperations/.*',
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "done": false,
-         *   //   "error": {},
-         *   //   "metadata": {},
-         *   //   "name": "my_name",
-         *   //   "response": {}
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1927,55 +1245,6 @@ export declare namespace storagetransfer_v1 {
         get(callback: BodyResponseCallback<Schema$Operation>): void;
         /**
          * Lists transfer operations. Operations are ordered by their creation time in reverse chronological order.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.transferOperations.list({
-         *     // 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.
-         *     filter: 'placeholder-value',
-         *     // Required. The name of the type being listed; must be `transferOperations`.
-         *     name: 'transferOperations',
-         *     // The list page size. The max allowed value is 256.
-         *     pageSize: 'placeholder-value',
-         *     // The list page token.
-         *     pageToken: 'placeholder-value',
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "nextPageToken": "my_nextPageToken",
-         *   //   "operations": []
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1990,52 +1259,6 @@ export declare namespace storagetransfer_v1 {
         list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
         /**
          * Pauses a transfer operation.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.transferOperations.pause({
-         *     // Required. The name of the transfer operation.
-         *     name: 'transferOperations/.*',
-         *
-         *     // Request body metadata
-         *     requestBody: {
-         *       // request body parameters
-         *       // {}
-         *     },
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {}
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2050,52 +1273,6 @@ export declare namespace storagetransfer_v1 {
         pause(callback: BodyResponseCallback<Schema$Empty>): void;
         /**
          * Resumes a transfer operation that is paused.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/storagetransfer.googleapis.com
-         * // - Login into gcloud by running:
-         * //   `$ gcloud auth application-default login`
-         * // - Install the npm module by running:
-         * //   `$ npm install googleapis`
-         *
-         * const {google} = require('googleapis');
-         * const storagetransfer = google.storagetransfer('v1');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await storagetransfer.transferOperations.resume({
-         *     // Required. The name of the transfer operation.
-         *     name: 'transferOperations/.*',
-         *
-         *     // Request body metadata
-         *     requestBody: {
-         *       // request body parameters
-         *       // {}
-         *     },
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {}
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
          *
          * @param params - Parameters for request
          * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.