@google-cloud/dms/build/src/v1/data_migration_service_client.d.ts

Cloud Database Migration API client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, IamClient, IamProtos, LocationsClient, LocationProtos } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Database Migration service
 * @class
 * @memberof v1
 */
export declare class DataMigrationServiceClient {
    private _terminated;
    private _opts;
    private _providedCustomServicePath;
    private _gaxModule;
    private _gaxGrpc;
    private _protos;
    private _defaults;
    private _universeDomain;
    private _servicePath;
    private _log;
    auth: gax.GoogleAuth;
    descriptors: Descriptors;
    warn: (code: string, message: string, warnType?: string) => void;
    innerApiCalls: {
        [name: string]: Function;
    };
    iamClient: IamClient;
    locationsClient: LocationsClient;
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    operationsClient: gax.OperationsClient;
    dataMigrationServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * 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?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
    /**
     * 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(): Promise<{
        [name: string]: Function;
    }>;
    /**
     * 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(): string;
    /**
     * 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(): string;
    /**
     * The DNS address for this API service.
     * @returns {string} The DNS address for this service.
     */
    get apiEndpoint(): string;
    get universeDomain(): string;
    /**
     * The port for this API service.
     * @returns {number} The default port for this service.
     */
    static get port(): number;
    /**
     * The scopes needed to make gRPC calls for every method defined
     * in this service.
     * @returns {string[]} List of default scopes.
     */
    static get scopes(): string[];
    getProjectId(): Promise<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): void;
    /**
     * Gets details of a single migration job.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Name of the migration job resource to get.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.MigrationJob|MigrationJob}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.get_migration_job.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_GetMigrationJob_async
     */
    getMigrationJob(request?: protos.google.cloud.clouddms.v1.IGetMigrationJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.clouddms.v1.IMigrationJob,
        protos.google.cloud.clouddms.v1.IGetMigrationJobRequest | undefined,
        {} | undefined
    ]>;
    getMigrationJob(request: protos.google.cloud.clouddms.v1.IGetMigrationJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IGetMigrationJobRequest | null | undefined, {} | null | undefined>): void;
    getMigrationJob(request: protos.google.cloud.clouddms.v1.IGetMigrationJobRequest, callback: Callback<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IGetMigrationJobRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Generate a SSH configuration script to configure the reverse SSH
     * connectivity.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.migrationJob
     *   Name of the migration job resource to generate the SSH script.
     * @param {string} request.vm
     *   Required. Bastion VM Instance name to use or to create.
     * @param {google.cloud.clouddms.v1.VmCreationConfig} request.vmCreationConfig
     *   The VM creation configuration
     * @param {google.cloud.clouddms.v1.VmSelectionConfig} request.vmSelectionConfig
     *   The VM selection configuration
     * @param {number} request.vmPort
     *   The port that will be open on the bastion host.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.SshScript|SshScript}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.generate_ssh_script.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_GenerateSshScript_async
     */
    generateSshScript(request?: protos.google.cloud.clouddms.v1.IGenerateSshScriptRequest, options?: CallOptions): Promise<[
        protos.google.cloud.clouddms.v1.ISshScript,
        protos.google.cloud.clouddms.v1.IGenerateSshScriptRequest | undefined,
        {} | undefined
    ]>;
    generateSshScript(request: protos.google.cloud.clouddms.v1.IGenerateSshScriptRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.ISshScript, protos.google.cloud.clouddms.v1.IGenerateSshScriptRequest | null | undefined, {} | null | undefined>): void;
    generateSshScript(request: protos.google.cloud.clouddms.v1.IGenerateSshScriptRequest, callback: Callback<protos.google.cloud.clouddms.v1.ISshScript, protos.google.cloud.clouddms.v1.IGenerateSshScriptRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Generate a TCP Proxy configuration script to configure a cloud-hosted VM
     * running a TCP Proxy.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.migrationJob
     *   Name of the migration job resource to generate the TCP Proxy script.
     * @param {string} request.vmName
     *   Required. The name of the Compute instance that will host the proxy.
     * @param {string} request.vmMachineType
     *   Required. The type of the Compute instance that will host the proxy.
     * @param {string} [request.vmZone]
     *   Optional. The Google Cloud Platform zone to create the VM in. The fully
     *   qualified name of the zone must be specified, including the region name,
     *   for example "us-central1-b". If not specified, uses the "-b" zone of the
     *   destination Connection Profile's region.
     * @param {string} request.vmSubnet
     *   Required. The name of the subnet the Compute instance will use for private
     *   connectivity. Must be supplied in the form of
     *   projects/{project}/regions/{region}/subnetworks/{subnetwork}.
     *   Note: the region for the subnet must match the Compute instance region.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.TcpProxyScript|TcpProxyScript}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.generate_tcp_proxy_script.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_GenerateTcpProxyScript_async
     */
    generateTcpProxyScript(request?: protos.google.cloud.clouddms.v1.IGenerateTcpProxyScriptRequest, options?: CallOptions): Promise<[
        protos.google.cloud.clouddms.v1.ITcpProxyScript,
        protos.google.cloud.clouddms.v1.IGenerateTcpProxyScriptRequest | undefined,
        {} | undefined
    ]>;
    generateTcpProxyScript(request: protos.google.cloud.clouddms.v1.IGenerateTcpProxyScriptRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.ITcpProxyScript, protos.google.cloud.clouddms.v1.IGenerateTcpProxyScriptRequest | null | undefined, {} | null | undefined>): void;
    generateTcpProxyScript(request: protos.google.cloud.clouddms.v1.IGenerateTcpProxyScriptRequest, callback: Callback<protos.google.cloud.clouddms.v1.ITcpProxyScript, protos.google.cloud.clouddms.v1.IGenerateTcpProxyScriptRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets details of a single connection profile.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Name of the connection profile resource to get.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.ConnectionProfile|ConnectionProfile}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.get_connection_profile.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_GetConnectionProfile_async
     */
    getConnectionProfile(request?: protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest, options?: CallOptions): Promise<[
        protos.google.cloud.clouddms.v1.IConnectionProfile,
        protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest | undefined,
        {} | undefined
    ]>;
    getConnectionProfile(request: protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IConnectionProfile, protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest | null | undefined, {} | null | undefined>): void;
    getConnectionProfile(request: protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest, callback: Callback<protos.google.cloud.clouddms.v1.IConnectionProfile, protos.google.cloud.clouddms.v1.IGetConnectionProfileRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets details of a single private connection.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the private connection to get.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.PrivateConnection|PrivateConnection}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.get_private_connection.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_GetPrivateConnection_async
     */
    getPrivateConnection(request?: protos.google.cloud.clouddms.v1.IGetPrivateConnectionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.clouddms.v1.IPrivateConnection,
        protos.google.cloud.clouddms.v1.IGetPrivateConnectionRequest | undefined,
        {} | undefined
    ]>;
    getPrivateConnection(request: protos.google.cloud.clouddms.v1.IGetPrivateConnectionRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IPrivateConnection, protos.google.cloud.clouddms.v1.IGetPrivateConnectionRequest | null | undefined, {} | null | undefined>): void;
    getPrivateConnection(request: protos.google.cloud.clouddms.v1.IGetPrivateConnectionRequest, callback: Callback<protos.google.cloud.clouddms.v1.IPrivateConnection, protos.google.cloud.clouddms.v1.IGetPrivateConnectionRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets details of a single conversion workspace.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Name of the conversion workspace resource to get.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.ConversionWorkspace|ConversionWorkspace}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.get_conversion_workspace.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_GetConversionWorkspace_async
     */
    getConversionWorkspace(request?: protos.google.cloud.clouddms.v1.IGetConversionWorkspaceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.clouddms.v1.IConversionWorkspace,
        protos.google.cloud.clouddms.v1.IGetConversionWorkspaceRequest | undefined,
        {} | undefined
    ]>;
    getConversionWorkspace(request: protos.google.cloud.clouddms.v1.IGetConversionWorkspaceRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IGetConversionWorkspaceRequest | null | undefined, {} | null | undefined>): void;
    getConversionWorkspace(request: protos.google.cloud.clouddms.v1.IGetConversionWorkspaceRequest, callback: Callback<protos.google.cloud.clouddms.v1.IConversionWorkspace, protos.google.cloud.clouddms.v1.IGetConversionWorkspaceRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Creates a new mapping rule for a given conversion workspace.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent which owns this collection of mapping rules.
     * @param {string} request.mappingRuleId
     *   Required. The ID of the rule to create.
     * @param {google.cloud.clouddms.v1.MappingRule} request.mappingRule
     *   Required. Represents a [mapping rule]
     *   (https://cloud.google.com/database-migration/reference/rest/v1/projects.locations.mappingRules)
     *   object.
     * @param {string} request.requestId
     *   A unique ID used to identify the request. If the server receives two
     *   requests with the same ID, then the second request is ignored.
     *
     *   It is recommended to always set this value to a UUID.
     *
     *   The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
     *   (_), and hyphens (-). The maximum length is 40 characters.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.MappingRule|MappingRule}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.create_mapping_rule.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_CreateMappingRule_async
     */
    createMappingRule(request?: protos.google.cloud.clouddms.v1.ICreateMappingRuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.clouddms.v1.IMappingRule,
        protos.google.cloud.clouddms.v1.ICreateMappingRuleRequest | undefined,
        {} | undefined
    ]>;
    createMappingRule(request: protos.google.cloud.clouddms.v1.ICreateMappingRuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IMappingRule, protos.google.cloud.clouddms.v1.ICreateMappingRuleRequest | null | undefined, {} | null | undefined>): void;
    createMappingRule(request: protos.google.cloud.clouddms.v1.ICreateMappingRuleRequest, callback: Callback<protos.google.cloud.clouddms.v1.IMappingRule, protos.google.cloud.clouddms.v1.ICreateMappingRuleRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Deletes a single mapping rule.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Name of the mapping rule resource to delete.
     * @param {string} [request.requestId]
     *   Optional. A unique ID used to identify the request. If the server receives
     *   two requests with the same ID, then the second request is ignored.
     *
     *   It is recommended to always set this value to a UUID.
     *
     *   The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
     *   (_), and hyphens (-). The maximum length is 40 characters.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.delete_mapping_rule.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_DeleteMappingRule_async
     */
    deleteMappingRule(request?: protos.google.cloud.clouddms.v1.IDeleteMappingRuleRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.clouddms.v1.IDeleteMappingRuleRequest | undefined,
        {} | undefined
    ]>;
    deleteMappingRule(request: protos.google.cloud.clouddms.v1.IDeleteMappingRuleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IDeleteMappingRuleRequest | null | undefined, {} | null | undefined>): void;
    deleteMappingRule(request: protos.google.cloud.clouddms.v1.IDeleteMappingRuleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IDeleteMappingRuleRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets the details of a mapping rule.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Name of the mapping rule resource to get.
     *   Example: conversionWorkspaces/123/mappingRules/rule123
     *
     *   In order to retrieve a previous revision of the mapping rule, also provide
     *   the revision ID.
     *   Example:
     *   conversionWorkspace/123/mappingRules/rule123@c7cfa2a8c7cfa2a8c7cfa2a8c7cfa2a8
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.MappingRule|MappingRule}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.get_mapping_rule.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_GetMappingRule_async
     */
    getMappingRule(request?: protos.google.cloud.clouddms.v1.IGetMappingRuleRequest, options?: CallOptions): Promise<[
        protos.google.cloud.clouddms.v1.IMappingRule,
        protos.google.cloud.clouddms.v1.IGetMappingRuleRequest | undefined,
        {} | undefined
    ]>;
    getMappingRule(request: protos.google.cloud.clouddms.v1.IGetMappingRuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IMappingRule, protos.google.cloud.clouddms.v1.IGetMappingRuleRequest | null | undefined, {} | null | undefined>): void;
    getMappingRule(request: protos.google.cloud.clouddms.v1.IGetMappingRuleRequest, callback: Callback<protos.google.cloud.clouddms.v1.IMappingRule, protos.google.cloud.clouddms.v1.IGetMappingRuleRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Searches/lists the background jobs for a specific
     * conversion workspace.
     *
     * The background jobs are not resources like conversion workspaces or
     * mapping rules, and they can't be created, updated or deleted.
     * Instead, they are a way to expose the data plane jobs log.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.conversionWorkspace
     *   Required. Name of the conversion workspace resource whose jobs are listed,
     *   in the form of:
     *   projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
     * @param {boolean} [request.returnMostRecentPerJobType]
     *   Optional. Whether or not to return just the most recent job per job type,
     * @param {number} [request.maxSize]
     *   Optional. The maximum number of jobs to return. The service may return
     *   fewer than this value. If unspecified, at most 100 jobs are
     *   returned. The maximum value is 100; values above 100 are coerced to
     *   100.
     * @param {google.protobuf.Timestamp} [request.completedUntilTime]
     *   Optional. If provided, only returns jobs that completed until (not
     *   including) the given timestamp.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.SearchBackgroundJobsResponse|SearchBackgroundJobsResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.search_background_jobs.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_SearchBackgroundJobs_async
     */
    searchBackgroundJobs(request?: protos.google.cloud.clouddms.v1.ISearchBackgroundJobsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.clouddms.v1.ISearchBackgroundJobsResponse,
        protos.google.cloud.clouddms.v1.ISearchBackgroundJobsRequest | undefined,
        {} | undefined
    ]>;
    searchBackgroundJobs(request: protos.google.cloud.clouddms.v1.ISearchBackgroundJobsRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.ISearchBackgroundJobsResponse, protos.google.cloud.clouddms.v1.ISearchBackgroundJobsRequest | null | undefined, {} | null | undefined>): void;
    searchBackgroundJobs(request: protos.google.cloud.clouddms.v1.ISearchBackgroundJobsRequest, callback: Callback<protos.google.cloud.clouddms.v1.ISearchBackgroundJobsResponse, protos.google.cloud.clouddms.v1.ISearchBackgroundJobsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Retrieves a list of committed revisions of a specific conversion
     * workspace.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.conversionWorkspace
     *   Required. Name of the conversion workspace resource whose revisions are
     *   listed. Must be in the form of:
     *   projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
     * @param {string} [request.commitId]
     *   Optional. Optional filter to request a specific commit ID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.clouddms.v1.DescribeConversionWorkspaceRevisionsResponse|DescribeConversionWorkspaceRevisionsResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.describe_conversion_workspace_revisions.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_DescribeConversionWorkspaceRevisions_async
     */
    describeConversionWorkspaceRevisions(request?: protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsResponse,
        protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsRequest | undefined,
        {} | undefined
    ]>;
    describeConversionWorkspaceRevisions(request: protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsRequest, options: CallOptions, callback: Callback<protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsResponse, protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsRequest | null | undefined, {} | null | undefined>): void;
    describeConversionWorkspaceRevisions(request: protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsRequest, callback: Callback<protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsResponse, protos.google.cloud.clouddms.v1.IDescribeConversionWorkspaceRevisionsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Creates a new migration job in a given project and location.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The parent which owns this collection of migration jobs.
     * @param {string} request.migrationJobId
     *   Required. The ID of the instance to create.
     * @param {google.cloud.clouddms.v1.MigrationJob} request.migrationJob
     *   Required. Represents a [migration
     *   job](https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs)
     *   object.
     * @param {string} [request.requestId]
     *   Optional. A unique ID used to identify the request. If the server receives
     *   two requests with the same ID, then the second request is ignored.
     *
     *   It is recommended to always set this value to a UUID.
     *
     *   The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
     *   (_), and hyphens (-). The maximum length is 40 characters.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.create_migration_job.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_CreateMigrationJob_async
     */
    createMigrationJob(request?: protos.google.cloud.clouddms.v1.ICreateMigrationJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    createMigrationJob(request: protos.google.cloud.clouddms.v1.ICreateMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    createMigrationJob(request: protos.google.cloud.clouddms.v1.ICreateMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `createMigrationJob()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.create_migration_job.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_CreateMigrationJob_async
     */
    checkCreateMigrationJobProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.MigrationJob, protos.google.cloud.clouddms.v1.OperationMetadata>>;
    /**
     * Updates the parameters of a single migration job.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.protobuf.FieldMask} request.updateMask
     *   Required. Field mask is used to specify the fields to be overwritten by the
     *   update in the conversion workspace resource.
     * @param {google.cloud.clouddms.v1.MigrationJob} request.migrationJob
     *   Required. The migration job parameters to update.
     * @param {string} request.requestId
     *   A unique ID used to identify the request. If the server receives two
     *   requests with the same ID, then the second request is ignored.
     *
     *   It is recommended to always set this value to a UUID.
     *
     *   The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
     *   (_), and hyphens (-). The maximum length is 40 characters.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.update_migration_job.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_UpdateMigrationJob_async
     */
    updateMigrationJob(request?: protos.google.cloud.clouddms.v1.IUpdateMigrationJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    updateMigrationJob(request: protos.google.cloud.clouddms.v1.IUpdateMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    updateMigrationJob(request: protos.google.cloud.clouddms.v1.IUpdateMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `updateMigrationJob()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.update_migration_job.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_UpdateMigrationJob_async
     */
    checkUpdateMigrationJobProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.MigrationJob, protos.google.cloud.clouddms.v1.OperationMetadata>>;
    /**
     * Deletes a single migration job.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Name of the migration job resource to delete.
     * @param {string} request.requestId
     *   A unique ID used to identify the request. If the server receives two
     *   requests with the same ID, then the second request is ignored.
     *
     *   It is recommended to always set this value to a UUID.
     *
     *   The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores
     *   (_), and hyphens (-). The maximum length is 40 characters.
     * @param {boolean} request.force
     *   The destination CloudSQL connection profile is always deleted with the
     *   migration job. In case of force delete, the destination CloudSQL replica
     *   database is also deleted.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.delete_migration_job.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_DeleteMigrationJob_async
     */
    deleteMigrationJob(request?: protos.google.cloud.clouddms.v1.IDeleteMigrationJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    deleteMigrationJob(request: protos.google.cloud.clouddms.v1.IDeleteMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    deleteMigrationJob(request: protos.google.cloud.clouddms.v1.IDeleteMigrationJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `deleteMigrationJob()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.delete_migration_job.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_DeleteMigrationJob_async
     */
    checkDeleteMigrationJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.clouddms.v1.OperationMetadata>>;
    /**
     * Start an already created migration job.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Name of the migration job resource to start.
     * @param {boolean} [request.skipValidation]
     *   Optional. Start the migration job without running prior configuration
     *   verification. Defaults to `false`.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.start_migration_job.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_StartMigrationJob_async
     */
    startMigrationJob(request?: protos.google.cloud.clouddms.v1.IStartMigrationJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    startMigrationJob(request: protos.google.cloud.clouddms.v1.IStartMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    startMigrationJob(request: protos.google.cloud.clouddms.v1.IStartMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `startMigrationJob()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.start_migration_job.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_StartMigrationJob_async
     */
    checkStartMigrationJobProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.MigrationJob, protos.google.cloud.clouddms.v1.OperationMetadata>>;
    /**
     * Stops a running migration job.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Name of the migration job resource to stop.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.stop_migration_job.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_StopMigrationJob_async
     */
    stopMigrationJob(request?: protos.google.cloud.clouddms.v1.IStopMigrationJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    stopMigrationJob(request: protos.google.cloud.clouddms.v1.IStopMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    stopMigrationJob(request: protos.google.cloud.clouddms.v1.IStopMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `stopMigrationJob()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.stop_migration_job.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_StopMigrationJob_async
     */
    checkStopMigrationJobProgress(name: string): Promise<LROperation<protos.google.cloud.clouddms.v1.MigrationJob, protos.google.cloud.clouddms.v1.OperationMetadata>>;
    /**
     * Resume a migration job that is currently stopped and is resumable (was
     * stopped during CDC phase).
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Name of the migration job resource to resume.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/data_migration_service.resume_migration_job.js</caption>
     * region_tag:datamigration_v1_generated_DataMigrationService_ResumeMigrationJob_async
     */
    resumeMigrationJob(request?: protos.google.cloud.clouddms.v1.IResumeMigrationJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    resumeMigrationJob(request: protos.google.cloud.clouddms.v1.IResumeMigrationJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    resumeMigrationJob(request: protos.google.cloud.clouddms.v1.IResumeMigrationJobRequest, callback: Callback<LROperation<protos.google.cloud.clouddms.v1.IMigrationJob, protos.google.cloud.clouddms.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `resumeMigrationJob()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-