Class v1.PipelineServiceClient (1.7.0)

This service lets you manage pipelines. v1

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of PipelineServiceClient.

Parameters
Name	Description
`opts`	`ClientOptions`
`gaxInstance`	`typeof gax \| typeof fallback` : 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); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

pipelineServiceStub

pipelineServiceStub?: Promise<{
        [name: string]: Function;
    }>;

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

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 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 value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
`request`	`CancelOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} \| undefined \| null>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} \| undefined \| null>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<protos.google.protobuf.Empty>`

Example


const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkRunPipelineProgress(name)

checkRunPipelineProgress(name: string): Promise<LROperation<protos.google.cloud.contentwarehouse.v1.RunPipelineResponse, protos.google.cloud.contentwarehouse.v1.RunPipelineMetadata>>;

Check the status of the long running operation returned by runPipeline().

Parameter
Name	Description
`name`	`string` The operation name that will be passed.

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.contentwarehouse.v1.RunPipelineResponse, protos.google.cloud.contentwarehouse.v1.RunPipelineMetadata>>`	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name which owns the resources of the pipeline.
   *  Format: projects/{project_number}/locations/{location}.
   */
  // const name = 'abc123'
  /**
   *  Cloud Storage ingestion pipeline.
   */
  // const gcsIngestPipeline = {}
  /**
   *  Use DocAI processors to process documents in Cloud Storage and ingest
   *  them to Document Warehouse.
   */
  // const gcsIngestWithDocAiProcessorsPipeline = {}
  /**
   *  Export docuemnts from Document Warehouse to CDW for training purpose.
   */
  // const exportCdwPipeline = {}
  /**
   *  Use a DocAI processor to process documents in Document Warehouse, and
   *  re-ingest the updated results into Document Warehouse.
   */
  // const processWithDocAiPipeline = {}
  /**
   *  The meta information collected about the end user, used to enforce access
   *  control for the service.
   */
  // const requestMetadata = {}

  // Imports the Contentwarehouse library
  const {PipelineServiceClient} = require('@google-cloud/contentwarehouse').v1;

  // Instantiates a client
  const contentwarehouseClient = new PipelineServiceClient();

  async function callRunPipeline() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await contentwarehouseClient.runPipeline(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRunPipeline();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
`Promise<void>`	{Promise} A promise that resolves when the client is closed.

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: 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>;

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.

Parameters
Name	Description
`request`	`DeleteOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<protos.google.protobuf.Empty>`

Example


const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

documentLinkPath(project, location, document, documentLink)

documentLinkPath(project: string, location: string, document: string, documentLink: string): string;

Return a fully-qualified documentLink resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`document`	`string`
`documentLink`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

documentSchemaPath(project, location, documentSchema)

documentSchemaPath(project: string, location: string, documentSchema: string): string;

Return a fully-qualified documentSchema resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`documentSchema`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: 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]>;

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.

Parameters
Name	Description
`request`	`GetOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<[protos.google.longrunning.Operation]>`

Example


const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
`Promise<string>`

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
`callback`	`Callback<string, undefined, undefined>`

Returns
Type	Description
`void`

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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
Type	Description
`Promise<{ [name: string]: Function; }>`	{Promise} A promise that resolves to an authenticated service stub.

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

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.

Parameters
Name	Description
`request`	`ListOperationsRequest` The request object that will be sent.
`options`	`CallOptions` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type	Description
`AsyncIterable<protos.google.longrunning.ListOperationsResponse>`	{Object} An iterable Object that conforms to iteration protocols.

Example


const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

matchContextFromSynonymSetName(synonymSetName)

matchContextFromSynonymSetName(synonymSetName: string): string | number;

Parse the context from SynonymSet resource.

Parameter
Name	Description
`synonymSetName`	`string` A fully-qualified path representing SynonymSet resource.

Returns
Type	Description
`string \| number`	{string} A string representing the context.

matchDocumentFromDocumentLinkName(documentLinkName)

matchDocumentFromDocumentLinkName(documentLinkName: string): string | number;

Parse the document from DocumentLink resource.

Parameter
Name	Description
`documentLinkName`	`string` A fully-qualified path representing DocumentLink resource.

Returns
Type	Description
`string \| number`	{string} A string representing the document.

matchDocumentFromProjectLocationDocumentName(projectLocationDocumentName)

matchDocumentFromProjectLocationDocumentName(projectLocationDocumentName: string): string | number;

Parse the document from ProjectLocationDocument resource.

Parameter
Name	Description
`projectLocationDocumentName`	`string` A fully-qualified path representing project_location_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the document.

matchDocumentLinkFromDocumentLinkName(documentLinkName)

matchDocumentLinkFromDocumentLinkName(documentLinkName: string): string | number;

Parse the document_link from DocumentLink resource.

Parameter
Name	Description
`documentLinkName`	`string` A fully-qualified path representing DocumentLink resource.

Returns
Type	Description
`string \| number`	{string} A string representing the document_link.

matchDocumentSchemaFromDocumentSchemaName(documentSchemaName)

matchDocumentSchemaFromDocumentSchemaName(documentSchemaName: string): string | number;

Parse the document_schema from DocumentSchema resource.

Parameter
Name	Description
`documentSchemaName`	`string` A fully-qualified path representing DocumentSchema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the document_schema.

matchLocationFromDocumentLinkName(documentLinkName)

matchLocationFromDocumentLinkName(documentLinkName: string): string | number;

Parse the location from DocumentLink resource.

Parameter
Name	Description
`documentLinkName`	`string` A fully-qualified path representing DocumentLink resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromDocumentSchemaName(documentSchemaName)

matchLocationFromDocumentSchemaName(documentSchemaName: string): string | number;

Parse the location from DocumentSchema resource.

Parameter
Name	Description
`documentSchemaName`	`string` A fully-qualified path representing DocumentSchema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name	Description
`locationName`	`string` A fully-qualified path representing Location resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDocumentName(projectLocationDocumentName)

matchLocationFromProjectLocationDocumentName(projectLocationDocumentName: string): string | number;

Parse the location from ProjectLocationDocument resource.

Parameter
Name	Description
`projectLocationDocumentName`	`string` A fully-qualified path representing project_location_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName)

matchLocationFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName: string): string | number;

Parse the location from ProjectLocationDocumentsReferenceId resource.

Parameter
Name	Description
`projectLocationDocumentsReferenceIdName`	`string` A fully-qualified path representing project_location_documents_reference_id resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromRuleSetName(ruleSetName)

matchLocationFromRuleSetName(ruleSetName: string): string | number;

Parse the location from RuleSet resource.

Parameter
Name	Description
`ruleSetName`	`string` A fully-qualified path representing RuleSet resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromSynonymSetName(synonymSetName)

matchLocationFromSynonymSetName(synonymSetName: string): string | number;

Parse the location from SynonymSet resource.

Parameter
Name	Description
`synonymSetName`	`string` A fully-qualified path representing SynonymSet resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchProjectFromDocumentLinkName(documentLinkName)

matchProjectFromDocumentLinkName(documentLinkName: string): string | number;

Parse the project from DocumentLink resource.

Parameter
Name	Description
`documentLinkName`	`string` A fully-qualified path representing DocumentLink resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromDocumentSchemaName(documentSchemaName)

matchProjectFromDocumentSchemaName(documentSchemaName: string): string | number;

Parse the project from DocumentSchema resource.

Parameter
Name	Description
`documentSchemaName`	`string` A fully-qualified path representing DocumentSchema resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name	Description
`locationName`	`string` A fully-qualified path representing Location resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDocumentName(projectLocationDocumentName)

matchProjectFromProjectLocationDocumentName(projectLocationDocumentName: string): string | number;

Parse the project from ProjectLocationDocument resource.

Parameter
Name	Description
`projectLocationDocumentName`	`string` A fully-qualified path representing project_location_document resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName)

matchProjectFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName: string): string | number;

Parse the project from ProjectLocationDocumentsReferenceId resource.

Parameter
Name	Description
`projectLocationDocumentsReferenceIdName`	`string` A fully-qualified path representing project_location_documents_reference_id resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromRuleSetName(ruleSetName)

matchProjectFromRuleSetName(ruleSetName: string): string | number;

Parse the project from RuleSet resource.

Parameter
Name	Description
`ruleSetName`	`string` A fully-qualified path representing RuleSet resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromSynonymSetName(synonymSetName)

matchProjectFromSynonymSetName(synonymSetName: string): string | number;

Parse the project from SynonymSet resource.

Parameter
Name	Description
`synonymSetName`	`string` A fully-qualified path representing SynonymSet resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchReferenceIdFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName)

matchReferenceIdFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName: string): string | number;

Parse the reference_id from ProjectLocationDocumentsReferenceId resource.

Parameter
Name	Description
`projectLocationDocumentsReferenceIdName`	`string` A fully-qualified path representing project_location_documents_reference_id resource.

Returns
Type	Description
`string \| number`	{string} A string representing the reference_id.

matchRuleSetFromRuleSetName(ruleSetName)

matchRuleSetFromRuleSetName(ruleSetName: string): string | number;

Parse the rule_set from RuleSet resource.

Parameter
Name	Description
`ruleSetName`	`string` A fully-qualified path representing RuleSet resource.

Returns
Type	Description
`string \| number`	{string} A string representing the rule_set.

projectLocationDocumentPath(project, location, document)

projectLocationDocumentPath(project: string, location: string, document: string): string;

Return a fully-qualified projectLocationDocument resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`document`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

projectLocationDocumentsReferenceIdPath(project, location, referenceId)

projectLocationDocumentsReferenceIdPath(project: string, location: string, referenceId: string): string;

Return a fully-qualified projectLocationDocumentsReferenceId resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`referenceId`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

ruleSetPath(project, location, ruleSet)

ruleSetPath(project: string, location: string, ruleSet: string): string;

Return a fully-qualified ruleSet resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`ruleSet`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

runPipeline(request, options)

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
    ]>;

Run a predefined pipeline.

Parameters
Name	Description
`request`	`IRunPipelineRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.contentwarehouse.v1.IRunPipelineResponse, protos.google.cloud.contentwarehouse.v1.IRunPipelineMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{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 documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name which owns the resources of the pipeline.
   *  Format: projects/{project_number}/locations/{location}.
   */
  // const name = 'abc123'
  /**
   *  Cloud Storage ingestion pipeline.
   */
  // const gcsIngestPipeline = {}
  /**
   *  Use DocAI processors to process documents in Cloud Storage and ingest
   *  them to Document Warehouse.
   */
  // const gcsIngestWithDocAiProcessorsPipeline = {}
  /**
   *  Export docuemnts from Document Warehouse to CDW for training purpose.
   */
  // const exportCdwPipeline = {}
  /**
   *  Use a DocAI processor to process documents in Document Warehouse, and
   *  re-ingest the updated results into Document Warehouse.
   */
  // const processWithDocAiPipeline = {}
  /**
   *  The meta information collected about the end user, used to enforce access
   *  control for the service.
   */
  // const requestMetadata = {}

  // Imports the Contentwarehouse library
  const {PipelineServiceClient} = require('@google-cloud/contentwarehouse').v1;

  // Instantiates a client
  const contentwarehouseClient = new PipelineServiceClient();

  async function callRunPipeline() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await contentwarehouseClient.runPipeline(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRunPipeline();

runPipeline(request, options, callback)

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;

Parameters
Name	Description
`request`	`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>`

Returns
Type	Description
`void`

runPipeline(request, callback)

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;

Parameters
Name	Description
`request`	`IRunPipelineRequest`
`callback`	`Callback<LROperation<protos.google.cloud.contentwarehouse.v1.IRunPipelineResponse, protos.google.cloud.contentwarehouse.v1.IRunPipelineMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

synonymSetPath(project, location, context)

synonymSetPath(project: string, location: string, context: string): string;

Return a fully-qualified synonymSet resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`context`	`string`

Returns
Type	Description
`string`	{string} Resource name string.