Class v1beta.SiteSearchEngineServiceClient (1.4.1)

Service for managing site search related resources. v1beta

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of SiteSearchEngineServiceClient.

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 SiteSearchEngineServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

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.

siteSearchEngineServiceStub

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

universeDomain

get universeDomain(): string;

warn

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

Methods

batchCreateTargetSites(request, options)

batchCreateTargetSites(request?: protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSitesRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSiteMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates in a batch.

Parameters
Name	Description
`request`	`IBatchCreateTargetSitesRequest` 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.v1beta.IBatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSiteMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource shared by all TargetSites being created.
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
   *  The parent field in the CreateBookRequest messages must either be empty or
   *  match this field.
   */
  // const parent = 'abc123'
  /**
   *  Required. The request message specifying the resources to create.
   *  A maximum of 20 TargetSites can be created in a batch.
   */
  // const requests = [1,2,3,4]

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

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

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

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

  callBatchCreateTargetSites();

batchCreateTargetSites(request, options, callback)

batchCreateTargetSites(request: protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSitesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IBatchCreateTargetSitesRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSiteMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

batchCreateTargetSites(request, callback)

batchCreateTargetSites(request: protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSitesRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IBatchCreateTargetSitesRequest`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.IBatchCreateTargetSiteMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

batchVerifyTargetSites(request, options)

batchVerifyTargetSites(request?: protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.

Parameters
Name	Description
`request`	`IBatchVerifyTargetSitesRequest` 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.v1beta.IBatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource shared by all TargetSites being verified.
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
   */
  // const parent = 'abc123'

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

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

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

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

  callBatchVerifyTargetSites();

batchVerifyTargetSites(request, options, callback)

batchVerifyTargetSites(request: protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IBatchVerifyTargetSitesRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

batchVerifyTargetSites(request, callback)

batchVerifyTargetSites(request: protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IBatchVerifyTargetSitesRequest`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.IBatchVerifyTargetSitesMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

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

checkBatchCreateTargetSitesProgress(name)

checkBatchCreateTargetSitesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.BatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.BatchCreateTargetSiteMetadata>>;

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

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

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource shared by all TargetSites being created.
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
   *  The parent field in the CreateBookRequest messages must either be empty or
   *  match this field.
   */
  // const parent = 'abc123'
  /**
   *  Required. The request message specifying the resources to create.
   *  A maximum of 20 TargetSites can be created in a batch.
   */
  // const requests = [1,2,3,4]

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

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

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

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

  callBatchCreateTargetSites();

checkBatchVerifyTargetSitesProgress(name)

checkBatchVerifyTargetSitesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.BatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1beta.BatchVerifyTargetSitesMetadata>>;

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

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

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource shared by all TargetSites being verified.
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
   */
  // const parent = 'abc123'

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

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

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

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

  callBatchVerifyTargetSites();

checkCreateTargetSiteProgress(name)

checkCreateTargetSiteProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.TargetSite, protos.google.cloud.discoveryengine.v1beta.CreateTargetSiteMetadata>>;

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

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

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent resource name of
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The TargetSite google.cloud.discoveryengine.v1beta.TargetSite 
   *  to create.
   */
  // const targetSite = {}

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

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

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

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

  callCreateTargetSite();

checkDeleteTargetSiteProgress(name)

checkDeleteTargetSiteProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1beta.DeleteTargetSiteMetadata>>;

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

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

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
   *  If the caller does not have permission to access the
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite, regardless of
   *  whether or not it exists, a PERMISSION_DENIED error is returned.
   *  If the requested
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite  does not
   *  exist, a NOT_FOUND error is returned.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteTargetSite();

checkDisableAdvancedSiteSearchProgress(name)

checkDisableAdvancedSiteSearchProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.DisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.DisableAdvancedSiteSearchMetadata>>;

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

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

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of the
   *  SiteSearchEngine google.cloud.discoveryengine.v1beta.SiteSearchEngine,
   *  such as
   *  `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
   */
  // const siteSearchEngine = 'abc123'

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

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

  async function callDisableAdvancedSiteSearch() {
    // Construct request
    const request = {
      siteSearchEngine,
    };

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

  callDisableAdvancedSiteSearch();

checkEnableAdvancedSiteSearchProgress(name)

checkEnableAdvancedSiteSearchProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.EnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.EnableAdvancedSiteSearchMetadata>>;

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

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

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of the
   *  SiteSearchEngine google.cloud.discoveryengine.v1beta.SiteSearchEngine,
   *  such as
   *  `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
   */
  // const siteSearchEngine = 'abc123'

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

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

  async function callEnableAdvancedSiteSearch() {
    // Construct request
    const request = {
      siteSearchEngine,
    };

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

  callEnableAdvancedSiteSearch();

checkRecrawlUrisProgress(name)

checkRecrawlUrisProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.RecrawlUrisResponse, protos.google.cloud.discoveryengine.v1beta.RecrawlUrisMetadata>>;

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

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

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of the
   *  SiteSearchEngine google.cloud.discoveryengine.v1beta.SiteSearchEngine,
   *  such as
   *  `projects/* /locations/* /collections/* /dataStores/* /siteSearchEngine`.
   */
  // const siteSearchEngine = 'abc123'
  /**
   *  Required. List of URIs to crawl. At most 10K URIs are supported, otherwise
   *  an INVALID_ARGUMENT error is thrown. Each URI should match at least one
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite  in
   *  `site_search_engine`.
   */
  // const uris = ['abc','def']

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

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

  async function callRecrawlUris() {
    // Construct request
    const request = {
      siteSearchEngine,
      uris,
    };

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

  callRecrawlUris();

checkUpdateTargetSiteProgress(name)

checkUpdateTargetSiteProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.TargetSite, protos.google.cloud.discoveryengine.v1beta.UpdateTargetSiteMetadata>>;

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

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

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

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The target site to update.
   *  If the caller does not have permission to update the
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite, regardless of
   *  whether or not it exists, a PERMISSION_DENIED error is returned.
   *  If the TargetSite google.cloud.discoveryengine.v1beta.TargetSite  to
   *  update does not exist, a NOT_FOUND error is returned.
   */
  // const targetSite = {}

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

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

  async function callUpdateTargetSite() {
    // Construct request
    const request = {
      targetSite,
    };

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

  callUpdateTargetSite();

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.

createTargetSite(request, options)

createTargetSite(request?: protos.google.cloud.discoveryengine.v1beta.ICreateTargetSiteRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.ICreateTargetSiteMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a .

Parameters
Name	Description
`request`	`ICreateTargetSiteRequest` 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.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.ICreateTargetSiteMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent resource name of
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The TargetSite google.cloud.discoveryengine.v1beta.TargetSite 
   *  to create.
   */
  // const targetSite = {}

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

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

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

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

  callCreateTargetSite();

createTargetSite(request, options, callback)

createTargetSite(request: protos.google.cloud.discoveryengine.v1beta.ICreateTargetSiteRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.ICreateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateTargetSiteRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.ICreateTargetSiteMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createTargetSite(request, callback)

createTargetSite(request: protos.google.cloud.discoveryengine.v1beta.ICreateTargetSiteRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.ICreateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`ICreateTargetSiteRequest`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.ICreateTargetSiteMetadata>, protos.google.longrunning.IOperation \| 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: ''});

deleteTargetSite(request, options)

deleteTargetSite(request?: protos.google.cloud.discoveryengine.v1beta.IDeleteTargetSiteRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteTargetSiteMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a .

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteTargetSiteMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
   *  If the caller does not have permission to access the
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite, regardless of
   *  whether or not it exists, a PERMISSION_DENIED error is returned.
   *  If the requested
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite  does not
   *  exist, a NOT_FOUND error is returned.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteTargetSite();

deleteTargetSite(request, options, callback)

deleteTargetSite(request: protos.google.cloud.discoveryengine.v1beta.IDeleteTargetSiteRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteTargetSiteRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteTargetSiteMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteTargetSite(request, callback)

deleteTargetSite(request: protos.google.cloud.discoveryengine.v1beta.IDeleteTargetSiteRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteTargetSiteRequest`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteTargetSiteMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

disableAdvancedSiteSearch(request, options)

disableAdvancedSiteSearch(request?: protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Downgrade from advanced site search to basic site search.

Parameters
Name	Description
`request`	`IDisableAdvancedSiteSearchRequest` 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.v1beta.IDisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of the
   *  SiteSearchEngine google.cloud.discoveryengine.v1beta.SiteSearchEngine,
   *  such as
   *  `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
   */
  // const siteSearchEngine = 'abc123'

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

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

  async function callDisableAdvancedSiteSearch() {
    // Construct request
    const request = {
      siteSearchEngine,
    };

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

  callDisableAdvancedSiteSearch();

disableAdvancedSiteSearch(request, options, callback)

disableAdvancedSiteSearch(request: protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDisableAdvancedSiteSearchRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

disableAdvancedSiteSearch(request, callback)

disableAdvancedSiteSearch(request: protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDisableAdvancedSiteSearchRequest`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.IDisableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

enableAdvancedSiteSearch(request, options)

enableAdvancedSiteSearch(request?: protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Upgrade from basic site search to advanced site search.

Parameters
Name	Description
`request`	`IEnableAdvancedSiteSearchRequest` 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.v1beta.IEnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of the
   *  SiteSearchEngine google.cloud.discoveryengine.v1beta.SiteSearchEngine,
   *  such as
   *  `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
   */
  // const siteSearchEngine = 'abc123'

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

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

  async function callEnableAdvancedSiteSearch() {
    // Construct request
    const request = {
      siteSearchEngine,
    };

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

  callEnableAdvancedSiteSearch();

enableAdvancedSiteSearch(request, options, callback)

enableAdvancedSiteSearch(request: protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IEnableAdvancedSiteSearchRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

enableAdvancedSiteSearch(request, callback)

enableAdvancedSiteSearch(request: protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IEnableAdvancedSiteSearchRequest`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1beta.IEnableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

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.

fetchDomainVerificationStatus(request, options)

fetchDomainVerificationStatus(request?: protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1beta.ITargetSite[],
        protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusRequest | null,
        protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusResponse
    ]>;

Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.

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

Returns

Type Description

Promise<[
        protos.google.cloud.discoveryengine.v1beta.ITargetSite[],
        protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusRequest | null,
        protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusResponse
    ]>

{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 fetchDomainVerificationStatusAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

fetchDomainVerificationStatus(request, options, callback)

fetchDomainVerificationStatus(request: protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusRequest, protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.ITargetSite>): void;

Parameters
Name	Description
`request`	`IFetchDomainVerificationStatusRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusRequest, protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusResponse \| null \| undefined, protos.google.cloud.discoveryengine.v1beta.ITargetSite>`

Returns
Type	Description
`void`

fetchDomainVerificationStatus(request, callback)

fetchDomainVerificationStatus(request: protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusRequest, protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.ITargetSite>): void;

Parameters
Name	Description
`request`	`IFetchDomainVerificationStatusRequest`
`callback`	`PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusRequest, protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusResponse \| null \| undefined, protos.google.cloud.discoveryengine.v1beta.ITargetSite>`

Returns
Type	Description
`void`

fetchDomainVerificationStatusAsync(request, options)

fetchDomainVerificationStatusAsync(request?: protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1beta.ITargetSite>;

Equivalent to fetchDomainVerificationStatus, but returns an iterable object.

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

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

Returns
Type	Description
`AsyncIterable<protos.google.cloud.discoveryengine.v1beta.ITargetSite>`	{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 site search engine resource under which we fetch all the
   *  domain verification status.
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
   */
  // const siteSearchEngine = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested. If
   *  unspecified, server will pick an appropriate default. The maximum 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, received from a previous `FetchDomainVerificationStatus`
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `FetchDomainVerificationStatus` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

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

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

  async function callFetchDomainVerificationStatus() {
    // Construct request
    const request = {
      siteSearchEngine,
    };

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

  callFetchDomainVerificationStatus();

fetchDomainVerificationStatusStream(request, options)

fetchDomainVerificationStatusStream(request?: protos.google.cloud.discoveryengine.v1beta.IFetchDomainVerificationStatusRequest, options?: CallOptions): Transform;

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

Parameters
Name	Description
`request`	`IFetchDomainVerificationStatusRequest` 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 fetchDomainVerificationStatusAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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)

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`

getSiteSearchEngine(request, options)

getSiteSearchEngine(request?: protos.google.cloud.discoveryengine.v1beta.IGetSiteSearchEngineRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1beta.ISiteSearchEngine,
        (protos.google.cloud.discoveryengine.v1beta.IGetSiteSearchEngineRequest | undefined),
        {} | undefined
    ]>;

Gets the SiteSearchEngine.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.discoveryengine.v1beta.ISiteSearchEngine, (protos.google.cloud.discoveryengine.v1beta.IGetSiteSearchEngineRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing SiteSearchEngine. 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. Resource name of
   *  SiteSearchEngine google.cloud.discoveryengine.v1beta.SiteSearchEngine,
   *  such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
   *  If the caller does not have permission to access the SiteSearchEngine,
   *  regardless of whether or not it exists, a PERMISSION_DENIED error is
   *  returned.
   */
  // const name = 'abc123'

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

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

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

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

  callGetSiteSearchEngine();

getSiteSearchEngine(request, options, callback)

getSiteSearchEngine(request: protos.google.cloud.discoveryengine.v1beta.IGetSiteSearchEngineRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ISiteSearchEngine, protos.google.cloud.discoveryengine.v1beta.IGetSiteSearchEngineRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetSiteSearchEngineRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1beta.ISiteSearchEngine, protos.google.cloud.discoveryengine.v1beta.IGetSiteSearchEngineRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getSiteSearchEngine(request, callback)

getSiteSearchEngine(request: protos.google.cloud.discoveryengine.v1beta.IGetSiteSearchEngineRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ISiteSearchEngine, protos.google.cloud.discoveryengine.v1beta.IGetSiteSearchEngineRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetSiteSearchEngineRequest`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1beta.ISiteSearchEngine, protos.google.cloud.discoveryengine.v1beta.IGetSiteSearchEngineRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getTargetSite(request, options)

getTargetSite(request?: protos.google.cloud.discoveryengine.v1beta.IGetTargetSiteRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1beta.ITargetSite,
        (protos.google.cloud.discoveryengine.v1beta.IGetTargetSiteRequest | undefined),
        {} | undefined
    ]>;

Gets a .

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

Returns
Type	Description
`Promise<[ protos.google.cloud.discoveryengine.v1beta.ITargetSite, (protos.google.cloud.discoveryengine.v1beta.IGetTargetSiteRequest \| 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
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
   *  If the caller does not have permission to access the
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite, regardless of
   *  whether or not it exists, a PERMISSION_DENIED error is returned.
   *  If the requested
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite  does not
   *  exist, a NOT_FOUND error is returned.
   */
  // const name = 'abc123'

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

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

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

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

  callGetTargetSite();

getTargetSite(request, options, callback)

getTargetSite(request: protos.google.cloud.discoveryengine.v1beta.IGetTargetSiteRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.IGetTargetSiteRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetTargetSiteRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.IGetTargetSiteRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getTargetSite(request, callback)

getTargetSite(request: protos.google.cloud.discoveryengine.v1beta.IGetTargetSiteRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.IGetTargetSiteRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetTargetSiteRequest`
`callback`	`Callback<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.IGetTargetSiteRequest \| 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.

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)

listTargetSites(request, options)

listTargetSites(request?: protos.google.cloud.discoveryengine.v1beta.IListTargetSitesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1beta.ITargetSite[],
        protos.google.cloud.discoveryengine.v1beta.IListTargetSitesRequest | null,
        protos.google.cloud.discoveryengine.v1beta.IListTargetSitesResponse
    ]>;

Gets a list of s.

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

Returns

Type Description

Promise<[
        protos.google.cloud.discoveryengine.v1beta.ITargetSite[],
        protos.google.cloud.discoveryengine.v1beta.IListTargetSitesRequest | null,
        protos.google.cloud.discoveryengine.v1beta.IListTargetSitesResponse
    ]>

{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 listTargetSitesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTargetSites(request, options, callback)

listTargetSites(request: protos.google.cloud.discoveryengine.v1beta.IListTargetSitesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListTargetSitesRequest, protos.google.cloud.discoveryengine.v1beta.IListTargetSitesResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.ITargetSite>): void;

Parameters
Name	Description
`request`	`IListTargetSitesRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListTargetSitesRequest, protos.google.cloud.discoveryengine.v1beta.IListTargetSitesResponse \| null \| undefined, protos.google.cloud.discoveryengine.v1beta.ITargetSite>`

Returns
Type	Description
`void`

listTargetSites(request, callback)

listTargetSites(request: protos.google.cloud.discoveryengine.v1beta.IListTargetSitesRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListTargetSitesRequest, protos.google.cloud.discoveryengine.v1beta.IListTargetSitesResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.ITargetSite>): void;

Parameters
Name	Description
`request`	`IListTargetSitesRequest`
`callback`	`PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListTargetSitesRequest, protos.google.cloud.discoveryengine.v1beta.IListTargetSitesResponse \| null \| undefined, protos.google.cloud.discoveryengine.v1beta.ITargetSite>`

Returns
Type	Description
`void`

listTargetSitesAsync(request, options)

listTargetSitesAsync(request?: protos.google.cloud.discoveryengine.v1beta.IListTargetSitesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1beta.ITargetSite>;

Equivalent to listTargetSites, but returns an iterable object.

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

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

Returns
Type	Description
`AsyncIterable<protos.google.cloud.discoveryengine.v1beta.ITargetSite>`	{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 site search engine resource name, such as
   *  `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
   *  If the caller does not have permission to list
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite s under this
   *  site search engine, regardless of whether or not this branch exists, a
   *  PERMISSION_DENIED error is returned.
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested. If
   *  unspecified, server will pick an appropriate default. The maximum 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, received from a previous `ListTargetSites` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListTargetSites`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListTargetSites();

listTargetSitesStream(request, options)

listTargetSitesStream(request?: protos.google.cloud.discoveryengine.v1beta.IListTargetSitesRequest, options?: CallOptions): Transform;

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

Parameters
Name	Description
`request`	`IListTargetSitesRequest` 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 `listTargetSitesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

recrawlUris(request, options)

recrawlUris(request?: protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisResponse, protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Request on-demand recrawl for a list of URIs.

Parameters
Name	Description
`request`	`IRecrawlUrisRequest` 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.v1beta.IRecrawlUrisResponse, protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of the
   *  SiteSearchEngine google.cloud.discoveryengine.v1beta.SiteSearchEngine,
   *  such as
   *  `projects/* /locations/* /collections/* /dataStores/* /siteSearchEngine`.
   */
  // const siteSearchEngine = 'abc123'
  /**
   *  Required. List of URIs to crawl. At most 10K URIs are supported, otherwise
   *  an INVALID_ARGUMENT error is thrown. Each URI should match at least one
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite  in
   *  `site_search_engine`.
   */
  // const uris = ['abc','def']

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

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

  async function callRecrawlUris() {
    // Construct request
    const request = {
      siteSearchEngine,
      uris,
    };

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

  callRecrawlUris();

recrawlUris(request, options, callback)

recrawlUris(request: protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisResponse, protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IRecrawlUrisRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisResponse, protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

recrawlUris(request, callback)

recrawlUris(request: protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisResponse, protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IRecrawlUrisRequest`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisResponse, protos.google.cloud.discoveryengine.v1beta.IRecrawlUrisMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateTargetSite(request, options)

updateTargetSite(request?: protos.google.cloud.discoveryengine.v1beta.IUpdateTargetSiteRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.IUpdateTargetSiteMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a .

Parameters
Name	Description
`request`	`IUpdateTargetSiteRequest` 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.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.IUpdateTargetSiteMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The target site to update.
   *  If the caller does not have permission to update the
   *  TargetSite google.cloud.discoveryengine.v1beta.TargetSite, regardless of
   *  whether or not it exists, a PERMISSION_DENIED error is returned.
   *  If the TargetSite google.cloud.discoveryengine.v1beta.TargetSite  to
   *  update does not exist, a NOT_FOUND error is returned.
   */
  // const targetSite = {}

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

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

  async function callUpdateTargetSite() {
    // Construct request
    const request = {
      targetSite,
    };

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

  callUpdateTargetSite();

updateTargetSite(request, options, callback)

updateTargetSite(request: protos.google.cloud.discoveryengine.v1beta.IUpdateTargetSiteRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.IUpdateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateTargetSiteRequest`
`options`	`CallOptions`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.IUpdateTargetSiteMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateTargetSite(request, callback)

updateTargetSite(request: protos.google.cloud.discoveryengine.v1beta.IUpdateTargetSiteRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.IUpdateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IUpdateTargetSiteRequest`
`callback`	`Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.ITargetSite, protos.google.cloud.discoveryengine.v1beta.IUpdateTargetSiteMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`