@google-cloud/dms
Version:
Cloud Database Migration API client for Node.js
796 lines • 195 kB
JavaScript
"use strict";
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ** This file is automatically generated by gapic-generator-typescript. **
// ** https://github.com/googleapis/gapic-generator-typescript **
// ** All changes to this file may be overwritten. **
Object.defineProperty(exports, "__esModule", { value: true });
exports.DataMigrationServiceClient = void 0;
const jsonProtos = require("../../protos/protos.json");
const google_gax_1 = require("google-gax");
/**
* Client JSON configuration object, loaded from
* `src/v1/data_migration_service_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
const gapicConfig = require("./data_migration_service_client_config.json");
const version = require('../../../package.json').version;
/**
* Database Migration service
* @class
* @memberof v1
*/
class DataMigrationServiceClient {
_terminated = false;
_opts;
_providedCustomServicePath;
_gaxModule;
_gaxGrpc;
_protos;
_defaults;
_universeDomain;
_servicePath;
_log = google_gax_1.loggingUtils.log('dms');
auth;
descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn;
innerApiCalls;
iamClient;
locationsClient;
pathTemplates;
operationsClient;
dataMigrationServiceStub;
/**
* Construct an instance of DataMigrationServiceClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @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
* need to avoid loading the default gRPC version and want to use the fallback
* 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: true}, gax);
* ```
*/
constructor(opts, gaxInstance) {
// Ensure that options include all the required fields.
const staticMembers = this.constructor;
if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
throw new Error('Please set either universe_domain or universeDomain, but not both.');
}
const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
this._servicePath = 'datamigration.' + this._universeDomain;
const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
const port = opts?.port || staticMembers.port;
const clientConfig = opts?.clientConfig ?? {};
const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
// Request numeric enum values if REST transport is used.
opts.numericEnums = true;
// If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
if (servicePath !== this._servicePath && !('scopes' in opts)) {
opts['scopes'] = staticMembers.scopes;
}
// Load google-gax module synchronously if needed
if (!gaxInstance) {
gaxInstance = require('google-gax');
}
// Choose either gRPC or proto-over-HTTP implementation of google-gax.
this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
// Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
// Save options to use in initialize() method.
this._opts = opts;
// Save the auth object to the client, for use by other methods.
this.auth = this._gaxGrpc.auth;
// Set useJWTAccessWithScope on the auth object.
this.auth.useJWTAccessWithScope = true;
// Set defaultServicePath on the auth object.
this.auth.defaultServicePath = this._servicePath;
// Set the default scopes in auth client if needed.
if (servicePath === this._servicePath) {
this.auth.defaultScopes = staticMembers.scopes;
}
this.iamClient = new this._gaxModule.IamClient(this._gaxGrpc, opts);
this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
// Determine the client header string.
const clientHeader = [
`gax/${this._gaxModule.version}`,
`gapic/${version}`,
];
if (typeof process === 'object' && 'versions' in process) {
clientHeader.push(`gl-node/${process.versions.node}`);
}
else {
clientHeader.push(`gl-web/${this._gaxModule.version}`);
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
}
else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
clientHeader.push(`${opts.libName}/${opts.libVersion}`);
}
// Load the applicable protos.
this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
// This API contains "path templates"; forward-slash-separated
// identifiers to uniquely identify resources within the API.
// Create useful helper objects for these.
this.pathTemplates = {
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}'),
};
// Some of the methods on this service return "paged" results,
// (e.g. 50 results at a time, with tokens to get subsequent
// pages). Denote the keys used for pagination and results.
this.descriptors.page = {
listMigrationJobs: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'migrationJobs'),
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')
};
const protoFilesRoot = this._gaxModule.protobufFromJSON(jsonProtos);
// This API contains "long-running operations", which return a
// an Operation object that allows for tracking of the operation,
// rather than holding a request open.
const lroOptions = {
auth: this.auth,
grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined
};
if (opts.fallback) {
lroOptions.protoJson = protoFilesRoot;
lroOptions.httpRules = [{ selector: 'google.cloud.location.Locations.GetLocation', get: '/v1/{name=projects/*/locations/*}', }, { selector: 'google.cloud.location.Locations.ListLocations', get: '/v1/{name=projects/*}/locations', }, { selector: 'google.iam.v1.IAMPolicy.GetIamPolicy', get: '/v1/{resource=projects/*/locations/*/connectionProfiles/*}:getIamPolicy', additional_bindings: [{ get: '/v1/{resource=projects/*/locations/*/migrationJobs/*}:getIamPolicy', }, { get: '/v1/{resource=projects/*/locations/*/conversionWorkspaces/*}:getIamPolicy', }, { get: '/v1/{resource=projects/*/locations/*/privateConnections/*}:getIamPolicy', }],
}, { selector: 'google.iam.v1.IAMPolicy.SetIamPolicy', post: '/v1/{resource=projects/*/locations/*/connectionProfiles/*}:setIamPolicy', body: '*', additional_bindings: [{ post: '/v1/{resource=projects/*/locations/*/migrationJobs/*}:setIamPolicy', body: '*', }, { post: '/v1/{resource=projects/*/locations/*/conversionWorkspaces/*}:setIamPolicy', body: '*', }, { post: '/v1/{resource=projects/*/locations/*/privateConnections/*}:setIamPolicy', body: '*', }],
}, { selector: 'google.iam.v1.IAMPolicy.TestIamPermissions', post: '/v1/{resource=projects/*/locations/*/migrationJobs/*}:testIamPermissions', body: '*', additional_bindings: [{ post: '/v1/{resource=projects/*/locations/*/connectionProfiles/*}:testIamPermissions', body: '*', }, { post: '/v1/{resource=projects/*/locations/*/conversionWorkspaces/*}:testIamPermissions', body: '*', }, { post: '/v1/{resource=projects/*/locations/*/privateConnections/*}:testIamPermissions', body: '*', }],
}, { selector: 'google.longrunning.Operations.CancelOperation', post: '/v1/{name=projects/*/locations/*/operations/*}:cancel', body: '*', }, { selector: 'google.longrunning.Operations.DeleteOperation', delete: '/v1/{name=projects/*/locations/*/operations/*}', }, { selector: 'google.longrunning.Operations.GetOperation', get: '/v1/{name=projects/*/locations/*/operations/*}', }, { selector: 'google.longrunning.Operations.ListOperations', get: '/v1/{name=projects/*/locations/*}/operations', }];
}
this.operationsClient = this._gaxModule.lro(lroOptions).operationsClient(opts);
const createMigrationJobResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.MigrationJob');
const createMigrationJobMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const updateMigrationJobResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.MigrationJob');
const updateMigrationJobMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const deleteMigrationJobResponse = protoFilesRoot.lookup('.google.protobuf.Empty');
const deleteMigrationJobMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const startMigrationJobResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.MigrationJob');
const startMigrationJobMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const stopMigrationJobResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.MigrationJob');
const stopMigrationJobMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const resumeMigrationJobResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.MigrationJob');
const resumeMigrationJobMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const promoteMigrationJobResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.MigrationJob');
const promoteMigrationJobMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const verifyMigrationJobResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.MigrationJob');
const verifyMigrationJobMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const restartMigrationJobResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.MigrationJob');
const restartMigrationJobMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const createConnectionProfileResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.ConnectionProfile');
const createConnectionProfileMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const updateConnectionProfileResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.ConnectionProfile');
const updateConnectionProfileMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const deleteConnectionProfileResponse = protoFilesRoot.lookup('.google.protobuf.Empty');
const deleteConnectionProfileMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const createPrivateConnectionResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.PrivateConnection');
const createPrivateConnectionMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const deletePrivateConnectionResponse = protoFilesRoot.lookup('.google.protobuf.Empty');
const deletePrivateConnectionMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const createConversionWorkspaceResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.ConversionWorkspace');
const createConversionWorkspaceMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const updateConversionWorkspaceResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.ConversionWorkspace');
const updateConversionWorkspaceMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const deleteConversionWorkspaceResponse = protoFilesRoot.lookup('.google.protobuf.Empty');
const deleteConversionWorkspaceMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const seedConversionWorkspaceResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.ConversionWorkspace');
const seedConversionWorkspaceMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const importMappingRulesResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.ConversionWorkspace');
const importMappingRulesMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const convertConversionWorkspaceResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.ConversionWorkspace');
const convertConversionWorkspaceMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const commitConversionWorkspaceResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.ConversionWorkspace');
const commitConversionWorkspaceMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const rollbackConversionWorkspaceResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.ConversionWorkspace');
const rollbackConversionWorkspaceMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
const applyConversionWorkspaceResponse = protoFilesRoot.lookup('.google.cloud.clouddms.v1.ConversionWorkspace');
const applyConversionWorkspaceMetadata = protoFilesRoot.lookup('.google.cloud.clouddms.v1.OperationMetadata');
this.descriptors.longrunning = {
createMigrationJob: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createMigrationJobResponse.decode.bind(createMigrationJobResponse), createMigrationJobMetadata.decode.bind(createMigrationJobMetadata)),
updateMigrationJob: new this._gaxModule.LongrunningDescriptor(this.operationsClient, updateMigrationJobResponse.decode.bind(updateMigrationJobResponse), updateMigrationJobMetadata.decode.bind(updateMigrationJobMetadata)),
deleteMigrationJob: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteMigrationJobResponse.decode.bind(deleteMigrationJobResponse), deleteMigrationJobMetadata.decode.bind(deleteMigrationJobMetadata)),
startMigrationJob: new this._gaxModule.LongrunningDescriptor(this.operationsClient, startMigrationJobResponse.decode.bind(startMigrationJobResponse), startMigrationJobMetadata.decode.bind(startMigrationJobMetadata)),
stopMigrationJob: new this._gaxModule.LongrunningDescriptor(this.operationsClient, stopMigrationJobResponse.decode.bind(stopMigrationJobResponse), stopMigrationJobMetadata.decode.bind(stopMigrationJobMetadata)),
resumeMigrationJob: new this._gaxModule.LongrunningDescriptor(this.operationsClient, resumeMigrationJobResponse.decode.bind(resumeMigrationJobResponse), resumeMigrationJobMetadata.decode.bind(resumeMigrationJobMetadata)),
promoteMigrationJob: new this._gaxModule.LongrunningDescriptor(this.operationsClient, promoteMigrationJobResponse.decode.bind(promoteMigrationJobResponse), promoteMigrationJobMetadata.decode.bind(promoteMigrationJobMetadata)),
verifyMigrationJob: new this._gaxModule.LongrunningDescriptor(this.operationsClient, verifyMigrationJobResponse.decode.bind(verifyMigrationJobResponse), verifyMigrationJobMetadata.decode.bind(verifyMigrationJobMetadata)),
restartMigrationJob: new this._gaxModule.LongrunningDescriptor(this.operationsClient, restartMigrationJobResponse.decode.bind(restartMigrationJobResponse), restartMigrationJobMetadata.decode.bind(restartMigrationJobMetadata)),
createConnectionProfile: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createConnectionProfileResponse.decode.bind(createConnectionProfileResponse), createConnectionProfileMetadata.decode.bind(createConnectionProfileMetadata)),
updateConnectionProfile: new this._gaxModule.LongrunningDescriptor(this.operationsClient, updateConnectionProfileResponse.decode.bind(updateConnectionProfileResponse), updateConnectionProfileMetadata.decode.bind(updateConnectionProfileMetadata)),
deleteConnectionProfile: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteConnectionProfileResponse.decode.bind(deleteConnectionProfileResponse), deleteConnectionProfileMetadata.decode.bind(deleteConnectionProfileMetadata)),
createPrivateConnection: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createPrivateConnectionResponse.decode.bind(createPrivateConnectionResponse), createPrivateConnectionMetadata.decode.bind(createPrivateConnectionMetadata)),
deletePrivateConnection: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deletePrivateConnectionResponse.decode.bind(deletePrivateConnectionResponse), deletePrivateConnectionMetadata.decode.bind(deletePrivateConnectionMetadata)),
createConversionWorkspace: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createConversionWorkspaceResponse.decode.bind(createConversionWorkspaceResponse), createConversionWorkspaceMetadata.decode.bind(createConversionWorkspaceMetadata)),
updateConversionWorkspace: new this._gaxModule.LongrunningDescriptor(this.operationsClient, updateConversionWorkspaceResponse.decode.bind(updateConversionWorkspaceResponse), updateConversionWorkspaceMetadata.decode.bind(updateConversionWorkspaceMetadata)),
deleteConversionWorkspace: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteConversionWorkspaceResponse.decode.bind(deleteConversionWorkspaceResponse), deleteConversionWorkspaceMetadata.decode.bind(deleteConversionWorkspaceMetadata)),
seedConversionWorkspace: new this._gaxModule.LongrunningDescriptor(this.operationsClient, seedConversionWorkspaceResponse.decode.bind(seedConversionWorkspaceResponse), seedConversionWorkspaceMetadata.decode.bind(seedConversionWorkspaceMetadata)),
importMappingRules: new this._gaxModule.LongrunningDescriptor(this.operationsClient, importMappingRulesResponse.decode.bind(importMappingRulesResponse), importMappingRulesMetadata.decode.bind(importMappingRulesMetadata)),
convertConversionWorkspace: new this._gaxModule.LongrunningDescriptor(this.operationsClient, convertConversionWorkspaceResponse.decode.bind(convertConversionWorkspaceResponse), convertConversionWorkspaceMetadata.decode.bind(convertConversionWorkspaceMetadata)),
commitConversionWorkspace: new this._gaxModule.LongrunningDescriptor(this.operationsClient, commitConversionWorkspaceResponse.decode.bind(commitConversionWorkspaceResponse), commitConversionWorkspaceMetadata.decode.bind(commitConversionWorkspaceMetadata)),
rollbackConversionWorkspace: new this._gaxModule.LongrunningDescriptor(this.operationsClient, rollbackConversionWorkspaceResponse.decode.bind(rollbackConversionWorkspaceResponse), rollbackConversionWorkspaceMetadata.decode.bind(rollbackConversionWorkspaceMetadata)),
applyConversionWorkspace: new this._gaxModule.LongrunningDescriptor(this.operationsClient, applyConversionWorkspaceResponse.decode.bind(applyConversionWorkspaceResponse), applyConversionWorkspaceMetadata.decode.bind(applyConversionWorkspaceMetadata))
};
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings('google.cloud.clouddms.v1.DataMigrationService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
// Set up a dictionary of "inner API calls"; the core implementation
// of calling the API is handled in `google-gax`, with this code
// merely providing the destination and request information.
this.innerApiCalls = {};
// Add a warn function to the client constructor so it can be easily tested.
this.warn = this._gaxModule.warn;
}
/**
* Initialize the client.
* Performs asynchronous operations (such as authentication) and prepares the client.
* This function will be called automatically when any class method is called for the
* first time, but if you need to initialize it before calling an actual method,
* feel free to call initialize() directly.
*
* You can await on this method if you want to make sure the client is initialized.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize() {
// If the client stub promise is already initialized, return immediately.
if (this.dataMigrationServiceStub) {
return this.dataMigrationServiceStub;
}
// Put together the "service stub" for
// google.cloud.clouddms.v1.DataMigrationService.
this.dataMigrationServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
this._protos.lookupService('google.cloud.clouddms.v1.DataMigrationService') :
// eslint-disable-next-line @typescript-eslint/no-explicit-any
this._protos.google.cloud.clouddms.v1.DataMigrationService, this._opts, this._providedCustomServicePath);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const dataMigrationServiceStubMethods = ['listMigrationJobs', 'getMigrationJob', 'createMigrationJob', 'updateMigrationJob', 'deleteMigrationJob', 'startMigrationJob', 'stopMigrationJob', 'resumeMigrationJob', 'promoteMigrationJob', 'verifyMigrationJob', 'restartMigrationJob', 'generateSshScript', 'generateTcpProxyScript', 'listConnectionProfiles', 'getConnectionProfile', 'createConnectionProfile', 'updateConnectionProfile', 'deleteConnectionProfile', 'createPrivateConnection', 'getPrivateConnection', 'listPrivateConnections', 'deletePrivateConnection', 'getConversionWorkspace', 'listConversionWorkspaces', 'createConversionWorkspace', 'updateConversionWorkspace', 'deleteConversionWorkspace', 'createMappingRule', 'deleteMappingRule', 'listMappingRules', 'getMappingRule', 'seedConversionWorkspace', 'importMappingRules', 'convertConversionWorkspace', 'commitConversionWorkspace', 'rollbackConversionWorkspace', 'applyConversionWorkspace', 'describeDatabaseEntities', 'searchBackgroundJobs', 'describeConversionWorkspaceRevisions', 'fetchStaticIps'];
for (const methodName of dataMigrationServiceStubMethods) {
const callPromise = this.dataMigrationServiceStub.then(stub => (...args) => {
if (this._terminated) {
return Promise.reject('The client has already been closed.');
}
const func = stub[methodName];
return func.apply(stub, args);
}, (err) => () => {
throw err;
});
const descriptor = this.descriptors.page[methodName] ||
this.descriptors.longrunning[methodName] ||
undefined;
const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
this.innerApiCalls[methodName] = apiCall;
}
return this.dataMigrationServiceStub;
}
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath() {
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'datamigration.googleapis.com';
}
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint() {
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'datamigration.googleapis.com';
}
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint() {
return this._servicePath;
}
get universeDomain() {
return this._universeDomain;
}
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port() {
return 443;
}
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes() {
return [
'https://www.googleapis.com/auth/cloud-platform'
];
}
/**
* Return the project ID used by this class.
* @returns {Promise} A promise that resolves to string containing the project ID.
*/
getProjectId(callback) {
if (callback) {
this.auth.getProjectId(callback);
return;
}
return this.auth.getProjectId();
}
getMigrationJob(request, optionsOrCallback, callback) {
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': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getMigrationJob request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getMigrationJob response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getMigrationJob(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getMigrationJob response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
generateSshScript(request, optionsOrCallback, callback) {
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': request.migrationJob ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('generateSshScript request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('generateSshScript response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.generateSshScript(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('generateSshScript response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
generateTcpProxyScript(request, optionsOrCallback, callback) {
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': request.migrationJob ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('generateTcpProxyScript request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('generateTcpProxyScript response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.generateTcpProxyScript(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('generateTcpProxyScript response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
getConnectionProfile(request, optionsOrCallback, callback) {
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': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getConnectionProfile request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getConnectionProfile response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getConnectionProfile(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getConnectionProfile response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
getPrivateConnection(request, optionsOrCallback, callback) {
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': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getPrivateConnection request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getPrivateConnection response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getPrivateConnection(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getPrivateConnection response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
getConversionWorkspace(request, optionsOrCallback, callback) {
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': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getConversionWorkspace request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getConversionWorkspace response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getConversionWorkspace(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getConversionWorkspace response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
createMappingRule(request, optionsOrCallback, callback) {
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': request.parent ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('createMappingRule request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('createMappingRule response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.createMappingRule(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('createMappingRule response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
deleteMappingRule(request, optionsOrCallback, callback) {
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': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('deleteMappingRule request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('deleteMappingRule response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.deleteMappingRule(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('deleteMappingRule response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
getMappingRule(request, optionsOrCallback, callback) {
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': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getMappingRule request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getMappingRule response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getMappingRule(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getMappingRule response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
searchBackgroundJobs(request, optionsOrCallback, callback) {
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({
'conversion_workspace': request.conversionWorkspace ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('searchBackgroundJobs request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('searchBackgroundJobs response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.searchBackgroundJobs(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('searchBackgroundJobs response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
describeConversionWorkspaceRevisions(request, optionsOrCallback, callback) {
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({
'conversion_workspace': request.conversionWorkspace ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('describeConversionWorkspaceRevisions request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('describeConversionWorkspaceRevisions response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.describeConversionWorkspaceRevisions(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('describeConversionWorkspaceRevisions response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
createMigrationJob(request, optionsOrCallback, callback) {
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._gaxM