@google-cloud/contentwarehouse

import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * A Service that manage/custom customer specified SynonymSets. * @class * @memberof v1 */ export declare class SynonymSetServiceClient { 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; }; synonymSetServiceStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of SynonymSetServiceClient. * * @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 SynonymSetServiceClient({fallback: true}, gax); * ``` */ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * Initialize the client. * Performs asynchronous operations (such as authentication) and prepares the client. * This function will be called automatically when any class method is called for the * first time, but if you need to initialize it before calling an actual method, * feel free to call initialize() directly. * * You can await on this method if you want to make sure the client is initialized. * * @returns {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise<string>; getProjectId(callback: Callback<string, undefined, undefined>): void; /** * Creates a SynonymSet for a single context. * Throws an ALREADY_EXISTS exception if a synonymset already exists * for the context. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent name. * Format: projects/{project_number}/locations/{location}. * @param {google.cloud.contentwarehouse.v1.SynonymSet} request.synonymSet * Required. The synonymSet to be created for a context * @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.contentwarehouse.v1.SynonymSet|SynonymSet}. * 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/synonym_set_service.create_synonym_set.js</caption> * region_tag:contentwarehouse_v1_generated_SynonymSetService_CreateSynonymSet_async */ createSynonymSet(request?: protos.google.cloud.contentwarehouse.v1.ICreateSynonymSetRequest, options?: CallOptions): Promise<[ protos.google.cloud.contentwarehouse.v1.ISynonymSet, (protos.google.cloud.contentwarehouse.v1.ICreateSynonymSetRequest | undefined), {} | undefined ]>; createSynonymSet(request: protos.google.cloud.contentwarehouse.v1.ICreateSynonymSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.contentwarehouse.v1.ISynonymSet, protos.google.cloud.contentwarehouse.v1.ICreateSynonymSetRequest | null | undefined, {} | null | undefined>): void; createSynonymSet(request: protos.google.cloud.contentwarehouse.v1.ICreateSynonymSetRequest, callback: Callback<protos.google.cloud.contentwarehouse.v1.ISynonymSet, protos.google.cloud.contentwarehouse.v1.ICreateSynonymSetRequest | null | undefined, {} | null | undefined>): void; /** * Gets a SynonymSet for a particular context. * Throws a NOT_FOUND exception if the Synonymset * does not exist * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the synonymSet to retrieve * Format: * projects/{project_number}/locations/{location}/synonymSets/{context}. * @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.contentwarehouse.v1.SynonymSet|SynonymSet}. * 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/synonym_set_service.get_synonym_set.js</caption> * region_tag:contentwarehouse_v1_generated_SynonymSetService_GetSynonymSet_async */ getSynonymSet(request?: protos.google.cloud.contentwarehouse.v1.IGetSynonymSetRequest, options?: CallOptions): Promise<[ protos.google.cloud.contentwarehouse.v1.ISynonymSet, protos.google.cloud.contentwarehouse.v1.IGetSynonymSetRequest | undefined, {} | undefined ]>; getSynonymSet(request: protos.google.cloud.contentwarehouse.v1.IGetSynonymSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.contentwarehouse.v1.ISynonymSet, protos.google.cloud.contentwarehouse.v1.IGetSynonymSetRequest | null | undefined, {} | null | undefined>): void; getSynonymSet(request: protos.google.cloud.contentwarehouse.v1.IGetSynonymSetRequest, callback: Callback<protos.google.cloud.contentwarehouse.v1.ISynonymSet, protos.google.cloud.contentwarehouse.v1.IGetSynonymSetRequest | null | undefined, {} | null | undefined>): void; /** * Remove the existing SynonymSet for the context and replaces it * with a new one. * Throws a NOT_FOUND exception if the SynonymSet is not found. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the synonymSet to update * Format: * projects/{project_number}/locations/{location}/synonymSets/{context}. * @param {google.cloud.contentwarehouse.v1.SynonymSet} request.synonymSet * Required. The synonymSet to be updated for the customer * @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.contentwarehouse.v1.SynonymSet|SynonymSet}. * 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/synonym_set_service.update_synonym_set.js</caption> * region_tag:contentwarehouse_v1_generated_SynonymSetService_UpdateSynonymSet_async */ updateSynonymSet(request?: protos.google.cloud.contentwarehouse.v1.IUpdateSynonymSetRequest, options?: CallOptions): Promise<[ protos.google.cloud.contentwarehouse.v1.ISynonymSet, (protos.google.cloud.contentwarehouse.v1.IUpdateSynonymSetRequest | undefined), {} | undefined ]>; updateSynonymSet(request: protos.google.cloud.contentwarehouse.v1.IUpdateSynonymSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.contentwarehouse.v1.ISynonymSet, protos.google.cloud.contentwarehouse.v1.IUpdateSynonymSetRequest | null | undefined, {} | null | undefined>): void; updateSynonymSet(request: protos.google.cloud.contentwarehouse.v1.IUpdateSynonymSetRequest, callback: Callback<protos.google.cloud.contentwarehouse.v1.ISynonymSet, protos.google.cloud.contentwarehouse.v1.IUpdateSynonymSetRequest | null | undefined, {} | null | undefined>): void; /** * Deletes a SynonymSet for a given context. * Throws a NOT_FOUND exception if the SynonymSet is not found. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the synonymSet to delete * Format: * projects/{project_number}/locations/{location}/synonymSets/{context}. * @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/synonym_set_service.delete_synonym_set.js</caption> * region_tag:contentwarehouse_v1_generated_SynonymSetService_DeleteSynonymSet_async */ deleteSynonymSet(request?: protos.google.cloud.contentwarehouse.v1.IDeleteSynonymSetRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contentwarehouse.v1.IDeleteSynonymSetRequest | undefined), {} | undefined ]>; deleteSynonymSet(request: protos.google.cloud.contentwarehouse.v1.IDeleteSynonymSetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contentwarehouse.v1.IDeleteSynonymSetRequest | null | undefined, {} | null | undefined>): void; deleteSynonymSet(request: protos.google.cloud.contentwarehouse.v1.IDeleteSynonymSetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contentwarehouse.v1.IDeleteSynonymSetRequest | null | undefined, {} | null | undefined>): void; /** * Returns all SynonymSets (for all contexts) for the specified location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent name. * Format: projects/{project_number}/locations/{location}. * @param {number} request.pageSize * The maximum number of synonymSets to return. The service may return * fewer than this value. * If unspecified, at most 50 rule sets will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous `ListSynonymSets` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListSynonymSets` * must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.contentwarehouse.v1.SynonymSet|SynonymSet}. * 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 `listSynonymSetsAsync()` * 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. */ listSynonymSets(request?: protos.google.cloud.contentwarehouse.v1.IListSynonymSetsRequest, options?: CallOptions): Promise<[ protos.google.cloud.contentwarehouse.v1.ISynonymSet[], protos.google.cloud.contentwarehouse.v1.IListSynonymSetsRequest | null, protos.google.cloud.contentwarehouse.v1.IListSynonymSetsResponse ]>; listSynonymSets(request: protos.google.cloud.contentwarehouse.v1.IListSynonymSetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contentwarehouse.v1.IListSynonymSetsRequest, protos.google.cloud.contentwarehouse.v1.IListSynonymSetsResponse | null | undefined, protos.google.cloud.contentwarehouse.v1.ISynonymSet>): void; listSynonymSets(request: protos.google.cloud.contentwarehouse.v1.IListSynonymSetsRequest, callback: PaginationCallback<protos.google.cloud.contentwarehouse.v1.IListSynonymSetsRequest, protos.google.cloud.contentwarehouse.v1.IListSynonymSetsResponse | null | undefined, protos.google.cloud.contentwarehouse.v1.ISynonymSet>): void; /** * Equivalent to `listSynonymSets`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent name. * Format: projects/{project_number}/locations/{location}. * @param {number} request.pageSize * The maximum number of synonymSets to return. The service may return * fewer than this value. * If unspecified, at most 50 rule sets will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous `ListSynonymSets` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListSynonymSets` * must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.contentwarehouse.v1.SynonymSet|SynonymSet} 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 `listSynonymSetsAsync()` * 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. */ listSynonymSetsStream(request?: protos.google.cloud.contentwarehouse.v1.IListSynonymSetsRequest, options?: CallOptions): Transform; /** * Equivalent to `listSynonymSets`, 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 parent name. * Format: projects/{project_number}/locations/{location}. * @param {number} request.pageSize * The maximum number of synonymSets to return. The service may return * fewer than this value. * If unspecified, at most 50 rule sets will be returned. * The maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} request.pageToken * A page token, received from a previous `ListSynonymSets` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListSynonymSets` * must match the call that provided the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.contentwarehouse.v1.SynonymSet|SynonymSet}. 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/synonym_set_service.list_synonym_sets.js</caption> * region_tag:contentwarehouse_v1_generated_SynonymSetService_ListSynonymSets_async */ listSynonymSetsAsync(request?: protos.google.cloud.contentwarehouse.v1.IListSynonymSetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contentwarehouse.v1.ISynonymSet>; /** * 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 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>; }