Class v1.IndexEndpointServiceClient (1.19.0)

A service for managing Vertex AI's IndexEndpoints. v1

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of IndexEndpointServiceClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

indexEndpointServiceStub

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

innerApiCalls

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

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

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

Methods

annotationPath(project, location, dataset, dataItem, annotation)

annotationPath(project: string, location: string, dataset: string, dataItem: string, annotation: string): string;

Return a fully-qualified annotation resource name string.

Parameters

Name	Description
project	`string`
location	`string`
dataset	`string`
dataItem	`string`
annotation	`string`

Returns

Type	Description
string	{string} Resource name string.

annotationSpecPath(project, location, dataset, annotationSpec)

annotationSpecPath(project: string, location: string, dataset: string, annotationSpec: string): string;

Return a fully-qualified annotationSpec resource name string.

Parameters

Name	Description
project	`string`
location	`string`
dataset	`string`
annotationSpec	`string`

Returns

Type	Description
string	{string} Resource name string.

artifactPath(project, location, metadataStore, artifact)

artifactPath(project: string, location: string, metadataStore: string, artifact: string): string;

Return a fully-qualified artifact resource name string.

Parameters

Name	Description
project	`string`
location	`string`
metadataStore	`string`
artifact	`string`

Returns

Type	Description
string	{string} Resource name string.

batchPredictionJobPath(project, location, batchPredictionJob)

batchPredictionJobPath(project: string, location: string, batchPredictionJob: string): string;

Return a fully-qualified batchPredictionJob resource name string.

Parameters

Name	Description
project	`string`
location	`string`
batchPredictionJob	`string`

Returns

Type	Description
string	{string} Resource name string.

checkCreateIndexEndpointProgress(name)

checkCreateIndexEndpointProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.IndexEndpoint, protos.google.cloud.aiplatform.v1.CreateIndexEndpointOperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1.IndexEndpoint, protos.google.cloud.aiplatform.v1.CreateIndexEndpointOperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Location to create the IndexEndpoint in.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The IndexEndpoint to create.
   */
  // const indexEndpoint = {}

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

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

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

  callCreateIndexEndpoint();

checkDeleteIndexEndpointProgress(name)

checkDeleteIndexEndpointProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.DeleteOperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.DeleteOperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the IndexEndpoint resource to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

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

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

  callDeleteIndexEndpoint();

checkDeployIndexProgress(name)

checkDeployIndexProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.DeployIndexResponse, protos.google.cloud.aiplatform.v1.DeployIndexOperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1.DeployIndexResponse, protos.google.cloud.aiplatform.v1.DeployIndexOperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the IndexEndpoint resource into which to deploy an Index.
   *  Format:
   *  `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
   */
  // const indexEndpoint = 'abc123'
  /**
   *  Required. The DeployedIndex to be created within the IndexEndpoint.
   */
  // const deployedIndex = {}

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

  async function callDeployIndex() {
    // Construct request
    const request = {
      indexEndpoint,
      deployedIndex,
    };

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

  callDeployIndex();

checkMutateDeployedIndexProgress(name)

checkMutateDeployedIndexProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.MutateDeployedIndexResponse, protos.google.cloud.aiplatform.v1.MutateDeployedIndexOperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1.MutateDeployedIndexResponse, protos.google.cloud.aiplatform.v1.MutateDeployedIndexOperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the IndexEndpoint resource into which to deploy an Index.
   *  Format:
   *  `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
   */
  // const indexEndpoint = 'abc123'
  /**
   *  Required. The DeployedIndex to be updated within the IndexEndpoint.
   *  Currently, the updatable fields are DeployedIndex automatic_resources 
   *  and DeployedIndex dedicated_resources 
   */
  // const deployedIndex = {}

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

  async function callMutateDeployedIndex() {
    // Construct request
    const request = {
      indexEndpoint,
      deployedIndex,
    };

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

  callMutateDeployedIndex();

checkUndeployIndexProgress(name)

checkUndeployIndexProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.UndeployIndexResponse, protos.google.cloud.aiplatform.v1.UndeployIndexOperationMetadata>>;

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

Parameter

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

Returns

Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1.UndeployIndexResponse, protos.google.cloud.aiplatform.v1.UndeployIndexOperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the IndexEndpoint resource from which to undeploy an Index.
   *  Format:
   *  `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
   */
  // const indexEndpoint = 'abc123'
  /**
   *  Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
   */
  // const deployedIndexId = 'abc123'

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

  async function callUndeployIndex() {
    // Construct request
    const request = {
      indexEndpoint,
      deployedIndexId,
    };

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

  callUndeployIndex();

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.

contextPath(project, location, metadataStore, context)

contextPath(project: string, location: string, metadataStore: string, context: string): string;

Return a fully-qualified context resource name string.

Parameters

Name	Description
project	`string`
location	`string`
metadataStore	`string`
context	`string`

Returns

Type	Description
string	{string} Resource name string.

createIndexEndpoint(request, options)

createIndexEndpoint(request?: protos.google.cloud.aiplatform.v1.ICreateIndexEndpointRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.ICreateIndexEndpointOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates an IndexEndpoint.

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateIndexEndpointRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.ICreateIndexEndpointOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Location to create the IndexEndpoint in.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The IndexEndpoint to create.
   */
  // const indexEndpoint = {}

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

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

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

  callCreateIndexEndpoint();

createIndexEndpoint(request, options, callback)

createIndexEndpoint(request: protos.google.cloud.aiplatform.v1.ICreateIndexEndpointRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.ICreateIndexEndpointOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateIndexEndpointRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.ICreateIndexEndpointOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createIndexEndpoint(request, callback)

createIndexEndpoint(request: protos.google.cloud.aiplatform.v1.ICreateIndexEndpointRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.ICreateIndexEndpointOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.ICreateIndexEndpointRequest`
callback	`Callback<LROperation<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.ICreateIndexEndpointOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

customJobPath(project, location, customJob)

customJobPath(project: string, location: string, customJob: string): string;

Return a fully-qualified customJob resource name string.

Parameters

Name	Description
project	`string`
location	`string`
customJob	`string`

Returns

Type	Description
string	{string} Resource name string.

dataItemPath(project, location, dataset, dataItem)

dataItemPath(project: string, location: string, dataset: string, dataItem: string): string;

Return a fully-qualified dataItem resource name string.

Parameters

Name	Description
project	`string`
location	`string`
dataset	`string`
dataItem	`string`

Returns

Type	Description
string	{string} Resource name string.

dataLabelingJobPath(project, location, dataLabelingJob)

dataLabelingJobPath(project: string, location: string, dataLabelingJob: string): string;

Return a fully-qualified dataLabelingJob resource name string.

Parameters

Name	Description
project	`string`
location	`string`
dataLabelingJob	`string`

Returns

Type	Description
string	{string} Resource name string.

datasetPath(project, location, dataset)

datasetPath(project: string, location: string, dataset: string): string;

Return a fully-qualified dataset resource name string.

Parameters

Name	Description
project	`string`
location	`string`
dataset	`string`

Returns

Type	Description
string	{string} Resource name string.

deleteIndexEndpoint(request, options)

deleteIndexEndpoint(request?: protos.google.cloud.aiplatform.v1.IDeleteIndexEndpointRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes an IndexEndpoint.

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteIndexEndpointRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the IndexEndpoint resource to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

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

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

  callDeleteIndexEndpoint();

deleteIndexEndpoint(request, options, callback)

deleteIndexEndpoint(request: protos.google.cloud.aiplatform.v1.IDeleteIndexEndpointRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteIndexEndpointRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteIndexEndpoint(request, callback)

deleteIndexEndpoint(request: protos.google.cloud.aiplatform.v1.IDeleteIndexEndpointRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeleteIndexEndpointRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deployIndex(request, options)

deployIndex(request?: protos.google.cloud.aiplatform.v1.IDeployIndexRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1.IDeployIndexResponse, protos.google.cloud.aiplatform.v1.IDeployIndexOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeployIndexRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.aiplatform.v1.IDeployIndexResponse, protos.google.cloud.aiplatform.v1.IDeployIndexOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the IndexEndpoint resource into which to deploy an Index.
   *  Format:
   *  `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
   */
  // const indexEndpoint = 'abc123'
  /**
   *  Required. The DeployedIndex to be created within the IndexEndpoint.
   */
  // const deployedIndex = {}

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

  async function callDeployIndex() {
    // Construct request
    const request = {
      indexEndpoint,
      deployedIndex,
    };

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

  callDeployIndex();

deployIndex(request, options, callback)

deployIndex(request: protos.google.cloud.aiplatform.v1.IDeployIndexRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IDeployIndexResponse, protos.google.cloud.aiplatform.v1.IDeployIndexOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeployIndexRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.aiplatform.v1.IDeployIndexResponse, protos.google.cloud.aiplatform.v1.IDeployIndexOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deployIndex(request, callback)

deployIndex(request: protos.google.cloud.aiplatform.v1.IDeployIndexRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IDeployIndexResponse, protos.google.cloud.aiplatform.v1.IDeployIndexOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IDeployIndexRequest`
callback	`Callback<LROperation<protos.google.cloud.aiplatform.v1.IDeployIndexResponse, protos.google.cloud.aiplatform.v1.IDeployIndexOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

endpointPath(project, location, endpoint)

endpointPath(project: string, location: string, endpoint: string): string;

Return a fully-qualified endpoint resource name string.

Parameters

Name	Description
project	`string`
location	`string`
endpoint	`string`

Returns

Type	Description
string	{string} Resource name string.

entityTypePath(project, location, featurestore, entityType)

entityTypePath(project: string, location: string, featurestore: string, entityType: string): string;

Return a fully-qualified entityType resource name string.

Parameters

Name	Description
project	`string`
location	`string`
featurestore	`string`
entityType	`string`

Returns

Type	Description
string	{string} Resource name string.

executionPath(project, location, metadataStore, execution)

executionPath(project: string, location: string, metadataStore: string, execution: string): string;

Return a fully-qualified execution resource name string.

Parameters

Name	Description
project	`string`
location	`string`
metadataStore	`string`
execution	`string`

Returns

Type	Description
string	{string} Resource name string.

featurePath(project, location, featurestore, entityType, feature)

featurePath(project: string, location: string, featurestore: string, entityType: string, feature: string): string;

Return a fully-qualified feature resource name string.

Parameters

Name	Description
project	`string`
location	`string`
featurestore	`string`
entityType	`string`
feature	`string`

Returns

Type	Description
string	{string} Resource name string.

featurestorePath(project, location, featurestore)

featurestorePath(project: string, location: string, featurestore: string): string;

Return a fully-qualified featurestore resource name string.

Parameters

Name	Description
project	`string`
location	`string`
featurestore	`string`

Returns

Type	Description
string	{string} Resource name string.

getIndexEndpoint(request, options)

getIndexEndpoint(request?: protos.google.cloud.aiplatform.v1.IGetIndexEndpointRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IIndexEndpoint,
        protos.google.cloud.aiplatform.v1.IGetIndexEndpointRequest | undefined,
        {} | undefined
    ]>;

Gets an IndexEndpoint.

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetIndexEndpointRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.IGetIndexEndpointRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [IndexEndpoint]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the IndexEndpoint resource.
   *  Format:
   *  `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
   */
  // const name = 'abc123'

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

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

    // Run request
    const response = await aiplatformClient.getIndexEndpoint(request);
    console.log(response);
  }

  callGetIndexEndpoint();

getIndexEndpoint(request, options, callback)

getIndexEndpoint(request: protos.google.cloud.aiplatform.v1.IGetIndexEndpointRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.IGetIndexEndpointRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetIndexEndpointRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.IGetIndexEndpointRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getIndexEndpoint(request, callback)

getIndexEndpoint(request: protos.google.cloud.aiplatform.v1.IGetIndexEndpointRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.IGetIndexEndpointRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IGetIndexEndpointRequest`
callback	`Callback<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.IGetIndexEndpointRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
void

hyperparameterTuningJobPath(project, location, hyperparameterTuningJob)

hyperparameterTuningJobPath(project: string, location: string, hyperparameterTuningJob: string): string;

Return a fully-qualified hyperparameterTuningJob resource name string.

Parameters

Name	Description
project	`string`
location	`string`
hyperparameterTuningJob	`string`

Returns

Type	Description
string	{string} Resource name string.

indexEndpointPath(project, location, indexEndpoint)

indexEndpointPath(project: string, location: string, indexEndpoint: string): string;

Return a fully-qualified indexEndpoint resource name string.

Parameters

Name	Description
project	`string`
location	`string`
indexEndpoint	`string`

Returns

Type	Description
string	{string} Resource name string.

indexPath(project, location, index)

indexPath(project: string, location: string, index: string): string;

Return a fully-qualified index resource name string.

Parameters

Name	Description
project	`string`
location	`string`
index	`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.

listIndexEndpoints(request, options)

listIndexEndpoints(request?: protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IIndexEndpoint[],
        protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest | null,
        protos.google.cloud.aiplatform.v1.IListIndexEndpointsResponse
    ]>;

Lists IndexEndpoints in a Location.

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[ protos.google.cloud.aiplatform.v1.IIndexEndpoint[], protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest | null, protos.google.cloud.aiplatform.v1.IListIndexEndpointsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [IndexEndpoint]. 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 listIndexEndpointsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listIndexEndpoints(request, options, callback)

listIndexEndpoints(request: protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest, protos.google.cloud.aiplatform.v1.IListIndexEndpointsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IIndexEndpoint>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest, protos.google.cloud.aiplatform.v1.IListIndexEndpointsResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.IIndexEndpoint>`

Returns

Type	Description
void

listIndexEndpoints(request, callback)

listIndexEndpoints(request: protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest, protos.google.cloud.aiplatform.v1.IListIndexEndpointsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IIndexEndpoint>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest`
callback	`PaginationCallback<protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest, protos.google.cloud.aiplatform.v1.IListIndexEndpointsResponse \| null \| undefined, protos.google.cloud.aiplatform.v1.IIndexEndpoint>`

Returns

Type	Description
void

listIndexEndpointsAsync(request, options)

listIndexEndpointsAsync(request?: protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IIndexEndpoint>;

Equivalent to listIndexEndpoints, but returns an iterable object.

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

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.aiplatform.v1.IIndexEndpoint>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [IndexEndpoint]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Location from which to list the IndexEndpoints.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. An expression for filtering the results of the request. For field names
   *  both snake_case and camelCase are supported.
   *    * `index_endpoint` supports = and !=. `index_endpoint` represents the
   *       IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
   *       resourcename google.cloud.aiplatform.v1.IndexEndpoint.name.
   *    * `display_name` supports =, != and regex()
   *              (uses re2 (https://github.com/google/re2/wiki/Syntax) syntax)
   *    * `labels` supports general map functions that is:
   *              `labels.key=value` - key:value equality
   *              `labels.key:* or labels:key - key existence
   *               A key including a space must be quoted. `labels."a key"`.
   *  Some examples:
   *    * `index_endpoint="1"`
   *    * `display_name="myDisplayName"`
   *    * `regex(display_name, "^A") -> The display name starts with an A.
   *    * `labels.myKey="myValue"`
   */
  // const filter = 'abc123'
  /**
   *  Optional. The standard list page size.
   */
  // const pageSize = 1234
  /**
   *  Optional. The standard list page token.
   *  Typically obtained via
   *  ListIndexEndpointsResponse.next_page_token google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token  of the previous
   *  IndexEndpointService.ListIndexEndpoints google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints  call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Mask specifying which fields to read.
   */
  // const readMask = {}

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

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

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

  callListIndexEndpoints();

listIndexEndpointsStream(request, options)

listIndexEndpointsStream(request?: protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IListIndexEndpointsRequest` 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 [IndexEndpoint] 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 listIndexEndpointsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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.

matchAnnotationFromAnnotationName(annotationName)

matchAnnotationFromAnnotationName(annotationName: string): string | number;

Parse the annotation from Annotation resource.

Parameter

Name	Description
annotationName	`string` A fully-qualified path representing Annotation resource.

Returns

Type	Description
string \| number	{string} A string representing the annotation.

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName)

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the annotation_spec from AnnotationSpec resource.

Parameter

Name	Description
annotationSpecName	`string` A fully-qualified path representing AnnotationSpec resource.

Returns

Type	Description
string \| number	{string} A string representing the annotation_spec.

matchArtifactFromArtifactName(artifactName)

matchArtifactFromArtifactName(artifactName: string): string | number;

Parse the artifact from Artifact resource.

Parameter

Name	Description
artifactName	`string` A fully-qualified path representing Artifact resource.

Returns

Type	Description
string \| number	{string} A string representing the artifact.

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName)

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the batch_prediction_job from BatchPredictionJob resource.

Parameter

Name	Description
batchPredictionJobName	`string` A fully-qualified path representing BatchPredictionJob resource.

Returns

Type	Description
string \| number	{string} A string representing the batch_prediction_job.

matchContextFromContextName(contextName)

matchContextFromContextName(contextName: string): string | number;

Parse the context from Context resource.

Parameter

Name	Description
contextName	`string` A fully-qualified path representing Context resource.

Returns

Type	Description
string \| number	{string} A string representing the context.

matchCustomJobFromCustomJobName(customJobName)

matchCustomJobFromCustomJobName(customJobName: string): string | number;

Parse the custom_job from CustomJob resource.

Parameter

Name	Description
customJobName	`string` A fully-qualified path representing CustomJob resource.

Returns

Type	Description
string \| number	{string} A string representing the custom_job.

matchDataItemFromAnnotationName(annotationName)

matchDataItemFromAnnotationName(annotationName: string): string | number;

Parse the data_item from Annotation resource.

Parameter

Name	Description
annotationName	`string` A fully-qualified path representing Annotation resource.

Returns

Type	Description
string \| number	{string} A string representing the data_item.

matchDataItemFromDataItemName(dataItemName)

matchDataItemFromDataItemName(dataItemName: string): string | number;

Parse the data_item from DataItem resource.

Parameter

Name	Description
dataItemName	`string` A fully-qualified path representing DataItem resource.

Returns

Type	Description
string \| number	{string} A string representing the data_item.

matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName)

matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the data_labeling_job from DataLabelingJob resource.

Parameter

Name	Description
dataLabelingJobName	`string` A fully-qualified path representing DataLabelingJob resource.

Returns

Type	Description
string \| number	{string} A string representing the data_labeling_job.

matchDatasetFromAnnotationName(annotationName)

matchDatasetFromAnnotationName(annotationName: string): string | number;

Parse the dataset from Annotation resource.

Parameter

Name	Description
annotationName	`string` A fully-qualified path representing Annotation resource.

Returns

Type	Description
string \| number	{string} A string representing the dataset.

matchDatasetFromAnnotationSpecName(annotationSpecName)

matchDatasetFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the dataset from AnnotationSpec resource.

Parameter

Name	Description
annotationSpecName	`string` A fully-qualified path representing AnnotationSpec resource.

Returns

Type	Description
string \| number	{string} A string representing the dataset.

matchDatasetFromDataItemName(dataItemName)

matchDatasetFromDataItemName(dataItemName: string): string | number;

Parse the dataset from DataItem resource.

Parameter

Name	Description
dataItemName	`string` A fully-qualified path representing DataItem resource.

Returns

Type	Description
string \| number	{string} A string representing the dataset.

matchDatasetFromDatasetName(datasetName)

matchDatasetFromDatasetName(datasetName: string): string | number;

Parse the dataset from Dataset resource.

Parameter

Name	Description
datasetName	`string` A fully-qualified path representing Dataset resource.

Returns

Type	Description
string \| number	{string} A string representing the dataset.

matchEndpointFromEndpointName(endpointName)

matchEndpointFromEndpointName(endpointName: string): string | number;

Parse the endpoint from Endpoint resource.

Parameter

Name	Description
endpointName	`string` A fully-qualified path representing Endpoint resource.

Returns

Type	Description
string \| number	{string} A string representing the endpoint.

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

Type	Description
string \| number	{string} A string representing the entity_type.

matchEntityTypeFromFeatureName(featureName)

matchEntityTypeFromFeatureName(featureName: string): string | number;

Parse the entity_type from Feature resource.

Parameter

Name	Description
featureName	`string` A fully-qualified path representing Feature resource.

Returns

Type	Description
string \| number	{string} A string representing the entity_type.

matchEvaluationFromModelEvaluationName(modelEvaluationName)

matchEvaluationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the evaluation from ModelEvaluation resource.

Parameter

Name	Description
modelEvaluationName	`string` A fully-qualified path representing ModelEvaluation resource.

Returns

Type	Description
string \| number	{string} A string representing the evaluation.

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName)

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the evaluation from ModelEvaluationSlice resource.

Parameter

Name	Description
modelEvaluationSliceName	`string` A fully-qualified path representing ModelEvaluationSlice resource.

Returns

Type	Description
string \| number	{string} A string representing the evaluation.

matchExecutionFromExecutionName(executionName)

matchExecutionFromExecutionName(executionName: string): string | number;

Parse the execution from Execution resource.

Parameter

Name	Description
executionName	`string` A fully-qualified path representing Execution resource.

Returns

Type	Description
string \| number	{string} A string representing the execution.

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName)

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the experiment from TensorboardExperiment resource.

Parameter

Name	Description
tensorboardExperimentName	`string` A fully-qualified path representing TensorboardExperiment resource.

Returns

Type	Description
string \| number	{string} A string representing the experiment.

matchExperimentFromTensorboardRunName(tensorboardRunName)

matchExperimentFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the experiment from TensorboardRun resource.

Parameter

Name	Description
tensorboardRunName	`string` A fully-qualified path representing TensorboardRun resource.

Returns

Type	Description
string \| number	{string} A string representing the experiment.

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the experiment from TensorboardTimeSeries resource.

Parameter

Name	Description
tensorboardTimeSeriesName	`string` A fully-qualified path representing TensorboardTimeSeries resource.

Returns

Type	Description
string \| number	{string} A string representing the experiment.

matchFeatureFromFeatureName(featureName)

matchFeatureFromFeatureName(featureName: string): string | number;

Parse the feature from Feature resource.

Parameter

Name	Description
featureName	`string` A fully-qualified path representing Feature resource.

Returns

Type	Description
string \| number	{string} A string representing the feature.

matchFeaturestoreFromEntityTypeName(entityTypeName)

matchFeaturestoreFromEntityTypeName(entityTypeName: string): string | number;

Parse the featurestore from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

Type	Description
string \| number	{string} A string representing the featurestore.

matchFeaturestoreFromFeatureName(featureName)

matchFeaturestoreFromFeatureName(featureName: string): string | number;

Parse the featurestore from Feature resource.

Parameter

Name	Description
featureName	`string` A fully-qualified path representing Feature resource.

Returns

Type	Description
string \| number	{string} A string representing the featurestore.

matchFeaturestoreFromFeaturestoreName(featurestoreName)

matchFeaturestoreFromFeaturestoreName(featurestoreName: string): string | number;

Parse the featurestore from Featurestore resource.

Parameter

Name	Description
featurestoreName	`string` A fully-qualified path representing Featurestore resource.

Returns

Type	Description
string \| number	{string} A string representing the featurestore.

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the hyperparameter_tuning_job from HyperparameterTuningJob resource.

Parameter

Name	Description
hyperparameterTuningJobName	`string` A fully-qualified path representing HyperparameterTuningJob resource.

Returns

Type	Description
string \| number	{string} A string representing the hyperparameter_tuning_job.

matchIndexEndpointFromIndexEndpointName(indexEndpointName)

matchIndexEndpointFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the index_endpoint from IndexEndpoint resource.

Parameter

Name	Description
indexEndpointName	`string` A fully-qualified path representing IndexEndpoint resource.

Returns

Type	Description
string \| number	{string} A string representing the index_endpoint.

matchIndexFromIndexName(indexName)

matchIndexFromIndexName(indexName: string): string | number;

Parse the index from Index resource.

Parameter

Name	Description
indexName	`string` A fully-qualified path representing Index resource.

Returns

Type	Description
string \| number	{string} A string representing the index.

matchLocationFromAnnotationName(annotationName)

matchLocationFromAnnotationName(annotationName: string): string | number;

Parse the location from Annotation resource.

Parameter

Name	Description
annotationName	`string` A fully-qualified path representing Annotation resource.

Returns

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

matchLocationFromAnnotationSpecName(annotationSpecName)

matchLocationFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the location from AnnotationSpec resource.

Parameter

Name	Description
annotationSpecName	`string` A fully-qualified path representing AnnotationSpec resource.

Returns

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

matchLocationFromArtifactName(artifactName)

matchLocationFromArtifactName(artifactName: string): string | number;

Parse the location from Artifact resource.

Parameter

Name	Description
artifactName	`string` A fully-qualified path representing Artifact resource.

Returns

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

matchLocationFromBatchPredictionJobName(batchPredictionJobName)

matchLocationFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the location from BatchPredictionJob resource.

Parameter

Name	Description
batchPredictionJobName	`string` A fully-qualified path representing BatchPredictionJob resource.

Returns

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

matchLocationFromContextName(contextName)

matchLocationFromContextName(contextName: string): string | number;

Parse the location from Context resource.

Parameter

Name	Description
contextName	`string` A fully-qualified path representing Context resource.

Returns

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

matchLocationFromCustomJobName(customJobName)

matchLocationFromCustomJobName(customJobName: string): string | number;

Parse the location from CustomJob resource.

Parameter

Name	Description
customJobName	`string` A fully-qualified path representing CustomJob resource.

Returns

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

matchLocationFromDataItemName(dataItemName)

matchLocationFromDataItemName(dataItemName: string): string | number;

Parse the location from DataItem resource.

Parameter

Name	Description
dataItemName	`string` A fully-qualified path representing DataItem resource.

Returns

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

matchLocationFromDataLabelingJobName(dataLabelingJobName)

matchLocationFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the location from DataLabelingJob resource.

Parameter

Name	Description
dataLabelingJobName	`string` A fully-qualified path representing DataLabelingJob resource.

Returns

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

matchLocationFromDatasetName(datasetName)

matchLocationFromDatasetName(datasetName: string): string | number;

Parse the location from Dataset resource.

Parameter

Name	Description
datasetName	`string` A fully-qualified path representing Dataset resource.

Returns

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

matchLocationFromEndpointName(endpointName)

matchLocationFromEndpointName(endpointName: string): string | number;

Parse the location from Endpoint resource.

Parameter

Name	Description
endpointName	`string` A fully-qualified path representing Endpoint resource.

Returns

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

matchLocationFromEntityTypeName(entityTypeName)

matchLocationFromEntityTypeName(entityTypeName: string): string | number;

Parse the location from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

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

matchLocationFromExecutionName(executionName)

matchLocationFromExecutionName(executionName: string): string | number;

Parse the location from Execution resource.

Parameter

Name	Description
executionName	`string` A fully-qualified path representing Execution resource.

Returns

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

matchLocationFromFeatureName(featureName)

matchLocationFromFeatureName(featureName: string): string | number;

Parse the location from Feature resource.

Parameter

Name	Description
featureName	`string` A fully-qualified path representing Feature resource.

Returns

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

matchLocationFromFeaturestoreName(featurestoreName)

matchLocationFromFeaturestoreName(featurestoreName: string): string | number;

Parse the location from Featurestore resource.

Parameter

Name	Description
featurestoreName	`string` A fully-qualified path representing Featurestore resource.

Returns

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

matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the location from HyperparameterTuningJob resource.

Parameter

Name	Description
hyperparameterTuningJobName	`string` A fully-qualified path representing HyperparameterTuningJob resource.

Returns

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

matchLocationFromIndexEndpointName(indexEndpointName)

matchLocationFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the location from IndexEndpoint resource.

Parameter

Name	Description
indexEndpointName	`string` A fully-qualified path representing IndexEndpoint resource.

Returns

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

matchLocationFromIndexName(indexName)

matchLocationFromIndexName(indexName: string): string | number;

Parse the location from Index resource.

Parameter

Name	Description
indexName	`string` A fully-qualified path representing Index 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.

matchLocationFromMetadataSchemaName(metadataSchemaName)

matchLocationFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the location from MetadataSchema resource.

Parameter

Name	Description
metadataSchemaName	`string` A fully-qualified path representing MetadataSchema resource.

Returns

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

matchLocationFromMetadataStoreName(metadataStoreName)

matchLocationFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the location from MetadataStore resource.

Parameter

Name	Description
metadataStoreName	`string` A fully-qualified path representing MetadataStore resource.

Returns

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

matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName)

matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;

Parse the location from ModelDeploymentMonitoringJob resource.

Parameter

Name	Description
modelDeploymentMonitoringJobName	`string` A fully-qualified path representing ModelDeploymentMonitoringJob resource.

Returns

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

matchLocationFromModelEvaluationName(modelEvaluationName)

matchLocationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the location from ModelEvaluation resource.

Parameter

Name	Description
modelEvaluationName	`string` A fully-qualified path representing ModelEvaluation resource.

Returns

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

matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName)

matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the location from ModelEvaluationSlice resource.

Parameter

Name	Description
modelEvaluationSliceName	`string` A fully-qualified path representing ModelEvaluationSlice resource.

Returns

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

matchLocationFromModelName(modelName)

matchLocationFromModelName(modelName: string): string | number;

Parse the location from Model resource.

Parameter

Name	Description
modelName	`string` A fully-qualified path representing Model resource.

Returns

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

matchLocationFromPipelineJobName(pipelineJobName)

matchLocationFromPipelineJobName(pipelineJobName: string): string | number;

Parse the location from PipelineJob resource.

Parameter

Name	Description
pipelineJobName	`string` A fully-qualified path representing PipelineJob resource.

Returns

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

matchLocationFromSpecialistPoolName(specialistPoolName)

matchLocationFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the location from SpecialistPool resource.

Parameter

Name	Description
specialistPoolName	`string` A fully-qualified path representing SpecialistPool resource.

Returns

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

matchLocationFromStudyName(studyName)

matchLocationFromStudyName(studyName: string): string | number;

Parse the location from Study resource.

Parameter

Name	Description
studyName	`string` A fully-qualified path representing Study resource.

Returns

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

matchLocationFromTensorboardExperimentName(tensorboardExperimentName)

matchLocationFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the location from TensorboardExperiment resource.

Parameter

Name	Description
tensorboardExperimentName	`string` A fully-qualified path representing TensorboardExperiment resource.

Returns

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

matchLocationFromTensorboardName(tensorboardName)

matchLocationFromTensorboardName(tensorboardName: string): string | number;

Parse the location from Tensorboard resource.

Parameter

Name	Description
tensorboardName	`string` A fully-qualified path representing Tensorboard resource.

Returns

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

matchLocationFromTensorboardRunName(tensorboardRunName)

matchLocationFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the location from TensorboardRun resource.

Parameter

Name	Description
tensorboardRunName	`string` A fully-qualified path representing TensorboardRun resource.

Returns

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

matchLocationFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchLocationFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the location from TensorboardTimeSeries resource.

Parameter

Name	Description
tensorboardTimeSeriesName	`string` A fully-qualified path representing TensorboardTimeSeries resource.

Returns

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

matchLocationFromTrainingPipelineName(trainingPipelineName)

matchLocationFromTrainingPipelineName(trainingPipelineName: string): string | number;

Parse the location from TrainingPipeline resource.

Parameter

Name	Description
trainingPipelineName	`string` A fully-qualified path representing TrainingPipeline resource.

Returns

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

matchLocationFromTrialName(trialName)

matchLocationFromTrialName(trialName: string): string | number;

Parse the location from Trial resource.

Parameter

Name	Description
trialName	`string` A fully-qualified path representing Trial resource.

Returns

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

matchMetadataSchemaFromMetadataSchemaName(metadataSchemaName)

matchMetadataSchemaFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the metadata_schema from MetadataSchema resource.

Parameter

Name	Description
metadataSchemaName	`string` A fully-qualified path representing MetadataSchema resource.

Returns

Type	Description
string \| number	{string} A string representing the metadata_schema.

matchMetadataStoreFromArtifactName(artifactName)

matchMetadataStoreFromArtifactName(artifactName: string): string | number;

Parse the metadata_store from Artifact resource.

Parameter

Name	Description
artifactName	`string` A fully-qualified path representing Artifact resource.

Returns

Type	Description
string \| number	{string} A string representing the metadata_store.

matchMetadataStoreFromContextName(contextName)

matchMetadataStoreFromContextName(contextName: string): string | number;

Parse the metadata_store from Context resource.

Parameter

Name	Description
contextName	`string` A fully-qualified path representing Context resource.

Returns

Type	Description
string \| number	{string} A string representing the metadata_store.

matchMetadataStoreFromExecutionName(executionName)

matchMetadataStoreFromExecutionName(executionName: string): string | number;

Parse the metadata_store from Execution resource.

Parameter

Name	Description
executionName	`string` A fully-qualified path representing Execution resource.

Returns

Type	Description
string \| number	{string} A string representing the metadata_store.

matchMetadataStoreFromMetadataSchemaName(metadataSchemaName)

matchMetadataStoreFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the metadata_store from MetadataSchema resource.

Parameter

Name	Description
metadataSchemaName	`string` A fully-qualified path representing MetadataSchema resource.

Returns

Type	Description
string \| number	{string} A string representing the metadata_store.

matchMetadataStoreFromMetadataStoreName(metadataStoreName)

matchMetadataStoreFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the metadata_store from MetadataStore resource.

Parameter

Name	Description
metadataStoreName	`string` A fully-qualified path representing MetadataStore resource.

Returns

Type	Description
string \| number	{string} A string representing the metadata_store.

matchModelDeploymentMonitoringJobFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName)

matchModelDeploymentMonitoringJobFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;

Parse the model_deployment_monitoring_job from ModelDeploymentMonitoringJob resource.

Parameter

Name	Description
modelDeploymentMonitoringJobName	`string` A fully-qualified path representing ModelDeploymentMonitoringJob resource.

Returns

Type	Description
string \| number	{string} A string representing the model_deployment_monitoring_job.

matchModelFromModelEvaluationName(modelEvaluationName)

matchModelFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the model from ModelEvaluation resource.

Parameter

Name	Description
modelEvaluationName	`string` A fully-qualified path representing ModelEvaluation resource.

Returns

Type	Description
string \| number	{string} A string representing the model.

matchModelFromModelEvaluationSliceName(modelEvaluationSliceName)

matchModelFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the model from ModelEvaluationSlice resource.

Parameter

Name	Description
modelEvaluationSliceName	`string` A fully-qualified path representing ModelEvaluationSlice resource.

Returns

Type	Description
string \| number	{string} A string representing the model.

matchModelFromModelName(modelName)

matchModelFromModelName(modelName: string): string | number;

Parse the model from Model resource.

Parameter

Name	Description
modelName	`string` A fully-qualified path representing Model resource.

Returns

Type	Description
string \| number	{string} A string representing the model.

matchPipelineJobFromPipelineJobName(pipelineJobName)

matchPipelineJobFromPipelineJobName(pipelineJobName: string): string | number;

Parse the pipeline_job from PipelineJob resource.

Parameter

Name	Description
pipelineJobName	`string` A fully-qualified path representing PipelineJob resource.

Returns

Type	Description
string \| number	{string} A string representing the pipeline_job.

matchProjectFromAnnotationName(annotationName)

matchProjectFromAnnotationName(annotationName: string): string | number;

Parse the project from Annotation resource.

Parameter

Name	Description
annotationName	`string` A fully-qualified path representing Annotation resource.

Returns

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

matchProjectFromAnnotationSpecName(annotationSpecName)

matchProjectFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the project from AnnotationSpec resource.

Parameter

Name	Description
annotationSpecName	`string` A fully-qualified path representing AnnotationSpec resource.

Returns

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

matchProjectFromArtifactName(artifactName)

matchProjectFromArtifactName(artifactName: string): string | number;

Parse the project from Artifact resource.

Parameter

Name	Description
artifactName	`string` A fully-qualified path representing Artifact resource.

Returns

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

matchProjectFromBatchPredictionJobName(batchPredictionJobName)

matchProjectFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the project from BatchPredictionJob resource.

Parameter

Name	Description
batchPredictionJobName	`string` A fully-qualified path representing BatchPredictionJob resource.

Returns

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

matchProjectFromContextName(contextName)

matchProjectFromContextName(contextName: string): string | number;

Parse the project from Context resource.

Parameter

Name	Description
contextName	`string` A fully-qualified path representing Context resource.

Returns

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

matchProjectFromCustomJobName(customJobName)

matchProjectFromCustomJobName(customJobName: string): string | number;

Parse the project from CustomJob resource.

Parameter

Name	Description
customJobName	`string` A fully-qualified path representing CustomJob resource.

Returns

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

matchProjectFromDataItemName(dataItemName)

matchProjectFromDataItemName(dataItemName: string): string | number;

Parse the project from DataItem resource.

Parameter

Name	Description
dataItemName	`string` A fully-qualified path representing DataItem resource.

Returns

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

matchProjectFromDataLabelingJobName(dataLabelingJobName)

matchProjectFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the project from DataLabelingJob resource.

Parameter

Name	Description
dataLabelingJobName	`string` A fully-qualified path representing DataLabelingJob resource.

Returns

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

matchProjectFromDatasetName(datasetName)

matchProjectFromDatasetName(datasetName: string): string | number;

Parse the project from Dataset resource.

Parameter

Name	Description
datasetName	`string` A fully-qualified path representing Dataset resource.

Returns

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

matchProjectFromEndpointName(endpointName)

matchProjectFromEndpointName(endpointName: string): string | number;

Parse the project from Endpoint resource.

Parameter

Name	Description
endpointName	`string` A fully-qualified path representing Endpoint resource.

Returns

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

matchProjectFromEntityTypeName(entityTypeName)

matchProjectFromEntityTypeName(entityTypeName: string): string | number;

Parse the project from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

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

matchProjectFromExecutionName(executionName)

matchProjectFromExecutionName(executionName: string): string | number;

Parse the project from Execution resource.

Parameter

Name	Description
executionName	`string` A fully-qualified path representing Execution resource.

Returns

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

matchProjectFromFeatureName(featureName)

matchProjectFromFeatureName(featureName: string): string | number;

Parse the project from Feature resource.

Parameter

Name	Description
featureName	`string` A fully-qualified path representing Feature resource.

Returns

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

matchProjectFromFeaturestoreName(featurestoreName)

matchProjectFromFeaturestoreName(featurestoreName: string): string | number;

Parse the project from Featurestore resource.

Parameter

Name	Description
featurestoreName	`string` A fully-qualified path representing Featurestore resource.

Returns

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

matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the project from HyperparameterTuningJob resource.

Parameter

Name	Description
hyperparameterTuningJobName	`string` A fully-qualified path representing HyperparameterTuningJob resource.

Returns

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

matchProjectFromIndexEndpointName(indexEndpointName)

matchProjectFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the project from IndexEndpoint resource.

Parameter

Name	Description
indexEndpointName	`string` A fully-qualified path representing IndexEndpoint resource.

Returns

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

matchProjectFromIndexName(indexName)

matchProjectFromIndexName(indexName: string): string | number;

Parse the project from Index resource.

Parameter

Name	Description
indexName	`string` A fully-qualified path representing Index 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.

matchProjectFromMetadataSchemaName(metadataSchemaName)

matchProjectFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the project from MetadataSchema resource.

Parameter

Name	Description
metadataSchemaName	`string` A fully-qualified path representing MetadataSchema resource.

Returns

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

matchProjectFromMetadataStoreName(metadataStoreName)

matchProjectFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the project from MetadataStore resource.

Parameter

Name	Description
metadataStoreName	`string` A fully-qualified path representing MetadataStore resource.

Returns

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

matchProjectFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName)

matchProjectFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;

Parse the project from ModelDeploymentMonitoringJob resource.

Parameter

Name	Description
modelDeploymentMonitoringJobName	`string` A fully-qualified path representing ModelDeploymentMonitoringJob resource.

Returns

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

matchProjectFromModelEvaluationName(modelEvaluationName)

matchProjectFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the project from ModelEvaluation resource.

Parameter

Name	Description
modelEvaluationName	`string` A fully-qualified path representing ModelEvaluation resource.

Returns

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

matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName)

matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the project from ModelEvaluationSlice resource.

Parameter

Name	Description
modelEvaluationSliceName	`string` A fully-qualified path representing ModelEvaluationSlice resource.

Returns

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

matchProjectFromModelName(modelName)

matchProjectFromModelName(modelName: string): string | number;

Parse the project from Model resource.

Parameter

Name	Description
modelName	`string` A fully-qualified path representing Model resource.

Returns

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

matchProjectFromPipelineJobName(pipelineJobName)

matchProjectFromPipelineJobName(pipelineJobName: string): string | number;

Parse the project from PipelineJob resource.

Parameter

Name	Description
pipelineJobName	`string` A fully-qualified path representing PipelineJob resource.

Returns

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

matchProjectFromSpecialistPoolName(specialistPoolName)

matchProjectFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the project from SpecialistPool resource.

Parameter

Name	Description
specialistPoolName	`string` A fully-qualified path representing SpecialistPool resource.

Returns

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

matchProjectFromStudyName(studyName)

matchProjectFromStudyName(studyName: string): string | number;

Parse the project from Study resource.

Parameter

Name	Description
studyName	`string` A fully-qualified path representing Study resource.

Returns

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

matchProjectFromTensorboardExperimentName(tensorboardExperimentName)

matchProjectFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the project from TensorboardExperiment resource.

Parameter

Name	Description
tensorboardExperimentName	`string` A fully-qualified path representing TensorboardExperiment resource.

Returns

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

matchProjectFromTensorboardName(tensorboardName)

matchProjectFromTensorboardName(tensorboardName: string): string | number;

Parse the project from Tensorboard resource.

Parameter

Name	Description
tensorboardName	`string` A fully-qualified path representing Tensorboard resource.

Returns

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

matchProjectFromTensorboardRunName(tensorboardRunName)

matchProjectFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the project from TensorboardRun resource.

Parameter

Name	Description
tensorboardRunName	`string` A fully-qualified path representing TensorboardRun resource.

Returns

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

matchProjectFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchProjectFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the project from TensorboardTimeSeries resource.

Parameter

Name	Description
tensorboardTimeSeriesName	`string` A fully-qualified path representing TensorboardTimeSeries resource.

Returns

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

matchProjectFromTrainingPipelineName(trainingPipelineName)

matchProjectFromTrainingPipelineName(trainingPipelineName: string): string | number;

Parse the project from TrainingPipeline resource.

Parameter

Name	Description
trainingPipelineName	`string` A fully-qualified path representing TrainingPipeline resource.

Returns

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

matchProjectFromTrialName(trialName)

matchProjectFromTrialName(trialName: string): string | number;

Parse the project from Trial resource.

Parameter

Name	Description
trialName	`string` A fully-qualified path representing Trial resource.

Returns

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

matchRunFromTensorboardRunName(tensorboardRunName)

matchRunFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the run from TensorboardRun resource.

Parameter

Name	Description
tensorboardRunName	`string` A fully-qualified path representing TensorboardRun resource.

Returns

Type	Description
string \| number	{string} A string representing the run.

matchRunFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchRunFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the run from TensorboardTimeSeries resource.

Parameter

Name	Description
tensorboardTimeSeriesName	`string` A fully-qualified path representing TensorboardTimeSeries resource.

Returns

Type	Description
string \| number	{string} A string representing the run.

matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName)

matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the slice from ModelEvaluationSlice resource.

Parameter

Name	Description
modelEvaluationSliceName	`string` A fully-qualified path representing ModelEvaluationSlice resource.

Returns

Type	Description
string \| number	{string} A string representing the slice.

matchSpecialistPoolFromSpecialistPoolName(specialistPoolName)

matchSpecialistPoolFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the specialist_pool from SpecialistPool resource.

Parameter

Name	Description
specialistPoolName	`string` A fully-qualified path representing SpecialistPool resource.

Returns

Type	Description
string \| number	{string} A string representing the specialist_pool.

matchStudyFromStudyName(studyName)

matchStudyFromStudyName(studyName: string): string | number;

Parse the study from Study resource.

Parameter

Name	Description
studyName	`string` A fully-qualified path representing Study resource.

Returns

Type	Description
string \| number	{string} A string representing the study.

matchStudyFromTrialName(trialName)

matchStudyFromTrialName(trialName: string): string | number;

Parse the study from Trial resource.

Parameter

Name	Description
trialName	`string` A fully-qualified path representing Trial resource.

Returns

Type	Description
string \| number	{string} A string representing the study.

matchTensorboardFromTensorboardExperimentName(tensorboardExperimentName)

matchTensorboardFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the tensorboard from TensorboardExperiment resource.

Parameter

Name	Description
tensorboardExperimentName	`string` A fully-qualified path representing TensorboardExperiment resource.

Returns

Type	Description
string \| number	{string} A string representing the tensorboard.

matchTensorboardFromTensorboardName(tensorboardName)

matchTensorboardFromTensorboardName(tensorboardName: string): string | number;

Parse the tensorboard from Tensorboard resource.

Parameter

Name	Description
tensorboardName	`string` A fully-qualified path representing Tensorboard resource.

Returns

Type	Description
string \| number	{string} A string representing the tensorboard.

matchTensorboardFromTensorboardRunName(tensorboardRunName)

matchTensorboardFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the tensorboard from TensorboardRun resource.

Parameter

Name	Description
tensorboardRunName	`string` A fully-qualified path representing TensorboardRun resource.

Returns

Type	Description
string \| number	{string} A string representing the tensorboard.

matchTensorboardFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchTensorboardFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the tensorboard from TensorboardTimeSeries resource.

Parameter

Name	Description
tensorboardTimeSeriesName	`string` A fully-qualified path representing TensorboardTimeSeries resource.

Returns

Type	Description
string \| number	{string} A string representing the tensorboard.

matchTimeSeriesFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchTimeSeriesFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the time_series from TensorboardTimeSeries resource.

Parameter

Name	Description
tensorboardTimeSeriesName	`string` A fully-qualified path representing TensorboardTimeSeries resource.

Returns

Type	Description
string \| number	{string} A string representing the time_series.

matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName)

matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName: string): string | number;

Parse the training_pipeline from TrainingPipeline resource.

Parameter

Name	Description
trainingPipelineName	`string` A fully-qualified path representing TrainingPipeline resource.

Returns

Type	Description
string \| number	{string} A string representing the training_pipeline.

matchTrialFromTrialName(trialName)

matchTrialFromTrialName(trialName: string): string | number;

Parse the trial from Trial resource.

Parameter

Name	Description
trialName	`string` A fully-qualified path representing Trial resource.

Returns

Type	Description
string \| number	{string} A string representing the trial.

metadataSchemaPath(project, location, metadataStore, metadataSchema)

metadataSchemaPath(project: string, location: string, metadataStore: string, metadataSchema: string): string;

Return a fully-qualified metadataSchema resource name string.

Parameters

Name	Description
project	`string`
location	`string`
metadataStore	`string`
metadataSchema	`string`

Returns

Type	Description
string	{string} Resource name string.

metadataStorePath(project, location, metadataStore)

metadataStorePath(project: string, location: string, metadataStore: string): string;

Return a fully-qualified metadataStore resource name string.

Parameters

Name	Description
project	`string`
location	`string`
metadataStore	`string`

Returns

Type	Description
string	{string} Resource name string.

modelDeploymentMonitoringJobPath(project, location, modelDeploymentMonitoringJob)

modelDeploymentMonitoringJobPath(project: string, location: string, modelDeploymentMonitoringJob: string): string;

Return a fully-qualified modelDeploymentMonitoringJob resource name string.

Parameters

Name	Description
project	`string`
location	`string`
modelDeploymentMonitoringJob	`string`

Returns

Type	Description
string	{string} Resource name string.

modelEvaluationPath(project, location, model, evaluation)

modelEvaluationPath(project: string, location: string, model: string, evaluation: string): string;

Return a fully-qualified modelEvaluation resource name string.

Parameters

Name	Description
project	`string`
location	`string`
model	`string`
evaluation	`string`

Returns

Type	Description
string	{string} Resource name string.

modelEvaluationSlicePath(project, location, model, evaluation, slice)

modelEvaluationSlicePath(project: string, location: string, model: string, evaluation: string, slice: string): string;

Return a fully-qualified modelEvaluationSlice resource name string.

Parameters

Name	Description
project	`string`
location	`string`
model	`string`
evaluation	`string`
slice	`string`

Returns

Type	Description
string	{string} Resource name string.

modelPath(project, location, model)

modelPath(project: string, location: string, model: string): string;

Return a fully-qualified model resource name string.

Parameters

Name	Description
project	`string`
location	`string`
model	`string`

Returns

Type	Description
string	{string} Resource name string.

mutateDeployedIndex(request, options)

mutateDeployedIndex(request?: protos.google.cloud.aiplatform.v1.IMutateDeployedIndexRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1.IMutateDeployedIndexResponse, protos.google.cloud.aiplatform.v1.IMutateDeployedIndexOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Update an existing DeployedIndex under an IndexEndpoint.

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IMutateDeployedIndexRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.aiplatform.v1.IMutateDeployedIndexResponse, protos.google.cloud.aiplatform.v1.IMutateDeployedIndexOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the IndexEndpoint resource into which to deploy an Index.
   *  Format:
   *  `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
   */
  // const indexEndpoint = 'abc123'
  /**
   *  Required. The DeployedIndex to be updated within the IndexEndpoint.
   *  Currently, the updatable fields are DeployedIndex automatic_resources 
   *  and DeployedIndex dedicated_resources 
   */
  // const deployedIndex = {}

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

  async function callMutateDeployedIndex() {
    // Construct request
    const request = {
      indexEndpoint,
      deployedIndex,
    };

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

  callMutateDeployedIndex();

mutateDeployedIndex(request, options, callback)

mutateDeployedIndex(request: protos.google.cloud.aiplatform.v1.IMutateDeployedIndexRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IMutateDeployedIndexResponse, protos.google.cloud.aiplatform.v1.IMutateDeployedIndexOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IMutateDeployedIndexRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.aiplatform.v1.IMutateDeployedIndexResponse, protos.google.cloud.aiplatform.v1.IMutateDeployedIndexOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

mutateDeployedIndex(request, callback)

mutateDeployedIndex(request: protos.google.cloud.aiplatform.v1.IMutateDeployedIndexRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IMutateDeployedIndexResponse, protos.google.cloud.aiplatform.v1.IMutateDeployedIndexOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IMutateDeployedIndexRequest`
callback	`Callback<LROperation<protos.google.cloud.aiplatform.v1.IMutateDeployedIndexResponse, protos.google.cloud.aiplatform.v1.IMutateDeployedIndexOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

pipelineJobPath(project, location, pipelineJob)

pipelineJobPath(project: string, location: string, pipelineJob: string): string;

Return a fully-qualified pipelineJob resource name string.

Parameters

Name	Description
project	`string`
location	`string`
pipelineJob	`string`

Returns

Type	Description
string	{string} Resource name string.

specialistPoolPath(project, location, specialistPool)

specialistPoolPath(project: string, location: string, specialistPool: string): string;

Return a fully-qualified specialistPool resource name string.

Parameters

Name	Description
project	`string`
location	`string`
specialistPool	`string`

Returns

Type	Description
string	{string} Resource name string.

studyPath(project, location, study)

studyPath(project: string, location: string, study: string): string;

Return a fully-qualified study resource name string.

Parameters

Name	Description
project	`string`
location	`string`
study	`string`

Returns

Type	Description
string	{string} Resource name string.

tensorboardExperimentPath(project, location, tensorboard, experiment)

tensorboardExperimentPath(project: string, location: string, tensorboard: string, experiment: string): string;

Return a fully-qualified tensorboardExperiment resource name string.

Parameters

Name	Description
project	`string`
location	`string`
tensorboard	`string`
experiment	`string`

Returns

Type	Description
string	{string} Resource name string.

tensorboardPath(project, location, tensorboard)

tensorboardPath(project: string, location: string, tensorboard: string): string;

Return a fully-qualified tensorboard resource name string.

Parameters

Name	Description
project	`string`
location	`string`
tensorboard	`string`

Returns

Type	Description
string	{string} Resource name string.

tensorboardRunPath(project, location, tensorboard, experiment, run)

tensorboardRunPath(project: string, location: string, tensorboard: string, experiment: string, run: string): string;

Return a fully-qualified tensorboardRun resource name string.

Parameters

Name	Description
project	`string`
location	`string`
tensorboard	`string`
experiment	`string`
run	`string`

Returns

Type	Description
string	{string} Resource name string.

tensorboardTimeSeriesPath(project, location, tensorboard, experiment, run, timeSeries)

tensorboardTimeSeriesPath(project: string, location: string, tensorboard: string, experiment: string, run: string, timeSeries: string): string;

Return a fully-qualified tensorboardTimeSeries resource name string.

Parameters

Name	Description
project	`string`
location	`string`
tensorboard	`string`
experiment	`string`
run	`string`
timeSeries	`string`

Returns

Type	Description
string	{string} Resource name string.

trainingPipelinePath(project, location, trainingPipeline)

trainingPipelinePath(project: string, location: string, trainingPipeline: string): string;

Return a fully-qualified trainingPipeline resource name string.

Parameters

Name	Description
project	`string`
location	`string`
trainingPipeline	`string`

Returns

Type	Description
string	{string} Resource name string.

trialPath(project, location, study, trial)

trialPath(project: string, location: string, study: string, trial: string): string;

Return a fully-qualified trial resource name string.

Parameters

Name	Description
project	`string`
location	`string`
study	`string`
trial	`string`

Returns

Type	Description
string	{string} Resource name string.

undeployIndex(request, options)

undeployIndex(request?: protos.google.cloud.aiplatform.v1.IUndeployIndexRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1.IUndeployIndexResponse, protos.google.cloud.aiplatform.v1.IUndeployIndexOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IUndeployIndexRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.aiplatform.v1.IUndeployIndexResponse, protos.google.cloud.aiplatform.v1.IUndeployIndexOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the IndexEndpoint resource from which to undeploy an Index.
   *  Format:
   *  `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
   */
  // const indexEndpoint = 'abc123'
  /**
   *  Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.
   */
  // const deployedIndexId = 'abc123'

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

  async function callUndeployIndex() {
    // Construct request
    const request = {
      indexEndpoint,
      deployedIndexId,
    };

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

  callUndeployIndex();

undeployIndex(request, options, callback)

undeployIndex(request: protos.google.cloud.aiplatform.v1.IUndeployIndexRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IUndeployIndexResponse, protos.google.cloud.aiplatform.v1.IUndeployIndexOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IUndeployIndexRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.aiplatform.v1.IUndeployIndexResponse, protos.google.cloud.aiplatform.v1.IUndeployIndexOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

undeployIndex(request, callback)

undeployIndex(request: protos.google.cloud.aiplatform.v1.IUndeployIndexRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IUndeployIndexResponse, protos.google.cloud.aiplatform.v1.IUndeployIndexOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IUndeployIndexRequest`
callback	`Callback<LROperation<protos.google.cloud.aiplatform.v1.IUndeployIndexResponse, protos.google.cloud.aiplatform.v1.IUndeployIndexOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateIndexEndpoint(request, options)

updateIndexEndpoint(request?: protos.google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IIndexEndpoint,
        protos.google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest | undefined,
        {} | undefined
    ]>;

Updates an IndexEndpoint.

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [IndexEndpoint]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The IndexEndpoint which replaces the resource on the server.
   */
  // const indexEndpoint = {}
  /**
   *  Required. The update mask applies to the resource. See google.protobuf.FieldMask google.protobuf.FieldMask.
   */
  // const updateMask = {}

  // Imports the Aiplatform library
  const {IndexEndpointServiceClient} = require('@google-cloud/aiplatform').v1;

  // Instantiates a client
  const aiplatformClient = new IndexEndpointServiceClient();

  async function callUpdateIndexEndpoint() {
    // Construct request
    const request = {
      indexEndpoint,
      updateMask,
    };

    // Run request
    const response = await aiplatformClient.updateIndexEndpoint(request);
    console.log(response);
  }

  callUpdateIndexEndpoint();

updateIndexEndpoint(request, options, callback)

updateIndexEndpoint(request: protos.google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateIndexEndpoint(request, callback)

updateIndexEndpoint(request: protos.google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest`
callback	`Callback<protos.google.cloud.aiplatform.v1.IIndexEndpoint, protos.google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void