@google-cloud/contentwarehouse

import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation } from 'google-gax'; import * as protos from '../../protos/protos'; /** * This service lets you manage pipelines. * @class * @memberof v1 */ export declare class PipelineServiceClient { 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; pipelineServiceStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of PipelineServiceClient. * * @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 PipelineServiceClient({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; /** * Run a predefined pipeline. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name which owns the resources of the pipeline. * Format: projects/{project_number}/locations/{location}. * @param {google.cloud.contentwarehouse.v1.GcsIngestPipeline} request.gcsIngestPipeline * Cloud Storage ingestion pipeline. * @param {google.cloud.contentwarehouse.v1.GcsIngestWithDocAiProcessorsPipeline} request.gcsIngestWithDocAiProcessorsPipeline * Use DocAI processors to process documents in Cloud Storage and ingest * them to Document Warehouse. * @param {google.cloud.contentwarehouse.v1.ExportToCdwPipeline} request.exportCdwPipeline * Export docuemnts from Document Warehouse to CDW for training purpose. * @param {google.cloud.contentwarehouse.v1.ProcessWithDocAiPipeline} request.processWithDocAiPipeline * Use a DocAI processor to process documents in Document Warehouse, and * re-ingest the updated results into Document Warehouse. * @param {google.cloud.contentwarehouse.v1.RequestMetadata} request.requestMetadata * The meta information collected about the end user, used to enforce access * control for the service. * @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/pipeline_service.run_pipeline.js</caption> * region_tag:contentwarehouse_v1_generated_PipelineService_RunPipeline_async */ runPipeline(request?: protos.google.cloud.contentwarehouse.v1.IRunPipelineRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.contentwarehouse.v1.IRunPipelineResponse, protos.google.cloud.contentwarehouse.v1.IRunPipelineMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; runPipeline(request: protos.google.cloud.contentwarehouse.v1.IRunPipelineRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.contentwarehouse.v1.IRunPipelineResponse, protos.google.cloud.contentwarehouse.v1.IRunPipelineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; runPipeline(request: protos.google.cloud.contentwarehouse.v1.IRunPipelineRequest, callback: Callback<LROperation<protos.google.cloud.contentwarehouse.v1.IRunPipelineResponse, protos.google.cloud.contentwarehouse.v1.IRunPipelineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `runPipeline()`. * @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/pipeline_service.run_pipeline.js</caption> * region_tag:contentwarehouse_v1_generated_PipelineService_RunPipeline_async */ checkRunPipelineProgress(name: string): Promise<LROperation<protos.google.cloud.contentwarehouse.v1.RunPipelineResponse, protos.google.cloud.contentwarehouse.v1.RunPipelineMetadata>>; /** * Gets the latest state of a long-running operation. Clients can use this * method to poll the operation result at intervals as recommended by the API * service. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} * for the details. * @param {function(?Error, ?Object)=} callback * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * @return {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * The promise has a method named "cancel" which cancels the ongoing API call. * * @example * ``` * const client = longrunning.operationsClient(); * const name = ''; * const [response] = await client.getOperation({name}); * // doThingsWith(response) * ``` */ getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>; /** * Lists operations that match the specified filter in the request. If the * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object. * * For-await-of syntax is used with the iterable to recursively get response element on-demand. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation collection. * @param {string} request.filter - The standard list filter. * @param {number=} request.pageSize - * The maximum number of resources contained in the underlying API * response. If page streaming is performed per-resource, this * parameter does not affect the return value. If page streaming is * performed per-page, this determines the maximum number of * resources in a page. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @returns {Object} * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}. * * @example * ``` * const client = longrunning.operationsClient(); * for await (const response of client.listOperationsAsync(request)); * // doThingsWith(response) * ``` */ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>; /** * Starts asynchronous cancellation on a long-running operation. The server * makes a best effort to cancel the operation, but success is not * guaranteed. If the server doesn't support this method, it returns * `google.rpc.Code.UNIMPLEMENTED`. Clients can use * {@link Operations.GetOperation} or * other methods to check whether the cancellation succeeded or whether the * operation completed despite cancellation. On successful cancellation, * the operation is not deleted; instead, it becomes an operation with * an {@link Operation.error} value with a {@link google.rpc.Status.code} of * 1, corresponding to `Code.CANCELLED`. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource to be cancelled. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. * @return {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * * @example * ``` * const client = longrunning.operationsClient(); * await client.cancelOperation({name: ''}); * ``` */ cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>; /** * Deletes a long-running operation. This method indicates that the client is * no longer interested in the operation result. It does not cancel the * operation. If the server doesn't support this method, it returns * `google.rpc.Code.UNIMPLEMENTED`. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource to be deleted. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} * for the details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. * @return {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * * @example * ``` * const client = longrunning.operationsClient(); * await client.deleteOperation({name: ''}); * ``` */ deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>; /** * Return a fully-qualified documentLink resource name string. * * @param {string} project * @param {string} location * @param {string} document * @param {string} document_link * @returns {string} Resource name string. */ documentLinkPath(project: string, location: string, document: string, documentLink: string): string; /** * Parse the project from DocumentLink resource. * * @param {string} documentLinkName * A fully-qualified path representing DocumentLink resource. * @returns {string} A string representing the project. */ matchProjectFromDocumentLinkName(documentLinkName: string): string | number; /** * Parse the location from DocumentLink resource. * * @param {string} documentLinkName * A fully-qualified path representing DocumentLink resource. * @returns {string} A string representing the location. */ matchLocationFromDocumentLinkName(documentLinkName: string): string | number; /** * Parse the document from DocumentLink resource. * * @param {string} documentLinkName * A fully-qualified path representing DocumentLink resource. * @returns {string} A string representing the document. */ matchDocumentFromDocumentLinkName(documentLinkName: string): string | number; /** * Parse the document_link from DocumentLink resource. * * @param {string} documentLinkName * A fully-qualified path representing DocumentLink resource. * @returns {string} A string representing the document_link. */ matchDocumentLinkFromDocumentLinkName(documentLinkName: string): string | number; /** * Return a fully-qualified documentSchema resource name string. * * @param {string} project * @param {string} location * @param {string} document_schema * @returns {string} Resource name string. */ documentSchemaPath(project: string, location: string, documentSchema: string): string; /** * Parse the project from DocumentSchema resource. * * @param {string} documentSchemaName * A fully-qualified path representing DocumentSchema resource. * @returns {string} A string representing the project. */ matchProjectFromDocumentSchemaName(documentSchemaName: string): string | number; /** * Parse the location from DocumentSchema resource. * * @param {string} documentSchemaName * A fully-qualified path representing DocumentSchema resource. * @returns {string} A string representing the location. */ matchLocationFromDocumentSchemaName(documentSchemaName: string): string | number; /** * Parse the document_schema from DocumentSchema resource. * * @param {string} documentSchemaName * A fully-qualified path representing DocumentSchema resource. * @returns {string} A string representing the document_schema. */ matchDocumentSchemaFromDocumentSchemaName(documentSchemaName: string): string | number; /** * 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 projectLocationDocument resource name string. * * @param {string} project * @param {string} location * @param {string} document * @returns {string} Resource name string. */ projectLocationDocumentPath(project: string, location: string, document: string): string; /** * Parse the project from ProjectLocationDocument resource. * * @param {string} projectLocationDocumentName * A fully-qualified path representing project_location_document resource. * @returns {string} A string representing the project. */ matchProjectFromProjectLocationDocumentName(projectLocationDocumentName: string): string | number; /** * Parse the location from ProjectLocationDocument resource. * * @param {string} projectLocationDocumentName * A fully-qualified path representing project_location_document resource. * @returns {string} A string representing the location. */ matchLocationFromProjectLocationDocumentName(projectLocationDocumentName: string): string | number; /** * Parse the document from ProjectLocationDocument resource. * * @param {string} projectLocationDocumentName * A fully-qualified path representing project_location_document resource. * @returns {string} A string representing the document. */ matchDocumentFromProjectLocationDocumentName(projectLocationDocumentName: string): string | number; /** * Return a fully-qualified projectLocationDocumentsReferenceId resource name string. * * @param {string} project * @param {string} location * @param {string} reference_id * @returns {string} Resource name string. */ projectLocationDocumentsReferenceIdPath(project: string, location: string, referenceId: string): string; /** * Parse the project from ProjectLocationDocumentsReferenceId resource. * * @param {string} projectLocationDocumentsReferenceIdName * A fully-qualified path representing project_location_documents_reference_id resource. * @returns {string} A string representing the project. */ matchProjectFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName: string): string | number; /** * Parse the location from ProjectLocationDocumentsReferenceId resource. * * @param {string} projectLocationDocumentsReferenceIdName * A fully-qualified path representing project_location_documents_reference_id resource. * @returns {string} A string representing the location. */ matchLocationFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName: string): string | number; /** * Parse the reference_id from ProjectLocationDocumentsReferenceId resource. * * @param {string} projectLocationDocumentsReferenceIdName * A fully-qualified path representing project_location_documents_reference_id resource. * @returns {string} A string representing the reference_id. */ matchReferenceIdFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName: string): string | number; /** * Return a fully-qualified ruleSet resource name string. * * @param {string} project * @param {string} location * @param {string} rule_set * @returns {string} Resource name string. */ ruleSetPath(project: string, location: string, ruleSet: string): string; /** * Parse the project from RuleSet resource. * * @param {string} ruleSetName * A fully-qualified path representing RuleSet resource. * @returns {string} A string representing the project. */ matchProjectFromRuleSetName(ruleSetName: string): string | number; /** * Parse the location from RuleSet resource. * * @param {string} ruleSetName * A fully-qualified path representing RuleSet resource. * @returns {string} A string representing the location. */ matchLocationFromRuleSetName(ruleSetName: string): string | number; /** * Parse the rule_set from RuleSet resource. * * @param {string} ruleSetName * A fully-qualified path representing RuleSet resource. * @returns {string} A string representing the rule_set. */ matchRuleSetFromRuleSetName(ruleSetName: string): string | number; /** * Return a fully-qualified synonymSet resource name string. * * @param {string} project * @param {string} location * @param {string} context * @returns {string} Resource name string. */ synonymSetPath(project: string, location: string, context: string): string; /** * Parse the project from SynonymSet resource. * * @param {string} synonymSetName * A fully-qualified path representing SynonymSet resource. * @returns {string} A string representing the project. */ matchProjectFromSynonymSetName(synonymSetName: string): string | number; /** * Parse the location from SynonymSet resource. * * @param {string} synonymSetName * A fully-qualified path representing SynonymSet resource. * @returns {string} A string representing the location. */ matchLocationFromSynonymSetName(synonymSetName: string): string | number; /** * Parse the context from SynonymSet resource. * * @param {string} synonymSetName * A fully-qualified path representing SynonymSet resource. * @returns {string} A string representing the context. */ matchContextFromSynonymSetName(synonymSetName: 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>; }