@google-cloud/discoveryengine 0.7.0 → 1.0.0

package/build/src/v1beta/schema_service_client.d.ts

@@ -4,7 +4,7 @@ import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, Pa
 import { Transform } from 'stream';
 import * as protos from '../../protos/protos';
 /**
- *  Service for managing {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s.
+ *  Service for managing {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s.
  * @class
  * @memberof v1beta
  */
@@ -109,7 +109,7 @@ export declare class SchemaServiceClient {
     getProjectId(): Promise<string>;
     getProjectId(callback: Callback<string, undefined, undefined>): void;
     /**
-     * Gets a {@link google.cloud.discoveryengine.v1beta.Schema|Schema}.
+     * Gets a {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}.
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -119,9 +119,8 @@ export declare class SchemaServiceClient {
      * @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 google.cloud.discoveryengine.v1beta.Schema | Schema}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}.
+     *   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/v1beta/schema_service.get_schema.js</caption>
      * region_tag:discoveryengine_v1beta_generated_SchemaService_GetSchema_async
@@ -134,7 +133,7 @@ export declare class SchemaServiceClient {
     getSchema(request: protos.google.cloud.discoveryengine.v1beta.IGetSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ISchema, protos.google.cloud.discoveryengine.v1beta.IGetSchemaRequest | null | undefined, {} | null | undefined>): void;
     getSchema(request: protos.google.cloud.discoveryengine.v1beta.IGetSchemaRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ISchema, protos.google.cloud.discoveryengine.v1beta.IGetSchemaRequest | null | undefined, {} | null | undefined>): void;
     /**
-     * Creates a {@link google.cloud.discoveryengine.v1beta.Schema|Schema}.
+     * Creates a {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}.
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -142,13 +141,13 @@ export declare class SchemaServiceClient {
      *   Required. The parent data store resource name, in the format of
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
      * @param {google.cloud.discoveryengine.v1beta.Schema} request.schema
-     *   Required. The {@link google.cloud.discoveryengine.v1beta.Schema|Schema} to
+     *   Required. The {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema} to
      *   create.
      * @param {string} request.schemaId
      *   Required. The ID to use for the
-     *   {@link google.cloud.discoveryengine.v1beta.Schema|Schema}, which will become the
+     *   {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}, which will become the
      *   final component of the
-     *   {@link google.cloud.discoveryengine.v1beta.Schema.name|Schema.name}.
+     *   {@link protos.google.cloud.discoveryengine.v1beta.Schema.name|Schema.name}.
      *
      *   This field should conform to
      *   [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
@@ -159,8 +158,7 @@ export declare class SchemaServiceClient {
      *   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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   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/v1beta/schema_service.create_schema.js</caption>
      * region_tag:discoveryengine_v1beta_generated_SchemaService_CreateSchema_async
@@ -178,25 +176,24 @@ export declare class SchemaServiceClient {
      *   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
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   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/v1beta/schema_service.create_schema.js</caption>
      * region_tag:discoveryengine_v1beta_generated_SchemaService_CreateSchema_async
      */
     checkCreateSchemaProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.Schema, protos.google.cloud.discoveryengine.v1beta.CreateSchemaMetadata>>;
     /**
-     * Updates a {@link google.cloud.discoveryengine.v1beta.Schema|Schema}.
+     * Updates a {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}.
      *
      * @param {Object} request
      *   The request object that will be sent.
      * @param {google.cloud.discoveryengine.v1beta.Schema} request.schema
-     *   Required. The {@link google.cloud.discoveryengine.v1beta.Schema|Schema} to
+     *   Required. The {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema} to
      *   update.
      * @param {boolean} request.allowMissing
      *   If set to true, and the
-     *   {@link google.cloud.discoveryengine.v1beta.Schema|Schema} is not found, a new
-     *   {@link google.cloud.discoveryengine.v1beta.Schema|Schema} will be created. In
+     *   {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema} is not found, a new
+     *   {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema} will be created. In
      *   this situation, `update_mask` is ignored.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
@@ -204,8 +201,7 @@ export declare class SchemaServiceClient {
      *   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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   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/v1beta/schema_service.update_schema.js</caption>
      * region_tag:discoveryengine_v1beta_generated_SchemaService_UpdateSchema_async
@@ -223,15 +219,14 @@ export declare class SchemaServiceClient {
      *   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
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   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/v1beta/schema_service.update_schema.js</caption>
      * region_tag:discoveryengine_v1beta_generated_SchemaService_UpdateSchema_async
      */
     checkUpdateSchemaProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.Schema, protos.google.cloud.discoveryengine.v1beta.UpdateSchemaMetadata>>;
     /**
-     * Deletes a {@link google.cloud.discoveryengine.v1beta.Schema|Schema}.
+     * Deletes a {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}.
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -244,8 +239,7 @@ export declare class SchemaServiceClient {
      *   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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   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/v1beta/schema_service.delete_schema.js</caption>
      * region_tag:discoveryengine_v1beta_generated_SchemaService_DeleteSchema_async
@@ -263,15 +257,14 @@ export declare class SchemaServiceClient {
      *   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
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   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/v1beta/schema_service.delete_schema.js</caption>
      * region_tag:discoveryengine_v1beta_generated_SchemaService_DeleteSchema_async
      */
     checkDeleteSchemaProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1beta.DeleteSchemaMetadata>>;
     /**
-     * Gets a list of {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s.
+     * Gets a list of {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s.
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -279,32 +272,31 @@ export declare class SchemaServiceClient {
      *   Required. The parent data store resource name, in the format of
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
      * @param {number} request.pageSize
-     *   The maximum number of {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s
+     *   The maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s
      *   to return. The service may return fewer than this value.
      *
      *   If unspecified, at most 100
-     *   {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s will be returned.
+     *   {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s 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
-     *   {@link google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
      *   call. Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to
-     *   {@link google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
      *   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 google.cloud.discoveryengine.v1beta.Schema | Schema}.
+     *   The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}.
      *   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 `listSchemasAsync()`
      *   method described below for async iteration which you can stop as needed.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      */
     listSchemas(request?: protos.google.cloud.discoveryengine.v1beta.IListSchemasRequest, options?: CallOptions): Promise<[
@@ -322,31 +314,30 @@ export declare class SchemaServiceClient {
      *   Required. The parent data store resource name, in the format of
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
      * @param {number} request.pageSize
-     *   The maximum number of {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s
+     *   The maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s
      *   to return. The service may return fewer than this value.
      *
      *   If unspecified, at most 100
-     *   {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s will be returned.
+     *   {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s 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
-     *   {@link google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
      *   call. Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to
-     *   {@link google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
      *   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 google.cloud.discoveryengine.v1beta.Schema | Schema} on 'data' event.
+     *   An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema} 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 `listSchemasAsync()`
      *   method described below for async iteration which you can stop as needed.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      */
     listSchemasStream(request?: protos.google.cloud.discoveryengine.v1beta.IListSchemasRequest, options?: CallOptions): Transform;
@@ -360,30 +351,29 @@ export declare class SchemaServiceClient {
      *   Required. The parent data store resource name, in the format of
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
      * @param {number} request.pageSize
-     *   The maximum number of {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s
+     *   The maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s
      *   to return. The service may return fewer than this value.
      *
      *   If unspecified, at most 100
-     *   {@link google.cloud.discoveryengine.v1beta.Schema|Schema}s will be returned.
+     *   {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}s 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
-     *   {@link google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
      *   call. Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to
-     *   {@link google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
+     *   {@link protos.google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas|SchemaService.ListSchemas}
      *   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 [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
+     *   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 google.cloud.discoveryengine.v1beta.Schema | Schema}. The API will be called under the hood as needed, once per the page,
+     *   {@link protos.google.cloud.discoveryengine.v1beta.Schema|Schema}. 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
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   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/v1beta/schema_service.list_schemas.js</caption>
      * region_tag:discoveryengine_v1beta_generated_SchemaService_ListSchemas_async
@@ -611,6 +601,57 @@ export declare class SchemaServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
+    /**
+     * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
      *
@@ -746,6 +787,48 @@ export declare class SchemaServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
+    /**
+     * Parse the conversation from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreSchema resource name string.
      *