@google-cloud/dms 3.0.0 → 3.1.0

package/build/src/v1/data_migration_service_client.js

@@ -60,8 +60,7 @@ class DataMigrationServiceClient {
      *     API remote host.
      * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
      *     Follows the structure of {@link gapicConfig}.
-     * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
-     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
      *     For more information, please check the
      *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
      * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
@@ -69,7 +68,7 @@ class DataMigrationServiceClient {
      *     HTTP implementation. Load only fallback version and pass it to the constructor:
      *     ```
      *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
-     *     const client = new DataMigrationServiceClient({fallback: 'rest'}, gax);
+     *     const client = new DataMigrationServiceClient({fallback: true}, gax);
      *     ```
      */
     constructor(opts, gaxInstance) {
@@ -128,7 +127,7 @@ class DataMigrationServiceClient {
         if (!opts.fallback) {
             clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
         }
-        else if (opts.fallback === 'rest') {
+        else {
             clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
         }
         if (opts.libName && opts.libVersion) {
@@ -143,6 +142,7 @@ class DataMigrationServiceClient {
             connectionProfilePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/connectionProfiles/{connection_profile}'),
             conversionWorkspacePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}'),
             locationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}'),
+            mappingRulePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}/mappingRules/{mapping_rule}'),
             migrationJobPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/migrationJobs/{migration_job}'),
             privateConnectionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/privateConnections/{private_connection}'),
             projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
@@ -155,6 +155,7 @@ class DataMigrationServiceClient {
             listConnectionProfiles: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'connectionProfiles'),
             listPrivateConnections: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'privateConnections'),
             listConversionWorkspaces: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'conversionWorkspaces'),
+            listMappingRules: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'mappingRules'),
             describeDatabaseEntities: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'databaseEntities'),
             fetchStaticIps: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'staticIps'),
         };
@@ -166,7 +167,7 @@ class DataMigrationServiceClient {
             auth: this.auth,
             grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined,
         };
-        if (opts.fallback === 'rest') {
+        if (opts.fallback) {
             lroOptions.protoJson = protoFilesRoot;
             lroOptions.httpRules = [
                 {
@@ -369,6 +370,7 @@ class DataMigrationServiceClient {
             'verifyMigrationJob',
             'restartMigrationJob',
             'generateSshScript',
+            'generateTcpProxyScript',
             'listConnectionProfiles',
             'getConnectionProfile',
             'createConnectionProfile',
@@ -383,6 +385,10 @@ class DataMigrationServiceClient {
             'createConversionWorkspace',
             'updateConversionWorkspace',
             'deleteConversionWorkspace',
+            'createMappingRule',
+            'deleteMappingRule',
+            'listMappingRules',
+            'getMappingRule',
             'seedConversionWorkspace',
             'importMappingRules',
             'convertConversionWorkspace',
@@ -495,6 +501,27 @@ class DataMigrationServiceClient {
         this.initialize();
         return this.innerApiCalls.generateSshScript(request, options, callback);
     }
+    generateTcpProxyScript(request, optionsOrCallback, callback) {
+        var _a;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                migration_job: (_a = request.migrationJob) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.generateTcpProxyScript(request, options, callback);
+    }
     getConnectionProfile(request, optionsOrCallback, callback) {
         var _a;
         request = request || {};
@@ -558,6 +585,69 @@ class DataMigrationServiceClient {
         this.initialize();
         return this.innerApiCalls.getConversionWorkspace(request, options, callback);
     }
+    createMappingRule(request, optionsOrCallback, callback) {
+        var _a;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.createMappingRule(request, options, callback);
+    }
+    deleteMappingRule(request, optionsOrCallback, callback) {
+        var _a;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.deleteMappingRule(request, options, callback);
+    }
+    getMappingRule(request, optionsOrCallback, callback) {
+        var _a;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.getMappingRule(request, options, callback);
+    }
     searchBackgroundJobs(request, optionsOrCallback, callback) {
         var _a;
         request = request || {};
@@ -1998,6 +2088,116 @@ class DataMigrationServiceClient {
         this.initialize();
         return this.descriptors.page.listConversionWorkspaces.asyncIterate(this.innerApiCalls['listConversionWorkspaces'], request, callSettings);
     }
+    listMappingRules(request, optionsOrCallback, callback) {
+        var _a;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.listMappingRules(request, options, callback);
+    }
+    /**
+     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. Name of the conversion workspace resource whose mapping rules are
+     *   listed in the form of:
+     *   projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
+     * @param {number} request.pageSize
+     *   The maximum number of rules to return. The service may return
+     *   fewer than this value.
+     * @param {string} request.pageToken
+     *   The nextPageToken value received in the previous call to
+     *   mappingRules.list, used in the subsequent request to retrieve the next
+     *   page of results. On first call this should be left blank. When paginating,
+     *   all other parameters provided to mappingRules.list must match the call
+     *   that provided the page token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.MappingRule|MappingRule} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `listMappingRulesAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    listMappingRulesStream(request, options) {
+        var _a;
+        request = request || {};
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
+            });
+        const defaultCallSettings = this._defaults['listMappingRules'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize();
+        return this.descriptors.page.listMappingRules.createStream(this.innerApiCalls.listMappingRules, request, callSettings);
+    }
+    /**
+     * Equivalent to `listMappingRules`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. Name of the conversion workspace resource whose mapping rules are
+     *   listed in the form of:
+     *   projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
+     * @param {number} request.pageSize
+     *   The maximum number of rules to return. The service may return
+     *   fewer than this value.
+     * @param {string} request.pageToken
+     *   The nextPageToken value received in the previous call to
+     *   mappingRules.list, used in the subsequent request to retrieve the next
+     *   page of results. On first call this should be left blank. When paginating,
+     *   all other parameters provided to mappingRules.list must match the call
+     *   that provided the page token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link protos.google.cloud.clouddms.v1.MappingRule|MappingRule}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/data_migration_service.list_mapping_rules.js</caption>
+     * region_tag:datamigration_v1_generated_DataMigrationService_ListMappingRules_async
+     */
+    listMappingRulesAsync(request, options) {
+        var _a;
+        request = request || {};
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
+            });
+        const defaultCallSettings = this._defaults['listMappingRules'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize();
+        return this.descriptors.page.listMappingRules.asyncIterate(this.innerApiCalls['listMappingRules'], request, callSettings);
+    }
     describeDatabaseEntities(request, optionsOrCallback, callback) {
         var _a;
         request = request || {};
@@ -2027,26 +2227,29 @@ class DataMigrationServiceClient {
      *   Required. Name of the conversion workspace resource whose database entities
      *   are described. Must be in the form of:
      *   projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
-     * @param {number} request.pageSize
-     *   The maximum number of entities to return. The service may return
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of entities to return. The service may return
      *   fewer entities than the value specifies.
-     * @param {string} request.pageToken
-     *   The nextPageToken value received in the previous call to
+     * @param {string} [request.pageToken]
+     *   Optional. The nextPageToken value received in the previous call to
      *   conversionWorkspace.describeDatabaseEntities, used in the subsequent
      *   request to retrieve the next page of results. On first call this should be
      *   left blank. When paginating, all other parameters provided to
      *   conversionWorkspace.describeDatabaseEntities must match the call that
      *   provided the page token.
      * @param {google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType} request.tree
-     *   The tree to fetch.
-     * @param {boolean} request.uncommitted
-     *   Whether to retrieve the latest committed version of the entities or the
-     *   latest version. This field is ignored if a specific commit_id is specified.
-     * @param {string} request.commitId
-     *   Request a specific commit ID. If not specified, the entities from the
-     *   latest commit are returned.
-     * @param {string} request.filter
-     *   Filter the returned entities based on AIP-160 standard.
+     *   Required. The tree to fetch.
+     * @param {boolean} [request.uncommitted]
+     *   Optional. Whether to retrieve the latest committed version of the entities
+     *   or the latest version. This field is ignored if a specific commit_id is
+     *   specified.
+     * @param {string} [request.commitId]
+     *   Optional. Request a specific commit ID. If not specified, the entities from
+     *   the latest commit are returned.
+     * @param {string} [request.filter]
+     *   Optional. Filter the returned entities based on AIP-160 standard.
+     * @param {google.cloud.clouddms.v1.DatabaseEntityView} [request.view]
+     *   Optional. Results view based on AIP-157
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -2083,26 +2286,29 @@ class DataMigrationServiceClient {
      *   Required. Name of the conversion workspace resource whose database entities
      *   are described. Must be in the form of:
      *   projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
-     * @param {number} request.pageSize
-     *   The maximum number of entities to return. The service may return
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of entities to return. The service may return
      *   fewer entities than the value specifies.
-     * @param {string} request.pageToken
-     *   The nextPageToken value received in the previous call to
+     * @param {string} [request.pageToken]
+     *   Optional. The nextPageToken value received in the previous call to
      *   conversionWorkspace.describeDatabaseEntities, used in the subsequent
      *   request to retrieve the next page of results. On first call this should be
      *   left blank. When paginating, all other parameters provided to
      *   conversionWorkspace.describeDatabaseEntities must match the call that
      *   provided the page token.
      * @param {google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType} request.tree
-     *   The tree to fetch.
-     * @param {boolean} request.uncommitted
-     *   Whether to retrieve the latest committed version of the entities or the
-     *   latest version. This field is ignored if a specific commit_id is specified.
-     * @param {string} request.commitId
-     *   Request a specific commit ID. If not specified, the entities from the
-     *   latest commit are returned.
-     * @param {string} request.filter
-     *   Filter the returned entities based on AIP-160 standard.
+     *   Required. The tree to fetch.
+     * @param {boolean} [request.uncommitted]
+     *   Optional. Whether to retrieve the latest committed version of the entities
+     *   or the latest version. This field is ignored if a specific commit_id is
+     *   specified.
+     * @param {string} [request.commitId]
+     *   Optional. Request a specific commit ID. If not specified, the entities from
+     *   the latest commit are returned.
+     * @param {string} [request.filter]
+     *   Optional. Filter the returned entities based on AIP-160 standard.
+     * @param {google.cloud.clouddms.v1.DatabaseEntityView} [request.view]
+     *   Optional. Results view based on AIP-157
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
@@ -2630,6 +2836,67 @@ class DataMigrationServiceClient {
     matchLocationFromLocationName(locationName) {
         return this.pathTemplates.locationPathTemplate.match(locationName).location;
     }
+    /**
+     * Return a fully-qualified mappingRule resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} conversion_workspace
+     * @param {string} mapping_rule
+     * @returns {string} Resource name string.
+     */
+    mappingRulePath(project, location, conversionWorkspace, mappingRule) {
+        return this.pathTemplates.mappingRulePathTemplate.render({
+            project: project,
+            location: location,
+            conversion_workspace: conversionWorkspace,
+            mapping_rule: mappingRule,
+        });
+    }
+    /**
+     * Parse the project from MappingRule resource.
+     *
+     * @param {string} mappingRuleName
+     *   A fully-qualified path representing MappingRule resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromMappingRuleName(mappingRuleName) {
+        return this.pathTemplates.mappingRulePathTemplate.match(mappingRuleName)
+            .project;
+    }
+    /**
+     * Parse the location from MappingRule resource.
+     *
+     * @param {string} mappingRuleName
+     *   A fully-qualified path representing MappingRule resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromMappingRuleName(mappingRuleName) {
+        return this.pathTemplates.mappingRulePathTemplate.match(mappingRuleName)
+            .location;
+    }
+    /**
+     * Parse the conversion_workspace from MappingRule resource.
+     *
+     * @param {string} mappingRuleName
+     *   A fully-qualified path representing MappingRule resource.
+     * @returns {string} A string representing the conversion_workspace.
+     */
+    matchConversionWorkspaceFromMappingRuleName(mappingRuleName) {
+        return this.pathTemplates.mappingRulePathTemplate.match(mappingRuleName)
+            .conversion_workspace;
+    }
+    /**
+     * Parse the mapping_rule from MappingRule resource.
+     *
+     * @param {string} mappingRuleName
+     *   A fully-qualified path representing MappingRule resource.
+     * @returns {string} A string representing the mapping_rule.
+     */
+    matchMappingRuleFromMappingRuleName(mappingRuleName) {
+        return this.pathTemplates.mappingRulePathTemplate.match(mappingRuleName)
+            .mapping_rule;
+    }
     /**
      * Return a fully-qualified migrationJob resource name string.
      *

package/build/src/v1/data_migration_service_client_config.json

@@ -6,6 +6,9 @@
                 "idempotent": [
                     "DEADLINE_EXCEEDED",
                     "UNAVAILABLE"
+                ],
+                "unavailable": [
+                    "UNAVAILABLE"
                 ]
             },
             "retry_params": {
@@ -17,6 +20,15 @@
                     "rpc_timeout_multiplier": 1,
                     "max_rpc_timeout_millis": 60000,
                     "total_timeout_millis": 600000
+                },
+                "ce5b960a6ed052e690863808e4f0deff3dc7d49f": {
+                    "initial_retry_delay_millis": 1000,
+                    "retry_delay_multiplier": 1.3,
+                    "max_retry_delay_millis": 10000,
+                    "initial_rpc_timeout_millis": 60000,
+                    "rpc_timeout_multiplier": 1,
+                    "max_rpc_timeout_millis": 60000,
+                    "total_timeout_millis": 600000
                 }
             },
             "methods": {
@@ -80,6 +92,11 @@
                     "retry_codes_name": "non_idempotent",
                     "retry_params_name": "default"
                 },
+                "GenerateTcpProxyScript": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
                 "ListConnectionProfiles": {
                     "timeout_millis": 60000,
                     "retry_codes_name": "non_idempotent",
@@ -150,6 +167,26 @@
                     "retry_codes_name": "non_idempotent",
                     "retry_params_name": "default"
                 },
+                "CreateMappingRule": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
+                "DeleteMappingRule": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
+                "ListMappingRules": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
+                "GetMappingRule": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
                 "SeedConversionWorkspace": {
                     "timeout_millis": 60000,
                     "retry_codes_name": "non_idempotent",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@google-cloud/dms",
   "description": "Cloud Database Migration API client for Node.js",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "license": "Apache-2.0",
   "author": "Google LLC",
   "engines": {
@@ -57,8 +57,8 @@
     "gapic-tools": "^0.1.8",
     "gts": "^5.0.0",
     "jsdoc": "^4.0.0",
-    "jsdoc-fresh": "^2.0.0",
-    "jsdoc-region-tag": "^2.0.0",
+    "jsdoc-fresh": "^3.0.0",
+    "jsdoc-region-tag": "^3.0.0",
     "linkinator": "4.1.2",
     "long": "^5.2.3",
     "mocha": "^9.2.2",