@google-cloud/contentwarehouse
Version:
Document AI Warehouse client for Node.js
565 lines (564 loc) • 31.1 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* This service lets you manage document schema.
* @class
* @memberof v1
*/
export declare class DocumentSchemaServiceClient {
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;
};
documentSchemaServiceStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of DocumentSchemaServiceClient.
*
* @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 DocumentSchemaServiceClient({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 document schema.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent name.
* @param {google.cloud.contentwarehouse.v1.DocumentSchema} request.documentSchema
* Required. The document schema to create.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.contentwarehouse.v1.DocumentSchema|DocumentSchema}.
* 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/document_schema_service.create_document_schema.js</caption>
* region_tag:contentwarehouse_v1_generated_DocumentSchemaService_CreateDocumentSchema_async
*/
createDocumentSchema(request?: protos.google.cloud.contentwarehouse.v1.ICreateDocumentSchemaRequest, options?: CallOptions): Promise<[
protos.google.cloud.contentwarehouse.v1.IDocumentSchema,
protos.google.cloud.contentwarehouse.v1.ICreateDocumentSchemaRequest | undefined,
{} | undefined
]>;
createDocumentSchema(request: protos.google.cloud.contentwarehouse.v1.ICreateDocumentSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.contentwarehouse.v1.IDocumentSchema, protos.google.cloud.contentwarehouse.v1.ICreateDocumentSchemaRequest | null | undefined, {} | null | undefined>): void;
createDocumentSchema(request: protos.google.cloud.contentwarehouse.v1.ICreateDocumentSchemaRequest, callback: Callback<protos.google.cloud.contentwarehouse.v1.IDocumentSchema, protos.google.cloud.contentwarehouse.v1.ICreateDocumentSchemaRequest | null | undefined, {} | null | undefined>): void;
/**
* Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the
* Document Schema is non-empty and does not equal the existing name.
* Supports only appending new properties, adding new ENUM possible values,
* and updating the
* {@link protos.google.cloud.contentwarehouse.v1.EnumTypeOptions.validation_check_disabled|EnumTypeOptions.validation_check_disabled}
* flag for ENUM possible values. Updating existing properties will result
* into INVALID_ARGUMENT.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the document schema to update.
* Format:
* projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
* @param {google.cloud.contentwarehouse.v1.DocumentSchema} request.documentSchema
* Required. The document schema to update with.
* @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.DocumentSchema|DocumentSchema}.
* 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/document_schema_service.update_document_schema.js</caption>
* region_tag:contentwarehouse_v1_generated_DocumentSchemaService_UpdateDocumentSchema_async
*/
updateDocumentSchema(request?: protos.google.cloud.contentwarehouse.v1.IUpdateDocumentSchemaRequest, options?: CallOptions): Promise<[
protos.google.cloud.contentwarehouse.v1.IDocumentSchema,
protos.google.cloud.contentwarehouse.v1.IUpdateDocumentSchemaRequest | undefined,
{} | undefined
]>;
updateDocumentSchema(request: protos.google.cloud.contentwarehouse.v1.IUpdateDocumentSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.contentwarehouse.v1.IDocumentSchema, protos.google.cloud.contentwarehouse.v1.IUpdateDocumentSchemaRequest | null | undefined, {} | null | undefined>): void;
updateDocumentSchema(request: protos.google.cloud.contentwarehouse.v1.IUpdateDocumentSchemaRequest, callback: Callback<protos.google.cloud.contentwarehouse.v1.IDocumentSchema, protos.google.cloud.contentwarehouse.v1.IUpdateDocumentSchemaRequest | null | undefined, {} | null | undefined>): void;
/**
* Gets a document schema. Returns NOT_FOUND if the document schema does not
* exist.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the document schema to retrieve.
* @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.DocumentSchema|DocumentSchema}.
* 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/document_schema_service.get_document_schema.js</caption>
* region_tag:contentwarehouse_v1_generated_DocumentSchemaService_GetDocumentSchema_async
*/
getDocumentSchema(request?: protos.google.cloud.contentwarehouse.v1.IGetDocumentSchemaRequest, options?: CallOptions): Promise<[
protos.google.cloud.contentwarehouse.v1.IDocumentSchema,
protos.google.cloud.contentwarehouse.v1.IGetDocumentSchemaRequest | undefined,
{} | undefined
]>;
getDocumentSchema(request: protos.google.cloud.contentwarehouse.v1.IGetDocumentSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.contentwarehouse.v1.IDocumentSchema, protos.google.cloud.contentwarehouse.v1.IGetDocumentSchemaRequest | null | undefined, {} | null | undefined>): void;
getDocumentSchema(request: protos.google.cloud.contentwarehouse.v1.IGetDocumentSchemaRequest, callback: Callback<protos.google.cloud.contentwarehouse.v1.IDocumentSchema, protos.google.cloud.contentwarehouse.v1.IGetDocumentSchemaRequest | null | undefined, {} | null | undefined>): void;
/**
* Deletes a document schema. Returns NOT_FOUND if the document schema does
* not exist. Returns BAD_REQUEST if the document schema has documents
* depending on it.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the document schema to delete.
* @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/document_schema_service.delete_document_schema.js</caption>
* region_tag:contentwarehouse_v1_generated_DocumentSchemaService_DeleteDocumentSchema_async
*/
deleteDocumentSchema(request?: protos.google.cloud.contentwarehouse.v1.IDeleteDocumentSchemaRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.contentwarehouse.v1.IDeleteDocumentSchemaRequest | undefined,
{} | undefined
]>;
deleteDocumentSchema(request: protos.google.cloud.contentwarehouse.v1.IDeleteDocumentSchemaRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contentwarehouse.v1.IDeleteDocumentSchemaRequest | null | undefined, {} | null | undefined>): void;
deleteDocumentSchema(request: protos.google.cloud.contentwarehouse.v1.IDeleteDocumentSchemaRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contentwarehouse.v1.IDeleteDocumentSchemaRequest | null | undefined, {} | null | undefined>): void;
/**
* Lists document schemas.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent, which owns this collection of document schemas.
* Format: projects/{project_number}/locations/{location}.
* @param {number} request.pageSize
* The maximum number of document schemas to return. The service may return
* fewer than this value.
* If unspecified, at most 50 document schemas 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 `ListDocumentSchemas` call.
* Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListDocumentSchemas`
* 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.DocumentSchema|DocumentSchema}.
* 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 `listDocumentSchemasAsync()`
* 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.
*/
listDocumentSchemas(request?: protos.google.cloud.contentwarehouse.v1.IListDocumentSchemasRequest, options?: CallOptions): Promise<[
protos.google.cloud.contentwarehouse.v1.IDocumentSchema[],
protos.google.cloud.contentwarehouse.v1.IListDocumentSchemasRequest | null,
protos.google.cloud.contentwarehouse.v1.IListDocumentSchemasResponse
]>;
listDocumentSchemas(request: protos.google.cloud.contentwarehouse.v1.IListDocumentSchemasRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contentwarehouse.v1.IListDocumentSchemasRequest, protos.google.cloud.contentwarehouse.v1.IListDocumentSchemasResponse | null | undefined, protos.google.cloud.contentwarehouse.v1.IDocumentSchema>): void;
listDocumentSchemas(request: protos.google.cloud.contentwarehouse.v1.IListDocumentSchemasRequest, callback: PaginationCallback<protos.google.cloud.contentwarehouse.v1.IListDocumentSchemasRequest, protos.google.cloud.contentwarehouse.v1.IListDocumentSchemasResponse | null | undefined, protos.google.cloud.contentwarehouse.v1.IDocumentSchema>): void;
/**
* Equivalent to `listDocumentSchemas`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent, which owns this collection of document schemas.
* Format: projects/{project_number}/locations/{location}.
* @param {number} request.pageSize
* The maximum number of document schemas to return. The service may return
* fewer than this value.
* If unspecified, at most 50 document schemas 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 `ListDocumentSchemas` call.
* Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListDocumentSchemas`
* 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.DocumentSchema|DocumentSchema} 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 `listDocumentSchemasAsync()`
* 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.
*/
listDocumentSchemasStream(request?: protos.google.cloud.contentwarehouse.v1.IListDocumentSchemasRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listDocumentSchemas`, 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, which owns this collection of document schemas.
* Format: projects/{project_number}/locations/{location}.
* @param {number} request.pageSize
* The maximum number of document schemas to return. The service may return
* fewer than this value.
* If unspecified, at most 50 document schemas 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 `ListDocumentSchemas` call.
* Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListDocumentSchemas`
* 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.DocumentSchema|DocumentSchema}. 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/document_schema_service.list_document_schemas.js</caption>
* region_tag:contentwarehouse_v1_generated_DocumentSchemaService_ListDocumentSchemas_async
*/
listDocumentSchemasAsync(request?: protos.google.cloud.contentwarehouse.v1.IListDocumentSchemasRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contentwarehouse.v1.IDocumentSchema>;
/**
* 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>;
}