Class v1alpha.EngineServiceClient (1.7.0)

Service for managing configuration. v1alpha

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of EngineServiceClient.

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

engineServiceStub

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

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

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

Methods

aclConfigPath(project, location)

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

Return a fully-qualified aclConfig resource name string.

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

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

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
`request`	`CancelOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} \| undefined \| null>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} \| undefined \| null>` The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<protos.google.protobuf.Empty>`

Example


const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateEngineProgress(name)

checkCreateEngineProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.Engine, protos.google.cloud.discoveryengine.v1alpha.CreateEngineMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.Engine, protos.google.cloud.discoveryengine.v1alpha.CreateEngineMetadata>>`	{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 name, such as
   *  `projects/{project}/locations/{location}/collections/{collection}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Engine google.cloud.discoveryengine.v1alpha.Engine  to
   *  create.
   */
  // const engine = {}
  /**
   *  Required. The ID to use for the
   *  Engine google.cloud.discoveryengine.v1alpha.Engine, which will become
   *  the final component of the
   *  Engine google.cloud.discoveryengine.v1alpha.Engine's resource name.
   *  This field must conform to RFC-1034 (https://tools.ietf.org/html/rfc1034)
   *  standard with a length limit of 63 characters. Otherwise, an
   *  INVALID_ARGUMENT error is returned.
   */
  // const engineId = 'abc123'

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

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

  async function callCreateEngine() {
    // Construct request
    const request = {
      parent,
      engine,
      engineId,
    };

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

  callCreateEngine();

checkDeleteEngineProgress(name)

checkDeleteEngineProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1alpha.DeleteEngineMetadata>>;

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

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.v1alpha.DeleteEngineMetadata>>`	{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
   *  Engine google.cloud.discoveryengine.v1alpha.Engine, such as
   *  `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
   *  If the caller does not have permission to delete the
   *  Engine google.cloud.discoveryengine.v1alpha.Engine, regardless of
   *  whether or not it exists, a PERMISSION_DENIED error is returned.
   *  If the Engine google.cloud.discoveryengine.v1alpha.Engine  to delete does
   *  not exist, a NOT_FOUND error is returned.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteEngine();

checkTuneEngineProgress(name)

checkTuneEngineProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.TuneEngineResponse, protos.google.cloud.discoveryengine.v1alpha.TuneEngineMetadata>>;

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

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

Returns
Type	Description
`Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.TuneEngineResponse, protos.google.cloud.discoveryengine.v1alpha.TuneEngineMetadata>>`	{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 resource name of the engine to tune.
   *  Format:
   *  `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callTuneEngine();

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.

collectionPath(project, location, collection)

collectionPath(project: string, location: string, collection: string): string;

Return a fully-qualified collection resource name string.

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

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

createEngine(request, options)

createEngine(request?: protos.google.cloud.discoveryengine.v1alpha.ICreateEngineRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.ICreateEngineMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a .

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.ICreateEngineMetadata>, 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 name, such as
   *  `projects/{project}/locations/{location}/collections/{collection}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Engine google.cloud.discoveryengine.v1alpha.Engine  to
   *  create.
   */
  // const engine = {}
  /**
   *  Required. The ID to use for the
   *  Engine google.cloud.discoveryengine.v1alpha.Engine, which will become
   *  the final component of the
   *  Engine google.cloud.discoveryengine.v1alpha.Engine's resource name.
   *  This field must conform to RFC-1034 (https://tools.ietf.org/html/rfc1034)
   *  standard with a length limit of 63 characters. Otherwise, an
   *  INVALID_ARGUMENT error is returned.
   */
  // const engineId = 'abc123'

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

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

  async function callCreateEngine() {
    // Construct request
    const request = {
      parent,
      engine,
      engineId,
    };

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

  callCreateEngine();

createEngine(request, options, callback)

createEngine(request: protos.google.cloud.discoveryengine.v1alpha.ICreateEngineRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.ICreateEngineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

createEngine(request, callback)

createEngine(request: protos.google.cloud.discoveryengine.v1alpha.ICreateEngineRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.ICreateEngineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

deleteEngine(request, options)

deleteEngine(request?: protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a .

Parameters
Name	Description
`request`	`IDeleteEngineRequest` 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.v1alpha.IDeleteEngineMetadata>, 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
   *  Engine google.cloud.discoveryengine.v1alpha.Engine, such as
   *  `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
   *  If the caller does not have permission to delete the
   *  Engine google.cloud.discoveryengine.v1alpha.Engine, regardless of
   *  whether or not it exists, a PERMISSION_DENIED error is returned.
   *  If the Engine google.cloud.discoveryengine.v1alpha.Engine  to delete does
   *  not exist, a NOT_FOUND error is returned.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteEngine();

deleteEngine(request, options, callback)

deleteEngine(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

deleteEngine(request, callback)

deleteEngine(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IDeleteEngineRequest`
`callback`	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineMetadata>, 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: ''});

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.

getEngine(request, options)

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

Gets a .

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

Returns
Type	Description
`Promise<[ protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IGetEngineRequest \| 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
   *  Engine google.cloud.discoveryengine.v1alpha.Engine, such as
   *  `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callGetEngine();

getEngine(request, options, callback)

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

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

Returns
Type	Description
`void`

getEngine(request, callback)

getEngine(request: protos.google.cloud.discoveryengine.v1alpha.IGetEngineRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IGetEngineRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

getLocation(request, options, callback)

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

Gets information about a location.

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

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

Example


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

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
`request`	`GetOperationRequest` The request object that will be sent.
`options`	`CallOptions \| Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`callback`	`Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
`Promise<[protos.google.longrunning.Operation]>`

Example


const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

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`

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.

listEngines(request, options)

listEngines(request?: protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1alpha.IEngine[],
        protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest | null,
        protos.google.cloud.discoveryengine.v1alpha.IListEnginesResponse
    ]>;

Lists all the s associated with the project.

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

Returns

Type Description

Promise<[
        protos.google.cloud.discoveryengine.v1alpha.IEngine[],
        protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest | null,
        protos.google.cloud.discoveryengine.v1alpha.IListEnginesResponse
    ]>

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

listEngines(request, options, callback)

listEngines(request: protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, protos.google.cloud.discoveryengine.v1alpha.IListEnginesResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.IEngine>): void;

Parameters
Name	Description
`request`	`IListEnginesRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, protos.google.cloud.discoveryengine.v1alpha.IListEnginesResponse \| null \| undefined, protos.google.cloud.discoveryengine.v1alpha.IEngine>`

Returns
Type	Description
`void`

listEngines(request, callback)

listEngines(request: protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, protos.google.cloud.discoveryengine.v1alpha.IListEnginesResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.IEngine>): void;

Parameters
Name	Description
`request`	`IListEnginesRequest`
`callback`	`PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, protos.google.cloud.discoveryengine.v1alpha.IListEnginesResponse \| null \| undefined, protos.google.cloud.discoveryengine.v1alpha.IEngine>`

Returns
Type	Description
`void`

listEnginesAsync(request, options)

listEnginesAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.IEngine>;

Equivalent to listEngines, but returns an iterable object.

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

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

Returns
Type	Description
`AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.IEngine>`	{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 resource name, such as
   *  `projects/{project}/locations/{location}/collections/{collection_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Not supported.
   */
  // const pageSize = 1234
  /**
   *  Optional. Not supported.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Filter by solution type. For example:
   *  solution_type=SOLUTION_TYPE_SEARCH
   */
  // const filter = 'abc123'

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

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

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

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

  callListEngines();

listEnginesStream(request, options)

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

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

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

listLocationsAsync(request, options)

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

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

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

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

Returns
Type	Description
`AsyncIterable<google.cloud.location.ILocation>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example


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

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name	Description
`request`	`ListOperationsRequest` The request object that will be sent.
`options`	`CallOptions` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type	Description
`AsyncIterable<protos.google.longrunning.ListOperationsResponse>`	{Object} An iterable Object that conforms to iteration protocols.

Example


const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the answer from ProjectLocationCollectionDataStoreSessionAnswer resource.

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

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

matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the answer from ProjectLocationCollectionEngineSessionAnswer resource.

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

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

matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the answer from ProjectLocationDataStoreSessionAnswer resource.

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

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

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

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

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

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.

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

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

matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.

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

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

matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the branch from ProjectLocationDataStoreBranchDocument resource.

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

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

matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

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

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

matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.

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

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

matchCollectionFromCollectionName(collectionName)

matchCollectionFromCollectionName(collectionName: string): string | number;

Parse the collection from Collection resource.

Parameter
Name	Description
`collectionName`	`string` A fully-qualified path representing Collection resource.

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

matchCollectionFromEngineName(engineName)

matchCollectionFromEngineName(engineName: string): string | number;

Parse the collection from Engine resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreConversation resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchCollectionFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStore resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSchema resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchCollectionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSessionAnswer resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchCollectionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSession resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName)

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

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

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

matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineConversation resource.

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

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

matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineServingConfig resource.

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

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

matchCollectionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchCollectionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineSessionAnswer resource.

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

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

matchCollectionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchCollectionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineSession resource.

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

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

matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.

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

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

matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the conversation from ProjectLocationCollectionEngineConversation resource.

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

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

matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the conversation from ProjectLocationDataStoreConversation resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchDataStoreFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStore resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchDataStoreFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSessionAnswer resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchDataStoreFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSession resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName)

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

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

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

matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.

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

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

matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the data_store from ProjectLocationDataStoreBranchDocument resource.

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

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

matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the data_store from ProjectLocationDataStoreConversation resource.

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

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

matchDataStoreFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName)

matchDataStoreFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;

Parse the data_store from ProjectLocationDataStoreDocumentProcessingConfig resource.

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

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

matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the data_store from ProjectLocationDataStore resource.

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

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

matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSchema resource.

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

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

matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the data_store from ProjectLocationDataStoreServingConfig resource.

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

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

matchDataStoreFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchDataStoreFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSessionAnswer resource.

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

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

matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName)

matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSession resource.

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

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

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName)

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.

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

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

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

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

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

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

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

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

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.

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

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

matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.

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

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

matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the document from ProjectLocationDataStoreBranchDocument resource.

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

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

matchEngineFromEngineName(engineName)

matchEngineFromEngineName(engineName: string): string | number;

Parse the engine from Engine resource.

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

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

matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineConversation resource.

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

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

matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineServingConfig resource.

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

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

matchEngineFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchEngineFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineSessionAnswer resource.

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

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

matchEngineFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchEngineFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineSession resource.

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

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

matchLocationFromAclConfigName(aclConfigName)

matchLocationFromAclConfigName(aclConfigName: string): string | number;

Parse the location from AclConfig resource.

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

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

matchLocationFromCollectionName(collectionName)

matchLocationFromCollectionName(collectionName: string): string | number;

Parse the location from Collection resource.

Parameter
Name	Description
`collectionName`	`string` A fully-qualified path representing Collection resource.

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

matchLocationFromEngineName(engineName)

matchLocationFromEngineName(engineName: string): string | number;

Parse the location from Engine resource.

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

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

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

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

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

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.

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

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

matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreConversation resource.

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

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

matchLocationFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchLocationFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

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

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

matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the location from ProjectLocationCollectionDataStore resource.

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

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

matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSchema resource.

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

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

matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.

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

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

matchLocationFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchLocationFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSessionAnswer resource.

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

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

matchLocationFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchLocationFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSession resource.

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

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

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName)

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.

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

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

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

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

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

matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the location from ProjectLocationCollectionEngineConversation resource.

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

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

matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the location from ProjectLocationCollectionEngineServingConfig resource.

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

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

matchLocationFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchLocationFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the location from ProjectLocationCollectionEngineSessionAnswer resource.

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

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

matchLocationFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchLocationFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the location from ProjectLocationCollectionEngineSession resource.

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

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

matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.

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

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

matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the location from ProjectLocationDataStoreBranchDocument resource.

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

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

matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the location from ProjectLocationDataStoreConversation resource.

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

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

matchLocationFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName)

matchLocationFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;

Parse the location from ProjectLocationDataStoreDocumentProcessingConfig resource.

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

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

matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the location from ProjectLocationDataStore resource.

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

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

matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the location from ProjectLocationDataStoreSchema resource.

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

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

matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the location from ProjectLocationDataStoreServingConfig resource.

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

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

matchLocationFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchLocationFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the location from ProjectLocationDataStoreSessionAnswer resource.

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

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

matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName)

matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;

Parse the location from ProjectLocationDataStoreSession resource.

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

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

matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName)

matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;

Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.

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

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

matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

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

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

matchProjectFromAclConfigName(aclConfigName)

matchProjectFromAclConfigName(aclConfigName: string): string | number;

Parse the project from AclConfig resource.

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

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

matchProjectFromCollectionName(collectionName)

matchProjectFromCollectionName(collectionName: string): string | number;

Parse the project from Collection resource.

Parameter
Name	Description
`collectionName`	`string` A fully-qualified path representing Collection resource.

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

matchProjectFromEngineName(engineName)

matchProjectFromEngineName(engineName: string): string | number;

Parse the project from Engine resource.

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

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

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

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

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

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.

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

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

matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreConversation resource.

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

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

matchProjectFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchProjectFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

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

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

matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the project from ProjectLocationCollectionDataStore resource.

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

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

matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSchema resource.

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

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

matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.

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

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

matchProjectFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchProjectFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSessionAnswer resource.

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

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

matchProjectFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchProjectFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSession resource.

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

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

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName)

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.

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

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

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

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

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

matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the project from ProjectLocationCollectionEngineConversation resource.

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

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

matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the project from ProjectLocationCollectionEngineServingConfig resource.

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

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

matchProjectFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchProjectFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the project from ProjectLocationCollectionEngineSessionAnswer resource.

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

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

matchProjectFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchProjectFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the project from ProjectLocationCollectionEngineSession resource.

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

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

matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.

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

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

matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the project from ProjectLocationDataStoreBranchDocument resource.

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

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

matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the project from ProjectLocationDataStoreConversation resource.

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

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

matchProjectFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName)

matchProjectFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;

Parse the project from ProjectLocationDataStoreDocumentProcessingConfig resource.

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

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

matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the project from ProjectLocationDataStore resource.

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

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

matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the project from ProjectLocationDataStoreSchema resource.

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

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

matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the project from ProjectLocationDataStoreServingConfig resource.

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

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

matchProjectFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchProjectFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the project from ProjectLocationDataStoreSessionAnswer resource.

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

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

matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName)

matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;

Parse the project from ProjectLocationDataStoreSession resource.

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

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

matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName)

matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;

Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.

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

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

matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

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

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

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

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

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

matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the schema from ProjectLocationCollectionDataStoreSchema resource.

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

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

matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the schema from ProjectLocationDataStoreSchema resource.

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

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

matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.

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

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

matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.

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

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

matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the serving_config from ProjectLocationDataStoreServingConfig resource.

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

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

matchSessionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchSessionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the session from ProjectLocationCollectionDataStoreSessionAnswer resource.

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

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

matchSessionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName)

matchSessionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;

Parse the session from ProjectLocationCollectionDataStoreSession resource.

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

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

matchSessionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchSessionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the session from ProjectLocationCollectionEngineSessionAnswer resource.

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

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

matchSessionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName)

matchSessionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;

Parse the session from ProjectLocationCollectionEngineSession resource.

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

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

matchSessionFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchSessionFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the session from ProjectLocationDataStoreSessionAnswer resource.

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

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

matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName)

matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;

Parse the session from ProjectLocationDataStoreSession resource.

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

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

matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

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

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

matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

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

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

pauseEngine(request, options)

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

Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.discoveryengine.v1alpha.IEngine, (protos.google.cloud.discoveryengine.v1alpha.IPauseEngineRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the engine to pause.
   *  Format:
   *  `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callPauseEngine();

pauseEngine(request, options, callback)

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

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

Returns
Type	Description
`void`

pauseEngine(request, callback)

pauseEngine(request: protos.google.cloud.discoveryengine.v1alpha.IPauseEngineRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IPauseEngineRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

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

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

Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.

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

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

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

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

Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.

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

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

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

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

Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.

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

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

projectLocationCollectionDataStoreDocumentProcessingConfigPath(project, location, collection, dataStore)

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

Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.

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

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

projectLocationCollectionDataStorePath(project, location, collection, dataStore)

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

Return a fully-qualified projectLocationCollectionDataStore resource name string.

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

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

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

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

Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.

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

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

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

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

Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.

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

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

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

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

Return a fully-qualified projectLocationCollectionDataStoreSessionAnswer resource name string.

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

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

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

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

Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.

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

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

projectLocationCollectionDataStoreSiteSearchEnginePath(project, location, collection, dataStore)

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

Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.

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

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

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

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

Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.

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

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

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

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

Return a fully-qualified projectLocationCollectionEngineConversation resource name string.

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

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

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

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

Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.

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

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

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

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

Return a fully-qualified projectLocationCollectionEngineSessionAnswer resource name string.

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

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

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

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

Return a fully-qualified projectLocationCollectionEngineSession resource name string.

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

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

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

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

Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.

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

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

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

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

Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.

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

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

projectLocationDataStoreConversationPath(project, location, dataStore, conversation)

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

Return a fully-qualified projectLocationDataStoreConversation resource name string.

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

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

projectLocationDataStoreDocumentProcessingConfigPath(project, location, dataStore)

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

Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.

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

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

projectLocationDataStorePath(project, location, dataStore)

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

Return a fully-qualified projectLocationDataStore resource name string.

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

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

projectLocationDataStoreSchemaPath(project, location, dataStore, schema)

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

Return a fully-qualified projectLocationDataStoreSchema resource name string.

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

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

projectLocationDataStoreServingConfigPath(project, location, dataStore, servingConfig)

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

Return a fully-qualified projectLocationDataStoreServingConfig resource name string.

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

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

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

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

Return a fully-qualified projectLocationDataStoreSessionAnswer resource name string.

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

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

projectLocationDataStoreSessionPath(project, location, dataStore, session)

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

Return a fully-qualified projectLocationDataStoreSession resource name string.

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

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

projectLocationDataStoreSiteSearchEnginePath(project, location, dataStore)

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

Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.

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

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

projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite)

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

Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.

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

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

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name	Description
`project`	`string`

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

resumeEngine(request, options)

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

Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

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

Returns
Type	Description
`Promise<[ protos.google.cloud.discoveryengine.v1alpha.IEngine, (protos.google.cloud.discoveryengine.v1alpha.IResumeEngineRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example


  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the engine to resume.
   *  Format:
   *  `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callResumeEngine();

resumeEngine(request, options, callback)

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

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

Returns
Type	Description
`void`

resumeEngine(request, callback)

resumeEngine(request: protos.google.cloud.discoveryengine.v1alpha.IResumeEngineRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IResumeEngineRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

tuneEngine(request, options)

tuneEngine(request?: protos.google.cloud.discoveryengine.v1alpha.ITuneEngineRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.discoveryengine.v1alpha.ITuneEngineResponse, protos.google.cloud.discoveryengine.v1alpha.ITuneEngineMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

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

Returns
Type	Description
`Promise<[ LROperation<protos.google.cloud.discoveryengine.v1alpha.ITuneEngineResponse, protos.google.cloud.discoveryengine.v1alpha.ITuneEngineMetadata>, 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 resource name of the engine to tune.
   *  Format:
   *  `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callTuneEngine();

tuneEngine(request, options, callback)

tuneEngine(request: protos.google.cloud.discoveryengine.v1alpha.ITuneEngineRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ITuneEngineResponse, protos.google.cloud.discoveryengine.v1alpha.ITuneEngineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

tuneEngine(request, callback)

tuneEngine(request: protos.google.cloud.discoveryengine.v1alpha.ITuneEngineRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ITuneEngineResponse, protos.google.cloud.discoveryengine.v1alpha.ITuneEngineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`

updateEngine(request, options)

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

Updates an

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

Returns
Type	Description
`Promise<[ protos.google.cloud.discoveryengine.v1alpha.IEngine, (protos.google.cloud.discoveryengine.v1alpha.IUpdateEngineRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example


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

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

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

  async function callUpdateEngine() {
    // Construct request
    const request = {
      engine,
    };

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

  callUpdateEngine();

updateEngine(request, options, callback)

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

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

Returns
Type	Description
`void`

updateEngine(request, callback)

updateEngine(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateEngineRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IUpdateEngineRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
`void`