Class v1.ControlServiceClient (1.9.0)

Version latest

• 1.9.0 (latest)
• 1.7.0
• 1.6.0
• 1.4.1
• 1.3.1
• 1.2.0
• 1.0.0
• 0.6.0
• 0.5.0
• 0.3.1
• 0.2.0

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request. v1

Package

@google-cloud/discoveryengine

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of ControlServiceClient.

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

controlServiceStub

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

descriptors

descriptors: Descriptors;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

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

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.

createControl(request, options)

createControl(request?: protos.google.cloud.discoveryengine.v1.ICreateControlRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1.IControl,
        protos.google.cloud.discoveryengine.v1.ICreateControlRequest | undefined,
        {} | undefined
    ]>;

Creates a Control.

By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the to create already exists, an ALREADY_EXISTS error is returned.

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

Returns
Type	Description
Promise<[ protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.ICreateControlRequest | 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 parent data store. Format:
   *  `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
   *  or
   *  `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Control to create.
   */
  // const control = {}
  /**
   *  Required. The ID to use for the Control, which will become the final
   *  component of the Control's resource name.
   *  This value must be within 1-63 characters.
   *  Valid characters are /[a-z][0-9]-_/.
   */
  // const controlId = 'abc123'

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

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

  async function callCreateControl() {
    // Construct request
    const request = {
      parent,
      control,
      controlId,
    };

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

  callCreateControl();

createControl(request, options, callback)

createControl(request: protos.google.cloud.discoveryengine.v1.ICreateControlRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.ICreateControlRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateControlRequest
options	CallOptions
callback	Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.ICreateControlRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createControl(request, callback)

createControl(request: protos.google.cloud.discoveryengine.v1.ICreateControlRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.ICreateControlRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateControlRequest
callback	Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.ICreateControlRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteControl(request, options)

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

Deletes a Control.

If the to delete does not exist, a NOT_FOUND error is returned.

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

Returns
Type	Description
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1.IDeleteControlRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

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

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

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

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

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

  callDeleteControl();

deleteControl(request, options, callback)

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

Parameters
Name	Description
request	IDeleteControlRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1.IDeleteControlRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteControl(request, callback)

deleteControl(request: protos.google.cloud.discoveryengine.v1.IDeleteControlRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1.IDeleteControlRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteControlRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1.IDeleteControlRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

enginePath(project, location, collection, engine)

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

Return a fully-qualified engine resource name string.

Parameters
Name	Description
project	string
location	string
collection	string
engine	string

Returns
Type	Description
string	{string} Resource name string.

getControl(request, options)

getControl(request?: protos.google.cloud.discoveryengine.v1.IGetControlRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1.IControl,
        protos.google.cloud.discoveryengine.v1.IGetControlRequest | undefined,
        {} | undefined
    ]>;

Gets a Control.

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

Returns
Type	Description
Promise<[ protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.IGetControlRequest | 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 resource name of the Control to get. Format:
   *  `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetControl();

getControl(request, options, callback)

getControl(request: protos.google.cloud.discoveryengine.v1.IGetControlRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.IGetControlRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetControlRequest
options	CallOptions
callback	Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.IGetControlRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getControl(request, callback)

getControl(request: protos.google.cloud.discoveryengine.v1.IGetControlRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.IGetControlRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetControlRequest
callback	Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.IGetControlRequest | 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);

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.

listControls(request, options)

listControls(request?: protos.google.cloud.discoveryengine.v1.IListControlsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1.IControl[],
        protos.google.cloud.discoveryengine.v1.IListControlsRequest | null,
        protos.google.cloud.discoveryengine.v1.IListControlsResponse
    ]>;

Lists all Controls by their parent .

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

Returns
Type	Description
Promise<[ protos.google.cloud.discoveryengine.v1.IControl[], protos.google.cloud.discoveryengine.v1.IListControlsRequest | null, protos.google.cloud.discoveryengine.v1.IListControlsResponse ]>	{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 listControlsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listControls(request, options, callback)

listControls(request: protos.google.cloud.discoveryengine.v1.IListControlsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1.IListControlsRequest, protos.google.cloud.discoveryengine.v1.IListControlsResponse | null | undefined, protos.google.cloud.discoveryengine.v1.IControl>): void;

Parameters
Name	Description
request	IListControlsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.discoveryengine.v1.IListControlsRequest, protos.google.cloud.discoveryengine.v1.IListControlsResponse | null | undefined, protos.google.cloud.discoveryengine.v1.IControl>

Returns
Type	Description
void

listControls(request, callback)

listControls(request: protos.google.cloud.discoveryengine.v1.IListControlsRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1.IListControlsRequest, protos.google.cloud.discoveryengine.v1.IListControlsResponse | null | undefined, protos.google.cloud.discoveryengine.v1.IControl>): void;

Parameters
Name	Description
request	IListControlsRequest
callback	PaginationCallback<protos.google.cloud.discoveryengine.v1.IListControlsRequest, protos.google.cloud.discoveryengine.v1.IListControlsResponse | null | undefined, protos.google.cloud.discoveryengine.v1.IControl>

Returns
Type	Description
void

listControlsAsync(request, options)

listControlsAsync(request?: protos.google.cloud.discoveryengine.v1.IListControlsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.IControl>;

Equivalent to listControls, but returns an iterable object.

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

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

Returns
Type	Description
AsyncIterable<protos.google.cloud.discoveryengine.v1.IControl>	{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 data store resource name. Format:
   *  `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
   *  or
   *  `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Maximum number of results to return. If unspecified, defaults
   *  to 50. Max allowed value is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListControls` call.
   *  Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. A filter to apply on the list results. Supported features:
   *  * List all the products under the parent branch if
   *  filter google.cloud.discoveryengine.v1.ListControlsRequest.filter  is
   *  unset. Currently this field is unsupported.
   */
  // const filter = 'abc123'

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

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

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

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

  callListControls();

listControlsStream(request, options)

listControlsStream(request?: protos.google.cloud.discoveryengine.v1.IListControlsRequest, options?: CallOptions): Transform;

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

Parameters
Name	Description
request	IListControlsRequest 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 listControlsAsync() 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
}

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	{string} Resource name string.

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.

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.

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

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

matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the branch from ProjectLocationDataStoreBranchDocument resource.

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

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

matchCollectionFromEngineName(engineName)

matchCollectionFromEngineName(engineName: string): string | number;

Parse the collection from Engine resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.

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

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

matchCollectionFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName)

matchCollectionFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreControl resource.

Parameter
Name	Description
projectLocationCollectionDataStoreControlName	string A fully-qualified path representing project_location_collection_data_store_control 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.

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.

matchCollectionFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName)

matchCollectionFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineControl resource.

Parameter
Name	Description
projectLocationCollectionEngineControlName	string A fully-qualified path representing project_location_collection_engine_control 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.

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.

matchControlFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName)

matchControlFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;

Parse the control from ProjectLocationCollectionDataStoreControl resource.

Parameter
Name	Description
projectLocationCollectionDataStoreControlName	string A fully-qualified path representing project_location_collection_data_store_control resource.

Returns
Type	Description
string | number	{string} A string representing the control.

matchControlFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName)

matchControlFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;

Parse the control from ProjectLocationCollectionEngineControl resource.

Parameter
Name	Description
projectLocationCollectionEngineControlName	string A fully-qualified path representing project_location_collection_engine_control resource.

Returns
Type	Description
string | number	{string} A string representing the control.

matchControlFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName)

matchControlFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;

Parse the control from ProjectLocationDataStoreControl resource.

Parameter
Name	Description
projectLocationDataStoreControlName	string A fully-qualified path representing project_location_data_store_control resource.

Returns
Type	Description
string | number	{string} A string representing the control.

matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName)

matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;

Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.

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

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

matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName)

matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;

Parse the conversation from ProjectLocationCollectionEngineConversation resource.

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

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

matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName)

matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;

Parse the conversation from ProjectLocationDataStoreConversation resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.

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

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

matchDataStoreFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName)

matchDataStoreFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreControl resource.

Parameter
Name	Description
projectLocationCollectionDataStoreControlName	string A fully-qualified path representing project_location_collection_data_store_control 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.

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.

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.

matchDataStoreFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName)

matchDataStoreFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;

Parse the data_store from ProjectLocationDataStoreControl resource.

Parameter
Name	Description
projectLocationDataStoreControlName	string A fully-qualified path representing project_location_data_store_control 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.

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.

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.

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

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

matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the document from ProjectLocationDataStoreBranchDocument resource.

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

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

matchEngineFromEngineName(engineName)

matchEngineFromEngineName(engineName: string): string | number;

Parse the engine from Engine resource.

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

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

matchEngineFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName)

matchEngineFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineControl resource.

Parameter
Name	Description
projectLocationCollectionEngineControlName	string A fully-qualified path representing project_location_collection_engine_control 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.

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.

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.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name	Description
locationName	string A fully-qualified path representing Location 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.

matchLocationFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName)

matchLocationFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreControl resource.

Parameter
Name	Description
projectLocationCollectionDataStoreControlName	string A fully-qualified path representing project_location_collection_data_store_control 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.

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.

matchLocationFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName)

matchLocationFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;

Parse the location from ProjectLocationCollectionEngineControl resource.

Parameter
Name	Description
projectLocationCollectionEngineControlName	string A fully-qualified path representing project_location_collection_engine_control 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.

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.

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.

matchLocationFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName)

matchLocationFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;

Parse the location from ProjectLocationDataStoreControl resource.

Parameter
Name	Description
projectLocationDataStoreControlName	string A fully-qualified path representing project_location_data_store_control 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.

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.

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.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name	Description
locationName	string A fully-qualified path representing Location 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.

matchProjectFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName)

matchProjectFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreControl resource.

Parameter
Name	Description
projectLocationCollectionDataStoreControlName	string A fully-qualified path representing project_location_collection_data_store_control 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.

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.

matchProjectFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName)

matchProjectFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName: string): string | number;

Parse the project from ProjectLocationCollectionEngineControl resource.

Parameter
Name	Description
projectLocationCollectionEngineControlName	string A fully-qualified path representing project_location_collection_engine_control 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.

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.

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.

matchProjectFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName)

matchProjectFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName: string): string | number;

Parse the project from ProjectLocationDataStoreControl resource.

Parameter
Name	Description
projectLocationDataStoreControlName	string A fully-qualified path representing project_location_data_store_control 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.

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.

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.

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.

projectLocationCollectionDataStoreControlPath(project, location, collection, dataStore, control)

projectLocationCollectionDataStoreControlPath(project: string, location: string, collection: string, dataStore: string, control: string): string;

Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.

Parameters
Name	Description
project	string
location	string
collection	string
dataStore	string
control	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.

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.

projectLocationCollectionEngineControlPath(project, location, collection, engine, control)

projectLocationCollectionEngineControlPath(project: string, location: string, collection: string, engine: string, control: string): string;

Return a fully-qualified projectLocationCollectionEngineControl resource name string.

Parameters
Name	Description
project	string
location	string
collection	string
engine	string
control	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.

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.

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.

projectLocationDataStoreControlPath(project, location, dataStore, control)

projectLocationDataStoreControlPath(project: string, location: string, dataStore: string, control: string): string;

Return a fully-qualified projectLocationDataStoreControl resource name string.

Parameters
Name	Description
project	string
location	string
dataStore	string
control	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.

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.

updateControl(request, options)

updateControl(request?: protos.google.cloud.discoveryengine.v1.IUpdateControlRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1.IControl,
        protos.google.cloud.discoveryengine.v1.IUpdateControlRequest | undefined,
        {} | undefined
    ]>;

Updates a Control.

action type cannot be changed. If the to update does not exist, a NOT_FOUND error is returned.

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

Returns
Type	Description
Promise<[ protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.IUpdateControlRequest | 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 Control to update.
   */
  // const control = {}
  /**
   *  Optional. Indicates which fields in the provided
   *  Control google.cloud.discoveryengine.v1.Control  to update. The following
   *  are NOT supported:
   *  * Control.name google.cloud.discoveryengine.v1.Control.name 
   *  * Control.solution_type google.cloud.discoveryengine.v1.Control.solution_type 
   *  If not set or empty, all supported fields are updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateControl() {
    // Construct request
    const request = {
      control,
    };

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

  callUpdateControl();

updateControl(request, options, callback)

updateControl(request: protos.google.cloud.discoveryengine.v1.IUpdateControlRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.IUpdateControlRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateControlRequest
options	CallOptions
callback	Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.IUpdateControlRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateControl(request, callback)

updateControl(request: protos.google.cloud.discoveryengine.v1.IUpdateControlRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.IUpdateControlRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateControlRequest
callback	Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.IUpdateControlRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void