Class v1.ModelServiceClient (3.4.0)

Version 3.4.0

• 3.15.0 (latest)
• 3.13.0
• 3.11.0
• 3.10.1
• 3.9.0
• 3.7.0
• 3.6.0
• 3.4.0
• 3.3.0
• 3.0.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.7.0
• 2.6.1
• 2.5.0
• 2.3.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.0
• 1.11.0
• 1.7.2

A service for managing Vertex AI's machine learning Models. v1

Package

@google-cloud/aiplatform

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of ModelServiceClient.

Parameters
Name	Description
opts	ClientOptions
gaxInstance	typeof gax | typeof fallback : loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new ModelServiceClient({fallback: true}, gax); ```

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;

iamClient

iamClient: IamClient;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

modelServiceStub

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

batchImportEvaluatedAnnotations(request, options)

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

Imports a list of externally generated EvaluatedAnnotations.

Parameters
Name	Description
request	IBatchImportEvaluatedAnnotationsRequest 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.IBatchImportEvaluatedAnnotationsResponse, (protos.google.cloud.aiplatform.v1.IBatchImportEvaluatedAnnotationsRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing BatchImportEvaluatedAnnotationsResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent ModelEvaluationSlice resource.
   *  Format:
   *  `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`
   */
  // const parent = 'abc123'
  /**
   *  Required. Evaluated annotations resource to be imported.
   */
  // const evaluatedAnnotations = [1,2,3,4]

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

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

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

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

  callBatchImportEvaluatedAnnotations();

batchImportEvaluatedAnnotations(request, options, callback)

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

Parameters
Name	Description
request	IBatchImportEvaluatedAnnotationsRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.IBatchImportEvaluatedAnnotationsResponse, protos.google.cloud.aiplatform.v1.IBatchImportEvaluatedAnnotationsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

batchImportEvaluatedAnnotations(request, callback)

batchImportEvaluatedAnnotations(request: protos.google.cloud.aiplatform.v1.IBatchImportEvaluatedAnnotationsRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IBatchImportEvaluatedAnnotationsResponse, protos.google.cloud.aiplatform.v1.IBatchImportEvaluatedAnnotationsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBatchImportEvaluatedAnnotationsRequest
callback	Callback<protos.google.cloud.aiplatform.v1.IBatchImportEvaluatedAnnotationsResponse, protos.google.cloud.aiplatform.v1.IBatchImportEvaluatedAnnotationsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

batchImportModelEvaluationSlices(request, options)

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

Imports a list of externally generated ModelEvaluationSlice.

Parameters
Name	Description
request	IBatchImportModelEvaluationSlicesRequest 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.IBatchImportModelEvaluationSlicesResponse, (protos.google.cloud.aiplatform.v1.IBatchImportModelEvaluationSlicesRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing BatchImportModelEvaluationSlicesResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent ModelEvaluation resource.
   *  Format:
   *  `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
   */
  // const parent = 'abc123'
  /**
   *  Required. Model evaluation slice resource to be imported.
   */
  // const modelEvaluationSlices = [1,2,3,4]

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

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

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

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

  callBatchImportModelEvaluationSlices();

batchImportModelEvaluationSlices(request, options, callback)

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

Parameters
Name	Description
request	IBatchImportModelEvaluationSlicesRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.IBatchImportModelEvaluationSlicesResponse, protos.google.cloud.aiplatform.v1.IBatchImportModelEvaluationSlicesRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

batchImportModelEvaluationSlices(request, callback)

batchImportModelEvaluationSlices(request: protos.google.cloud.aiplatform.v1.IBatchImportModelEvaluationSlicesRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IBatchImportModelEvaluationSlicesResponse, protos.google.cloud.aiplatform.v1.IBatchImportModelEvaluationSlicesRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBatchImportModelEvaluationSlicesRequest
callback	Callback<protos.google.cloud.aiplatform.v1.IBatchImportModelEvaluationSlicesResponse, protos.google.cloud.aiplatform.v1.IBatchImportModelEvaluationSlicesRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

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.

cancelOperation(request, options, callback)

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

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

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

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

Example

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

checkCopyModelProgress(name)

checkCopyModelProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.CopyModelResponse, protos.google.cloud.aiplatform.v1.CopyModelOperationMetadata>>;

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

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

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. Copy source_model into a new Model with this ID. The ID will
   *  become the final component of the model resource name.
   *  This value may be up to 63 characters, and valid characters are
   *  `[a-z0-9_-]`. The first character cannot be a number or hyphen.
   */
  // const modelId = 'abc123'
  /**
   *  Optional. Specify this field to copy source_model into this existing
   *  Model as a new version. Format:
   *  `projects/{project}/locations/{location}/models/{model}`
   */
  // const parentModel = 'abc123'
  /**
   *  Required. The resource name of the Location into which to copy the Model.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource name of the Model to copy. That Model must be in the
   *  same Project. Format:
   *  `projects/{project}/locations/{location}/models/{model}`
   */
  // const sourceModel = 'abc123'
  /**
   *  Customer-managed encryption key options. If this is set,
   *  then the Model copy will be encrypted with the provided encryption key.
   */
  // const encryptionSpec = {}

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

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

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

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

  callCopyModel();

checkDeleteModelProgress(name)

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

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

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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Model resource to be deleted.
   *  Format: `projects/{project}/locations/{location}/models/{model}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteModel();

checkDeleteModelVersionProgress(name)

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

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

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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the model version to be deleted, with a version ID
   *  explicitly included.
   *  Example: `projects/{project}/locations/{location}/models/{model}@1234`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteModelVersion();

checkExportModelProgress(name)

checkExportModelProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.ExportModelResponse, protos.google.cloud.aiplatform.v1.ExportModelOperationMetadata>>;

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

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

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Model to export.
   *  The resource name may contain version id or version alias to specify the
   *  version, if no version is specified, the default version will be exported.
   */
  // const name = 'abc123'
  /**
   *  Required. The desired output location and configuration.
   */
  // const outputConfig = {}

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

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

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

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

  callExportModel();

checkUpdateExplanationDatasetProgress(name)

checkUpdateExplanationDatasetProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.UpdateExplanationDatasetResponse, protos.google.cloud.aiplatform.v1.UpdateExplanationDatasetOperationMetadata>>;

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

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

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Model to update.
   *  Format: `projects/{project}/locations/{location}/models/{model}`
   */
  // const model = 'abc123'
  /**
   *  The example config containing the location of the dataset.
   */
  // const examples = {}

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

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

  async function callUpdateExplanationDataset() {
    // Construct request
    const request = {
      model,
    };

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

  callUpdateExplanationDataset();

checkUploadModelProgress(name)

checkUploadModelProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.UploadModelResponse, protos.google.cloud.aiplatform.v1.UploadModelOperationMetadata>>;

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

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

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Location into which to upload the Model.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The resource name of the model into which to upload the version.
   *  Only specify this field when uploading a new version.
   */
  // const parentModel = 'abc123'
  /**
   *  Optional. The ID to use for the uploaded Model, which will become the final
   *  component of the model resource name.
   *  This value may be up to 63 characters, and valid characters are
   *  `[a-z0-9_-]`. The first character cannot be a number or hyphen.
   */
  // const modelId = 'abc123'
  /**
   *  Required. The Model to create.
   */
  // const model = {}
  /**
   *  Optional. The user-provided custom service account to use to do the model
   *  upload. If empty, Vertex AI Service
   *  Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
   *  will be used. Users uploading the Model must have the
   *  `iam.serviceAccounts.actAs` permission on this service account. Also, this
   *  account must belong to the project specified in the `parent` field and have
   *  all necessary read permissions.
   */
  // const serviceAccount = 'abc123'

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

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

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

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

  callUploadModel();

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.

copyModel(request, options)

copyModel(request?: protos.google.cloud.aiplatform.v1.ICopyModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1.ICopyModelResponse, protos.google.cloud.aiplatform.v1.ICopyModelOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. Copy source_model into a new Model with this ID. The ID will
   *  become the final component of the model resource name.
   *  This value may be up to 63 characters, and valid characters are
   *  `[a-z0-9_-]`. The first character cannot be a number or hyphen.
   */
  // const modelId = 'abc123'
  /**
   *  Optional. Specify this field to copy source_model into this existing
   *  Model as a new version. Format:
   *  `projects/{project}/locations/{location}/models/{model}`
   */
  // const parentModel = 'abc123'
  /**
   *  Required. The resource name of the Location into which to copy the Model.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The resource name of the Model to copy. That Model must be in the
   *  same Project. Format:
   *  `projects/{project}/locations/{location}/models/{model}`
   */
  // const sourceModel = 'abc123'
  /**
   *  Customer-managed encryption key options. If this is set,
   *  then the Model copy will be encrypted with the provided encryption key.
   */
  // const encryptionSpec = {}

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

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

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

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

  callCopyModel();

copyModel(request, options, callback)

copyModel(request: protos.google.cloud.aiplatform.v1.ICopyModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.ICopyModelResponse, protos.google.cloud.aiplatform.v1.ICopyModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICopyModelRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1.ICopyModelResponse, protos.google.cloud.aiplatform.v1.ICopyModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

copyModel(request, callback)

copyModel(request: protos.google.cloud.aiplatform.v1.ICopyModelRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.ICopyModelResponse, protos.google.cloud.aiplatform.v1.ICopyModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICopyModelRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1.ICopyModelResponse, protos.google.cloud.aiplatform.v1.ICopyModelOperationMetadata>, 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.

datasetVersionPath(project, location, dataset, datasetVersion)

datasetVersionPath(project: string, location: string, dataset: string, datasetVersion: string): string;

Return a fully-qualified datasetVersion resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
datasetVersion	string

Returns
Type	Description
string	{string} Resource name string.

deleteModel(request, options)

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

Deletes a Model.

A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its field.

Parameters
Name	Description
request	IDeleteModelRequest 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Model resource to be deleted.
   *  Format: `projects/{project}/locations/{location}/models/{model}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteModel();

deleteModel(request, options, callback)

deleteModel(request: protos.google.cloud.aiplatform.v1.IDeleteModelRequest, 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	IDeleteModelRequest
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

deleteModel(request, callback)

deleteModel(request: protos.google.cloud.aiplatform.v1.IDeleteModelRequest, 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	IDeleteModelRequest
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

deleteModelVersion(request, options)

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

Deletes a Model version.

Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use for deleting the Model instead.

Parameters
Name	Description
request	IDeleteModelVersionRequest 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the model version to be deleted, with a version ID
   *  explicitly included.
   *  Example: `projects/{project}/locations/{location}/models/{model}@1234`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteModelVersion();

deleteModelVersion(request, options, callback)

deleteModelVersion(request: protos.google.cloud.aiplatform.v1.IDeleteModelVersionRequest, 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	IDeleteModelVersionRequest
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

deleteModelVersion(request, callback)

deleteModelVersion(request: protos.google.cloud.aiplatform.v1.IDeleteModelVersionRequest, 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	IDeleteModelVersionRequest
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

deleteOperation(request, options, callback)

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

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

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

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

Example

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

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.

exportModel(request, options)

exportModel(request?: protos.google.cloud.aiplatform.v1.IExportModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1.IExportModelResponse, protos.google.cloud.aiplatform.v1.IExportModelOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Model to export.
   *  The resource name may contain version id or version alias to specify the
   *  version, if no version is specified, the default version will be exported.
   */
  // const name = 'abc123'
  /**
   *  Required. The desired output location and configuration.
   */
  // const outputConfig = {}

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

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

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

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

  callExportModel();

exportModel(request, options, callback)

exportModel(request: protos.google.cloud.aiplatform.v1.IExportModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IExportModelResponse, protos.google.cloud.aiplatform.v1.IExportModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IExportModelRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1.IExportModelResponse, protos.google.cloud.aiplatform.v1.IExportModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

exportModel(request, callback)

exportModel(request: protos.google.cloud.aiplatform.v1.IExportModelRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IExportModelResponse, protos.google.cloud.aiplatform.v1.IExportModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IExportModelRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1.IExportModelResponse, protos.google.cloud.aiplatform.v1.IExportModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

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.

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	IamProtos.google.iam.v1.GetIamPolicyRequest The request object that will be sent.
options	CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
Promise<[google.iam.v1.Policy]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, options, callback)

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

Gets information about a location.

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

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

Example

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

getModel(request, options)

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

Gets a Model.

Parameters
Name	Description
request	IGetModelRequest 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.IModel, protos.google.cloud.aiplatform.v1.IGetModelRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Model resource.
   *  Format: `projects/{project}/locations/{location}/models/{model}`
   *  In order to retrieve a specific version of the model, also provide
   *  the version ID or version alias.
   *    Example: `projects/{project}/locations/{location}/models/{model}@2`
   *               or
   *             `projects/{project}/locations/{location}/models/{model}@golden`
   *  If no version ID or alias is specified, the "default" version will be
   *  returned. The "default" version alias is created for the first version of
   *  the model, and can be moved to other versions later on. There will be
   *  exactly one default version.
   */
  // const name = 'abc123'

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

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

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

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

  callGetModel();

getModel(request, options, callback)

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

Parameters
Name	Description
request	IGetModelRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.IModel, protos.google.cloud.aiplatform.v1.IGetModelRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getModel(request, callback)

getModel(request: protos.google.cloud.aiplatform.v1.IGetModelRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IModel, protos.google.cloud.aiplatform.v1.IGetModelRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetModelRequest
callback	Callback<protos.google.cloud.aiplatform.v1.IModel, protos.google.cloud.aiplatform.v1.IGetModelRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getModelEvaluation(request, options)

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

Gets a ModelEvaluation.

Parameters
Name	Description
request	IGetModelEvaluationRequest 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.IModelEvaluation, protos.google.cloud.aiplatform.v1.IGetModelEvaluationRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the ModelEvaluation resource.
   *  Format:
   *  `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetModelEvaluation();

getModelEvaluation(request, options, callback)

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

Parameters
Name	Description
request	IGetModelEvaluationRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.IModelEvaluation, protos.google.cloud.aiplatform.v1.IGetModelEvaluationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getModelEvaluation(request, callback)

getModelEvaluation(request: protos.google.cloud.aiplatform.v1.IGetModelEvaluationRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IModelEvaluation, protos.google.cloud.aiplatform.v1.IGetModelEvaluationRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetModelEvaluationRequest
callback	Callback<protos.google.cloud.aiplatform.v1.IModelEvaluation, protos.google.cloud.aiplatform.v1.IGetModelEvaluationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getModelEvaluationSlice(request, options)

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

Gets a ModelEvaluationSlice.

Parameters
Name	Description
request	IGetModelEvaluationSliceRequest 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.IModelEvaluationSlice, (protos.google.cloud.aiplatform.v1.IGetModelEvaluationSliceRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the ModelEvaluationSlice resource.
   *  Format:
   *  `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetModelEvaluationSlice();

getModelEvaluationSlice(request, options, callback)

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

Parameters
Name	Description
request	IGetModelEvaluationSliceRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.IModelEvaluationSlice, protos.google.cloud.aiplatform.v1.IGetModelEvaluationSliceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getModelEvaluationSlice(request, callback)

getModelEvaluationSlice(request: protos.google.cloud.aiplatform.v1.IGetModelEvaluationSliceRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IModelEvaluationSlice, protos.google.cloud.aiplatform.v1.IGetModelEvaluationSliceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetModelEvaluationSliceRequest
callback	Callback<protos.google.cloud.aiplatform.v1.IModelEvaluationSlice, protos.google.cloud.aiplatform.v1.IGetModelEvaluationSliceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getOperation(request, options, callback)

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

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

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

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

Example

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

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
Promise<string>

getProjectId(callback)

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

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

Returns
Type	Description
void

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.

importModelEvaluation(request, options)

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

Imports an externally generated ModelEvaluation.

Parameters
Name	Description
request	IImportModelEvaluationRequest 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.IModelEvaluation, (protos.google.cloud.aiplatform.v1.IImportModelEvaluationRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent model resource.
   *  Format: `projects/{project}/locations/{location}/models/{model}`
   */
  // const parent = 'abc123'
  /**
   *  Required. Model evaluation resource to be imported.
   */
  // const modelEvaluation = {}

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

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

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

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

  callImportModelEvaluation();

importModelEvaluation(request, options, callback)

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

Parameters
Name	Description
request	IImportModelEvaluationRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.IModelEvaluation, protos.google.cloud.aiplatform.v1.IImportModelEvaluationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

importModelEvaluation(request, callback)

importModelEvaluation(request: protos.google.cloud.aiplatform.v1.IImportModelEvaluationRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IModelEvaluation, protos.google.cloud.aiplatform.v1.IImportModelEvaluationRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IImportModelEvaluationRequest
callback	Callback<protos.google.cloud.aiplatform.v1.IModelEvaluation, protos.google.cloud.aiplatform.v1.IImportModelEvaluationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

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.

listLocationsAsync(request, options)

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

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

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

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

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

Example

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

listModelEvaluations(request, options)

listModelEvaluations(request?: protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IModelEvaluation[],
        protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest | null,
        protos.google.cloud.aiplatform.v1.IListModelEvaluationsResponse
    ]>;

Lists ModelEvaluations in a Model.

Parameters
Name	Description
request	IListModelEvaluationsRequest 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.IModelEvaluation[], protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest | null, protos.google.cloud.aiplatform.v1.IListModelEvaluationsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listModelEvaluationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listModelEvaluations(request, options, callback)

listModelEvaluations(request: protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest, protos.google.cloud.aiplatform.v1.IListModelEvaluationsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModelEvaluation>): void;

Parameters
Name	Description
request	IListModelEvaluationsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest, protos.google.cloud.aiplatform.v1.IListModelEvaluationsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModelEvaluation>

Returns
Type	Description
void

listModelEvaluations(request, callback)

listModelEvaluations(request: protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest, protos.google.cloud.aiplatform.v1.IListModelEvaluationsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModelEvaluation>): void;

Parameters
Name	Description
request	IListModelEvaluationsRequest
callback	PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest, protos.google.cloud.aiplatform.v1.IListModelEvaluationsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModelEvaluation>

Returns
Type	Description
void

listModelEvaluationsAsync(request, options)

listModelEvaluationsAsync(request?: protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IModelEvaluation>;

Equivalent to listModelEvaluations, but returns an iterable object.

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

Parameters
Name	Description
request	IListModelEvaluationsRequest 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.IModelEvaluation>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Model to list the ModelEvaluations from.
   *  Format: `projects/{project}/locations/{location}/models/{model}`
   */
  // const parent = 'abc123'
  /**
   *  The standard list filter.
   */
  // const filter = 'abc123'
  /**
   *  The standard list page size.
   */
  // const pageSize = 1234
  /**
   *  The standard list page token.
   *  Typically obtained via
   *  ListModelEvaluationsResponse.next_page_token google.cloud.aiplatform.v1.ListModelEvaluationsResponse.next_page_token 
   *  of the previous
   *  ModelService.ListModelEvaluations google.cloud.aiplatform.v1.ModelService.ListModelEvaluations 
   *  call.
   */
  // const pageToken = 'abc123'
  /**
   *  Mask specifying which fields to read.
   */
  // const readMask = {}

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

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

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

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

  callListModelEvaluations();

listModelEvaluationSlices(request, options)

listModelEvaluationSlices(request?: protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IModelEvaluationSlice[],
        protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest | null,
        protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesResponse
    ]>;

Lists ModelEvaluationSlices in a ModelEvaluation.

Parameters
Name	Description
request	IListModelEvaluationSlicesRequest 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.IModelEvaluationSlice[], protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest | null, protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listModelEvaluationSlicesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listModelEvaluationSlices(request, options, callback)

listModelEvaluationSlices(request: protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest, protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModelEvaluationSlice>): void;

Parameters
Name	Description
request	IListModelEvaluationSlicesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest, protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModelEvaluationSlice>

Returns
Type	Description
void

listModelEvaluationSlices(request, callback)

listModelEvaluationSlices(request: protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest, protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModelEvaluationSlice>): void;

Parameters
Name	Description
request	IListModelEvaluationSlicesRequest
callback	PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest, protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModelEvaluationSlice>

Returns
Type	Description
void

listModelEvaluationSlicesAsync(request, options)

listModelEvaluationSlicesAsync(request?: protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IModelEvaluationSlice>;

Equivalent to listModelEvaluationSlices, but returns an iterable object.

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

Parameters
Name	Description
request	IListModelEvaluationSlicesRequest 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.IModelEvaluationSlice>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the ModelEvaluation to list the
   *  ModelEvaluationSlices from. Format:
   *  `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`
   */
  // const parent = 'abc123'
  /**
   *  The standard list filter.
   *    * `slice.dimension` - for =.
   */
  // const filter = 'abc123'
  /**
   *  The standard list page size.
   */
  // const pageSize = 1234
  /**
   *  The standard list page token.
   *  Typically obtained via
   *  ListModelEvaluationSlicesResponse.next_page_token google.cloud.aiplatform.v1.ListModelEvaluationSlicesResponse.next_page_token 
   *  of the previous
   *  ModelService.ListModelEvaluationSlices google.cloud.aiplatform.v1.ModelService.ListModelEvaluationSlices 
   *  call.
   */
  // const pageToken = 'abc123'
  /**
   *  Mask specifying which fields to read.
   */
  // const readMask = {}

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

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

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

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

  callListModelEvaluationSlices();

listModelEvaluationSlicesStream(request, options)

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

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

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

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listModelEvaluationSlicesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listModelEvaluationsStream(request, options)

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

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

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

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listModelEvaluationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listModels(request, options)

listModels(request?: protos.google.cloud.aiplatform.v1.IListModelsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IModel[],
        protos.google.cloud.aiplatform.v1.IListModelsRequest | null,
        protos.google.cloud.aiplatform.v1.IListModelsResponse
    ]>;

Lists Models in a Location.

Parameters
Name	Description
request	IListModelsRequest 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.IModel[], protos.google.cloud.aiplatform.v1.IListModelsRequest | null, protos.google.cloud.aiplatform.v1.IListModelsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listModelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listModels(request, options, callback)

listModels(request: protos.google.cloud.aiplatform.v1.IListModelsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelsRequest, protos.google.cloud.aiplatform.v1.IListModelsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModel>): void;

Parameters
Name	Description
request	IListModelsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelsRequest, protos.google.cloud.aiplatform.v1.IListModelsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModel>

Returns
Type	Description
void

listModels(request, callback)

listModels(request: protos.google.cloud.aiplatform.v1.IListModelsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelsRequest, protos.google.cloud.aiplatform.v1.IListModelsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModel>): void;

Parameters
Name	Description
request	IListModelsRequest
callback	PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelsRequest, protos.google.cloud.aiplatform.v1.IListModelsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModel>

Returns
Type	Description
void

listModelsAsync(request, options)

listModelsAsync(request?: protos.google.cloud.aiplatform.v1.IListModelsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IModel>;

Equivalent to listModels, but returns an iterable object.

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

Parameters
Name	Description
request	IListModelsRequest 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.IModel>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Location to list the Models from.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  An expression for filtering the results of the request. For field names
   *  both snake_case and camelCase are supported.
   *    * `model` supports = and !=. `model` represents the Model ID,
   *      i.e. the last segment of the Model's resource
   *      name google.cloud.aiplatform.v1.Model.name.
   *    * `display_name` supports = and !=
   *    * `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:
   *    * `model=1234`
   *    * `displayName="myDisplayName"`
   *    * `labels.myKey="myValue"`
   */
  // const filter = 'abc123'
  /**
   *  The standard list page size.
   */
  // const pageSize = 1234
  /**
   *  The standard list page token.
   *  Typically obtained via
   *  ListModelsResponse.next_page_token google.cloud.aiplatform.v1.ListModelsResponse.next_page_token 
   *  of the previous
   *  ModelService.ListModels google.cloud.aiplatform.v1.ModelService.ListModels 
   *  call.
   */
  // const pageToken = 'abc123'
  /**
   *  Mask specifying which fields to read.
   */
  // const readMask = {}
  /**
   *  A comma-separated list of fields to order by, sorted in ascending order.
   *  Use "desc" after a field name for descending.
   *  Supported fields:
   *    * `display_name`
   *    * `create_time`
   *    * `update_time`
   *  Example: `display_name, create_time desc`.
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListModels();

listModelsStream(request, options)

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

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

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

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listModelsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listModelVersions(request, options)

listModelVersions(request?: protos.google.cloud.aiplatform.v1.IListModelVersionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IModel[],
        protos.google.cloud.aiplatform.v1.IListModelVersionsRequest | null,
        protos.google.cloud.aiplatform.v1.IListModelVersionsResponse
    ]>;

Lists versions of the specified model.

Parameters
Name	Description
request	IListModelVersionsRequest 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.IModel[], protos.google.cloud.aiplatform.v1.IListModelVersionsRequest | null, protos.google.cloud.aiplatform.v1.IListModelVersionsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listModelVersionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listModelVersions(request, options, callback)

listModelVersions(request: protos.google.cloud.aiplatform.v1.IListModelVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelVersionsRequest, protos.google.cloud.aiplatform.v1.IListModelVersionsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModel>): void;

Parameters
Name	Description
request	IListModelVersionsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelVersionsRequest, protos.google.cloud.aiplatform.v1.IListModelVersionsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModel>

Returns
Type	Description
void

listModelVersions(request, callback)

listModelVersions(request: protos.google.cloud.aiplatform.v1.IListModelVersionsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelVersionsRequest, protos.google.cloud.aiplatform.v1.IListModelVersionsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModel>): void;

Parameters
Name	Description
request	IListModelVersionsRequest
callback	PaginationCallback<protos.google.cloud.aiplatform.v1.IListModelVersionsRequest, protos.google.cloud.aiplatform.v1.IListModelVersionsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IModel>

Returns
Type	Description
void

listModelVersionsAsync(request, options)

listModelVersionsAsync(request?: protos.google.cloud.aiplatform.v1.IListModelVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IModel>;

Equivalent to listModelVersions, but returns an iterable object.

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

Parameters
Name	Description
request	IListModelVersionsRequest 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.IModel>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the model to list versions for.
   */
  // const name = 'abc123'
  /**
   *  The standard list page size.
   */
  // const pageSize = 1234
  /**
   *  The standard list page token.
   *  Typically obtained via
   *  next_page_token google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token 
   *  of the previous
   *  ListModelVersions google.cloud.aiplatform.v1.ModelService.ListModelVersions 
   *  call.
   */
  // const pageToken = 'abc123'
  /**
   *  An expression for filtering the results of the request. For field names
   *  both snake_case and camelCase are supported.
   *    * `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:
   *    * `labels.myKey="myValue"`
   */
  // const filter = 'abc123'
  /**
   *  Mask specifying which fields to read.
   */
  // const readMask = {}
  /**
   *  A comma-separated list of fields to order by, sorted in ascending order.
   *  Use "desc" after a field name for descending.
   *  Supported fields:
   *    * `create_time`
   *    * `update_time`
   *  Example: `update_time asc, create_time desc`.
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListModelVersions();

listModelVersionsStream(request, options)

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

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

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

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listModelVersionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOperationsAsync(request, options)

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

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

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

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

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

Example

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

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.

matchDatasetFromDatasetVersionName(datasetVersionName)

matchDatasetFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the dataset from DatasetVersion resource.

Parameter
Name	Description
datasetVersionName	string A fully-qualified path representing DatasetVersion resource.

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

matchDatasetFromSavedQueryName(savedQueryName)

matchDatasetFromSavedQueryName(savedQueryName: string): string | number;

Parse the dataset from SavedQuery resource.

Parameter
Name	Description
savedQueryName	string A fully-qualified path representing SavedQuery resource.

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

matchDatasetVersionFromDatasetVersionName(datasetVersionName)

matchDatasetVersionFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the dataset_version from DatasetVersion resource.

Parameter
Name	Description
datasetVersionName	string A fully-qualified path representing DatasetVersion resource.

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

matchEndpointFromProjectLocationEndpointName(projectLocationEndpointName)

matchEndpointFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number;

Parse the endpoint from ProjectLocationEndpoint resource.

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

matchLocationFromDatasetVersionName(datasetVersionName)

matchLocationFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the location from DatasetVersion resource.

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

matchLocationFromNasJobName(nasJobName)

matchLocationFromNasJobName(nasJobName: string): string | number;

Parse the location from NasJob resource.

Parameter
Name	Description
nasJobName	string A fully-qualified path representing NasJob resource.

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

matchLocationFromNasTrialDetailName(nasTrialDetailName)

matchLocationFromNasTrialDetailName(nasTrialDetailName: string): string | number;

Parse the location from NasTrialDetail resource.

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

matchLocationFromProjectLocationEndpointName(projectLocationEndpointName)

matchLocationFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number;

Parse the location from ProjectLocationEndpoint resource.

Parameter
Name	Description
projectLocationEndpointName	string A fully-qualified path representing project_location_endpoint resource.

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

matchLocationFromProjectLocationPublisherModelName(projectLocationPublisherModelName)

matchLocationFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number;

Parse the location from ProjectLocationPublisherModel resource.

Parameter
Name	Description
projectLocationPublisherModelName	string A fully-qualified path representing project_location_publisher_model resource.

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

matchLocationFromSavedQueryName(savedQueryName)

matchLocationFromSavedQueryName(savedQueryName: string): string | number;

Parse the location from SavedQuery resource.

Parameter
Name	Description
savedQueryName	string A fully-qualified path representing SavedQuery resource.

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

matchLocationFromScheduleName(scheduleName)

matchLocationFromScheduleName(scheduleName: string): string | number;

Parse the location from Schedule resource.

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

matchModelFromProjectLocationPublisherModelName(projectLocationPublisherModelName)

matchModelFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number;

Parse the model from ProjectLocationPublisherModel resource.

Parameter
Name	Description
projectLocationPublisherModelName	string A fully-qualified path representing project_location_publisher_model resource.

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

matchModelFromPublisherModelName(publisherModelName)

matchModelFromPublisherModelName(publisherModelName: string): string | number;

Parse the model from PublisherModel resource.

Parameter
Name	Description
publisherModelName	string A fully-qualified path representing PublisherModel resource.

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

matchNasJobFromNasJobName(nasJobName)

matchNasJobFromNasJobName(nasJobName: string): string | number;

Parse the nas_job from NasJob resource.

Parameter
Name	Description
nasJobName	string A fully-qualified path representing NasJob resource.

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

matchNasJobFromNasTrialDetailName(nasTrialDetailName)

matchNasJobFromNasTrialDetailName(nasTrialDetailName: string): string | number;

Parse the nas_job from NasTrialDetail resource.

Parameter
Name	Description
nasTrialDetailName	string A fully-qualified path representing NasTrialDetail resource.

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

matchNasTrialDetailFromNasTrialDetailName(nasTrialDetailName)

matchNasTrialDetailFromNasTrialDetailName(nasTrialDetailName: string): string | number;

Parse the nas_trial_detail from NasTrialDetail resource.

Parameter
Name	Description
nasTrialDetailName	string A fully-qualified path representing NasTrialDetail resource.

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

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.

matchProjectFromDatasetVersionName(datasetVersionName)

matchProjectFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the project from DatasetVersion resource.

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

matchProjectFromNasJobName(nasJobName)

matchProjectFromNasJobName(nasJobName: string): string | number;

Parse the project from NasJob resource.

Parameter
Name	Description
nasJobName	string A fully-qualified path representing NasJob resource.

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

matchProjectFromNasTrialDetailName(nasTrialDetailName)

matchProjectFromNasTrialDetailName(nasTrialDetailName: string): string | number;

Parse the project from NasTrialDetail resource.

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

matchProjectFromProjectLocationEndpointName(projectLocationEndpointName)

matchProjectFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number;

Parse the project from ProjectLocationEndpoint resource.

Parameter
Name	Description
projectLocationEndpointName	string A fully-qualified path representing project_location_endpoint resource.

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

matchProjectFromProjectLocationPublisherModelName(projectLocationPublisherModelName)

matchProjectFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number;

Parse the project from ProjectLocationPublisherModel resource.

Parameter
Name	Description
projectLocationPublisherModelName	string A fully-qualified path representing project_location_publisher_model resource.

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

matchProjectFromSavedQueryName(savedQueryName)

matchProjectFromSavedQueryName(savedQueryName: string): string | number;

Parse the project from SavedQuery resource.

Parameter
Name	Description
savedQueryName	string A fully-qualified path representing SavedQuery resource.

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

matchProjectFromScheduleName(scheduleName)

matchProjectFromScheduleName(scheduleName: string): string | number;

Parse the project from Schedule resource.

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

matchPublisherFromProjectLocationPublisherModelName(projectLocationPublisherModelName)

matchPublisherFromProjectLocationPublisherModelName(projectLocationPublisherModelName: string): string | number;

Parse the publisher from ProjectLocationPublisherModel resource.

Parameter
Name	Description
projectLocationPublisherModelName	string A fully-qualified path representing project_location_publisher_model resource.

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

matchPublisherFromPublisherModelName(publisherModelName)

matchPublisherFromPublisherModelName(publisherModelName: string): string | number;

Parse the publisher from PublisherModel resource.

Parameter
Name	Description
publisherModelName	string A fully-qualified path representing PublisherModel resource.

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

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.

matchSavedQueryFromSavedQueryName(savedQueryName)

matchSavedQueryFromSavedQueryName(savedQueryName: string): string | number;

Parse the saved_query from SavedQuery resource.

Parameter
Name	Description
savedQueryName	string A fully-qualified path representing SavedQuery resource.

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

matchScheduleFromScheduleName(scheduleName)

matchScheduleFromScheduleName(scheduleName: string): string | number;

Parse the schedule from Schedule resource.

Parameter
Name	Description
scheduleName	string A fully-qualified path representing Schedule resource.

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

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.

mergeVersionAliases(request, options)

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

Merges a set of aliases for a Model version.

Parameters
Name	Description
request	IMergeVersionAliasesRequest 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.IModel, protos.google.cloud.aiplatform.v1.IMergeVersionAliasesRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the model version to merge aliases, with a version ID
   *  explicitly included.
   *  Example: `projects/{project}/locations/{location}/models/{model}@1234`
   */
  // const name = 'abc123'
  /**
   *  Required. The set of version aliases to merge.
   *  The alias should be at most 128 characters, and match
   *  `[a-z][a-zA-Z0-9-]{0,126}[a-z-0-9]`.
   *  Add the `-` prefix to an alias means removing that alias from the version.
   *  `-` is NOT counted in the 128 characters. Example: `-golden` means removing
   *  the `golden` alias from the version.
   *  There is NO ordering in aliases, which means
   *  1) The aliases returned from GetModel API might not have the exactly same
   *  order from this MergeVersionAliases API. 2) Adding and deleting the same
   *  alias in the request is not recommended, and the 2 operations will be
   *  cancelled out.
   */
  // const versionAliases = ['abc','def']

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

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

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

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

  callMergeVersionAliases();

mergeVersionAliases(request, options, callback)

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

Parameters
Name	Description
request	IMergeVersionAliasesRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.IModel, protos.google.cloud.aiplatform.v1.IMergeVersionAliasesRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

mergeVersionAliases(request, callback)

mergeVersionAliases(request: protos.google.cloud.aiplatform.v1.IMergeVersionAliasesRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IModel, protos.google.cloud.aiplatform.v1.IMergeVersionAliasesRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IMergeVersionAliasesRequest
callback	Callback<protos.google.cloud.aiplatform.v1.IModel, protos.google.cloud.aiplatform.v1.IMergeVersionAliasesRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

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.

nasJobPath(project, location, nasJob)

nasJobPath(project: string, location: string, nasJob: string): string;

Return a fully-qualified nasJob resource name string.

Parameters
Name	Description
project	string
location	string
nasJob	string

Returns
Type	Description
string	{string} Resource name string.

nasTrialDetailPath(project, location, nasJob, nasTrialDetail)

nasTrialDetailPath(project: string, location: string, nasJob: string, nasTrialDetail: string): string;

Return a fully-qualified nasTrialDetail resource name string.

Parameters
Name	Description
project	string
location	string
nasJob	string
nasTrialDetail	string

Returns
Type	Description
string	{string} Resource name string.

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.

projectLocationEndpointPath(project, location, endpoint)

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

Return a fully-qualified projectLocationEndpoint resource name string.

Parameters
Name	Description
project	string
location	string
endpoint	string

Returns
Type	Description
string	{string} Resource name string.

projectLocationPublisherModelPath(project, location, publisher, model)

projectLocationPublisherModelPath(project: string, location: string, publisher: string, model: string): string;

Return a fully-qualified projectLocationPublisherModel resource name string.

Parameters
Name	Description
project	string
location	string
publisher	string
model	string

Returns
Type	Description
string	{string} Resource name string.

publisherModelPath(publisher, model)

publisherModelPath(publisher: string, model: string): string;

Return a fully-qualified publisherModel resource name string.

Parameters
Name	Description
publisher	string
model	string

Returns
Type	Description
string	{string} Resource name string.

savedQueryPath(project, location, dataset, savedQuery)

savedQueryPath(project: string, location: string, dataset: string, savedQuery: string): string;

Return a fully-qualified savedQuery resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
savedQuery	string

Returns
Type	Description
string	{string} Resource name string.

schedulePath(project, location, schedule)

schedulePath(project: string, location: string, schedule: string): string;

Return a fully-qualified schedule resource name string.

Parameters
Name	Description
project	string
location	string
schedule	string

Returns
Type	Description
string	{string} Resource name string.

setIamPolicy(request, options, callback)

setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
request	IamProtos.google.iam.v1.SetIamPolicyRequest The request object that will be sent.
options	CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
Promise<[google.iam.v1.Policy]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

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.

testIamPermissions(request, options, callback)

testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
request	IamProtos.google.iam.v1.TestIamPermissionsRequest The request object that will be sent.
options	CallOptions | Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing .

Returns
Type	Description
Promise<[google.iam.v1.TestIamPermissionsResponse]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

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.

updateExplanationDataset(request, options)

updateExplanationDataset(request?: protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetResponse, protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Incrementally update the dataset used for an examples model.

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Model to update.
   *  Format: `projects/{project}/locations/{location}/models/{model}`
   */
  // const model = 'abc123'
  /**
   *  The example config containing the location of the dataset.
   */
  // const examples = {}

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

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

  async function callUpdateExplanationDataset() {
    // Construct request
    const request = {
      model,
    };

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

  callUpdateExplanationDataset();

updateExplanationDataset(request, options, callback)

updateExplanationDataset(request: protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetResponse, protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateExplanationDatasetRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetResponse, protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateExplanationDataset(request, callback)

updateExplanationDataset(request: protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetResponse, protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateExplanationDatasetRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetResponse, protos.google.cloud.aiplatform.v1.IUpdateExplanationDatasetOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateModel(request, options)

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

Updates a Model.

Parameters
Name	Description
request	IUpdateModelRequest 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.IModel, protos.google.cloud.aiplatform.v1.IUpdateModelRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Model which replaces the resource on the server.
   *  When Model Versioning is enabled, the model.name will be used to determine
   *  whether to update the model or model version.
   *  1. model.name with the @ value, e.g. models/123@1, refers to a version
   *  specific update.
   *  2. model.name without the @ value, e.g. models/123, refers to a model
   *  update.
   *  3. model.name with @-, e.g. models/123@-, refers to a model update.
   *  4. Supported model fields: display_name, description; supported
   *  version-specific fields: version_description. Labels are supported in both
   *  scenarios. Both the model labels and the version labels are merged when a
   *  model is returned. When updating labels, if the request is for
   *  model-specific update, model label gets updated. Otherwise, version labels
   *  get updated.
   *  5. A model name or model version name fields update mismatch will cause a
   *  precondition error.
   *  6. One request cannot update both the model and the version fields. You
   *  must update them separately.
   */
  // const model = {}
  /**
   *  Required. The update mask applies to the resource.
   *  For the `FieldMask` definition, see
   *  google.protobuf.FieldMask google.protobuf.FieldMask.
   */
  // const updateMask = {}

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

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

  async function callUpdateModel() {
    // Construct request
    const request = {
      model,
      updateMask,
    };

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

  callUpdateModel();

updateModel(request, options, callback)

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

Parameters
Name	Description
request	IUpdateModelRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1.IModel, protos.google.cloud.aiplatform.v1.IUpdateModelRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateModel(request, callback)

updateModel(request: protos.google.cloud.aiplatform.v1.IUpdateModelRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IModel, protos.google.cloud.aiplatform.v1.IUpdateModelRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateModelRequest
callback	Callback<protos.google.cloud.aiplatform.v1.IModel, protos.google.cloud.aiplatform.v1.IUpdateModelRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

uploadModel(request, options)

uploadModel(request?: protos.google.cloud.aiplatform.v1.IUploadModelRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1.IUploadModelResponse, protos.google.cloud.aiplatform.v1.IUploadModelOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Uploads a Model artifact into Vertex AI.

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Location into which to upload the Model.
   *  Format: `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The resource name of the model into which to upload the version.
   *  Only specify this field when uploading a new version.
   */
  // const parentModel = 'abc123'
  /**
   *  Optional. The ID to use for the uploaded Model, which will become the final
   *  component of the model resource name.
   *  This value may be up to 63 characters, and valid characters are
   *  `[a-z0-9_-]`. The first character cannot be a number or hyphen.
   */
  // const modelId = 'abc123'
  /**
   *  Required. The Model to create.
   */
  // const model = {}
  /**
   *  Optional. The user-provided custom service account to use to do the model
   *  upload. If empty, Vertex AI Service
   *  Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
   *  will be used. Users uploading the Model must have the
   *  `iam.serviceAccounts.actAs` permission on this service account. Also, this
   *  account must belong to the project specified in the `parent` field and have
   *  all necessary read permissions.
   */
  // const serviceAccount = 'abc123'

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

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

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

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

  callUploadModel();

uploadModel(request, options, callback)

uploadModel(request: protos.google.cloud.aiplatform.v1.IUploadModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IUploadModelResponse, protos.google.cloud.aiplatform.v1.IUploadModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUploadModelRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1.IUploadModelResponse, protos.google.cloud.aiplatform.v1.IUploadModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

uploadModel(request, callback)

uploadModel(request: protos.google.cloud.aiplatform.v1.IUploadModelRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IUploadModelResponse, protos.google.cloud.aiplatform.v1.IUploadModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUploadModelRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1.IUploadModelResponse, protos.google.cloud.aiplatform.v1.IUploadModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void