@google-cloud/lineage
Version:
Data Lineage API client for Node.js
736 lines • 84.4 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* Lineage is used to track data flows between assets over time. You can
* create {@link protos.google.cloud.datacatalog.lineage.v1.LineageEvent|LineageEvents}
* to record lineage between multiple sources and a single target, for
* example, when table data is based on data from multiple tables.
* @class
* @memberof v1
*/
export declare class LineageClient {
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;
};
operationsClient: gax.OperationsClient;
lineageStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of LineageClient.
*
* @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 LineageClient({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 new lineage events together with their parents: process and run.
* Updates the process and run if they already exist.
* Mapped from Open Lineage specification:
* https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The name of the project and its location that should own the
* process, run, and lineage event.
* @param {google.protobuf.Struct} request.openLineage
* Required. OpenLineage message following OpenLineage format:
* https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json
* @param {string} request.requestId
* A unique identifier for this request. Restricted to 36 ASCII characters.
* A random UUID is recommended. This request is idempotent only if a
* `request_id` is provided.
* @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.datacatalog.lineage.v1.ProcessOpenLineageRunEventResponse|ProcessOpenLineageRunEventResponse}.
* 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/lineage.process_open_lineage_run_event.js</caption>
* region_tag:datalineage_v1_generated_Lineage_ProcessOpenLineageRunEvent_async
*/
processOpenLineageRunEvent(request?: protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventRequest, options?: CallOptions): Promise<[
protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventResponse,
protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventRequest | undefined,
{} | undefined
]>;
processOpenLineageRunEvent(request: protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventResponse, protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventRequest | null | undefined, {} | null | undefined>): void;
processOpenLineageRunEvent(request: protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventRequest, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventResponse, protos.google.cloud.datacatalog.lineage.v1.IProcessOpenLineageRunEventRequest | null | undefined, {} | null | undefined>): void;
/**
* Creates a new process.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The name of the project and its location that should own the
* process.
* @param {google.cloud.datacatalog.lineage.v1.Process} request.process
* Required. The process to create.
* @param {string} request.requestId
* A unique identifier for this request. Restricted to 36 ASCII characters.
* A random UUID is recommended. This request is idempotent only if a
* `request_id` is provided.
* @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.datacatalog.lineage.v1.Process|Process}.
* 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/lineage.create_process.js</caption>
* region_tag:datalineage_v1_generated_Lineage_CreateProcess_async
*/
createProcess(request?: protos.google.cloud.datacatalog.lineage.v1.ICreateProcessRequest, options?: CallOptions): Promise<[
protos.google.cloud.datacatalog.lineage.v1.IProcess,
protos.google.cloud.datacatalog.lineage.v1.ICreateProcessRequest | undefined,
{} | undefined
]>;
createProcess(request: protos.google.cloud.datacatalog.lineage.v1.ICreateProcessRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IProcess, protos.google.cloud.datacatalog.lineage.v1.ICreateProcessRequest | null | undefined, {} | null | undefined>): void;
createProcess(request: protos.google.cloud.datacatalog.lineage.v1.ICreateProcessRequest, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IProcess, protos.google.cloud.datacatalog.lineage.v1.ICreateProcessRequest | null | undefined, {} | null | undefined>): void;
/**
* Updates a process.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.datacatalog.lineage.v1.Process} request.process
* Required. The lineage process to update.
*
* The process's `name` field is used to identify the process to update.
* @param {google.protobuf.FieldMask} request.updateMask
* The list of fields to update. Currently not used. The whole message is
* updated.
* @param {boolean} request.allowMissing
* If set to true and the process is not found, the request inserts it.
* @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.datacatalog.lineage.v1.Process|Process}.
* 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/lineage.update_process.js</caption>
* region_tag:datalineage_v1_generated_Lineage_UpdateProcess_async
*/
updateProcess(request?: protos.google.cloud.datacatalog.lineage.v1.IUpdateProcessRequest, options?: CallOptions): Promise<[
protos.google.cloud.datacatalog.lineage.v1.IProcess,
protos.google.cloud.datacatalog.lineage.v1.IUpdateProcessRequest | undefined,
{} | undefined
]>;
updateProcess(request: protos.google.cloud.datacatalog.lineage.v1.IUpdateProcessRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IProcess, protos.google.cloud.datacatalog.lineage.v1.IUpdateProcessRequest | null | undefined, {} | null | undefined>): void;
updateProcess(request: protos.google.cloud.datacatalog.lineage.v1.IUpdateProcessRequest, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IProcess, protos.google.cloud.datacatalog.lineage.v1.IUpdateProcessRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets the details of the specified process.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the process 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.datacatalog.lineage.v1.Process|Process}.
* 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/lineage.get_process.js</caption>
* region_tag:datalineage_v1_generated_Lineage_GetProcess_async
*/
getProcess(request?: protos.google.cloud.datacatalog.lineage.v1.IGetProcessRequest, options?: CallOptions): Promise<[
protos.google.cloud.datacatalog.lineage.v1.IProcess,
protos.google.cloud.datacatalog.lineage.v1.IGetProcessRequest | undefined,
{} | undefined
]>;
getProcess(request: protos.google.cloud.datacatalog.lineage.v1.IGetProcessRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IProcess, protos.google.cloud.datacatalog.lineage.v1.IGetProcessRequest | null | undefined, {} | null | undefined>): void;
getProcess(request: protos.google.cloud.datacatalog.lineage.v1.IGetProcessRequest, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IProcess, protos.google.cloud.datacatalog.lineage.v1.IGetProcessRequest | null | undefined, {} | null | undefined>): void;
/**
* Creates a new run.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The name of the process that should own the run.
* @param {google.cloud.datacatalog.lineage.v1.Run} request.run
* Required. The run to create.
* @param {string} request.requestId
* A unique identifier for this request. Restricted to 36 ASCII characters.
* A random UUID is recommended. This request is idempotent only if a
* `request_id` is provided.
* @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.datacatalog.lineage.v1.Run|Run}.
* 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/lineage.create_run.js</caption>
* region_tag:datalineage_v1_generated_Lineage_CreateRun_async
*/
createRun(request?: protos.google.cloud.datacatalog.lineage.v1.ICreateRunRequest, options?: CallOptions): Promise<[
protos.google.cloud.datacatalog.lineage.v1.IRun,
protos.google.cloud.datacatalog.lineage.v1.ICreateRunRequest | undefined,
{} | undefined
]>;
createRun(request: protos.google.cloud.datacatalog.lineage.v1.ICreateRunRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IRun, protos.google.cloud.datacatalog.lineage.v1.ICreateRunRequest | null | undefined, {} | null | undefined>): void;
createRun(request: protos.google.cloud.datacatalog.lineage.v1.ICreateRunRequest, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IRun, protos.google.cloud.datacatalog.lineage.v1.ICreateRunRequest | null | undefined, {} | null | undefined>): void;
/**
* Updates a run.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.datacatalog.lineage.v1.Run} request.run
* Required. The lineage run to update.
*
* The run's `name` field is used to identify the run to update.
*
* Format:
* `projects/{project}/locations/{location}/processes/{process}/runs/{run}`.
* @param {google.protobuf.FieldMask} request.updateMask
* The list of fields to update. Currently not used. The whole message is
* updated.
* @param {boolean} request.allowMissing
* If set to true and the run is not found, the request creates it.
* @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.datacatalog.lineage.v1.Run|Run}.
* 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/lineage.update_run.js</caption>
* region_tag:datalineage_v1_generated_Lineage_UpdateRun_async
*/
updateRun(request?: protos.google.cloud.datacatalog.lineage.v1.IUpdateRunRequest, options?: CallOptions): Promise<[
protos.google.cloud.datacatalog.lineage.v1.IRun,
protos.google.cloud.datacatalog.lineage.v1.IUpdateRunRequest | undefined,
{} | undefined
]>;
updateRun(request: protos.google.cloud.datacatalog.lineage.v1.IUpdateRunRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IRun, protos.google.cloud.datacatalog.lineage.v1.IUpdateRunRequest | null | undefined, {} | null | undefined>): void;
updateRun(request: protos.google.cloud.datacatalog.lineage.v1.IUpdateRunRequest, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IRun, protos.google.cloud.datacatalog.lineage.v1.IUpdateRunRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets the details of the specified run.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the run 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.datacatalog.lineage.v1.Run|Run}.
* 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/lineage.get_run.js</caption>
* region_tag:datalineage_v1_generated_Lineage_GetRun_async
*/
getRun(request?: protos.google.cloud.datacatalog.lineage.v1.IGetRunRequest, options?: CallOptions): Promise<[
protos.google.cloud.datacatalog.lineage.v1.IRun,
protos.google.cloud.datacatalog.lineage.v1.IGetRunRequest | undefined,
{} | undefined
]>;
getRun(request: protos.google.cloud.datacatalog.lineage.v1.IGetRunRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IRun, protos.google.cloud.datacatalog.lineage.v1.IGetRunRequest | null | undefined, {} | null | undefined>): void;
getRun(request: protos.google.cloud.datacatalog.lineage.v1.IGetRunRequest, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.IRun, protos.google.cloud.datacatalog.lineage.v1.IGetRunRequest | null | undefined, {} | null | undefined>): void;
/**
* Creates a new lineage event.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The name of the run that should own the lineage event.
* @param {google.cloud.datacatalog.lineage.v1.LineageEvent} request.lineageEvent
* Required. The lineage event to create.
* @param {string} request.requestId
* A unique identifier for this request. Restricted to 36 ASCII characters.
* A random UUID is recommended. This request is idempotent only if a
* `request_id` is provided.
* @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.datacatalog.lineage.v1.LineageEvent|LineageEvent}.
* 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/lineage.create_lineage_event.js</caption>
* region_tag:datalineage_v1_generated_Lineage_CreateLineageEvent_async
*/
createLineageEvent(request?: protos.google.cloud.datacatalog.lineage.v1.ICreateLineageEventRequest, options?: CallOptions): Promise<[
protos.google.cloud.datacatalog.lineage.v1.ILineageEvent,
protos.google.cloud.datacatalog.lineage.v1.ICreateLineageEventRequest | undefined,
{} | undefined
]>;
createLineageEvent(request: protos.google.cloud.datacatalog.lineage.v1.ICreateLineageEventRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.ILineageEvent, protos.google.cloud.datacatalog.lineage.v1.ICreateLineageEventRequest | null | undefined, {} | null | undefined>): void;
createLineageEvent(request: protos.google.cloud.datacatalog.lineage.v1.ICreateLineageEventRequest, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.ILineageEvent, protos.google.cloud.datacatalog.lineage.v1.ICreateLineageEventRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets details of a specified lineage event.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the lineage event 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.datacatalog.lineage.v1.LineageEvent|LineageEvent}.
* 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/lineage.get_lineage_event.js</caption>
* region_tag:datalineage_v1_generated_Lineage_GetLineageEvent_async
*/
getLineageEvent(request?: protos.google.cloud.datacatalog.lineage.v1.IGetLineageEventRequest, options?: CallOptions): Promise<[
protos.google.cloud.datacatalog.lineage.v1.ILineageEvent,
protos.google.cloud.datacatalog.lineage.v1.IGetLineageEventRequest | undefined,
{} | undefined
]>;
getLineageEvent(request: protos.google.cloud.datacatalog.lineage.v1.IGetLineageEventRequest, options: CallOptions, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.ILineageEvent, protos.google.cloud.datacatalog.lineage.v1.IGetLineageEventRequest | null | undefined, {} | null | undefined>): void;
getLineageEvent(request: protos.google.cloud.datacatalog.lineage.v1.IGetLineageEventRequest, callback: Callback<protos.google.cloud.datacatalog.lineage.v1.ILineageEvent, protos.google.cloud.datacatalog.lineage.v1.IGetLineageEventRequest | null | undefined, {} | null | undefined>): void;
/**
* Deletes the lineage event with the specified name.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the lineage event to delete.
* @param {boolean} request.allowMissing
* If set to true and the lineage event is not found, the request
* succeeds but the server doesn't perform any actions.
* @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/lineage.delete_lineage_event.js</caption>
* region_tag:datalineage_v1_generated_Lineage_DeleteLineageEvent_async
*/
deleteLineageEvent(request?: protos.google.cloud.datacatalog.lineage.v1.IDeleteLineageEventRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.datacatalog.lineage.v1.IDeleteLineageEventRequest | undefined,
{} | undefined
]>;
deleteLineageEvent(request: protos.google.cloud.datacatalog.lineage.v1.IDeleteLineageEventRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.lineage.v1.IDeleteLineageEventRequest | null | undefined, {} | null | undefined>): void;
deleteLineageEvent(request: protos.google.cloud.datacatalog.lineage.v1.IDeleteLineageEventRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.lineage.v1.IDeleteLineageEventRequest | null | undefined, {} | null | undefined>): void;
/**
* Deletes the process with the specified name.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the process to delete.
* @param {boolean} request.allowMissing
* If set to true and the process is not found, the request
* succeeds but the server doesn't perform any actions.
* @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/lineage.delete_process.js</caption>
* region_tag:datalineage_v1_generated_Lineage_DeleteProcess_async
*/
deleteProcess(request?: protos.google.cloud.datacatalog.lineage.v1.IDeleteProcessRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.lineage.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
deleteProcess(request: protos.google.cloud.datacatalog.lineage.v1.IDeleteProcessRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.lineage.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
deleteProcess(request: protos.google.cloud.datacatalog.lineage.v1.IDeleteProcessRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.lineage.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `deleteProcess()`.
* @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/lineage.delete_process.js</caption>
* region_tag:datalineage_v1_generated_Lineage_DeleteProcess_async
*/
checkDeleteProcessProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.datacatalog.lineage.v1.OperationMetadata>>;
/**
* Deletes the run with the specified name.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the run to delete.
* @param {boolean} request.allowMissing
* If set to true and the run is not found, the request
* succeeds but the server doesn't perform any actions.
* @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/lineage.delete_run.js</caption>
* region_tag:datalineage_v1_generated_Lineage_DeleteRun_async
*/
deleteRun(request?: protos.google.cloud.datacatalog.lineage.v1.IDeleteRunRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.lineage.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
deleteRun(request: protos.google.cloud.datacatalog.lineage.v1.IDeleteRunRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.lineage.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
deleteRun(request: protos.google.cloud.datacatalog.lineage.v1.IDeleteRunRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datacatalog.lineage.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `deleteRun()`.
* @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/lineage.delete_run.js</caption>
* region_tag:datalineage_v1_generated_Lineage_DeleteRun_async
*/
checkDeleteRunProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.datacatalog.lineage.v1.OperationMetadata>>;
/**
* List processes in the given project and location. List order is descending
* by insertion time.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The name of the project and its location that owns this
* collection of processes.
* @param {number} request.pageSize
* The maximum number of processes to return. The service may return
* fewer than this value. If unspecified, at most 50 processes are
* returned. The maximum value is 100; values greater than 100 are cut to
* 100.
* @param {string} request.pageToken
* The page token received from a previous `ListProcesses` call. Specify
* it to get the next page.
*
* When paginating, all other parameters specified in this call must
* match the parameters of 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.datacatalog.lineage.v1.Process|Process}.
* 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 `listProcessesAsync()`
* 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.
*/
listProcesses(request?: protos.google.cloud.datacatalog.lineage.v1.IListProcessesRequest, options?: CallOptions): Promise<[
protos.google.cloud.datacatalog.lineage.v1.IProcess[],
protos.google.cloud.datacatalog.lineage.v1.IListProcessesRequest | null,
protos.google.cloud.datacatalog.lineage.v1.IListProcessesResponse
]>;
listProcesses(request: protos.google.cloud.datacatalog.lineage.v1.IListProcessesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datacatalog.lineage.v1.IListProcessesRequest, protos.google.cloud.datacatalog.lineage.v1.IListProcessesResponse | null | undefined, protos.google.cloud.datacatalog.lineage.v1.IProcess>): void;
listProcesses(request: protos.google.cloud.datacatalog.lineage.v1.IListProcessesRequest, callback: PaginationCallback<protos.google.cloud.datacatalog.lineage.v1.IListProcessesRequest, protos.google.cloud.datacatalog.lineage.v1.IListProcessesResponse | null | undefined, protos.google.cloud.datacatalog.lineage.v1.IProcess>): void;
/**
* Equivalent to `listProcesses`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The name of the project and its location that owns this
* collection of processes.
* @param {number} request.pageSize
* The maximum number of processes to return. The service may return
* fewer than this value. If unspecified, at most 50 processes are
* returned. The maximum value is 100; values greater than 100 are cut to
* 100.
* @param {string} request.pageToken
* The page token received from a previous `ListProcesses` call. Specify
* it to get the next page.
*
* When paginating, all other parameters specified in this call must
* match the parameters of 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.datacatalog.lineage.v1.Process|Process} 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 `listProcessesAsync()`
* 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.
*/
listProcessesStream(request?: protos.google.cloud.datacatalog.lineage.v1.IListProcessesRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listProcesses`, 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 name of the project and its location that owns this
* collection of processes.
* @param {number} request.pageSize
* The maximum number of processes to return. The service may return
* fewer than this value. If unspecified, at most 50 processes are
* returned. The maximum value is 100; values greater than 100 are cut to
* 100.
* @param {string} request.pageToken
* The page token received from a previous `ListProcesses` call. Specify
* it to get the next page.
*
* When paginating, all other parameters specified in this call must
* match the parameters of 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.datacatalog.lineage.v1.Process|Process}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/lineage.list_processes.js</caption>
* region_tag:datalineage_v1_generated_Lineage_ListProcesses_async
*/
listProcessesAsync(request?: protos.google.cloud.datacatalog.lineage.v1.IListProcessesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datacatalog.lineage.v1.IProcess>;
/**
* Lists runs in the given project and location. List order is descending by
* `start_time`.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The name of process that owns this collection of runs.
* @param {number} request.pageSize
* The maximum number of runs to return. The service may return
* fewer than this value. If unspecified, at most 50 runs are
* returned. The maximum value is 100; values greater than 100 are cut to
* 100.
* @param {string} request.pageToken
* The page token received from a previous `ListRuns` call. Specify
* it to get the next page.
*
* When paginating, all other parameters specified in this call must
* match the parameters of 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.datacatalog.lineage.v1.Run|Run}.
* 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 `listRunsAsync()`
* 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.
*/
listRuns(request?: protos.google.cloud.datacatalog.lineage.v1.IListRunsRequest, options?: CallOptions): Promise<[
protos.google.cloud.datacatalog.lineage.v1.IRun[],
protos.google.cloud.datacatalog.lineage.v1.IListRunsRequest | null,
protos.google.cloud.datacatalog.lineage.v1.IListRunsResponse
]>;
listRuns(request: protos.google.cloud.datacatalog.lineage.v1.IListRunsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datacatalog.lineage.v1.IListRunsRequest, protos.google.cloud.datacatalog.lineage.v1.IListRunsResponse | null | undefined, protos.google.cloud.datacatalog.lineage.v1.IRun>): void;
listRuns(request: protos.google.cloud.datacatalog.lineage.v1.IListRunsRequest, callback: PaginationCallback<protos.google.cloud.datacatalog.lineage.v1.IListRunsRequest, protos.google.cloud.datacatalog.lineage.v1.IListRunsResponse | null | undefined, protos.google.cloud.datacatalog.lineage.v1.IRun>): void;
/**
* Equivalent to `listRuns`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The name of process that owns this collection of runs.
* @param {number} request.pageSize
* The maximum number of runs to return. The service may return
* fewer than this value. If unspecified, at most 50 runs are
* returned. The maximum value is 100; values greater than 100 are cut to
* 100.
* @param {string} request.pageToken
* The page token received from a previous `ListRuns` call. Specify
* it to get the next page.
*
* When paginating, all other parameters specified in this call must
* match the parameters of 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.datacatalog.lineage.v1.Run|Run} 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 `listRunsAsync()`
* 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.
*/
listRunsStream(request?: protos.google.cloud.datacatalog.lineage.v1.IListRunsRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listRuns`, 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 name of process that owns this collection of runs.
* @param {number} request.pageSize
* The maximum number of runs to return. The service may return
* fewer than this value. If unspecified, at most 50 runs are
* returned. The maximum value is 100; values greater than 100 are cut to
* 100.
* @param {string} request.pageToken
* The page token received from a previous `ListRuns` call. Specify
* it to get the next page.
*
* When paginating, all other parameters specified in this call must
* match the parameters of 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.datacatalog.lineage.v1.Run|Run}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/lineage.list_runs.js</caption>
* region_tag:datalineage_v1_generated_Lineage_ListRuns_async
*/
listRunsAsync(request?: protos.google.cloud.datacatalog.lineage.v1.IListRunsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datacatalog.lineage.v1.IRun>;
/**
* Lists lineage events in the given project and location. The list order is
* not defined.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The name of the run that owns the collection of lineage events to
* get.
* @param {number} request.pageSize
* The maximum number of lineage events to return.
*
* The service may return fewer events than this value.
* If unspecified, at most 50 events are returned. The maximum value is 100;
* values greater than 100 are cut to 100.
* @param {string} request.pageToken
* The page token received from a previous `ListLineageEvents` call. Specify
* it to get the next page.
*
* When paginating, all other parameters specified in this call must
* match the parameters of 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.datacatalog.lineage.v1.LineageEvent|LineageEvent}.
* 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 `listLineageEventsAsync()`
* 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.
*/
listLineageEvents(request?: protos.google.cloud.datacatalog.lineage.v1.IListLineageEventsRequest, options?: CallOptions): Promise<[
protos.google.cloud.datacatalog.lineage.v1.ILineageEvent[],
protos.google.cloud.datacatalog.lineage.v1.IListLineageEventsRequest | null,
protos.google.cloud.datacatalog.lineage.v1.IListLineageEventsResponse
]>;
listLineageEvents(request: protos.google.cloud.datacatalog.lineage.v1.IListLineageEventsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datacatalog.lineage.v1.IListLineageEventsRequest, protos.google.cloud.datacatalog.lineage.v1.IListLineageEventsResponse | null | undefined, protos.google.cloud.datacatalog.lineage.v1.ILineageEvent>): void;
listLineageEvents(request: protos.google.cloud.datacatalog.lineage.v1.IListLineageEventsRequest, callback: PaginationCallback<protos.google.cloud.datacatalog.lineage.v1.IListLineageEventsRequest, protos.google.cloud.datacatalog.lineage.v1.IListLineageEventsResponse | null | undefined, protos.google.cloud.datacatalog.lineage.v1.ILineageEvent>): void;
/**
* Equivalent to `listLineageEvents`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The name of the run that owns the collection of lineage events to
* get.
* @param {number} request.pageSize
* The maximum number of lineage events to return.
*
* The service may return fewer events than this value.
* If unspecified, at most 50 events are returned. The maximum value is 100;
* values greater than 100 are cut to 100.
* @param {string} reque