Class v1beta.LicenseConfigServiceClient (2.8.0)

Service for managing license config related resources. v1beta

Package

@google-cloud/discoveryengine

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of LicenseConfigServiceClient.

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

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

licenseConfigServiceStub

licenseConfigServiceStub?: Promise<{
        [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

aclConfigPath(project, location)

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

Return a fully-qualified aclConfig resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

assistAnswerPath(project, location, collection, engine, session, assistAnswer)

assistAnswerPath(project: string, location: string, collection: string, engine: string, session: string, assistAnswer: string): string;

Return a fully-qualified assistAnswer resource name string.

Parameters
Name Description
project string
location string
collection string
engine string
session string
assistAnswer string
Returns
Type Description
string

{string} Resource name string.

assistantPath(project, location, collection, engine, assistant)

assistantPath(project: string, location: string, collection: string, engine: string, assistant: string): string;

Return a fully-qualified assistant resource name string.

Parameters
Name Description
project string
location string
collection string
engine string
assistant string
Returns
Type Description
string

{string} Resource name string.

billingAccountLicenseConfigPath(billingAccount, billingAccountLicenseConfig)

billingAccountLicenseConfigPath(billingAccount: string, billingAccountLicenseConfig: string): string;

Return a fully-qualified billingAccountLicenseConfig resource name string.

Parameters
Name Description
billingAccount string
billingAccountLicenseConfig string
Returns
Type Description
string

{string} Resource name string.

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.

createLicenseConfig(request, options)

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

Creates a This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.

Parameters
Name Description
request ICreateLicenseConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, (protos.google.cloud.discoveryengine.v1beta.ICreateLicenseConfigRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource name, such as
   *  `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The
   *  LicenseConfig google.cloud.discoveryengine.v1beta.LicenseConfig  to
   *  create.
   */
  // const licenseConfig = {}
  /**
   *  Optional. The ID to use for the
   *  LicenseConfig google.cloud.discoveryengine.v1beta.LicenseConfig, which
   *  will become the final component of the
   *  LicenseConfig google.cloud.discoveryengine.v1beta.LicenseConfig's
   *  resource name. We are using the tier (product edition) name as the license
   *  config id such as `search` or `search_and_assistant`.
   */
  // const licenseConfigId = 'abc123'

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

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

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

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

  callCreateLicenseConfig();

createLicenseConfig(request, options, callback)

createLicenseConfig(request: protos.google.cloud.discoveryengine.v1beta.ICreateLicenseConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, protos.google.cloud.discoveryengine.v1beta.ICreateLicenseConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateLicenseConfigRequest
options CallOptions
callback Callback<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, protos.google.cloud.discoveryengine.v1beta.ICreateLicenseConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createLicenseConfig(request, callback)

createLicenseConfig(request: protos.google.cloud.discoveryengine.v1beta.ICreateLicenseConfigRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, protos.google.cloud.discoveryengine.v1beta.ICreateLicenseConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateLicenseConfigRequest
callback Callback<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, protos.google.cloud.discoveryengine.v1beta.ICreateLicenseConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

distributeLicenseConfig(request, options)

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

Distributes a from billing account level to project level.

Parameters
Name Description
request IDistributeLicenseConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.discoveryengine.v1beta.IDistributeLicenseConfigResponse, (protos.google.cloud.discoveryengine.v1beta.IDistributeLicenseConfigRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DistributeLicenseConfigResponse. 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 BillingAccountLicenseConfig .
   *  Format:
   *  `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.
   */
  // const billingAccountLicenseConfig = 'abc123'
  /**
   *  Required. The target GCP project number to distribute the license config
   *  to.
   */
  // const projectNumber = 1234
  /**
   *  Required. The target GCP project region to distribute the license config
   *  to.
   */
  // const location = 'abc123'
  /**
   *  Required. The number of licenses to distribute.
   */
  // const licenseCount = 1234
  /**
   *  Optional. Distribute seats to this license config instead of creating a new
   *  one. If not specified, a new license config will be created from the
   *  billing account license config.
   */
  // const licenseConfigId = 'abc123'

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

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

  async function callDistributeLicenseConfig() {
    // Construct request
    const request = {
      billingAccountLicenseConfig,
      projectNumber,
      location,
      licenseCount,
    };

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

  callDistributeLicenseConfig();

distributeLicenseConfig(request, options, callback)

distributeLicenseConfig(request: protos.google.cloud.discoveryengine.v1beta.IDistributeLicenseConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDistributeLicenseConfigResponse, protos.google.cloud.discoveryengine.v1beta.IDistributeLicenseConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDistributeLicenseConfigRequest
options CallOptions
callback Callback<protos.google.cloud.discoveryengine.v1beta.IDistributeLicenseConfigResponse, protos.google.cloud.discoveryengine.v1beta.IDistributeLicenseConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

distributeLicenseConfig(request, callback)

distributeLicenseConfig(request: protos.google.cloud.discoveryengine.v1beta.IDistributeLicenseConfigRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDistributeLicenseConfigResponse, protos.google.cloud.discoveryengine.v1beta.IDistributeLicenseConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDistributeLicenseConfigRequest
callback Callback<protos.google.cloud.discoveryengine.v1beta.IDistributeLicenseConfigResponse, protos.google.cloud.discoveryengine.v1beta.IDistributeLicenseConfigRequest | 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.

evaluationPath(project, location, evaluation)

evaluationPath(project: string, location: string, evaluation: string): string;

Return a fully-qualified evaluation resource name string.

Parameters
Name Description
project string
location string
evaluation string
Returns
Type Description
string

{string} Resource name string.

getLicenseConfig(request, options)

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

Gets a .

Parameters
Name Description
request IGetLicenseConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, (protos.google.cloud.discoveryengine.v1beta.IGetLicenseConfigRequest | 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
   *  LicenseConfig google.cloud.discoveryengine.v1beta.LicenseConfig, such as
   *  `projects/{project}/locations/{location}/licenseConfigs/*`.
   *  If the caller does not have permission to access the
   *  LicenseConfig google.cloud.discoveryengine.v1beta.LicenseConfig,
   *  regardless of whether or not it exists, a PERMISSION_DENIED error is
   *  returned.
   *  If the requested
   *  LicenseConfig google.cloud.discoveryengine.v1beta.LicenseConfig  does not
   *  exist, a NOT_FOUND error is returned.
   */
  // const name = 'abc123'

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

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

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

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

  callGetLicenseConfig();

getLicenseConfig(request, options, callback)

getLicenseConfig(request: protos.google.cloud.discoveryengine.v1beta.IGetLicenseConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, protos.google.cloud.discoveryengine.v1beta.IGetLicenseConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetLicenseConfigRequest
options CallOptions
callback Callback<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, protos.google.cloud.discoveryengine.v1beta.IGetLicenseConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLicenseConfig(request, callback)

getLicenseConfig(request: protos.google.cloud.discoveryengine.v1beta.IGetLicenseConfigRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, protos.google.cloud.discoveryengine.v1beta.IGetLicenseConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetLicenseConfigRequest
callback Callback<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, protos.google.cloud.discoveryengine.v1beta.IGetLicenseConfigRequest | 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

groundingConfigPath(project, location, groundingConfig)

groundingConfigPath(project: string, location: string, groundingConfig: string): string;

Return a fully-qualified groundingConfig resource name string.

Parameters
Name Description
project string
location string
groundingConfig string
Returns
Type Description
string

{string} Resource name string.

identityMappingStorePath(project, location, identityMappingStore)

identityMappingStorePath(project: string, location: string, identityMappingStore: string): string;

Return a fully-qualified identityMappingStore resource name string.

Parameters
Name Description
project string
location string
identityMappingStore string
Returns
Type Description
string

{string} Resource name string.

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.

licenseConfigPath(project, location, licenseConfig)

licenseConfigPath(project: string, location: string, licenseConfig: string): string;

Return a fully-qualified licenseConfig resource name string.

Parameters
Name Description
project string
location string
licenseConfig string
Returns
Type Description
string

{string} Resource name string.

listLicenseConfigs(request, options)

listLicenseConfigs(request?: protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.discoveryengine.v1beta.ILicenseConfig[],
        protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsRequest | null,
        protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsResponse
    ]>;

Lists all the s associated with the project.

Parameters
Name Description
request IListLicenseConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.discoveryengine.v1beta.ILicenseConfig[], protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsRequest | null, protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsResponse ]>

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

listLicenseConfigs(request, options, callback)

listLicenseConfigs(request: protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsRequest, protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.ILicenseConfig>): void;
Parameters
Name Description
request IListLicenseConfigsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsRequest, protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.ILicenseConfig>
Returns
Type Description
void

listLicenseConfigs(request, callback)

listLicenseConfigs(request: protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsRequest, protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.ILicenseConfig>): void;
Parameters
Name Description
request IListLicenseConfigsRequest
callback PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsRequest, protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.ILicenseConfig>
Returns
Type Description
void

listLicenseConfigsAsync(request, options)

listLicenseConfigsAsync(request?: protos.google.cloud.discoveryengine.v1beta.IListLicenseConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig>;

Equivalent to listLicenseConfigs, but returns an iterable object.

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

Parameters
Name Description
request IListLicenseConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig>

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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent branch resource name, such as
   *  `projects/{project}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Not supported.
   */
  // const pageSize = 1234
  /**
   *  Optional. Not supported.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The filter to apply to the list results.
   *  The supported fields are:
   *    * `subscription_tier`
   *    * `state`
   *  Examples:
   *    * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all
   *    active search license configs.
   *    * `state=ACTIVE` - Lists all active license configs.
   *  The filter string should be a comma-separated list of field=value pairs.
   */
  // const filter = 'abc123'

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

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

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

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

  callListLicenseConfigs();

listLicenseConfigsStream(request, options)

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

Equivalent to listLicenseConfigs, but returns a NodeJS Stream object.

Parameters
Name Description
request IListLicenseConfigsRequest

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 listLicenseConfigsAsync() 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.

matchAssistAnswerFromAssistAnswerName(assistAnswerName)

matchAssistAnswerFromAssistAnswerName(assistAnswerName: string): string | number;

Parse the assist_answer from AssistAnswer resource.

Parameter
Name Description
assistAnswerName string

A fully-qualified path representing AssistAnswer resource.
Returns
Type Description
string | number

{string} A string representing the assist_answer.

matchAssistantFromAssistantName(assistantName)

matchAssistantFromAssistantName(assistantName: string): string | number;

Parse the assistant from Assistant resource.

Parameter
Name Description
assistantName string

A fully-qualified path representing Assistant resource.
Returns
Type Description
string | number

{string} A string representing the assistant.

matchBillingAccountFromBillingAccountLicenseConfigName(billingAccountLicenseConfigName)

matchBillingAccountFromBillingAccountLicenseConfigName(billingAccountLicenseConfigName: string): string | number;

Parse the billing_account from BillingAccountLicenseConfig resource.

Parameter
Name Description
billingAccountLicenseConfigName string

A fully-qualified path representing BillingAccountLicenseConfig resource.
Returns
Type Description
string | number

{string} A string representing the billing_account.

matchBillingAccountLicenseConfigFromBillingAccountLicenseConfigName(billingAccountLicenseConfigName)

matchBillingAccountLicenseConfigFromBillingAccountLicenseConfigName(billingAccountLicenseConfigName: string): string | number;

Parse the billing_account_license_config from BillingAccountLicenseConfig resource.

Parameter
Name Description
billingAccountLicenseConfigName string

A fully-qualified path representing BillingAccountLicenseConfig resource.
Returns
Type Description
string | number

{string} A string representing the billing_account_license_config.

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the branch.

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentName string

A fully-qualified path representing project_location_collection_data_store_branch_document resource.
Returns
Type Description
string | number

{string} A string representing the branch.

matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the branch.

matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the branch from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name Description
projectLocationDataStoreBranchDocumentName string

A fully-qualified path representing project_location_data_store_branch_document resource.
Returns
Type Description
string | number

{string} A string representing the branch.

matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the chunk.

matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the chunk.

matchCmekConfigFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName)

matchCmekConfigFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;

Parse the cmek_config from ProjectLocationCmekConfigs resource.

Parameter
Name Description
projectLocationCmekConfigsName string

A fully-qualified path representing project_location_cmekConfigs resource.
Returns
Type Description
string | number

{string} A string representing the cmek_config.

matchCollaborativeProjectFromProjectLocationCollectionEngineCollaborativeProjectSessionsName(projectLocationCollectionEngineCollaborativeProjectSessionsName)

matchCollaborativeProjectFromProjectLocationCollectionEngineCollaborativeProjectSessionsName(projectLocationCollectionEngineCollaborativeProjectSessionsName: string): string | number;

Parse the collaborative_project from ProjectLocationCollectionEngineCollaborativeProjectSessions resource.

Parameter
Name Description
projectLocationCollectionEngineCollaborativeProjectSessionsName string

A fully-qualified path representing project_location_collection_engine_collaborative_project_sessions resource.
Returns
Type Description
string | number

{string} A string representing the collaborative_project.

matchCollectionFromAssistAnswerName(assistAnswerName)

matchCollectionFromAssistAnswerName(assistAnswerName: string): string | number;

Parse the collection from AssistAnswer resource.

Parameter
Name Description
assistAnswerName string

A fully-qualified path representing AssistAnswer resource.
Returns
Type Description
string | number

{string} A string representing the collection.

matchCollectionFromAssistantName(assistantName)

matchCollectionFromAssistantName(assistantName: string): string | number;

Parse the collection from Assistant resource.

Parameter
Name Description
assistantName string

A fully-qualified path representing Assistant resource.
Returns
Type Description
string | number

{string} A string representing the collection.

matchCollectionFromEngineName(engineName)

matchCollectionFromEngineName(engineName: string): string | number;

Parse the collection from Engine resource.

Parameter
Name Description
engineName string

A fully-qualified path representing Engine resource.
Returns
Type Description
string | number

{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentName string

A fully-qualified path representing project_location_collection_data_store_branch_document resource.
Returns
Type Description
string | number

{string} A string representing the collection.

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.

matchCollectionFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName)

matchCollectionFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreCustomTuningModel resource.

Parameter
Name Description
projectLocationCollectionDataStoreCustomTuningModelName string

A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
Returns
Type Description
string | number

{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchCollectionFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

Parameter
Name Description
projectLocationCollectionDataStoreDocumentProcessingConfigName string

A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
Returns
Type Description
string | number

{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStore resource.

Parameter
Name Description
projectLocationCollectionDataStoreName string

A fully-qualified path representing project_location_collection_data_store resource.
Returns
Type Description
string | number

{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name Description
projectLocationCollectionDataStoreSchemaName string

A fully-qualified path representing project_location_collection_data_store_schema resource.
Returns
Type Description
string | number

{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name Description
projectLocationCollectionDataStoreServingConfigName string

A fully-qualified path representing project_location_collection_data_store_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchCollectionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name Description
projectLocationCollectionDataStoreSessionAnswerName string

A fully-qualified path representing project_location_collection_data_store_session_answer resource.
Returns
Type Description
string | number

{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName)

matchCollectionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSessions resource.

Parameter
Name Description
projectLocationCollectionDataStoreSessionsName string

A fully-qualified path representing project_location_collection_data_store_sessions 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.

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName)

matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;

Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.

Parameter
Name Description
projectLocationCollectionDataStoreSiteSearchEngineSitemapName string

A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap 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.

matchCollectionFromProjectLocationCollectionEngineCollaborativeProjectSessionsName(projectLocationCollectionEngineCollaborativeProjectSessionsName)

matchCollectionFromProjectLocationCollectionEngineCollaborativeProjectSessionsName(projectLocationCollectionEngineCollaborativeProjectSessionsName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineCollaborativeProjectSessions resource.

Parameter
Name Description
projectLocationCollectionEngineCollaborativeProjectSessionsName string

A fully-qualified path representing project_location_collection_engine_collaborative_project_sessions 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.

matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name Description
projectLocationCollectionEngineServingConfigName string

A fully-qualified path representing project_location_collection_engine_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchCollectionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name Description
projectLocationCollectionEngineSessionAnswerName string

A fully-qualified path representing project_location_collection_engine_session_answer resource.
Returns
Type Description
string | number

{string} A string representing the collection.

matchCollectionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName)

matchCollectionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;

Parse the collection from ProjectLocationCollectionEngineSessions resource.

Parameter
Name Description
projectLocationCollectionEngineSessionsName string

A fully-qualified path representing project_location_collection_engine_sessions 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.

matchCustomTuningModelFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName)

matchCustomTuningModelFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;

Parse the custom_tuning_model from ProjectLocationCollectionDataStoreCustomTuningModel resource.

Parameter
Name Description
projectLocationCollectionDataStoreCustomTuningModelName string

A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
Returns
Type Description
string | number

{string} A string representing the custom_tuning_model.

matchCustomTuningModelFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName)

matchCustomTuningModelFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;

Parse the custom_tuning_model from ProjectLocationDataStoreCustomTuningModel resource.

Parameter
Name Description
projectLocationDataStoreCustomTuningModelName string

A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
Returns
Type Description
string | number

{string} A string representing the custom_tuning_model.

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentName string

A fully-qualified path representing project_location_collection_data_store_branch_document resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

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.

matchDataStoreFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName)

matchDataStoreFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreCustomTuningModel resource.

Parameter
Name Description
projectLocationCollectionDataStoreCustomTuningModelName string

A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchDataStoreFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

Parameter
Name Description
projectLocationCollectionDataStoreDocumentProcessingConfigName string

A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStore resource.

Parameter
Name Description
projectLocationCollectionDataStoreName string

A fully-qualified path representing project_location_collection_data_store resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name Description
projectLocationCollectionDataStoreSchemaName string

A fully-qualified path representing project_location_collection_data_store_schema resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name Description
projectLocationCollectionDataStoreServingConfigName string

A fully-qualified path representing project_location_collection_data_store_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchDataStoreFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name Description
projectLocationCollectionDataStoreSessionAnswerName string

A fully-qualified path representing project_location_collection_data_store_session_answer resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName)

matchDataStoreFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSessions resource.

Parameter
Name Description
projectLocationCollectionDataStoreSessionsName string

A fully-qualified path representing project_location_collection_data_store_sessions 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.

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName)

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.

Parameter
Name Description
projectLocationCollectionDataStoreSiteSearchEngineSitemapName string

A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName)

matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name Description
projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName string

A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the data_store from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name Description
projectLocationDataStoreBranchDocumentName string

A fully-qualified path representing project_location_data_store_branch_document resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

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.

matchDataStoreFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName)

matchDataStoreFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;

Parse the data_store from ProjectLocationDataStoreCustomTuningModel resource.

Parameter
Name Description
projectLocationDataStoreCustomTuningModelName string

A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName)

matchDataStoreFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;

Parse the data_store from ProjectLocationDataStoreDocumentProcessingConfig resource.

Parameter
Name Description
projectLocationDataStoreDocumentProcessingConfigName string

A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the data_store from ProjectLocationDataStore resource.

Parameter
Name Description
projectLocationDataStoreName string

A fully-qualified path representing project_location_data_store resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSchema resource.

Parameter
Name Description
projectLocationDataStoreSchemaName string

A fully-qualified path representing project_location_data_store_schema resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the data_store from ProjectLocationDataStoreServingConfig resource.

Parameter
Name Description
projectLocationDataStoreServingConfigName string

A fully-qualified path representing project_location_data_store_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchDataStoreFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name Description
projectLocationDataStoreSessionAnswerName string

A fully-qualified path representing project_location_data_store_session_answer resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName)

matchDataStoreFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSessions resource.

Parameter
Name Description
projectLocationDataStoreSessionsName string

A fully-qualified path representing project_location_data_store_sessions 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.

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName)

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.

Parameter
Name Description
projectLocationDataStoreSiteSearchEngineSitemapName string

A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName)

matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;

Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.

Parameter
Name Description
projectLocationDataStoreSiteSearchEngineTargetSiteName string

A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
Returns
Type Description
string | number

{string} A string representing the data_store.

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the document.

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentName string

A fully-qualified path representing project_location_collection_data_store_branch_document resource.
Returns
Type Description
string | number

{string} A string representing the document.

matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the document.

matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the document from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name Description
projectLocationDataStoreBranchDocumentName string

A fully-qualified path representing project_location_data_store_branch_document resource.
Returns
Type Description
string | number

{string} A string representing the document.

matchEngineFromAssistAnswerName(assistAnswerName)

matchEngineFromAssistAnswerName(assistAnswerName: string): string | number;

Parse the engine from AssistAnswer resource.

Parameter
Name Description
assistAnswerName string

A fully-qualified path representing AssistAnswer resource.
Returns
Type Description
string | number

{string} A string representing the engine.

matchEngineFromAssistantName(assistantName)

matchEngineFromAssistantName(assistantName: string): string | number;

Parse the engine from Assistant resource.

Parameter
Name Description
assistantName string

A fully-qualified path representing Assistant resource.
Returns
Type Description
string | number

{string} A string representing the engine.

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.

matchEngineFromProjectLocationCollectionEngineCollaborativeProjectSessionsName(projectLocationCollectionEngineCollaborativeProjectSessionsName)

matchEngineFromProjectLocationCollectionEngineCollaborativeProjectSessionsName(projectLocationCollectionEngineCollaborativeProjectSessionsName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineCollaborativeProjectSessions resource.

Parameter
Name Description
projectLocationCollectionEngineCollaborativeProjectSessionsName string

A fully-qualified path representing project_location_collection_engine_collaborative_project_sessions 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.

matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name Description
projectLocationCollectionEngineServingConfigName string

A fully-qualified path representing project_location_collection_engine_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the engine.

matchEngineFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchEngineFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name Description
projectLocationCollectionEngineSessionAnswerName string

A fully-qualified path representing project_location_collection_engine_session_answer resource.
Returns
Type Description
string | number

{string} A string representing the engine.

matchEngineFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName)

matchEngineFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;

Parse the engine from ProjectLocationCollectionEngineSessions resource.

Parameter
Name Description
projectLocationCollectionEngineSessionsName string

A fully-qualified path representing project_location_collection_engine_sessions resource.
Returns
Type Description
string | number

{string} A string representing the engine.

matchEvaluationFromEvaluationName(evaluationName)

matchEvaluationFromEvaluationName(evaluationName: string): string | number;

Parse the evaluation from Evaluation resource.

Parameter
Name Description
evaluationName string

A fully-qualified path representing Evaluation resource.
Returns
Type Description
string | number

{string} A string representing the evaluation.

matchGroundingConfigFromGroundingConfigName(groundingConfigName)

matchGroundingConfigFromGroundingConfigName(groundingConfigName: string): string | number;

Parse the grounding_config from GroundingConfig resource.

Parameter
Name Description
groundingConfigName string

A fully-qualified path representing GroundingConfig resource.
Returns
Type Description
string | number

{string} A string representing the grounding_config.

matchIdentityMappingStoreFromIdentityMappingStoreName(identityMappingStoreName)

matchIdentityMappingStoreFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;

Parse the identity_mapping_store from IdentityMappingStore resource.

Parameter
Name Description
identityMappingStoreName string

A fully-qualified path representing IdentityMappingStore resource.
Returns
Type Description
string | number

{string} A string representing the identity_mapping_store.

matchLicenseConfigFromLicenseConfigName(licenseConfigName)

matchLicenseConfigFromLicenseConfigName(licenseConfigName: string): string | number;

Parse the license_config from LicenseConfig resource.

Parameter
Name Description
licenseConfigName string

A fully-qualified path representing LicenseConfig resource.
Returns
Type Description
string | number

{string} A string representing the license_config.

matchLocationFromAclConfigName(aclConfigName)

matchLocationFromAclConfigName(aclConfigName: string): string | number;

Parse the location from AclConfig resource.

Parameter
Name Description
aclConfigName string

A fully-qualified path representing AclConfig resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromAssistAnswerName(assistAnswerName)

matchLocationFromAssistAnswerName(assistAnswerName: string): string | number;

Parse the location from AssistAnswer resource.

Parameter
Name Description
assistAnswerName string

A fully-qualified path representing AssistAnswer resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromAssistantName(assistantName)

matchLocationFromAssistantName(assistantName: string): string | number;

Parse the location from Assistant resource.

Parameter
Name Description
assistantName string

A fully-qualified path representing Assistant resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromEngineName(engineName)

matchLocationFromEngineName(engineName: string): string | number;

Parse the location from Engine resource.

Parameter
Name Description
engineName string

A fully-qualified path representing Engine resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromEvaluationName(evaluationName)

matchLocationFromEvaluationName(evaluationName: string): string | number;

Parse the location from Evaluation resource.

Parameter
Name Description
evaluationName string

A fully-qualified path representing Evaluation resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromGroundingConfigName(groundingConfigName)

matchLocationFromGroundingConfigName(groundingConfigName: string): string | number;

Parse the location from GroundingConfig resource.

Parameter
Name Description
groundingConfigName string

A fully-qualified path representing GroundingConfig resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromIdentityMappingStoreName(identityMappingStoreName)

matchLocationFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;

Parse the location from IdentityMappingStore resource.

Parameter
Name Description
identityMappingStoreName string

A fully-qualified path representing IdentityMappingStore resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLicenseConfigName(licenseConfigName)

matchLocationFromLicenseConfigName(licenseConfigName: string): string | number;

Parse the location from LicenseConfig resource.

Parameter
Name Description
licenseConfigName string

A fully-qualified path representing LicenseConfig 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.

matchLocationFromProjectLocationCmekConfigName(projectLocationCmekConfigName)

matchLocationFromProjectLocationCmekConfigName(projectLocationCmekConfigName: string): string | number;

Parse the location from ProjectLocationCmekConfig resource.

Parameter
Name Description
projectLocationCmekConfigName string

A fully-qualified path representing project_location_cmekConfig resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName)

matchLocationFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;

Parse the location from ProjectLocationCmekConfigs resource.

Parameter
Name Description
projectLocationCmekConfigsName string

A fully-qualified path representing project_location_cmekConfigs resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentName string

A fully-qualified path representing project_location_collection_data_store_branch_document resource.
Returns
Type Description
string | number

{string} A string representing the location.

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.

matchLocationFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName)

matchLocationFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreCustomTuningModel resource.

Parameter
Name Description
projectLocationCollectionDataStoreCustomTuningModelName string

A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchLocationFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

Parameter
Name Description
projectLocationCollectionDataStoreDocumentProcessingConfigName string

A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the location from ProjectLocationCollectionDataStore resource.

Parameter
Name Description
projectLocationCollectionDataStoreName string

A fully-qualified path representing project_location_collection_data_store resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name Description
projectLocationCollectionDataStoreSchemaName string

A fully-qualified path representing project_location_collection_data_store_schema resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name Description
projectLocationCollectionDataStoreServingConfigName string

A fully-qualified path representing project_location_collection_data_store_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchLocationFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name Description
projectLocationCollectionDataStoreSessionAnswerName string

A fully-qualified path representing project_location_collection_data_store_session_answer resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName)

matchLocationFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSessions resource.

Parameter
Name Description
projectLocationCollectionDataStoreSessionsName string

A fully-qualified path representing project_location_collection_data_store_sessions 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.

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName)

matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;

Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.

Parameter
Name Description
projectLocationCollectionDataStoreSiteSearchEngineSitemapName string

A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap 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.

matchLocationFromProjectLocationCollectionEngineCollaborativeProjectSessionsName(projectLocationCollectionEngineCollaborativeProjectSessionsName)

matchLocationFromProjectLocationCollectionEngineCollaborativeProjectSessionsName(projectLocationCollectionEngineCollaborativeProjectSessionsName: string): string | number;

Parse the location from ProjectLocationCollectionEngineCollaborativeProjectSessions resource.

Parameter
Name Description
projectLocationCollectionEngineCollaborativeProjectSessionsName string

A fully-qualified path representing project_location_collection_engine_collaborative_project_sessions 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.

matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the location from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name Description
projectLocationCollectionEngineServingConfigName string

A fully-qualified path representing project_location_collection_engine_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchLocationFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the location from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name Description
projectLocationCollectionEngineSessionAnswerName string

A fully-qualified path representing project_location_collection_engine_session_answer resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName)

matchLocationFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;

Parse the location from ProjectLocationCollectionEngineSessions resource.

Parameter
Name Description
projectLocationCollectionEngineSessionsName string

A fully-qualified path representing project_location_collection_engine_sessions resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the location from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name Description
projectLocationDataStoreBranchDocumentName string

A fully-qualified path representing project_location_data_store_branch_document resource.
Returns
Type Description
string | number

{string} A string representing the location.

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.

matchLocationFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName)

matchLocationFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;

Parse the location from ProjectLocationDataStoreCustomTuningModel resource.

Parameter
Name Description
projectLocationDataStoreCustomTuningModelName string

A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName)

matchLocationFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;

Parse the location from ProjectLocationDataStoreDocumentProcessingConfig resource.

Parameter
Name Description
projectLocationDataStoreDocumentProcessingConfigName string

A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the location from ProjectLocationDataStore resource.

Parameter
Name Description
projectLocationDataStoreName string

A fully-qualified path representing project_location_data_store resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the location from ProjectLocationDataStoreSchema resource.

Parameter
Name Description
projectLocationDataStoreSchemaName string

A fully-qualified path representing project_location_data_store_schema resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the location from ProjectLocationDataStoreServingConfig resource.

Parameter
Name Description
projectLocationDataStoreServingConfigName string

A fully-qualified path representing project_location_data_store_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchLocationFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the location from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name Description
projectLocationDataStoreSessionAnswerName string

A fully-qualified path representing project_location_data_store_session_answer resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName)

matchLocationFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;

Parse the location from ProjectLocationDataStoreSessions resource.

Parameter
Name Description
projectLocationDataStoreSessionsName string

A fully-qualified path representing project_location_data_store_sessions 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.

matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName)

matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;

Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.

Parameter
Name Description
projectLocationDataStoreSiteSearchEngineSitemapName string

A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap 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.

matchLocationFromSampleQueryName(sampleQueryName)

matchLocationFromSampleQueryName(sampleQueryName: string): string | number;

Parse the location from SampleQuery resource.

Parameter
Name Description
sampleQueryName string

A fully-qualified path representing SampleQuery resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromSampleQuerySetName(sampleQuerySetName)

matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;

Parse the location from SampleQuerySet resource.

Parameter
Name Description
sampleQuerySetName string

A fully-qualified path representing SampleQuerySet resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromUserStoreName(userStoreName)

matchLocationFromUserStoreName(userStoreName: string): string | number;

Parse the location from UserStore resource.

Parameter
Name Description
userStoreName string

A fully-qualified path representing UserStore resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchProjectFromAclConfigName(aclConfigName)

matchProjectFromAclConfigName(aclConfigName: string): string | number;

Parse the project from AclConfig resource.

Parameter
Name Description
aclConfigName string

A fully-qualified path representing AclConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromAssistAnswerName(assistAnswerName)

matchProjectFromAssistAnswerName(assistAnswerName: string): string | number;

Parse the project from AssistAnswer resource.

Parameter
Name Description
assistAnswerName string

A fully-qualified path representing AssistAnswer resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromAssistantName(assistantName)

matchProjectFromAssistantName(assistantName: string): string | number;

Parse the project from Assistant resource.

Parameter
Name Description
assistantName string

A fully-qualified path representing Assistant resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromEngineName(engineName)

matchProjectFromEngineName(engineName: string): string | number;

Parse the project from Engine resource.

Parameter
Name Description
engineName string

A fully-qualified path representing Engine resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromEvaluationName(evaluationName)

matchProjectFromEvaluationName(evaluationName: string): string | number;

Parse the project from Evaluation resource.

Parameter
Name Description
evaluationName string

A fully-qualified path representing Evaluation resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromGroundingConfigName(groundingConfigName)

matchProjectFromGroundingConfigName(groundingConfigName: string): string | number;

Parse the project from GroundingConfig resource.

Parameter
Name Description
groundingConfigName string

A fully-qualified path representing GroundingConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromIdentityMappingStoreName(identityMappingStoreName)

matchProjectFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;

Parse the project from IdentityMappingStore resource.

Parameter
Name Description
identityMappingStoreName string

A fully-qualified path representing IdentityMappingStore resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLicenseConfigName(licenseConfigName)

matchProjectFromLicenseConfigName(licenseConfigName: string): string | number;

Parse the project from LicenseConfig resource.

Parameter
Name Description
licenseConfigName string

A fully-qualified path representing LicenseConfig 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.

matchProjectFromProjectLocationCmekConfigName(projectLocationCmekConfigName)

matchProjectFromProjectLocationCmekConfigName(projectLocationCmekConfigName: string): string | number;

Parse the project from ProjectLocationCmekConfig resource.

Parameter
Name Description
projectLocationCmekConfigName string

A fully-qualified path representing project_location_cmekConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName)

matchProjectFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;

Parse the project from ProjectLocationCmekConfigs resource.

Parameter
Name Description
projectLocationCmekConfigsName string

A fully-qualified path representing project_location_cmekConfigs resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName)

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName)

matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.

Parameter
Name Description
projectLocationCollectionDataStoreBranchDocumentName string

A fully-qualified path representing project_location_collection_data_store_branch_document resource.
Returns
Type Description
string | number

{string} A string representing the project.

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.

matchProjectFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName)

matchProjectFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreCustomTuningModel resource.

Parameter
Name Description
projectLocationCollectionDataStoreCustomTuningModelName string

A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName)

matchProjectFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.

Parameter
Name Description
projectLocationCollectionDataStoreDocumentProcessingConfigName string

A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)

matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;

Parse the project from ProjectLocationCollectionDataStore resource.

Parameter
Name Description
projectLocationCollectionDataStoreName string

A fully-qualified path representing project_location_collection_data_store resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name Description
projectLocationCollectionDataStoreSchemaName string

A fully-qualified path representing project_location_collection_data_store_schema resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name Description
projectLocationCollectionDataStoreServingConfigName string

A fully-qualified path representing project_location_collection_data_store_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName)

matchProjectFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSessionAnswer resource.

Parameter
Name Description
projectLocationCollectionDataStoreSessionAnswerName string

A fully-qualified path representing project_location_collection_data_store_session_answer resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName)

matchProjectFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSessions resource.

Parameter
Name Description
projectLocationCollectionDataStoreSessionsName string

A fully-qualified path representing project_location_collection_data_store_sessions 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.

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName)

matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;

Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.

Parameter
Name Description
projectLocationCollectionDataStoreSiteSearchEngineSitemapName string

A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap 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.

matchProjectFromProjectLocationCollectionEngineCollaborativeProjectSessionsName(projectLocationCollectionEngineCollaborativeProjectSessionsName)

matchProjectFromProjectLocationCollectionEngineCollaborativeProjectSessionsName(projectLocationCollectionEngineCollaborativeProjectSessionsName: string): string | number;

Parse the project from ProjectLocationCollectionEngineCollaborativeProjectSessions resource.

Parameter
Name Description
projectLocationCollectionEngineCollaborativeProjectSessionsName string

A fully-qualified path representing project_location_collection_engine_collaborative_project_sessions 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.

matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the project from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name Description
projectLocationCollectionEngineServingConfigName string

A fully-qualified path representing project_location_collection_engine_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName)

matchProjectFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;

Parse the project from ProjectLocationCollectionEngineSessionAnswer resource.

Parameter
Name Description
projectLocationCollectionEngineSessionAnswerName string

A fully-qualified path representing project_location_collection_engine_session_answer resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName)

matchProjectFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;

Parse the project from ProjectLocationCollectionEngineSessions resource.

Parameter
Name Description
projectLocationCollectionEngineSessionsName string

A fully-qualified path representing project_location_collection_engine_sessions resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName)

matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;

Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.

Parameter
Name Description
projectLocationDataStoreBranchDocumentChunkName string

A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName)

matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;

Parse the project from ProjectLocationDataStoreBranchDocument resource.

Parameter
Name Description
projectLocationDataStoreBranchDocumentName string

A fully-qualified path representing project_location_data_store_branch_document resource.
Returns
Type Description
string | number

{string} A string representing the project.

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.

matchProjectFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName)

matchProjectFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName: string): string | number;

Parse the project from ProjectLocationDataStoreCustomTuningModel resource.

Parameter
Name Description
projectLocationDataStoreCustomTuningModelName string

A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName)

matchProjectFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;

Parse the project from ProjectLocationDataStoreDocumentProcessingConfig resource.

Parameter
Name Description
projectLocationDataStoreDocumentProcessingConfigName string

A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName)

matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;

Parse the project from ProjectLocationDataStore resource.

Parameter
Name Description
projectLocationDataStoreName string

A fully-qualified path representing project_location_data_store resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the project from ProjectLocationDataStoreSchema resource.

Parameter
Name Description
projectLocationDataStoreSchemaName string

A fully-qualified path representing project_location_data_store_schema resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the project from ProjectLocationDataStoreServingConfig resource.

Parameter
Name Description
projectLocationDataStoreServingConfigName string

A fully-qualified path representing project_location_data_store_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName)

matchProjectFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;

Parse the project from ProjectLocationDataStoreSessionAnswer resource.

Parameter
Name Description
projectLocationDataStoreSessionAnswerName string

A fully-qualified path representing project_location_data_store_session_answer resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName)

matchProjectFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;

Parse the project from ProjectLocationDataStoreSessions resource.

Parameter
Name Description
projectLocationDataStoreSessionsName string

A fully-qualified path representing project_location_data_store_sessions 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.

matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName)

matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;

Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.

Parameter
Name Description
projectLocationDataStoreSiteSearchEngineSitemapName string

A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap 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.

matchProjectFromSampleQueryName(sampleQueryName)

matchProjectFromSampleQueryName(sampleQueryName: string): string | number;

Parse the project from SampleQuery resource.

Parameter
Name Description
sampleQueryName string

A fully-qualified path representing SampleQuery resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromSampleQuerySetName(sampleQuerySetName)

matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;

Parse the project from SampleQuerySet resource.

Parameter
Name Description
sampleQuerySetName string

A fully-qualified path representing SampleQuerySet resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromUserStoreName(userStoreName)

matchProjectFromUserStoreName(userStoreName: string): string | number;

Parse the project from UserStore resource.

Parameter
Name Description
userStoreName string

A fully-qualified path representing UserStore resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchSampleQueryFromSampleQueryName(sampleQueryName)

matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;

Parse the sample_query from SampleQuery resource.

Parameter
Name Description
sampleQueryName string

A fully-qualified path representing SampleQuery resource.
Returns
Type Description
string | number

{string} A string representing the sample_query.

matchSampleQuerySetFromSampleQueryName(sampleQueryName)

matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;

Parse the sample_query_set from SampleQuery resource.

Parameter
Name Description
sampleQueryName string

A fully-qualified path representing SampleQuery resource.
Returns
Type Description
string | number

{string} A string representing the sample_query_set.

matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName)

matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;

Parse the sample_query_set from SampleQuerySet resource.

Parameter
Name Description
sampleQuerySetName string

A fully-qualified path representing SampleQuerySet resource.
Returns
Type Description
string | number

{string} A string representing the sample_query_set.

matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName)

matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;

Parse the schema from ProjectLocationCollectionDataStoreSchema resource.

Parameter
Name Description
projectLocationCollectionDataStoreSchemaName string

A fully-qualified path representing project_location_collection_data_store_schema resource.
Returns
Type Description
string | number

{string} A string representing the schema.

matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName)

matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;

Parse the schema from ProjectLocationDataStoreSchema resource.

Parameter
Name Description
projectLocationDataStoreSchemaName string

A fully-qualified path representing project_location_data_store_schema resource.
Returns
Type Description
string | number

{string} A string representing the schema.

matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName)

matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;

Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.

Parameter
Name Description
projectLocationCollectionDataStoreServingConfigName string

A fully-qualified path representing project_location_collection_data_store_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the serving_config.

matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName)

matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;

Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.

Parameter
Name Description
projectLocationCollectionEngineServingConfigName string

A fully-qualified path representing project_location_collection_engine_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the serving_config.

matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName)

matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;

Parse the serving_config from ProjectLocationDataStoreServingConfig resource.

Parameter
Name Description
projectLocationDataStoreServingConfigName string

A fully-qualified path representing project_location_data_store_serving_config resource.
Returns
Type Description
string | number

{string} A string representing the serving_config.

matchSessionFromAssistAnswerName(assistAnswerName)

matchSessionFromAssistAnswerName(assistAnswerName: string): string | number;

Parse the session from AssistAnswer resource.

Parameter
Name Description
assistAnswerName string

A fully-qualified path representing AssistAnswer resource.
Returns
Type Description
string | number

{string} A string representing the session.

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.

matchSessionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName)

matchSessionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;

Parse the session from ProjectLocationCollectionDataStoreSessions resource.

Parameter
Name Description
projectLocationCollectionDataStoreSessionsName string

A fully-qualified path representing project_location_collection_data_store_sessions resource.
Returns
Type Description
string | number

{string} A string representing the session.

matchSessionFromProjectLocationCollectionEngineCollaborativeProjectSessionsName(projectLocationCollectionEngineCollaborativeProjectSessionsName)

matchSessionFromProjectLocationCollectionEngineCollaborativeProjectSessionsName(projectLocationCollectionEngineCollaborativeProjectSessionsName: string): string | number;

Parse the session from ProjectLocationCollectionEngineCollaborativeProjectSessions resource.

Parameter
Name Description
projectLocationCollectionEngineCollaborativeProjectSessionsName string

A fully-qualified path representing project_location_collection_engine_collaborative_project_sessions 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.

matchSessionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName)

matchSessionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;

Parse the session from ProjectLocationCollectionEngineSessions resource.

Parameter
Name Description
projectLocationCollectionEngineSessionsName string

A fully-qualified path representing project_location_collection_engine_sessions 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.

matchSessionFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName)

matchSessionFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;

Parse the session from ProjectLocationDataStoreSessions resource.

Parameter
Name Description
projectLocationDataStoreSessionsName string

A fully-qualified path representing project_location_data_store_sessions resource.
Returns
Type Description
string | number

{string} A string representing the session.

matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName)

matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;

Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.

Parameter
Name Description
projectLocationCollectionDataStoreSiteSearchEngineSitemapName string

A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
Returns
Type Description
string | number

{string} A string representing the sitemap.

matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName)

matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;

Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.

Parameter
Name Description
projectLocationDataStoreSiteSearchEngineSitemapName string

A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
Returns
Type Description
string | number

{string} A string representing the sitemap.

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.

matchUserStoreFromUserStoreName(userStoreName)

matchUserStoreFromUserStoreName(userStoreName: string): string | number;

Parse the user_store from UserStore resource.

Parameter
Name Description
userStoreName string

A fully-qualified path representing UserStore resource.
Returns
Type Description
string | number

{string} A string representing the user_store.

projectLocationCmekConfigPath(project, location)

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

Return a fully-qualified projectLocationCmekConfig resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

projectLocationCmekConfigsPath(project, location, cmekConfig)

projectLocationCmekConfigsPath(project: string, location: string, cmekConfig: string): string;

Return a fully-qualified projectLocationCmekConfigs resource name string.

Parameters
Name Description
project string
location string
cmekConfig string
Returns
Type Description
string

{string} Resource name string.

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

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

Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.

Parameters
Name Description
project string
location string
collection string
dataStore string
branch string
document string
chunk string
Returns
Type Description
string

{string} Resource name string.

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

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

Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.

Parameters
Name Description
project string
location string
collection string
dataStore string
branch string
document string
Returns
Type Description
string

{string} Resource name string.

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.

projectLocationCollectionDataStoreCustomTuningModelPath(project, location, collection, dataStore, customTuningModel)

projectLocationCollectionDataStoreCustomTuningModelPath(project: string, location: string, collection: string, dataStore: string, customTuningModel: string): string;

Return a fully-qualified projectLocationCollectionDataStoreCustomTuningModel resource name string.

Parameters
Name Description
project string
location string
collection string
dataStore string
customTuningModel string
Returns
Type Description
string

{string} Resource name string.

projectLocationCollectionDataStoreDocumentProcessingConfigPath(project, location, collection, dataStore)

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

Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.

Parameters
Name Description
project string
location string
collection string
dataStore string
Returns
Type Description
string

{string} Resource name string.

projectLocationCollectionDataStorePath(project, location, collection, dataStore)

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

Return a fully-qualified projectLocationCollectionDataStore resource name string.

Parameters
Name Description
project string
location string
collection string
dataStore string
Returns
Type Description
string

{string} Resource name string.

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

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

Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.

Parameters
Name Description
project string
location string
collection string
dataStore string
schema string
Returns
Type Description
string

{string} Resource name string.

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

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

Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.

Parameters
Name Description
project string
location string
collection string
dataStore string
servingConfig string
Returns
Type Description
string

{string} Resource name string.

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

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

Return a fully-qualified projectLocationCollectionDataStoreSessionAnswer resource name string.

Parameters
Name Description
project string
location string
collection string
dataStore string
session string
answer string
Returns
Type Description
string

{string} Resource name string.

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

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

Return a fully-qualified projectLocationCollectionDataStoreSessions 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.

projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project, location, collection, dataStore, sitemap)

projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project: string, location: string, collection: string, dataStore: string, sitemap: string): string;

Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.

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

projectLocationCollectionEngineCollaborativeProjectSessionsPath(project, location, collection, engine, collaborativeProject, session)

projectLocationCollectionEngineCollaborativeProjectSessionsPath(project: string, location: string, collection: string, engine: string, collaborativeProject: string, session: string): string;

Return a fully-qualified projectLocationCollectionEngineCollaborativeProjectSessions resource name string.

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

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

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

Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.

Parameters
Name Description
project string
location string
collection string
engine string
servingConfig string
Returns
Type Description
string

{string} Resource name string.

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

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

Return a fully-qualified projectLocationCollectionEngineSessionAnswer resource name string.

Parameters
Name Description
project string
location string
collection string
engine string
session string
answer string
Returns
Type Description
string

{string} Resource name string.

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

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

Return a fully-qualified projectLocationCollectionEngineSessions resource name string.

Parameters
Name Description
project string
location string
collection string
engine string
session string
Returns
Type Description
string

{string} Resource name string.

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

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

Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.

Parameters
Name Description
project string
location string
dataStore string
branch string
document string
chunk string
Returns
Type Description
string

{string} Resource name string.

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

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

Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.

Parameters
Name Description
project string
location string
dataStore string
branch string
document string
Returns
Type Description
string

{string} Resource name string.

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.

projectLocationDataStoreCustomTuningModelPath(project, location, dataStore, customTuningModel)

projectLocationDataStoreCustomTuningModelPath(project: string, location: string, dataStore: string, customTuningModel: string): string;

Return a fully-qualified projectLocationDataStoreCustomTuningModel resource name string.

Parameters
Name Description
project string
location string
dataStore string
customTuningModel string
Returns
Type Description
string

{string} Resource name string.

projectLocationDataStoreDocumentProcessingConfigPath(project, location, dataStore)

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

Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.

Parameters
Name Description
project string
location string
dataStore string
Returns
Type Description
string

{string} Resource name string.

projectLocationDataStorePath(project, location, dataStore)

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

Return a fully-qualified projectLocationDataStore resource name string.

Parameters
Name Description
project string
location string
dataStore string
Returns
Type Description
string

{string} Resource name string.

projectLocationDataStoreSchemaPath(project, location, dataStore, schema)

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

Return a fully-qualified projectLocationDataStoreSchema resource name string.

Parameters
Name Description
project string
location string
dataStore string
schema string
Returns
Type Description
string

{string} Resource name string.

projectLocationDataStoreServingConfigPath(project, location, dataStore, servingConfig)

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

Return a fully-qualified projectLocationDataStoreServingConfig resource name string.

Parameters
Name Description
project string
location string
dataStore string
servingConfig string
Returns
Type Description
string

{string} Resource name string.

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

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

Return a fully-qualified projectLocationDataStoreSessionAnswer resource name string.

Parameters
Name Description
project string
location string
dataStore string
session string
answer string
Returns
Type Description
string

{string} Resource name string.

projectLocationDataStoreSessionsPath(project, location, dataStore, session)

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

Return a fully-qualified projectLocationDataStoreSessions 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.

projectLocationDataStoreSiteSearchEngineSitemapPath(project, location, dataStore, sitemap)

projectLocationDataStoreSiteSearchEngineSitemapPath(project: string, location: string, dataStore: string, sitemap: string): string;

Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.

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

retractLicenseConfig(request, options)

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

This method is called from the billing account side to retract the from the given project back to the billing account.

Parameters
Name Description
request IRetractLicenseConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.discoveryengine.v1beta.IRetractLicenseConfigResponse, (protos.google.cloud.discoveryengine.v1beta.IRetractLicenseConfigRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing RetractLicenseConfigResponse. 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 BillingAccountLicenseConfig .
   *  Format:
   *  `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.
   */
  // const billingAccountLicenseConfig = 'abc123'
  /**
   *  Required. Full resource name of
   *  LicenseConfig google.cloud.discoveryengine.v1beta.LicenseConfig.
   *  Format:
   *  `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.
   */
  // const licenseConfig = 'abc123'
  /**
   *  Optional. If set to true, retract the entire license config. Otherwise,
   *  retract the specified license count.
   */
  // const fullRetract = true
  /**
   *  Optional. The number of licenses to retract. Only used when full_retract is
   *  false.
   */
  // const licenseCount = 1234

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

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

  async function callRetractLicenseConfig() {
    // Construct request
    const request = {
      billingAccountLicenseConfig,
      licenseConfig,
    };

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

  callRetractLicenseConfig();

retractLicenseConfig(request, options, callback)

retractLicenseConfig(request: protos.google.cloud.discoveryengine.v1beta.IRetractLicenseConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IRetractLicenseConfigResponse, protos.google.cloud.discoveryengine.v1beta.IRetractLicenseConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IRetractLicenseConfigRequest
options CallOptions
callback Callback<protos.google.cloud.discoveryengine.v1beta.IRetractLicenseConfigResponse, protos.google.cloud.discoveryengine.v1beta.IRetractLicenseConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

retractLicenseConfig(request, callback)

retractLicenseConfig(request: protos.google.cloud.discoveryengine.v1beta.IRetractLicenseConfigRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IRetractLicenseConfigResponse, protos.google.cloud.discoveryengine.v1beta.IRetractLicenseConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IRetractLicenseConfigRequest
callback Callback<protos.google.cloud.discoveryengine.v1beta.IRetractLicenseConfigResponse, protos.google.cloud.discoveryengine.v1beta.IRetractLicenseConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

sampleQueryPath(project, location, sampleQuerySet, sampleQuery)

sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;

Return a fully-qualified sampleQuery resource name string.

Parameters
Name Description
project string
location string
sampleQuerySet string
sampleQuery string
Returns
Type Description
string

{string} Resource name string.

sampleQuerySetPath(project, location, sampleQuerySet)

sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;

Return a fully-qualified sampleQuerySet resource name string.

Parameters
Name Description
project string
location string
sampleQuerySet string
Returns
Type Description
string

{string} Resource name string.

updateLicenseConfig(request, options)

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

Updates the

Parameters
Name Description
request IUpdateLicenseConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, (protos.google.cloud.discoveryengine.v1beta.IUpdateLicenseConfigRequest | 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
   *  LicenseConfig google.cloud.discoveryengine.v1beta.LicenseConfig  to
   *  update.
   */
  // const licenseConfig = {}
  /**
   *  Optional. Indicates which fields in the provided
   *  LicenseConfig google.cloud.discoveryengine.v1beta.LicenseConfig  to
   *  update.
   *  If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
   *  is returned.
   */
  // const updateMask = {}

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

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

  async function callUpdateLicenseConfig() {
    // Construct request
    const request = {
      licenseConfig,
    };

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

  callUpdateLicenseConfig();

updateLicenseConfig(request, options, callback)

updateLicenseConfig(request: protos.google.cloud.discoveryengine.v1beta.IUpdateLicenseConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, protos.google.cloud.discoveryengine.v1beta.IUpdateLicenseConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateLicenseConfigRequest
options CallOptions
callback Callback<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, protos.google.cloud.discoveryengine.v1beta.IUpdateLicenseConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateLicenseConfig(request, callback)

updateLicenseConfig(request: protos.google.cloud.discoveryengine.v1beta.IUpdateLicenseConfigRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, protos.google.cloud.discoveryengine.v1beta.IUpdateLicenseConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateLicenseConfigRequest
callback Callback<protos.google.cloud.discoveryengine.v1beta.ILicenseConfig, protos.google.cloud.discoveryengine.v1beta.IUpdateLicenseConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

userStorePath(project, location, userStore)

userStorePath(project: string, location: string, userStore: string): string;

Return a fully-qualified userStore resource name string.

Parameters
Name Description
project string
location string
userStore string
Returns
Type Description
string

{string} Resource name string.