@google-cloud/bigquery-migration
Version:
bigquery-migration client for Node.js
568 lines (567 loc) • 35.6 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* Service to handle EDW migrations.
* @class
* @memberof v2
*/
export declare class MigrationServiceClient {
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;
};
pathTemplates: {
[name: string]: gax.PathTemplate;
};
migrationServiceStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of MigrationServiceClient.
*
* @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 MigrationServiceClient({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;
/**
* Creates a migration workflow.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The name of the project to which this migration workflow belongs.
* Example: `projects/foo/locations/bar`
* @param {google.cloud.bigquery.migration.v2.MigrationWorkflow} request.migrationWorkflow
* Required. The migration workflow to create.
* @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.bigquery.migration.v2.MigrationWorkflow|MigrationWorkflow}.
* 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/v2/migration_service.create_migration_workflow.js</caption>
* region_tag:bigquerymigration_v2_generated_MigrationService_CreateMigrationWorkflow_async
*/
createMigrationWorkflow(request?: protos.google.cloud.bigquery.migration.v2.ICreateMigrationWorkflowRequest, options?: CallOptions): Promise<[
protos.google.cloud.bigquery.migration.v2.IMigrationWorkflow,
(protos.google.cloud.bigquery.migration.v2.ICreateMigrationWorkflowRequest | undefined),
{} | undefined
]>;
createMigrationWorkflow(request: protos.google.cloud.bigquery.migration.v2.ICreateMigrationWorkflowRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.migration.v2.IMigrationWorkflow, protos.google.cloud.bigquery.migration.v2.ICreateMigrationWorkflowRequest | null | undefined, {} | null | undefined>): void;
createMigrationWorkflow(request: protos.google.cloud.bigquery.migration.v2.ICreateMigrationWorkflowRequest, callback: Callback<protos.google.cloud.bigquery.migration.v2.IMigrationWorkflow, protos.google.cloud.bigquery.migration.v2.ICreateMigrationWorkflowRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets a previously created migration workflow.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The unique identifier for the migration workflow.
* Example: `projects/123/locations/us/workflows/1234`
* @param {google.protobuf.FieldMask} request.readMask
* The list of fields to be retrieved.
* @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.bigquery.migration.v2.MigrationWorkflow|MigrationWorkflow}.
* 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/v2/migration_service.get_migration_workflow.js</caption>
* region_tag:bigquerymigration_v2_generated_MigrationService_GetMigrationWorkflow_async
*/
getMigrationWorkflow(request?: protos.google.cloud.bigquery.migration.v2.IGetMigrationWorkflowRequest, options?: CallOptions): Promise<[
protos.google.cloud.bigquery.migration.v2.IMigrationWorkflow,
(protos.google.cloud.bigquery.migration.v2.IGetMigrationWorkflowRequest | undefined),
{} | undefined
]>;
getMigrationWorkflow(request: protos.google.cloud.bigquery.migration.v2.IGetMigrationWorkflowRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.migration.v2.IMigrationWorkflow, protos.google.cloud.bigquery.migration.v2.IGetMigrationWorkflowRequest | null | undefined, {} | null | undefined>): void;
getMigrationWorkflow(request: protos.google.cloud.bigquery.migration.v2.IGetMigrationWorkflowRequest, callback: Callback<protos.google.cloud.bigquery.migration.v2.IMigrationWorkflow, protos.google.cloud.bigquery.migration.v2.IGetMigrationWorkflowRequest | null | undefined, {} | null | undefined>): void;
/**
* Deletes a migration workflow by name.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The unique identifier for the migration workflow.
* Example: `projects/123/locations/us/workflows/1234`
* @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/v2/migration_service.delete_migration_workflow.js</caption>
* region_tag:bigquerymigration_v2_generated_MigrationService_DeleteMigrationWorkflow_async
*/
deleteMigrationWorkflow(request?: protos.google.cloud.bigquery.migration.v2.IDeleteMigrationWorkflowRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.bigquery.migration.v2.IDeleteMigrationWorkflowRequest | undefined),
{} | undefined
]>;
deleteMigrationWorkflow(request: protos.google.cloud.bigquery.migration.v2.IDeleteMigrationWorkflowRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.migration.v2.IDeleteMigrationWorkflowRequest | null | undefined, {} | null | undefined>): void;
deleteMigrationWorkflow(request: protos.google.cloud.bigquery.migration.v2.IDeleteMigrationWorkflowRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.migration.v2.IDeleteMigrationWorkflowRequest | null | undefined, {} | null | undefined>): void;
/**
* Starts a previously created migration workflow. I.e., the state transitions
* from DRAFT to RUNNING. This is a no-op if the state is already RUNNING.
* An error will be signaled if the state is anything other than DRAFT or
* RUNNING.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The unique identifier for the migration workflow.
* Example: `projects/123/locations/us/workflows/1234`
* @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/v2/migration_service.start_migration_workflow.js</caption>
* region_tag:bigquerymigration_v2_generated_MigrationService_StartMigrationWorkflow_async
*/
startMigrationWorkflow(request?: protos.google.cloud.bigquery.migration.v2.IStartMigrationWorkflowRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.bigquery.migration.v2.IStartMigrationWorkflowRequest | undefined),
{} | undefined
]>;
startMigrationWorkflow(request: protos.google.cloud.bigquery.migration.v2.IStartMigrationWorkflowRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.migration.v2.IStartMigrationWorkflowRequest | null | undefined, {} | null | undefined>): void;
startMigrationWorkflow(request: protos.google.cloud.bigquery.migration.v2.IStartMigrationWorkflowRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.bigquery.migration.v2.IStartMigrationWorkflowRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets a previously created migration subtask.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The unique identifier for the migration subtask.
* Example: `projects/123/locations/us/workflows/1234/subtasks/543`
* @param {google.protobuf.FieldMask} [request.readMask]
* Optional. The list of fields to be retrieved.
* @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.bigquery.migration.v2.MigrationSubtask|MigrationSubtask}.
* 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/v2/migration_service.get_migration_subtask.js</caption>
* region_tag:bigquerymigration_v2_generated_MigrationService_GetMigrationSubtask_async
*/
getMigrationSubtask(request?: protos.google.cloud.bigquery.migration.v2.IGetMigrationSubtaskRequest, options?: CallOptions): Promise<[
protos.google.cloud.bigquery.migration.v2.IMigrationSubtask,
(protos.google.cloud.bigquery.migration.v2.IGetMigrationSubtaskRequest | undefined),
{} | undefined
]>;
getMigrationSubtask(request: protos.google.cloud.bigquery.migration.v2.IGetMigrationSubtaskRequest, options: CallOptions, callback: Callback<protos.google.cloud.bigquery.migration.v2.IMigrationSubtask, protos.google.cloud.bigquery.migration.v2.IGetMigrationSubtaskRequest | null | undefined, {} | null | undefined>): void;
getMigrationSubtask(request: protos.google.cloud.bigquery.migration.v2.IGetMigrationSubtaskRequest, callback: Callback<protos.google.cloud.bigquery.migration.v2.IMigrationSubtask, protos.google.cloud.bigquery.migration.v2.IGetMigrationSubtaskRequest | null | undefined, {} | null | undefined>): void;
/**
* Lists previously created migration workflow.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The project and location of the migration workflows to list.
* Example: `projects/123/locations/us`
* @param {google.protobuf.FieldMask} request.readMask
* The list of fields to be retrieved.
* @param {number} request.pageSize
* The maximum number of migration workflows to return. The service may return
* fewer than this number.
* @param {string} request.pageToken
* A page token, received from previous `ListMigrationWorkflows` call.
* Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListMigrationWorkflows`
* must match the call that provided the page token.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of {@link protos.google.cloud.bigquery.migration.v2.MigrationWorkflow|MigrationWorkflow}.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed and will merge results from all the pages into this array.
* Note that it can affect your quota.
* We recommend using `listMigrationWorkflowsAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listMigrationWorkflows(request?: protos.google.cloud.bigquery.migration.v2.IListMigrationWorkflowsRequest, options?: CallOptions): Promise<[
protos.google.cloud.bigquery.migration.v2.IMigrationWorkflow[],
protos.google.cloud.bigquery.migration.v2.IListMigrationWorkflowsRequest | null,
protos.google.cloud.bigquery.migration.v2.IListMigrationWorkflowsResponse
]>;
listMigrationWorkflows(request: protos.google.cloud.bigquery.migration.v2.IListMigrationWorkflowsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.bigquery.migration.v2.IListMigrationWorkflowsRequest, protos.google.cloud.bigquery.migration.v2.IListMigrationWorkflowsResponse | null | undefined, protos.google.cloud.bigquery.migration.v2.IMigrationWorkflow>): void;
listMigrationWorkflows(request: protos.google.cloud.bigquery.migration.v2.IListMigrationWorkflowsRequest, callback: PaginationCallback<protos.google.cloud.bigquery.migration.v2.IListMigrationWorkflowsRequest, protos.google.cloud.bigquery.migration.v2.IListMigrationWorkflowsResponse | null | undefined, protos.google.cloud.bigquery.migration.v2.IMigrationWorkflow>): void;
/**
* Equivalent to `listMigrationWorkflows`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The project and location of the migration workflows to list.
* Example: `projects/123/locations/us`
* @param {google.protobuf.FieldMask} request.readMask
* The list of fields to be retrieved.
* @param {number} request.pageSize
* The maximum number of migration workflows to return. The service may return
* fewer than this number.
* @param {string} request.pageToken
* A page token, received from previous `ListMigrationWorkflows` call.
* Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListMigrationWorkflows`
* must match the call that provided the page token.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.cloud.bigquery.migration.v2.MigrationWorkflow|MigrationWorkflow} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed. Note that it can affect your quota.
* We recommend using `listMigrationWorkflowsAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listMigrationWorkflowsStream(request?: protos.google.cloud.bigquery.migration.v2.IListMigrationWorkflowsRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listMigrationWorkflows`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The project and location of the migration workflows to list.
* Example: `projects/123/locations/us`
* @param {google.protobuf.FieldMask} request.readMask
* The list of fields to be retrieved.
* @param {number} request.pageSize
* The maximum number of migration workflows to return. The service may return
* fewer than this number.
* @param {string} request.pageToken
* A page token, received from previous `ListMigrationWorkflows` call.
* Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListMigrationWorkflows`
* must match the call that provided the page token.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.cloud.bigquery.migration.v2.MigrationWorkflow|MigrationWorkflow}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2/migration_service.list_migration_workflows.js</caption>
* region_tag:bigquerymigration_v2_generated_MigrationService_ListMigrationWorkflows_async
*/
listMigrationWorkflowsAsync(request?: protos.google.cloud.bigquery.migration.v2.IListMigrationWorkflowsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.bigquery.migration.v2.IMigrationWorkflow>;
/**
* Lists previously created migration subtasks.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The migration task of the subtasks to list.
* Example: `projects/123/locations/us/workflows/1234`
* @param {google.protobuf.FieldMask} [request.readMask]
* Optional. The list of fields to be retrieved.
* @param {number} [request.pageSize]
* Optional. The maximum number of migration tasks to return. The service may
* return fewer than this number.
* @param {string} [request.pageToken]
* Optional. A page token, received from previous `ListMigrationSubtasks`
* call. Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListMigrationSubtasks`
* must match the call that provided the page token.
* @param {string} [request.filter]
* Optional. The filter to apply. This can be used to get the subtasks of a
* specific tasks in a workflow, e.g. `migration_task = "ab012"` where
* `"ab012"` is the task ID (not the name in the named map).
* @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 Array of {@link protos.google.cloud.bigquery.migration.v2.MigrationSubtask|MigrationSubtask}.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed and will merge results from all the pages into this array.
* Note that it can affect your quota.
* We recommend using `listMigrationSubtasksAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listMigrationSubtasks(request?: protos.google.cloud.bigquery.migration.v2.IListMigrationSubtasksRequest, options?: CallOptions): Promise<[
protos.google.cloud.bigquery.migration.v2.IMigrationSubtask[],
protos.google.cloud.bigquery.migration.v2.IListMigrationSubtasksRequest | null,
protos.google.cloud.bigquery.migration.v2.IListMigrationSubtasksResponse
]>;
listMigrationSubtasks(request: protos.google.cloud.bigquery.migration.v2.IListMigrationSubtasksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.bigquery.migration.v2.IListMigrationSubtasksRequest, protos.google.cloud.bigquery.migration.v2.IListMigrationSubtasksResponse | null | undefined, protos.google.cloud.bigquery.migration.v2.IMigrationSubtask>): void;
listMigrationSubtasks(request: protos.google.cloud.bigquery.migration.v2.IListMigrationSubtasksRequest, callback: PaginationCallback<protos.google.cloud.bigquery.migration.v2.IListMigrationSubtasksRequest, protos.google.cloud.bigquery.migration.v2.IListMigrationSubtasksResponse | null | undefined, protos.google.cloud.bigquery.migration.v2.IMigrationSubtask>): void;
/**
* Equivalent to `listMigrationSubtasks`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The migration task of the subtasks to list.
* Example: `projects/123/locations/us/workflows/1234`
* @param {google.protobuf.FieldMask} [request.readMask]
* Optional. The list of fields to be retrieved.
* @param {number} [request.pageSize]
* Optional. The maximum number of migration tasks to return. The service may
* return fewer than this number.
* @param {string} [request.pageToken]
* Optional. A page token, received from previous `ListMigrationSubtasks`
* call. Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListMigrationSubtasks`
* must match the call that provided the page token.
* @param {string} [request.filter]
* Optional. The filter to apply. This can be used to get the subtasks of a
* specific tasks in a workflow, e.g. `migration_task = "ab012"` where
* `"ab012"` is the task ID (not the name in the named map).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.cloud.bigquery.migration.v2.MigrationSubtask|MigrationSubtask} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed. Note that it can affect your quota.
* We recommend using `listMigrationSubtasksAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listMigrationSubtasksStream(request?: protos.google.cloud.bigquery.migration.v2.IListMigrationSubtasksRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listMigrationSubtasks`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The migration task of the subtasks to list.
* Example: `projects/123/locations/us/workflows/1234`
* @param {google.protobuf.FieldMask} [request.readMask]
* Optional. The list of fields to be retrieved.
* @param {number} [request.pageSize]
* Optional. The maximum number of migration tasks to return. The service may
* return fewer than this number.
* @param {string} [request.pageToken]
* Optional. A page token, received from previous `ListMigrationSubtasks`
* call. Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListMigrationSubtasks`
* must match the call that provided the page token.
* @param {string} [request.filter]
* Optional. The filter to apply. This can be used to get the subtasks of a
* specific tasks in a workflow, e.g. `migration_task = "ab012"` where
* `"ab012"` is the task ID (not the name in the named map).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.cloud.bigquery.migration.v2.MigrationSubtask|MigrationSubtask}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2/migration_service.list_migration_subtasks.js</caption>
* region_tag:bigquerymigration_v2_generated_MigrationService_ListMigrationSubtasks_async
*/
listMigrationSubtasksAsync(request?: protos.google.cloud.bigquery.migration.v2.IListMigrationSubtasksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.bigquery.migration.v2.IMigrationSubtask>;
/**
* Return a fully-qualified location resource name string.
*
* @param {string} project
* @param {string} location
* @returns {string} Resource name string.
*/
locationPath(project: string, location: string): string;
/**
* Parse the project from Location resource.
*
* @param {string} locationName
* A fully-qualified path representing Location resource.
* @returns {string} A string representing the project.
*/
matchProjectFromLocationName(locationName: string): string | number;
/**
* Parse the location from Location resource.
*
* @param {string} locationName
* A fully-qualified path representing Location resource.
* @returns {string} A string representing the location.
*/
matchLocationFromLocationName(locationName: string): string | number;
/**
* Return a fully-qualified migrationSubtask resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} workflow
* @param {string} subtask
* @returns {string} Resource name string.
*/
migrationSubtaskPath(project: string, location: string, workflow: string, subtask: string): string;
/**
* Parse the project from MigrationSubtask resource.
*
* @param {string} migrationSubtaskName
* A fully-qualified path representing MigrationSubtask resource.
* @returns {string} A string representing the project.
*/
matchProjectFromMigrationSubtaskName(migrationSubtaskName: string): string | number;
/**
* Parse the location from MigrationSubtask resource.
*
* @param {string} migrationSubtaskName
* A fully-qualified path representing MigrationSubtask resource.
* @returns {string} A string representing the location.
*/
matchLocationFromMigrationSubtaskName(migrationSubtaskName: string): string | number;
/**
* Parse the workflow from MigrationSubtask resource.
*
* @param {string} migrationSubtaskName
* A fully-qualified path representing MigrationSubtask resource.
* @returns {string} A string representing the workflow.
*/
matchWorkflowFromMigrationSubtaskName(migrationSubtaskName: string): string | number;
/**
* Parse the subtask from MigrationSubtask resource.
*
* @param {string} migrationSubtaskName
* A fully-qualified path representing MigrationSubtask resource.
* @returns {string} A string representing the subtask.
*/
matchSubtaskFromMigrationSubtaskName(migrationSubtaskName: string): string | number;
/**
* Return a fully-qualified migrationWorkflow resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} workflow
* @returns {string} Resource name string.
*/
migrationWorkflowPath(project: string, location: string, workflow: string): string;
/**
* Parse the project from MigrationWorkflow resource.
*
* @param {string} migrationWorkflowName
* A fully-qualified path representing MigrationWorkflow resource.
* @returns {string} A string representing the project.
*/
matchProjectFromMigrationWorkflowName(migrationWorkflowName: string): string | number;
/**
* Parse the location from MigrationWorkflow resource.
*
* @param {string} migrationWorkflowName
* A fully-qualified path representing MigrationWorkflow resource.
* @returns {string} A string representing the location.
*/
matchLocationFromMigrationWorkflowName(migrationWorkflowName: string): string | number;
/**
* Parse the workflow from MigrationWorkflow resource.
*
* @param {string} migrationWorkflowName
* A fully-qualified path representing MigrationWorkflow resource.
* @returns {string} A string representing the workflow.
*/
matchWorkflowFromMigrationWorkflowName(migrationWorkflowName: string): string | number;
/**
* Terminate the gRPC channel and close the client.
*
* The client will no longer be usable and all future behavior is undefined.
* @returns {Promise} A promise that resolves when the client is closed.
*/
close(): Promise<void>;
}