Class v1alpha.DocumentServiceClient (1.7.0)

Service for ingesting information of the customer's website. v1alpha

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of DocumentServiceClient.

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 DocumentServiceClient({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;

documentServiceStub

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

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

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

aclConfigPath(project, location)

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

Return a fully-qualified aclConfig resource name string.

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

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

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: ''});

checkImportDocumentsProgress(name)

checkImportDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.ImportDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.ImportDocumentsMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.ImportDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.ImportDocumentsMetadata>>`	{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.
   */
  /**
   *  The Inline source for the input content for documents.
   */
  // const inlineSource = {}
  /**
   *  Cloud Storage location for the input content.
   */
  // const gcsSource = {}
  /**
   *  BigQuery input source.
   */
  // const bigquerySource = {}
  /**
   *  FhirStore input source.
   */
  // const fhirStoreSource = {}
  /**
   *  Spanner input source.
   */
  // const spannerSource = {}
  /**
   *  Cloud SQL input source.
   */
  // const cloudSqlSource = {}
  /**
   *  Firestore input source.
   */
  // const firestoreSource = {}
  /**
   *  Cloud Bigtable input source.
   */
  // const bigtableSource = {}
  /**
   *  Required. The parent branch resource name, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
   *  Requires create/update permission.
   */
  // const parent = 'abc123'
  /**
   *  The desired location of errors incurred during the Import.
   */
  // const errorConfig = {}
  /**
   *  The mode of reconciliation between existing documents and the documents to
   *  be imported. Defaults to
   *  ReconciliationMode.INCREMENTAL google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL.
   */
  // const reconciliationMode = {}
  /**
   *  Indicates which fields in the provided imported documents to update. If
   *  not set, the default is to update all fields.
   */
  // const updateMask = {}
  /**
   *  Whether to automatically generate IDs for the documents if absent.
   *  If set to `true`,
   *  Document.id google.cloud.discoveryengine.v1alpha.Document.id s are
   *  automatically generated based on the hash of the payload, where IDs may not
   *  be consistent during multiple imports. In which case
   *  ReconciliationMode.FULL google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.FULL 
   *  is highly recommended to avoid duplicate contents. If unset or set to
   *  `false`, Document.id google.cloud.discoveryengine.v1alpha.Document.id s
   *  have to be specified using
   *  id_field google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.id_field,
   *  otherwise, documents without IDs fail to be imported.
   *  Supported data sources:
   *  * GcsSource google.cloud.discoveryengine.v1alpha.GcsSource.
   *  GcsSource.data_schema google.cloud.discoveryengine.v1alpha.GcsSource.data_schema 
   *  must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
   *  * BigQuerySource google.cloud.discoveryengine.v1alpha.BigQuerySource.
   *  BigQuerySource.data_schema google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema 
   *  must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
   *  * SpannerSource google.cloud.discoveryengine.v1alpha.SpannerSource.
   *  * CloudSqlSource google.cloud.discoveryengine.v1alpha.CloudSqlSource.
   *  * FirestoreSource google.cloud.discoveryengine.v1alpha.FirestoreSource.
   *  * BigtableSource google.cloud.discoveryengine.v1alpha.BigtableSource.
   */
  // const autoGenerateIds = true
  /**
   *  The field indicates the ID field or column to be used as unique IDs of
   *  the documents.
   *  For GcsSource google.cloud.discoveryengine.v1alpha.GcsSource  it is the
   *  key of the JSON field. For instance, `my_id` for JSON `{"my_id":
   *  "some_uuid"}`. For others, it may be the column name of the table where the
   *  unique ids are stored.
   *  The values of the JSON field or the table column are used as the
   *  Document.id google.cloud.discoveryengine.v1alpha.Document.id s. The JSON
   *  field or the table column must be of string type, and the values must be
   *  set as valid strings conform to
   *  RFC-1034 (https://tools.ietf.org/html/rfc1034) with 1-63 characters.
   *  Otherwise, documents without valid IDs fail to be imported.
   *  Only set this field when
   *  auto_generate_ids google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.auto_generate_ids 
   *  is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
   *  If it is unset, a default value `_id` is used when importing from the
   *  allowed data sources.
   *  Supported data sources:
   *  * GcsSource google.cloud.discoveryengine.v1alpha.GcsSource.
   *  GcsSource.data_schema google.cloud.discoveryengine.v1alpha.GcsSource.data_schema 
   *  must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
   *  * BigQuerySource google.cloud.discoveryengine.v1alpha.BigQuerySource.
   *  BigQuerySource.data_schema google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema 
   *  must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
   *  * SpannerSource google.cloud.discoveryengine.v1alpha.SpannerSource.
   *  * CloudSqlSource google.cloud.discoveryengine.v1alpha.CloudSqlSource.
   *  * FirestoreSource google.cloud.discoveryengine.v1alpha.FirestoreSource.
   *  * BigtableSource google.cloud.discoveryengine.v1alpha.BigtableSource.
   */
  // const idField = 'abc123'

  // Imports the Discoveryengine library
  const {DocumentServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new DocumentServiceClient();

  async function callImportDocuments() {
    // Construct request
    const request = {
      parent,
    };

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

  callImportDocuments();

checkPurgeDocumentsProgress(name)

checkPurgeDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.PurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.PurgeDocumentsMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.PurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.PurgeDocumentsMetadata>>`	{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.
   */
  /**
   *  Cloud Storage location for the input content.
   *  Supported `data_schema`:
   *  * `document_id`: One valid
   *  Document.id google.cloud.discoveryengine.v1alpha.Document.id  per line.
   */
  // const gcsSource = {}
  /**
   *  Required. The parent resource name, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Filter matching documents to purge. Only currently supported
   *  value is
   *  `*` (all items).
   */
  // const filter = 'abc123'
  /**
   *  The desired location of errors incurred during the purge.
   */
  // const errorConfig = {}
  /**
   *  Actually performs the purge. If `force` is set to false, return the
   *  expected purge count without deleting any documents.
   */
  // const force = true

  // Imports the Discoveryengine library
  const {DocumentServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new DocumentServiceClient();

  async function callPurgeDocuments() {
    // Construct request
    const request = {
      parent,
      filter,
    };

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

  callPurgeDocuments();

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.

createDocument(request, options)

createDocument(request?: protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1alpha.IDocument,
        (protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest | undefined),
        {} | undefined
    ]>;

Creates a .

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

Returns
Type	Description
`Promise<[ protos.google.cloud.discoveryengine.v1alpha.IDocument, (protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 parent resource name, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Document google.cloud.discoveryengine.v1alpha.Document  to
   *  create.
   */
  // const document = {}
  /**
   *  Required. The ID to use for the
   *  Document google.cloud.discoveryengine.v1alpha.Document, which will
   *  become the final component of the
   *  Document.name google.cloud.discoveryengine.v1alpha.Document.name.
   *  If the caller does not have permission to create the
   *  Document google.cloud.discoveryengine.v1alpha.Document, regardless of
   *  whether or not it exists, a `PERMISSION_DENIED` error is returned.
   *  This field must be unique among all
   *  Document google.cloud.discoveryengine.v1alpha.Document s with the same
   *  parent google.cloud.discoveryengine.v1alpha.CreateDocumentRequest.parent.
   *  Otherwise, an `ALREADY_EXISTS` error is returned.
   *  This field must conform to RFC-1034 (https://tools.ietf.org/html/rfc1034)
   *  standard with a length limit of 63 characters. Otherwise, an
   *  `INVALID_ARGUMENT` error is returned.
   */
  // const documentId = 'abc123'

  // Imports the Discoveryengine library
  const {DocumentServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new DocumentServiceClient();

  async function callCreateDocument() {
    // Construct request
    const request = {
      parent,
      document,
      documentId,
    };

    // Run request
    const response = await discoveryengineClient.createDocument(request);
    console.log(response);
  }

  callCreateDocument();

createDocument(request, options, callback)

createDocument(request: protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateDocumentRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createDocument(request, callback)

createDocument(request: protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateDocumentRequest`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteDocument(request, options)

deleteDocument(request?: protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest | undefined),
        {} | undefined
    ]>;

Deletes a .

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

Returns
Type	Description
`Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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. Full resource name of
   *  Document google.cloud.discoveryengine.v1alpha.Document, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
   *  If the caller does not have permission to delete the
   *  Document google.cloud.discoveryengine.v1alpha.Document, regardless of
   *  whether or not it exists, a `PERMISSION_DENIED` error is returned.
   *  If the Document google.cloud.discoveryengine.v1alpha.Document  to delete
   *  does not exist, a `NOT_FOUND` error is returned.
   */
  // const name = 'abc123'

  // Imports the Discoveryengine library
  const {DocumentServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new DocumentServiceClient();

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

    // Run request
    const response = await discoveryengineClient.deleteDocument(request);
    console.log(response);
  }

  callDeleteDocument();

deleteDocument(request, options, callback)

deleteDocument(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteDocumentRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteDocument(request, callback)

deleteDocument(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteDocumentRequest`
`callback`	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

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: ''});

enginePath(project, location, collection, engine)

enginePath(project: string, location: string, collection: string, engine: string): string;

Return a fully-qualified engine resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`

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

getDocument(request, options)

getDocument(request?: protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1alpha.IDocument,
        (protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest | undefined),
        {} | undefined
    ]>;

Gets a .

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

Returns
Type	Description
`Promise<[ protos.google.cloud.discoveryengine.v1alpha.IDocument, (protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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. Full resource name of
   *  Document google.cloud.discoveryengine.v1alpha.Document, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
   *  If the caller does not have permission to access the
   *  Document google.cloud.discoveryengine.v1alpha.Document, regardless of
   *  whether or not it exists, a `PERMISSION_DENIED` error is returned.
   *  If the requested Document google.cloud.discoveryengine.v1alpha.Document 
   *  does not exist, a `NOT_FOUND` error is returned.
   */
  // const name = 'abc123'

  // Imports the Discoveryengine library
  const {DocumentServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new DocumentServiceClient();

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

    // Run request
    const response = await discoveryengineClient.getDocument(request);
    console.log(response);
  }

  callGetDocument();

getDocument(request, options, callback)

getDocument(request: protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetDocumentRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getDocument(request, callback)

getDocument(request: protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetDocumentRequest`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IGetLocationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>` Call options. See CallOptions for more details.
`callback`	`Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`Promise<google.cloud.location.ILocation>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example


const [response] = await client.getLocation(request);

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)

getProcessedDocument(request, options)

getProcessedDocument(request?: protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1alpha.IProcessedDocument,
        (protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest | undefined),
        {} | undefined
    ]>;

Gets the parsed layout information for a .

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

Returns
Type	Description
`Promise<[ protos.google.cloud.discoveryengine.v1alpha.IProcessedDocument, (protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing ProcessedDocument. 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. Full resource name of
   *  Document google.cloud.discoveryengine.v1alpha.Document, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
   *  If the caller does not have permission to access the
   *  Document google.cloud.discoveryengine.v1alpha.Document, regardless of
   *  whether or not it exists, a `PERMISSION_DENIED` error is returned.
   *  If the requested Document google.cloud.discoveryengine.v1alpha.Document 
   *  does not exist, a `NOT_FOUND` error is returned.
   */
  // const name = 'abc123'
  /**
   *  Required. What type of processing to return.
   */
  // const processedDocumentType = {}
  /**
   *  What format output should be.  If unspecified, defaults to JSON.
   */
  // const processedDocumentFormat = {}

  // Imports the Discoveryengine library
  const {DocumentServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new DocumentServiceClient();

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

    // Run request
    const response = await discoveryengineClient.getProcessedDocument(request);
    console.log(response);
  }

  callGetProcessedDocument();

getProcessedDocument(request, options, callback)

getProcessedDocument(request: protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IProcessedDocument, protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetProcessedDocumentRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1alpha.IProcessedDocument, protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getProcessedDocument(request, callback)

getProcessedDocument(request: protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IProcessedDocument, protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetProcessedDocumentRequest`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1alpha.IProcessedDocument, protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

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`

importDocuments(request, options)

importDocuments(request?: protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Bulk import of multiple s. Request processing may be synchronous. Non-existing items will be created.

Note: It is possible for a subset of the s to be successfully updated.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsMetadata>, 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.
   */
  /**
   *  The Inline source for the input content for documents.
   */
  // const inlineSource = {}
  /**
   *  Cloud Storage location for the input content.
   */
  // const gcsSource = {}
  /**
   *  BigQuery input source.
   */
  // const bigquerySource = {}
  /**
   *  FhirStore input source.
   */
  // const fhirStoreSource = {}
  /**
   *  Spanner input source.
   */
  // const spannerSource = {}
  /**
   *  Cloud SQL input source.
   */
  // const cloudSqlSource = {}
  /**
   *  Firestore input source.
   */
  // const firestoreSource = {}
  /**
   *  Cloud Bigtable input source.
   */
  // const bigtableSource = {}
  /**
   *  Required. The parent branch resource name, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
   *  Requires create/update permission.
   */
  // const parent = 'abc123'
  /**
   *  The desired location of errors incurred during the Import.
   */
  // const errorConfig = {}
  /**
   *  The mode of reconciliation between existing documents and the documents to
   *  be imported. Defaults to
   *  ReconciliationMode.INCREMENTAL google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL.
   */
  // const reconciliationMode = {}
  /**
   *  Indicates which fields in the provided imported documents to update. If
   *  not set, the default is to update all fields.
   */
  // const updateMask = {}
  /**
   *  Whether to automatically generate IDs for the documents if absent.
   *  If set to `true`,
   *  Document.id google.cloud.discoveryengine.v1alpha.Document.id s are
   *  automatically generated based on the hash of the payload, where IDs may not
   *  be consistent during multiple imports. In which case
   *  ReconciliationMode.FULL google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.FULL 
   *  is highly recommended to avoid duplicate contents. If unset or set to
   *  `false`, Document.id google.cloud.discoveryengine.v1alpha.Document.id s
   *  have to be specified using
   *  id_field google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.id_field,
   *  otherwise, documents without IDs fail to be imported.
   *  Supported data sources:
   *  * GcsSource google.cloud.discoveryengine.v1alpha.GcsSource.
   *  GcsSource.data_schema google.cloud.discoveryengine.v1alpha.GcsSource.data_schema 
   *  must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
   *  * BigQuerySource google.cloud.discoveryengine.v1alpha.BigQuerySource.
   *  BigQuerySource.data_schema google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema 
   *  must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
   *  * SpannerSource google.cloud.discoveryengine.v1alpha.SpannerSource.
   *  * CloudSqlSource google.cloud.discoveryengine.v1alpha.CloudSqlSource.
   *  * FirestoreSource google.cloud.discoveryengine.v1alpha.FirestoreSource.
   *  * BigtableSource google.cloud.discoveryengine.v1alpha.BigtableSource.
   */
  // const autoGenerateIds = true
  /**
   *  The field indicates the ID field or column to be used as unique IDs of
   *  the documents.
   *  For GcsSource google.cloud.discoveryengine.v1alpha.GcsSource  it is the
   *  key of the JSON field. For instance, `my_id` for JSON `{"my_id":
   *  "some_uuid"}`. For others, it may be the column name of the table where the
   *  unique ids are stored.
   *  The values of the JSON field or the table column are used as the
   *  Document.id google.cloud.discoveryengine.v1alpha.Document.id s. The JSON
   *  field or the table column must be of string type, and the values must be
   *  set as valid strings conform to
   *  RFC-1034 (https://tools.ietf.org/html/rfc1034) with 1-63 characters.
   *  Otherwise, documents without valid IDs fail to be imported.
   *  Only set this field when
   *  auto_generate_ids google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.auto_generate_ids 
   *  is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
   *  If it is unset, a default value `_id` is used when importing from the
   *  allowed data sources.
   *  Supported data sources:
   *  * GcsSource google.cloud.discoveryengine.v1alpha.GcsSource.
   *  GcsSource.data_schema google.cloud.discoveryengine.v1alpha.GcsSource.data_schema 
   *  must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
   *  * BigQuerySource google.cloud.discoveryengine.v1alpha.BigQuerySource.
   *  BigQuerySource.data_schema google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema 
   *  must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
   *  * SpannerSource google.cloud.discoveryengine.v1alpha.SpannerSource.
   *  * CloudSqlSource google.cloud.discoveryengine.v1alpha.CloudSqlSource.
   *  * FirestoreSource google.cloud.discoveryengine.v1alpha.FirestoreSource.
   *  * BigtableSource google.cloud.discoveryengine.v1alpha.BigtableSource.
   */
  // const idField = 'abc123'

  // Imports the Discoveryengine library
  const {DocumentServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new DocumentServiceClient();

  async function callImportDocuments() {
    // Construct request
    const request = {
      parent,
    };

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

  callImportDocuments();

importDocuments(request, options, callback)

importDocuments(request: protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IImportDocumentsRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

importDocuments(request, callback)

importDocuments(request: protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IImportDocumentsRequest`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| 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.

listDocuments(request, options)

listDocuments(request?: protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1alpha.IDocument[],
        protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest | null,
        protos.google.cloud.discoveryengine.v1alpha.IListDocumentsResponse
    ]>;

Gets a list of s.

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

Returns

Type Description

Promise<[
        protos.google.cloud.discoveryengine.v1alpha.IDocument[],
        protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest | null,
        protos.google.cloud.discoveryengine.v1alpha.IListDocumentsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listDocumentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDocuments(request, options, callback)

listDocuments(request: protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, protos.google.cloud.discoveryengine.v1alpha.IListDocumentsResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.IDocument>): void;

Parameters
Name	Description
`request`	`IListDocumentsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, protos.google.cloud.discoveryengine.v1alpha.IListDocumentsResponse \| null \| undefined, protos.google.cloud.discoveryengine.v1alpha.IDocument>`

Returns
Type	Description
`void`

listDocuments(request, callback)

listDocuments(request: protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, protos.google.cloud.discoveryengine.v1alpha.IListDocumentsResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.IDocument>): void;

Parameters
Name	Description
`request`	`IListDocumentsRequest`
`callback`	`PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, protos.google.cloud.discoveryengine.v1alpha.IListDocumentsResponse \| null \| undefined, protos.google.cloud.discoveryengine.v1alpha.IDocument>`

Returns
Type	Description
`void`

listDocumentsAsync(request, options)

listDocumentsAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.IDocument>;

Equivalent to listDocuments, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

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

Returns
Type	Description
`AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.IDocument>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 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 parent branch resource name, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
   *  Use `default_branch` as the branch ID, to list documents under the default
   *  branch.
   *  If the caller does not have permission to list
   *  Document google.cloud.discoveryengine.v1alpha.Document s under this
   *  branch, regardless of whether or not this branch exists, a
   *  `PERMISSION_DENIED` error is returned.
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of
   *  Document google.cloud.discoveryengine.v1alpha.Document s to return. If
   *  unspecified, defaults to 100. The maximum allowed value is 1000. Values
   *  above 1000 will be coerced to 1000.
   *  If this field is negative, an `INVALID_ARGUMENT` error is returned.
   */
  // const pageSize = 1234
  /**
   *  A page token
   *  ListDocumentsResponse.next_page_token google.cloud.discoveryengine.v1alpha.ListDocumentsResponse.next_page_token,
   *  received from a previous
   *  DocumentService.ListDocuments google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  DocumentService.ListDocuments google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments 
   *  must match the call that provided the page token. Otherwise, an
   *  `INVALID_ARGUMENT` error is returned.
   */
  // const pageToken = 'abc123'

  // Imports the Discoveryengine library
  const {DocumentServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new DocumentServiceClient();

  async function callListDocuments() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = discoveryengineClient.listDocumentsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDocuments();

listDocumentsStream(request, options)

listDocumentsStream(request?: protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

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

Returns
Type	Description
`Transform`	{Stream} An object stream which emits an object representing 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 `listDocumentsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
`request`	`LocationProtos.google.cloud.location.IListLocationsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`AsyncIterable<google.cloud.location.ILocation>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples.

Example


const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

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)

matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the answer from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_data_store_session_answer resource.

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

matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the answer from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_engine_session_answer resource.

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

matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the answer from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_data_store_session_answer resource.

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

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.

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

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

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

matchBranchFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName)

matchBranchFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;

Parse the branch from ProjectLocationCollectionDataStoreBranch resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchName`	`string` A fully-qualified path representing project_location_collection_data_store_branch resource.

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

matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_data_store_branch_document_chunk resource.

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

matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the branch from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

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

matchBranchFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName)

matchBranchFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;

Parse the branch from ProjectLocationDataStoreBranch resource.

Parameter
Name	Description
`projectLocationDataStoreBranchName`	`string` A fully-qualified path representing project_location_data_store_branch resource.

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

matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.

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

matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_data_store_branch_document_chunk resource.

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

matchCollectionFromEngineName(engineName)

matchCollectionFromEngineName(engineName: string): string | number;

Parse the collection from Engine resource.

Parameter
Name	Description
`engineName`	`string` A fully-qualified path representing Engine resource.

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

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.

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

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

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

matchCollectionFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName)

matchCollectionFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreBranch resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchName`	`string` A fully-qualified path representing project_location_collection_data_store_branch resource.

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

matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

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

matchCollectionFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchCollectionFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.

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

matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStore resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreName`	`string` A fully-qualified path representing project_location_collection_data_store resource.

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

matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

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

matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_serving_config resource.

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

matchCollectionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchCollectionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_data_store_session_answer resource.

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

matchCollectionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchCollectionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSession resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionName`	`string` A fully-qualified path representing project_location_collection_data_store_session resource.

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

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName)

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.

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

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.

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

matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineConversation resource.

Parameter
Name	Description
`projectLocationCollectionEngineConversationName`	`string` A fully-qualified path representing project_location_collection_engine_conversation resource.

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

matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionEngineServingConfigName`	`string` A fully-qualified path representing project_location_collection_engine_serving_config resource.

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

matchCollectionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchCollectionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_engine_session_answer resource.

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

matchCollectionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchCollectionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineSession resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionName`	`string` A fully-qualified path representing project_location_collection_engine_session resource.

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

matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

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

matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the conversation from ProjectLocationCollectionEngineConversation resource.

Parameter
Name	Description
`projectLocationCollectionEngineConversationName`	`string` A fully-qualified path representing project_location_collection_engine_conversation resource.

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

matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the conversation from ProjectLocationDataStoreConversation resource.

Parameter
Name	Description
`projectLocationDataStoreConversationName`	`string` A fully-qualified path representing project_location_data_store_conversation resource.

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

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.

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

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

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

matchDataStoreFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName)

matchDataStoreFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreBranch resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchName`	`string` A fully-qualified path representing project_location_collection_data_store_branch resource.

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

matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

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

matchDataStoreFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchDataStoreFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.

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

matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStore resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreName`	`string` A fully-qualified path representing project_location_collection_data_store resource.

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

matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

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

matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_serving_config resource.

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

matchDataStoreFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchDataStoreFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_data_store_session_answer resource.

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

matchDataStoreFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchDataStoreFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSession resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionName`	`string` A fully-qualified path representing project_location_collection_data_store_session resource.

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

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName)

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.

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

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.

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

matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_data_store_branch_document_chunk resource.

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

matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the data_store from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

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

matchDataStoreFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName)

matchDataStoreFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;

Parse the data_store from ProjectLocationDataStoreBranch resource.

Parameter
Name	Description
`projectLocationDataStoreBranchName`	`string` A fully-qualified path representing project_location_data_store_branch resource.

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

matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the data_store from ProjectLocationDataStoreConversation resource.

Parameter
Name	Description
`projectLocationDataStoreConversationName`	`string` A fully-qualified path representing project_location_data_store_conversation resource.

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

matchDataStoreFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName)

matchDataStoreFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;

Parse the data_store from ProjectLocationDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.

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

matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the data_store from ProjectLocationDataStore resource.

Parameter
Name	Description
`projectLocationDataStoreName`	`string` A fully-qualified path representing project_location_data_store resource.

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

matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSchema resource.

Parameter
Name	Description
`projectLocationDataStoreSchemaName`	`string` A fully-qualified path representing project_location_data_store_schema resource.

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

matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the data_store from ProjectLocationDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_data_store_serving_config resource.

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

matchDataStoreFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchDataStoreFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_data_store_session_answer resource.

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

matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName)

matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSession resource.

Parameter
Name	Description
`projectLocationDataStoreSessionName`	`string` A fully-qualified path representing project_location_data_store_session resource.

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

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName)

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine resource.

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

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.

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

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.

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

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

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

matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_data_store_branch_document_chunk resource.

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

matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the document from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

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

matchEngineFromEngineName(engineName)

matchEngineFromEngineName(engineName: string): string | number;

Parse the engine from Engine resource.

Parameter
Name	Description
`engineName`	`string` A fully-qualified path representing Engine resource.

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

matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineConversation resource.

Parameter
Name	Description
`projectLocationCollectionEngineConversationName`	`string` A fully-qualified path representing project_location_collection_engine_conversation resource.

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

matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionEngineServingConfigName`	`string` A fully-qualified path representing project_location_collection_engine_serving_config resource.

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

matchEngineFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchEngineFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_engine_session_answer resource.

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

matchEngineFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchEngineFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineSession resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionName`	`string` A fully-qualified path representing project_location_collection_engine_session resource.

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

matchLocationFromAclConfigName(aclConfigName)

matchLocationFromAclConfigName(aclConfigName: string): string | number;

Parse the location from AclConfig resource.

Parameter
Name	Description
`aclConfigName`	`string` A fully-qualified path representing AclConfig resource.

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

matchLocationFromEngineName(engineName)

matchLocationFromEngineName(engineName: string): string | number;

Parse the location from Engine resource.

Parameter
Name	Description
`engineName`	`string` A fully-qualified path representing Engine resource.

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

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.

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

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

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

matchLocationFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName)

matchLocationFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreBranch resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchName`	`string` A fully-qualified path representing project_location_collection_data_store_branch resource.

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

matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

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

matchLocationFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchLocationFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.

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

matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the location from ProjectLocationCollectionDataStore resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreName`	`string` A fully-qualified path representing project_location_collection_data_store resource.

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

matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

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

matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_serving_config resource.

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

matchLocationFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchLocationFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_data_store_session_answer resource.

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

matchLocationFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchLocationFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSession resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionName`	`string` A fully-qualified path representing project_location_collection_data_store_session resource.

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

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName)

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.

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

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.

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

matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the location from ProjectLocationCollectionEngineConversation resource.

Parameter
Name	Description
`projectLocationCollectionEngineConversationName`	`string` A fully-qualified path representing project_location_collection_engine_conversation resource.

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

matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the location from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionEngineServingConfigName`	`string` A fully-qualified path representing project_location_collection_engine_serving_config resource.

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

matchLocationFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchLocationFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the location from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_engine_session_answer resource.

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

matchLocationFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchLocationFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the location from ProjectLocationCollectionEngineSession resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionName`	`string` A fully-qualified path representing project_location_collection_engine_session resource.

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

matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_data_store_branch_document_chunk resource.

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

matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the location from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

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

matchLocationFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName)

matchLocationFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;

Parse the location from ProjectLocationDataStoreBranch resource.

Parameter
Name	Description
`projectLocationDataStoreBranchName`	`string` A fully-qualified path representing project_location_data_store_branch resource.

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

matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the location from ProjectLocationDataStoreConversation resource.

Parameter
Name	Description
`projectLocationDataStoreConversationName`	`string` A fully-qualified path representing project_location_data_store_conversation resource.

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

matchLocationFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName)

matchLocationFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;

Parse the location from ProjectLocationDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.

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

matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the location from ProjectLocationDataStore resource.

Parameter
Name	Description
`projectLocationDataStoreName`	`string` A fully-qualified path representing project_location_data_store resource.

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

matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the location from ProjectLocationDataStoreSchema resource.

Parameter
Name	Description
`projectLocationDataStoreSchemaName`	`string` A fully-qualified path representing project_location_data_store_schema resource.

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

matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the location from ProjectLocationDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_data_store_serving_config resource.

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

matchLocationFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchLocationFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the location from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_data_store_session_answer resource.

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

matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName)

matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;

Parse the location from ProjectLocationDataStoreSession resource.

Parameter
Name	Description
`projectLocationDataStoreSessionName`	`string` A fully-qualified path representing project_location_data_store_session resource.

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

matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName)

matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;

Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine resource.

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

matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.

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

matchProjectFromAclConfigName(aclConfigName)

matchProjectFromAclConfigName(aclConfigName: string): string | number;

Parse the project from AclConfig resource.

Parameter
Name	Description
`aclConfigName`	`string` A fully-qualified path representing AclConfig resource.

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

matchProjectFromEngineName(engineName)

matchProjectFromEngineName(engineName: string): string | number;

Parse the project from Engine resource.

Parameter
Name	Description
`engineName`	`string` A fully-qualified path representing Engine resource.

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

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.

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

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_collection_data_store_branch_document resource.

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

matchProjectFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName)

matchProjectFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreBranch resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreBranchName`	`string` A fully-qualified path representing project_location_collection_data_store_branch resource.

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

matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreConversation resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreConversationName`	`string` A fully-qualified path representing project_location_collection_data_store_conversation resource.

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

matchProjectFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchProjectFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.

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

matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the project from ProjectLocationCollectionDataStore resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreName`	`string` A fully-qualified path representing project_location_collection_data_store resource.

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

matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

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

matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_serving_config resource.

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

matchProjectFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchProjectFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_data_store_session_answer resource.

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

matchProjectFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchProjectFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSession resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionName`	`string` A fully-qualified path representing project_location_collection_data_store_session resource.

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

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName)

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.

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

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.

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

matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the project from ProjectLocationCollectionEngineConversation resource.

Parameter
Name	Description
`projectLocationCollectionEngineConversationName`	`string` A fully-qualified path representing project_location_collection_engine_conversation resource.

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

matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the project from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionEngineServingConfigName`	`string` A fully-qualified path representing project_location_collection_engine_serving_config resource.

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

matchProjectFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchProjectFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the project from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_engine_session_answer resource.

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

matchProjectFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchProjectFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the project from ProjectLocationCollectionEngineSession resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionName`	`string` A fully-qualified path representing project_location_collection_engine_session resource.

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

matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentChunkName`	`string` A fully-qualified path representing project_location_data_store_branch_document_chunk resource.

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

matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the project from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name	Description
`projectLocationDataStoreBranchDocumentName`	`string` A fully-qualified path representing project_location_data_store_branch_document resource.

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

matchProjectFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName)

matchProjectFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;

Parse the project from ProjectLocationDataStoreBranch resource.

Parameter
Name	Description
`projectLocationDataStoreBranchName`	`string` A fully-qualified path representing project_location_data_store_branch resource.

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

matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the project from ProjectLocationDataStoreConversation resource.

Parameter
Name	Description
`projectLocationDataStoreConversationName`	`string` A fully-qualified path representing project_location_data_store_conversation resource.

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

matchProjectFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName)

matchProjectFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;

Parse the project from ProjectLocationDataStoreDocumentProcessingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreDocumentProcessingConfigName`	`string` A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.

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

matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the project from ProjectLocationDataStore resource.

Parameter
Name	Description
`projectLocationDataStoreName`	`string` A fully-qualified path representing project_location_data_store resource.

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

matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the project from ProjectLocationDataStoreSchema resource.

Parameter
Name	Description
`projectLocationDataStoreSchemaName`	`string` A fully-qualified path representing project_location_data_store_schema resource.

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

matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the project from ProjectLocationDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_data_store_serving_config resource.

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

matchProjectFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchProjectFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the project from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_data_store_session_answer resource.

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

matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName)

matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;

Parse the project from ProjectLocationDataStoreSession resource.

Parameter
Name	Description
`projectLocationDataStoreSessionName`	`string` A fully-qualified path representing project_location_data_store_session resource.

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

matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName)

matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;

Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine resource.

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

matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.

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

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name	Description
`projectName`	`string` A fully-qualified path representing Project resource.

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

matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the schema from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSchemaName`	`string` A fully-qualified path representing project_location_collection_data_store_schema resource.

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

matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the schema from ProjectLocationDataStoreSchema resource.

Parameter
Name	Description
`projectLocationDataStoreSchemaName`	`string` A fully-qualified path representing project_location_data_store_schema resource.

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

matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_collection_data_store_serving_config resource.

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

matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name	Description
`projectLocationCollectionEngineServingConfigName`	`string` A fully-qualified path representing project_location_collection_engine_serving_config resource.

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

matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the serving_config from ProjectLocationDataStoreServingConfig resource.

Parameter
Name	Description
`projectLocationDataStoreServingConfigName`	`string` A fully-qualified path representing project_location_data_store_serving_config resource.

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

matchSessionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchSessionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the session from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_data_store_session_answer resource.

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

matchSessionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchSessionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the session from ProjectLocationCollectionDataStoreSession resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSessionName`	`string` A fully-qualified path representing project_location_collection_data_store_session resource.

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

matchSessionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchSessionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the session from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionAnswerName`	`string` A fully-qualified path representing project_location_collection_engine_session_answer resource.

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

matchSessionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchSessionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the session from ProjectLocationCollectionEngineSession resource.

Parameter
Name	Description
`projectLocationCollectionEngineSessionName`	`string` A fully-qualified path representing project_location_collection_engine_session resource.

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

matchSessionFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchSessionFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the session from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name	Description
`projectLocationDataStoreSessionAnswerName`	`string` A fully-qualified path representing project_location_data_store_session_answer resource.

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

matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName)

matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;

Parse the session from ProjectLocationDataStoreSession resource.

Parameter
Name	Description
`projectLocationDataStoreSessionName`	`string` A fully-qualified path representing project_location_data_store_session resource.

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

matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.

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

matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name	Description
`projectLocationDataStoreSiteSearchEngineTargetSiteName`	`string` A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.

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

projectLocationCollectionDataStoreBranchDocumentChunkPath(project, location, collection, dataStore, branch, document, chunk)

projectLocationCollectionDataStoreBranchDocumentChunkPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string, chunk: string): string;

Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`branch`	`string`
`document`	`string`
`chunk`	`string`

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

projectLocationCollectionDataStoreBranchDocumentPath(project, location, collection, dataStore, branch, document)

projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;

Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`branch`	`string`
`document`	`string`

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

projectLocationCollectionDataStoreBranchPath(project, location, collection, dataStore, branch)

projectLocationCollectionDataStoreBranchPath(project: string, location: string, collection: string, dataStore: string, branch: string): string;

Return a fully-qualified projectLocationCollectionDataStoreBranch resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`branch`	`string`

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

projectLocationCollectionDataStoreConversationPath(project, location, collection, dataStore, conversation)

projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;

Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`conversation`	`string`

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

projectLocationCollectionDataStoreDocumentProcessingConfigPath(project, location, collection, dataStore)

projectLocationCollectionDataStoreDocumentProcessingConfigPath(project: string, location: string, collection: string, dataStore: string): string;

Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`

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

projectLocationCollectionDataStorePath(project, location, collection, dataStore)

projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;

Return a fully-qualified projectLocationCollectionDataStore resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`

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

projectLocationCollectionDataStoreSchemaPath(project, location, collection, dataStore, schema)

projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;

Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`schema`	`string`

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

projectLocationCollectionDataStoreServingConfigPath(project, location, collection, dataStore, servingConfig)

projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;

Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`servingConfig`	`string`

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

projectLocationCollectionDataStoreSessionAnswerPath(project, location, collection, dataStore, session, answer)

projectLocationCollectionDataStoreSessionAnswerPath(project: string, location: string, collection: string, dataStore: string, session: string, answer: string): string;

Return a fully-qualified projectLocationCollectionDataStoreSessionAnswer resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`session`	`string`
`answer`	`string`

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

projectLocationCollectionDataStoreSessionPath(project, location, collection, dataStore, session)

projectLocationCollectionDataStoreSessionPath(project: string, location: string, collection: string, dataStore: string, session: string): string;

Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`session`	`string`

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

projectLocationCollectionDataStoreSiteSearchEnginePath(project, location, collection, dataStore)

projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;

Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`

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

projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project, location, collection, dataStore, targetSite)

projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;

Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`targetSite`	`string`

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

projectLocationCollectionEngineConversationPath(project, location, collection, engine, conversation)

projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;

Return a fully-qualified projectLocationCollectionEngineConversation resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`
`conversation`	`string`

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

projectLocationCollectionEngineServingConfigPath(project, location, collection, engine, servingConfig)

projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;

Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`
`servingConfig`	`string`

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

projectLocationCollectionEngineSessionAnswerPath(project, location, collection, engine, session, answer)

projectLocationCollectionEngineSessionAnswerPath(project: string, location: string, collection: string, engine: string, session: string, answer: string): string;

Return a fully-qualified projectLocationCollectionEngineSessionAnswer resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`
`session`	`string`
`answer`	`string`

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

projectLocationCollectionEngineSessionPath(project, location, collection, engine, session)

projectLocationCollectionEngineSessionPath(project: string, location: string, collection: string, engine: string, session: string): string;

Return a fully-qualified projectLocationCollectionEngineSession resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`
`session`	`string`

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

projectLocationDataStoreBranchDocumentChunkPath(project, location, dataStore, branch, document, chunk)

projectLocationDataStoreBranchDocumentChunkPath(project: string, location: string, dataStore: string, branch: string, document: string, chunk: string): string;

Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`branch`	`string`
`document`	`string`
`chunk`	`string`

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

projectLocationDataStoreBranchDocumentPath(project, location, dataStore, branch, document)

projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;

Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.

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

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

projectLocationDataStoreBranchPath(project, location, dataStore, branch)

projectLocationDataStoreBranchPath(project: string, location: string, dataStore: string, branch: string): string;

Return a fully-qualified projectLocationDataStoreBranch resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`branch`	`string`

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

projectLocationDataStoreConversationPath(project, location, dataStore, conversation)

projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;

Return a fully-qualified projectLocationDataStoreConversation resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`conversation`	`string`

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

projectLocationDataStoreDocumentProcessingConfigPath(project, location, dataStore)

projectLocationDataStoreDocumentProcessingConfigPath(project: string, location: string, dataStore: string): string;

Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.

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

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

projectLocationDataStorePath(project, location, dataStore)

projectLocationDataStorePath(project: string, location: string, dataStore: string): string;

Return a fully-qualified projectLocationDataStore resource name string.

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

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

projectLocationDataStoreSchemaPath(project, location, dataStore, schema)

projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;

Return a fully-qualified projectLocationDataStoreSchema resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`schema`	`string`

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

projectLocationDataStoreServingConfigPath(project, location, dataStore, servingConfig)

projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;

Return a fully-qualified projectLocationDataStoreServingConfig resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`servingConfig`	`string`

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

projectLocationDataStoreSessionAnswerPath(project, location, dataStore, session, answer)

projectLocationDataStoreSessionAnswerPath(project: string, location: string, dataStore: string, session: string, answer: string): string;

Return a fully-qualified projectLocationDataStoreSessionAnswer resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`session`	`string`
`answer`	`string`

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

projectLocationDataStoreSessionPath(project, location, dataStore, session)

projectLocationDataStoreSessionPath(project: string, location: string, dataStore: string, session: string): string;

Return a fully-qualified projectLocationDataStoreSession resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`session`	`string`

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

projectLocationDataStoreSiteSearchEnginePath(project, location, dataStore)

projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;

Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.

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

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

projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite)

projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;

Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`targetSite`	`string`

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

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name	Description
`project`	`string`

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

purgeDocuments(request, options)

purgeDocuments(request?: protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Permanently deletes all selected s in a branch.

This process is asynchronous. Depending on the number of s to be deleted, this operation can take hours to complete. Before the delete operation completes, some s might still be returned by or .

To get a list of the s to be deleted, set PurgeDocumentsRequest.force to false.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsMetadata>, 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.
   */
  /**
   *  Cloud Storage location for the input content.
   *  Supported `data_schema`:
   *  * `document_id`: One valid
   *  Document.id google.cloud.discoveryengine.v1alpha.Document.id  per line.
   */
  // const gcsSource = {}
  /**
   *  Required. The parent resource name, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Filter matching documents to purge. Only currently supported
   *  value is
   *  `*` (all items).
   */
  // const filter = 'abc123'
  /**
   *  The desired location of errors incurred during the purge.
   */
  // const errorConfig = {}
  /**
   *  Actually performs the purge. If `force` is set to false, return the
   *  expected purge count without deleting any documents.
   */
  // const force = true

  // Imports the Discoveryengine library
  const {DocumentServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new DocumentServiceClient();

  async function callPurgeDocuments() {
    // Construct request
    const request = {
      parent,
      filter,
    };

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

  callPurgeDocuments();

purgeDocuments(request, options, callback)

purgeDocuments(request: protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IPurgeDocumentsRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

purgeDocuments(request, callback)

purgeDocuments(request: protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IPurgeDocumentsRequest`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateDocument(request, options)

updateDocument(request?: protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1alpha.IDocument,
        (protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest | undefined),
        {} | undefined
    ]>;

Updates a .

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

Returns
Type	Description
`Promise<[ protos.google.cloud.discoveryengine.v1alpha.IDocument, (protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 document to update/create.
   *  If the caller does not have permission to update the
   *  Document google.cloud.discoveryengine.v1alpha.Document, regardless of
   *  whether or not it exists, a `PERMISSION_DENIED` error is returned.
   *  If the Document google.cloud.discoveryengine.v1alpha.Document  to update
   *  does not exist and
   *  allow_missing google.cloud.discoveryengine.v1alpha.UpdateDocumentRequest.allow_missing 
   *  is not set, a `NOT_FOUND` error is returned.
   */
  // const document = {}
  /**
   *  If set to true, and the
   *  Document google.cloud.discoveryengine.v1alpha.Document  is not found, a
   *  new Document google.cloud.discoveryengine.v1alpha.Document  will be
   *  created.
   */
  // const allowMissing = true
  /**
   *  Indicates which fields in the provided imported 'document' to update. If
   *  not set, will by default update all fields.
   */
  // const updateMask = {}

  // Imports the Discoveryengine library
  const {DocumentServiceClient} = require('@google-cloud/discoveryengine').v1alpha;

  // Instantiates a client
  const discoveryengineClient = new DocumentServiceClient();

  async function callUpdateDocument() {
    // Construct request
    const request = {
      document,
    };

    // Run request
    const response = await discoveryengineClient.updateDocument(request);
    console.log(response);
  }

  callUpdateDocument();

updateDocument(request, options, callback)

updateDocument(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateDocumentRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateDocument(request, callback)

updateDocument(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateDocumentRequest`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`