Class v1.ModelServiceClient (2.3.0)

Stay organized with collections Save and categorize content based on your preferences.

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
NameDescription
opts ClientOptions
gaxInstance typeof gax | typeof gax.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: 'rest'}, 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
NameDescription
project string
location string
dataset string
dataItem string
annotation string
Returns
TypeDescription
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
NameDescription
project string
location string
dataset string
annotationSpec string
Returns
TypeDescription
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
NameDescription
project string
location string
metadataStore string
artifact string
Returns
TypeDescription
string

{string} Resource name string.

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
NameDescription
request protos.google.cloud.aiplatform.v1.IBatchImportModelEvaluationSlicesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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 = 1234

  // 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
void

batchPredictionJobPath(project, location, batchPredictionJob)

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

Return a fully-qualified batchPredictionJob resource name string.

Parameters
NameDescription
project string
location string
batchPredictionJob string
Returns
TypeDescription
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
NameDescription
request protos.google.longrunning.CancelOperationRequest

The request object that will be sent.

options gax.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]https://googleapis.github.io/gax-nodejs/global.html#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
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

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

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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.DeleteOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * 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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.aiplatform.v1.DeleteOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * 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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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();

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
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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 = {}

  // 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
TypeDescription
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
NameDescription
project string
location string
metadataStore string
context string
Returns
TypeDescription
string

{string} Resource name string.

customJobPath(project, location, customJob)

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

Return a fully-qualified customJob resource name string.

Parameters
NameDescription
project string
location string
customJob string
Returns
TypeDescription
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
NameDescription
project string
location string
dataset string
dataItem string
Returns
TypeDescription
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
NameDescription
project string
location string
dataLabelingJob string
Returns
TypeDescription
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
NameDescription
project string
location string
dataset string
Returns
TypeDescription
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 resource has a based on the model in its field.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IDeleteModelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
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 created from it. Deleting the only version in the Model is not allowed. Use for deleting the Model instead.

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IDeleteModelVersionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
request protos.google.longrunning.DeleteOperationRequest

The request object that will be sent.

options gax.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]https://googleapis.github.io/gax-nodejs/global.html#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
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

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

endpointPath(project, location, endpoint)

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

Return a fully-qualified endpoint resource name string.

Parameters
NameDescription
project string
location string
endpoint string
Returns
TypeDescription
string

{string} Resource name string.

entityTypePath(project, location, featurestore, entityType)

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

Return a fully-qualified entityType resource name string.

Parameters
NameDescription
project string
location string
featurestore string
entityType string
Returns
TypeDescription
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
NameDescription
project string
location string
metadataStore string
execution string
Returns
TypeDescription
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 .

Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IExportModelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
project string
location string
featurestore string
entityType string
feature string
Returns
TypeDescription
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
NameDescription
project string
location string
featurestore string
Returns
TypeDescription
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
NameDescription
request IamProtos.google.iam.v1.GetIamPolicyRequest

The request object that will be sent.

options gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.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]https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html for the details.

callback Callback<IamProtos.google.iam.v1.Policy, IamProtos.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 [Policy].

Returns
TypeDescription
Promise<IamProtos.google.iam.v1.Policy>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Policy]. 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
NameDescription
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

options gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.

callback Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
Promise<LocationProtos.google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Location]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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
NameDescription
request protos.google.cloud.aiplatform.v1.IGetModelRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 [Model]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
request protos.google.cloud.aiplatform.v1.IGetModelEvaluationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 [ModelEvaluation]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
request protos.google.cloud.aiplatform.v1.IGetModelEvaluationSliceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 [ModelEvaluationSlice]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
request protos.google.longrunning.GetOperationRequest

The request object that will be sent.

options gax.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]https://googleapis.github.io/gax-nodejs/global.html#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 [google.longrunning.Operation]. {Promise} - The promise which resolves to an array. The first element of the array is an object representing [google.longrunning.Operation]. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
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
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

hyperparameterTuningJobPath(project, location, hyperparameterTuningJob)

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

Return a fully-qualified hyperparameterTuningJob resource name string.

Parameters
NameDescription
project string
location string
hyperparameterTuningJob string
Returns
TypeDescription
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
NameDescription
request protos.google.cloud.aiplatform.v1.IImportModelEvaluationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 [ModelEvaluation]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
void

indexEndpointPath(project, location, indexEndpoint)

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

Return a fully-qualified indexEndpoint resource name string.

Parameters
NameDescription
project string
location string
indexEndpoint string
Returns
TypeDescription
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
NameDescription
project string
location string
index string
Returns
TypeDescription
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
TypeDescription
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
NameDescription
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<LocationProtos.google.cloud.location.ILocation>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Location]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

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
NameDescription
request protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 [ModelEvaluation]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
request protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.aiplatform.v1.IModelEvaluation>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ModelEvaluation]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * 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
NameDescription
request protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 [ModelEvaluationSlice]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
request protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.aiplatform.v1.IModelEvaluationSlice>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ModelEvaluationSlice]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * 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
NameDescription
request protos.google.cloud.aiplatform.v1.IListModelEvaluationSlicesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [ModelEvaluationSlice] 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
NameDescription
request protos.google.cloud.aiplatform.v1.IListModelEvaluationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [ModelEvaluation] 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
NameDescription
request protos.google.cloud.aiplatform.v1.IListModelsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 [Model]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
request protos.google.cloud.aiplatform.v1.IListModelsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.aiplatform.v1.IModel>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Model]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * 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
NameDescription
request protos.google.cloud.aiplatform.v1.IListModelsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Model] 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
NameDescription
request protos.google.cloud.aiplatform.v1.IListModelVersionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 [Model]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
request protos.google.cloud.aiplatform.v1.IListModelVersionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.aiplatform.v1.IModel>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Model]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * 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
   *  ListModelVersionsResponse.next_page_token google.cloud.aiplatform.v1.ListModelVersionsResponse.next_page_token  of the previous
   *  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 = {}

  // 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
NameDescription
request protos.google.cloud.aiplatform.v1.IListModelVersionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Model] 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
NameDescription
request protos.google.longrunning.ListOperationsRequest

The request object that will be sent.

options gax.CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/global.html#CallOptions for the details.

Returns
TypeDescription
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{Object} An iterable Object that conforms to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/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
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchAnnotationFromAnnotationName(annotationName)

matchAnnotationFromAnnotationName(annotationName: string): string | number;

Parse the annotation from Annotation resource.

Parameter
NameDescription
annotationName string

A fully-qualified path representing Annotation resource.

Returns
TypeDescription
string | number

{string} A string representing the annotation.

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName)

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the annotation_spec from AnnotationSpec resource.

Parameter
NameDescription
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the annotation_spec.

matchArtifactFromArtifactName(artifactName)

matchArtifactFromArtifactName(artifactName: string): string | number;

Parse the artifact from Artifact resource.

Parameter
NameDescription
artifactName string

A fully-qualified path representing Artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the artifact.

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName)

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the batch_prediction_job from BatchPredictionJob resource.

Parameter
NameDescription
batchPredictionJobName string

A fully-qualified path representing BatchPredictionJob resource.

Returns
TypeDescription
string | number

{string} A string representing the batch_prediction_job.

matchContextFromContextName(contextName)

matchContextFromContextName(contextName: string): string | number;

Parse the context from Context resource.

Parameter
NameDescription
contextName string

A fully-qualified path representing Context resource.

Returns
TypeDescription
string | number

{string} A string representing the context.

matchCustomJobFromCustomJobName(customJobName)

matchCustomJobFromCustomJobName(customJobName: string): string | number;

Parse the custom_job from CustomJob resource.

Parameter
NameDescription
customJobName string

A fully-qualified path representing CustomJob resource.

Returns
TypeDescription
string | number

{string} A string representing the custom_job.

matchDataItemFromAnnotationName(annotationName)

matchDataItemFromAnnotationName(annotationName: string): string | number;

Parse the data_item from Annotation resource.

Parameter
NameDescription
annotationName string

A fully-qualified path representing Annotation resource.

Returns
TypeDescription
string | number

{string} A string representing the data_item.

matchDataItemFromDataItemName(dataItemName)

matchDataItemFromDataItemName(dataItemName: string): string | number;

Parse the data_item from DataItem resource.

Parameter
NameDescription
dataItemName string

A fully-qualified path representing DataItem resource.

Returns
TypeDescription
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
NameDescription
dataLabelingJobName string

A fully-qualified path representing DataLabelingJob resource.

Returns
TypeDescription
string | number

{string} A string representing the data_labeling_job.

matchDatasetFromAnnotationName(annotationName)

matchDatasetFromAnnotationName(annotationName: string): string | number;

Parse the dataset from Annotation resource.

Parameter
NameDescription
annotationName string

A fully-qualified path representing Annotation resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchDatasetFromAnnotationSpecName(annotationSpecName)

matchDatasetFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the dataset from AnnotationSpec resource.

Parameter
NameDescription
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchDatasetFromDataItemName(dataItemName)

matchDatasetFromDataItemName(dataItemName: string): string | number;

Parse the dataset from DataItem resource.

Parameter
NameDescription
dataItemName string

A fully-qualified path representing DataItem resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchDatasetFromDatasetName(datasetName)

matchDatasetFromDatasetName(datasetName: string): string | number;

Parse the dataset from Dataset resource.

Parameter
NameDescription
datasetName string

A fully-qualified path representing Dataset resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchDatasetFromSavedQueryName(savedQueryName)

matchDatasetFromSavedQueryName(savedQueryName: string): string | number;

Parse the dataset from SavedQuery resource.

Parameter
NameDescription
savedQueryName string

A fully-qualified path representing SavedQuery resource.

Returns
TypeDescription
string | number

{string} A string representing the dataset.

matchEndpointFromEndpointName(endpointName)

matchEndpointFromEndpointName(endpointName: string): string | number;

Parse the endpoint from Endpoint resource.

Parameter
NameDescription
endpointName string

A fully-qualified path representing Endpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the endpoint.

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEntityTypeFromFeatureName(featureName)

matchEntityTypeFromFeatureName(featureName: string): string | number;

Parse the entity_type from Feature resource.

Parameter
NameDescription
featureName string

A fully-qualified path representing Feature resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEvaluationFromModelEvaluationName(modelEvaluationName)

matchEvaluationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the evaluation from ModelEvaluation resource.

Parameter
NameDescription
modelEvaluationName string

A fully-qualified path representing ModelEvaluation resource.

Returns
TypeDescription
string | number

{string} A string representing the evaluation.

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName)

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the evaluation from ModelEvaluationSlice resource.

Parameter
NameDescription
modelEvaluationSliceName string

A fully-qualified path representing ModelEvaluationSlice resource.

Returns
TypeDescription
string | number

{string} A string representing the evaluation.

matchExecutionFromExecutionName(executionName)

matchExecutionFromExecutionName(executionName: string): string | number;

Parse the execution from Execution resource.

Parameter
NameDescription
executionName string

A fully-qualified path representing Execution resource.

Returns
TypeDescription
string | number

{string} A string representing the execution.

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName)

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the experiment from TensorboardExperiment resource.

Parameter
NameDescription
tensorboardExperimentName string

A fully-qualified path representing TensorboardExperiment resource.

Returns
TypeDescription
string | number

{string} A string representing the experiment.

matchExperimentFromTensorboardRunName(tensorboardRunName)

matchExperimentFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the experiment from TensorboardRun resource.

Parameter
NameDescription
tensorboardRunName string

A fully-qualified path representing TensorboardRun resource.

Returns
TypeDescription
string | number

{string} A string representing the experiment.

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the experiment from TensorboardTimeSeries resource.

Parameter
NameDescription
tensorboardTimeSeriesName string

A fully-qualified path representing TensorboardTimeSeries resource.

Returns
TypeDescription
string | number

{string} A string representing the experiment.

matchFeatureFromFeatureName(featureName)

matchFeatureFromFeatureName(featureName: string): string | number;

Parse the feature from Feature resource.

Parameter
NameDescription
featureName string

A fully-qualified path representing Feature resource.

Returns
TypeDescription
string | number

{string} A string representing the feature.

matchFeaturestoreFromEntityTypeName(entityTypeName)

matchFeaturestoreFromEntityTypeName(entityTypeName: string): string | number;

Parse the featurestore from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the featurestore.

matchFeaturestoreFromFeatureName(featureName)

matchFeaturestoreFromFeatureName(featureName: string): string | number;

Parse the featurestore from Feature resource.

Parameter
NameDescription
featureName string

A fully-qualified path representing Feature resource.

Returns
TypeDescription
string | number

{string} A string representing the featurestore.

matchFeaturestoreFromFeaturestoreName(featurestoreName)

matchFeaturestoreFromFeaturestoreName(featurestoreName: string): string | number;

Parse the featurestore from Featurestore resource.

Parameter
NameDescription
featurestoreName string

A fully-qualified path representing Featurestore resource.

Returns
TypeDescription
string | number

{string} A string representing the featurestore.

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the hyperparameter_tuning_job from HyperparameterTuningJob resource.

Parameter
NameDescription
hyperparameterTuningJobName string

A fully-qualified path representing HyperparameterTuningJob resource.

Returns
TypeDescription
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
NameDescription
indexEndpointName string

A fully-qualified path representing IndexEndpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the index_endpoint.

matchIndexFromIndexName(indexName)

matchIndexFromIndexName(indexName: string): string | number;

Parse the index from Index resource.

Parameter
NameDescription
indexName string

A fully-qualified path representing Index resource.

Returns
TypeDescription
string | number

{string} A string representing the index.

matchLocationFromAnnotationName(annotationName)

matchLocationFromAnnotationName(annotationName: string): string | number;

Parse the location from Annotation resource.

Parameter
NameDescription
annotationName string

A fully-qualified path representing Annotation resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromAnnotationSpecName(annotationSpecName)

matchLocationFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the location from AnnotationSpec resource.

Parameter
NameDescription
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromArtifactName(artifactName)

matchLocationFromArtifactName(artifactName: string): string | number;

Parse the location from Artifact resource.

Parameter
NameDescription
artifactName string

A fully-qualified path representing Artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromBatchPredictionJobName(batchPredictionJobName)

matchLocationFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the location from BatchPredictionJob resource.

Parameter
NameDescription
batchPredictionJobName string

A fully-qualified path representing BatchPredictionJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromContextName(contextName)

matchLocationFromContextName(contextName: string): string | number;

Parse the location from Context resource.

Parameter
NameDescription
contextName string

A fully-qualified path representing Context resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromCustomJobName(customJobName)

matchLocationFromCustomJobName(customJobName: string): string | number;

Parse the location from CustomJob resource.

Parameter
NameDescription
customJobName string

A fully-qualified path representing CustomJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDataItemName(dataItemName)

matchLocationFromDataItemName(dataItemName: string): string | number;

Parse the location from DataItem resource.

Parameter
NameDescription
dataItemName string

A fully-qualified path representing DataItem resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDataLabelingJobName(dataLabelingJobName)

matchLocationFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the location from DataLabelingJob resource.

Parameter
NameDescription
dataLabelingJobName string

A fully-qualified path representing DataLabelingJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDatasetName(datasetName)

matchLocationFromDatasetName(datasetName: string): string | number;

Parse the location from Dataset resource.

Parameter
NameDescription
datasetName string

A fully-qualified path representing Dataset resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromEndpointName(endpointName)

matchLocationFromEndpointName(endpointName: string): string | number;

Parse the location from Endpoint resource.

Parameter
NameDescription
endpointName string

A fully-qualified path representing Endpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromEntityTypeName(entityTypeName)

matchLocationFromEntityTypeName(entityTypeName: string): string | number;

Parse the location from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromExecutionName(executionName)

matchLocationFromExecutionName(executionName: string): string | number;

Parse the location from Execution resource.

Parameter
NameDescription
executionName string

A fully-qualified path representing Execution resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromFeatureName(featureName)

matchLocationFromFeatureName(featureName: string): string | number;

Parse the location from Feature resource.

Parameter
NameDescription
featureName string

A fully-qualified path representing Feature resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromFeaturestoreName(featurestoreName)

matchLocationFromFeaturestoreName(featurestoreName: string): string | number;

Parse the location from Featurestore resource.

Parameter
NameDescription
featurestoreName string

A fully-qualified path representing Featurestore resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the location from HyperparameterTuningJob resource.

Parameter
NameDescription
hyperparameterTuningJobName string

A fully-qualified path representing HyperparameterTuningJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromIndexEndpointName(indexEndpointName)

matchLocationFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the location from IndexEndpoint resource.

Parameter
NameDescription
indexEndpointName string

A fully-qualified path representing IndexEndpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromIndexName(indexName)

matchLocationFromIndexName(indexName: string): string | number;

Parse the location from Index resource.

Parameter
NameDescription
indexName string

A fully-qualified path representing Index resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromMetadataSchemaName(metadataSchemaName)

matchLocationFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the location from MetadataSchema resource.

Parameter
NameDescription
metadataSchemaName string

A fully-qualified path representing MetadataSchema resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromMetadataStoreName(metadataStoreName)

matchLocationFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the location from MetadataStore resource.

Parameter
NameDescription
metadataStoreName string

A fully-qualified path representing MetadataStore resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName)

matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;

Parse the location from ModelDeploymentMonitoringJob resource.

Parameter
NameDescription
modelDeploymentMonitoringJobName string

A fully-qualified path representing ModelDeploymentMonitoringJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromModelEvaluationName(modelEvaluationName)

matchLocationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the location from ModelEvaluation resource.

Parameter
NameDescription
modelEvaluationName string

A fully-qualified path representing ModelEvaluation resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName)

matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the location from ModelEvaluationSlice resource.

Parameter
NameDescription
modelEvaluationSliceName string

A fully-qualified path representing ModelEvaluationSlice resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromModelName(modelName)

matchLocationFromModelName(modelName: string): string | number;

Parse the location from Model resource.

Parameter
NameDescription
modelName string

A fully-qualified path representing Model resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromPipelineJobName(pipelineJobName)

matchLocationFromPipelineJobName(pipelineJobName: string): string | number;

Parse the location from PipelineJob resource.

Parameter
NameDescription
pipelineJobName string

A fully-qualified path representing PipelineJob resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromSavedQueryName(savedQueryName)

matchLocationFromSavedQueryName(savedQueryName: string): string | number;

Parse the location from SavedQuery resource.

Parameter
NameDescription
savedQueryName string

A fully-qualified path representing SavedQuery resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromSpecialistPoolName(specialistPoolName)

matchLocationFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the location from SpecialistPool resource.

Parameter
NameDescription
specialistPoolName string

A fully-qualified path representing SpecialistPool resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromStudyName(studyName)

matchLocationFromStudyName(studyName: string): string | number;

Parse the location from Study resource.

Parameter
NameDescription
studyName string

A fully-qualified path representing Study resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTensorboardExperimentName(tensorboardExperimentName)

matchLocationFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the location from TensorboardExperiment resource.

Parameter
NameDescription
tensorboardExperimentName string

A fully-qualified path representing TensorboardExperiment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTensorboardName(tensorboardName)

matchLocationFromTensorboardName(tensorboardName: string): string | number;

Parse the location from Tensorboard resource.

Parameter
NameDescription
tensorboardName string

A fully-qualified path representing Tensorboard resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTensorboardRunName(tensorboardRunName)

matchLocationFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the location from TensorboardRun resource.

Parameter
NameDescription
tensorboardRunName string

A fully-qualified path representing TensorboardRun resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchLocationFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the location from TensorboardTimeSeries resource.

Parameter
NameDescription
tensorboardTimeSeriesName string

A fully-qualified path representing TensorboardTimeSeries resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTrainingPipelineName(trainingPipelineName)

matchLocationFromTrainingPipelineName(trainingPipelineName: string): string | number;

Parse the location from TrainingPipeline resource.

Parameter
NameDescription
trainingPipelineName string

A fully-qualified path representing TrainingPipeline resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTrialName(trialName)

matchLocationFromTrialName(trialName: string): string | number;

Parse the location from Trial resource.

Parameter
NameDescription
trialName string

A fully-qualified path representing Trial resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchMetadataSchemaFromMetadataSchemaName(metadataSchemaName)

matchMetadataSchemaFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the metadata_schema from MetadataSchema resource.

Parameter
NameDescription
metadataSchemaName string

A fully-qualified path representing MetadataSchema resource.

Returns
TypeDescription
string | number

{string} A string representing the metadata_schema.

matchMetadataStoreFromArtifactName(artifactName)

matchMetadataStoreFromArtifactName(artifactName: string): string | number;

Parse the metadata_store from Artifact resource.

Parameter
NameDescription
artifactName string

A fully-qualified path representing Artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the metadata_store.

matchMetadataStoreFromContextName(contextName)

matchMetadataStoreFromContextName(contextName: string): string | number;

Parse the metadata_store from Context resource.

Parameter
NameDescription
contextName string

A fully-qualified path representing Context resource.

Returns
TypeDescription
string | number

{string} A string representing the metadata_store.

matchMetadataStoreFromExecutionName(executionName)

matchMetadataStoreFromExecutionName(executionName: string): string | number;

Parse the metadata_store from Execution resource.

Parameter
NameDescription
executionName string

A fully-qualified path representing Execution resource.

Returns
TypeDescription
string | number

{string} A string representing the metadata_store.

matchMetadataStoreFromMetadataSchemaName(metadataSchemaName)

matchMetadataStoreFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the metadata_store from MetadataSchema resource.

Parameter
NameDescription
metadataSchemaName string

A fully-qualified path representing MetadataSchema resource.

Returns
TypeDescription
string | number

{string} A string representing the metadata_store.

matchMetadataStoreFromMetadataStoreName(metadataStoreName)

matchMetadataStoreFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the metadata_store from MetadataStore resource.

Parameter
NameDescription
metadataStoreName string

A fully-qualified path representing MetadataStore resource.

Returns
TypeDescription
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
NameDescription
modelDeploymentMonitoringJobName string

A fully-qualified path representing ModelDeploymentMonitoringJob resource.

Returns
TypeDescription
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
NameDescription
modelEvaluationName string

A fully-qualified path representing ModelEvaluation resource.

Returns
TypeDescription
string | number

{string} A string representing the model.

matchModelFromModelEvaluationSliceName(modelEvaluationSliceName)

matchModelFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the model from ModelEvaluationSlice resource.

Parameter
NameDescription
modelEvaluationSliceName string

A fully-qualified path representing ModelEvaluationSlice resource.

Returns
TypeDescription
string | number

{string} A string representing the model.

matchModelFromModelName(modelName)

matchModelFromModelName(modelName: string): string | number;

Parse the model from Model resource.

Parameter
NameDescription
modelName string

A fully-qualified path representing Model resource.

Returns
TypeDescription
string | number

{string} A string representing the model.

matchPipelineJobFromPipelineJobName(pipelineJobName)

matchPipelineJobFromPipelineJobName(pipelineJobName: string): string | number;

Parse the pipeline_job from PipelineJob resource.

Parameter
NameDescription
pipelineJobName string

A fully-qualified path representing PipelineJob resource.

Returns
TypeDescription
string | number

{string} A string representing the pipeline_job.

matchProjectFromAnnotationName(annotationName)

matchProjectFromAnnotationName(annotationName: string): string | number;

Parse the project from Annotation resource.

Parameter
NameDescription
annotationName string

A fully-qualified path representing Annotation resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromAnnotationSpecName(annotationSpecName)

matchProjectFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the project from AnnotationSpec resource.

Parameter
NameDescription
annotationSpecName string

A fully-qualified path representing AnnotationSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromArtifactName(artifactName)

matchProjectFromArtifactName(artifactName: string): string | number;

Parse the project from Artifact resource.

Parameter
NameDescription
artifactName string

A fully-qualified path representing Artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromBatchPredictionJobName(batchPredictionJobName)

matchProjectFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the project from BatchPredictionJob resource.

Parameter
NameDescription
batchPredictionJobName string

A fully-qualified path representing BatchPredictionJob resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromContextName(contextName)

matchProjectFromContextName(contextName: string): string | number;

Parse the project from Context resource.

Parameter
NameDescription
contextName string

A fully-qualified path representing Context resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromCustomJobName(customJobName)

matchProjectFromCustomJobName(customJobName: string): string | number;

Parse the project from CustomJob resource.

Parameter
NameDescription
customJobName string

A fully-qualified path representing CustomJob resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromDataItemName(dataItemName)

matchProjectFromDataItemName(dataItemName: string): string | number;

Parse the project from DataItem resource.

Parameter
NameDescription
dataItemName string

A fully-qualified path representing DataItem resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromDataLabelingJobName(dataLabelingJobName)

matchProjectFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the project from DataLabelingJob resource.

Parameter
NameDescription
dataLabelingJobName string

A fully-qualified path representing DataLabelingJob resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromDatasetName(datasetName)

matchProjectFromDatasetName(datasetName: string): string | number;

Parse the project from Dataset resource.

Parameter
NameDescription
datasetName string

A fully-qualified path representing Dataset resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromEndpointName(endpointName)

matchProjectFromEndpointName(endpointName: string): string | number;

Parse the project from Endpoint resource.

Parameter
NameDescription
endpointName string

A fully-qualified path representing Endpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromEntityTypeName(entityTypeName)

matchProjectFromEntityTypeName(entityTypeName: string): string | number;

Parse the project from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromExecutionName(executionName)

matchProjectFromExecutionName(executionName: string): string | number;

Parse the project from Execution resource.

Parameter
NameDescription
executionName string

A fully-qualified path representing Execution resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromFeatureName(featureName)

matchProjectFromFeatureName(featureName: string): string | number;

Parse the project from Feature resource.

Parameter
NameDescription
featureName string

A fully-qualified path representing Feature resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromFeaturestoreName(featurestoreName)

matchProjectFromFeaturestoreName(featurestoreName: string): string | number;

Parse the project from Featurestore resource.

Parameter
NameDescription
featurestoreName string

A fully-qualified path representing Featurestore resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName)

matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName: string): string | number;

Parse the project from HyperparameterTuningJob resource.

Parameter
NameDescription
hyperparameterTuningJobName string

A fully-qualified path representing HyperparameterTuningJob resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromIndexEndpointName(indexEndpointName)

matchProjectFromIndexEndpointName(indexEndpointName: string): string | number;

Parse the project from IndexEndpoint resource.

Parameter
NameDescription
indexEndpointName string

A fully-qualified path representing IndexEndpoint resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromIndexName(indexName)

matchProjectFromIndexName(indexName: string): string | number;

Parse the project from Index resource.

Parameter
NameDescription
indexName string

A fully-qualified path representing Index resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromMetadataSchemaName(metadataSchemaName)

matchProjectFromMetadataSchemaName(metadataSchemaName: string): string | number;

Parse the project from MetadataSchema resource.

Parameter
NameDescription
metadataSchemaName string

A fully-qualified path representing MetadataSchema resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromMetadataStoreName(metadataStoreName)

matchProjectFromMetadataStoreName(metadataStoreName: string): string | number;

Parse the project from MetadataStore resource.

Parameter
NameDescription
metadataStoreName string

A fully-qualified path representing MetadataStore resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName)

matchProjectFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName: string): string | number;

Parse the project from ModelDeploymentMonitoringJob resource.

Parameter
NameDescription
modelDeploymentMonitoringJobName string

A fully-qualified path representing ModelDeploymentMonitoringJob resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromModelEvaluationName(modelEvaluationName)

matchProjectFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the project from ModelEvaluation resource.

Parameter
NameDescription
modelEvaluationName string

A fully-qualified path representing ModelEvaluation resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName)

matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the project from ModelEvaluationSlice resource.

Parameter
NameDescription
modelEvaluationSliceName string

A fully-qualified path representing ModelEvaluationSlice resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromModelName(modelName)

matchProjectFromModelName(modelName: string): string | number;

Parse the project from Model resource.

Parameter
NameDescription
modelName string

A fully-qualified path representing Model resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromPipelineJobName(pipelineJobName)

matchProjectFromPipelineJobName(pipelineJobName: string): string | number;

Parse the project from PipelineJob resource.

Parameter
NameDescription
pipelineJobName string

A fully-qualified path representing PipelineJob resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromSavedQueryName(savedQueryName)

matchProjectFromSavedQueryName(savedQueryName: string): string | number;

Parse the project from SavedQuery resource.

Parameter
NameDescription
savedQueryName string

A fully-qualified path representing SavedQuery resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromSpecialistPoolName(specialistPoolName)

matchProjectFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the project from SpecialistPool resource.

Parameter
NameDescription
specialistPoolName string

A fully-qualified path representing SpecialistPool resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromStudyName(studyName)

matchProjectFromStudyName(studyName: string): string | number;

Parse the project from Study resource.

Parameter
NameDescription
studyName string

A fully-qualified path representing Study resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTensorboardExperimentName(tensorboardExperimentName)

matchProjectFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the project from TensorboardExperiment resource.

Parameter
NameDescription
tensorboardExperimentName string

A fully-qualified path representing TensorboardExperiment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTensorboardName(tensorboardName)

matchProjectFromTensorboardName(tensorboardName: string): string | number;

Parse the project from Tensorboard resource.

Parameter
NameDescription
tensorboardName string

A fully-qualified path representing Tensorboard resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTensorboardRunName(tensorboardRunName)

matchProjectFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the project from TensorboardRun resource.

Parameter
NameDescription
tensorboardRunName string

A fully-qualified path representing TensorboardRun resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchProjectFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the project from TensorboardTimeSeries resource.

Parameter
NameDescription
tensorboardTimeSeriesName string

A fully-qualified path representing TensorboardTimeSeries resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTrainingPipelineName(trainingPipelineName)

matchProjectFromTrainingPipelineName(trainingPipelineName: string): string | number;

Parse the project from TrainingPipeline resource.

Parameter
NameDescription
trainingPipelineName string

A fully-qualified path representing TrainingPipeline resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTrialName(trialName)

matchProjectFromTrialName(trialName: string): string | number;

Parse the project from Trial resource.

Parameter
NameDescription
trialName string

A fully-qualified path representing Trial resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchRunFromTensorboardRunName(tensorboardRunName)

matchRunFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the run from TensorboardRun resource.

Parameter
NameDescription
tensorboardRunName string

A fully-qualified path representing TensorboardRun resource.

Returns
TypeDescription
string | number

{string} A string representing the run.

matchRunFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchRunFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the run from TensorboardTimeSeries resource.

Parameter
NameDescription
tensorboardTimeSeriesName string

A fully-qualified path representing TensorboardTimeSeries resource.

Returns
TypeDescription
string | number

{string} A string representing the run.

matchSavedQueryFromSavedQueryName(savedQueryName)

matchSavedQueryFromSavedQueryName(savedQueryName: string): string | number;

Parse the saved_query from SavedQuery resource.

Parameter
NameDescription
savedQueryName string

A fully-qualified path representing SavedQuery resource.

Returns
TypeDescription
string | number

{string} A string representing the saved_query.

matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName)

matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the slice from ModelEvaluationSlice resource.

Parameter
NameDescription
modelEvaluationSliceName string

A fully-qualified path representing ModelEvaluationSlice resource.

Returns
TypeDescription
string | number

{string} A string representing the slice.

matchSpecialistPoolFromSpecialistPoolName(specialistPoolName)

matchSpecialistPoolFromSpecialistPoolName(specialistPoolName: string): string | number;

Parse the specialist_pool from SpecialistPool resource.

Parameter
NameDescription
specialistPoolName string

A fully-qualified path representing SpecialistPool resource.

Returns
TypeDescription
string | number

{string} A string representing the specialist_pool.

matchStudyFromStudyName(studyName)

matchStudyFromStudyName(studyName: string): string | number;

Parse the study from Study resource.

Parameter
NameDescription
studyName string

A fully-qualified path representing Study resource.

Returns
TypeDescription
string | number

{string} A string representing the study.

matchStudyFromTrialName(trialName)

matchStudyFromTrialName(trialName: string): string | number;

Parse the study from Trial resource.

Parameter
NameDescription
trialName string

A fully-qualified path representing Trial resource.

Returns
TypeDescription
string | number

{string} A string representing the study.

matchTensorboardFromTensorboardExperimentName(tensorboardExperimentName)

matchTensorboardFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the tensorboard from TensorboardExperiment resource.

Parameter
NameDescription
tensorboardExperimentName string

A fully-qualified path representing TensorboardExperiment resource.

Returns
TypeDescription
string | number

{string} A string representing the tensorboard.

matchTensorboardFromTensorboardName(tensorboardName)

matchTensorboardFromTensorboardName(tensorboardName: string): string | number;

Parse the tensorboard from Tensorboard resource.

Parameter
NameDescription
tensorboardName string

A fully-qualified path representing Tensorboard resource.

Returns
TypeDescription
string | number

{string} A string representing the tensorboard.

matchTensorboardFromTensorboardRunName(tensorboardRunName)

matchTensorboardFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the tensorboard from TensorboardRun resource.

Parameter
NameDescription
tensorboardRunName string

A fully-qualified path representing TensorboardRun resource.

Returns
TypeDescription
string | number

{string} A string representing the tensorboard.

matchTensorboardFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchTensorboardFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the tensorboard from TensorboardTimeSeries resource.

Parameter
NameDescription
tensorboardTimeSeriesName string

A fully-qualified path representing TensorboardTimeSeries resource.

Returns
TypeDescription
string | number

{string} A string representing the tensorboard.

matchTimeSeriesFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchTimeSeriesFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the time_series from TensorboardTimeSeries resource.

Parameter
NameDescription
tensorboardTimeSeriesName string

A fully-qualified path representing TensorboardTimeSeries resource.

Returns
TypeDescription
string | number

{string} A string representing the time_series.

matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName)

matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName: string): string | number;

Parse the training_pipeline from TrainingPipeline resource.

Parameter
NameDescription
trainingPipelineName string

A fully-qualified path representing TrainingPipeline resource.

Returns
TypeDescription
string | number

{string} A string representing the training_pipeline.

matchTrialFromTrialName(trialName)

matchTrialFromTrialName(trialName: string): string | number;

Parse the trial from Trial resource.

Parameter
NameDescription
trialName string

A fully-qualified path representing Trial resource.

Returns
TypeDescription
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
NameDescription
request protos.google.cloud.aiplatform.v1.IMergeVersionAliasesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 [Model]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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 = 'abc123'

  // 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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
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>
Returns
TypeDescription
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
NameDescription
project string
location string
metadataStore string
metadataSchema string
Returns
TypeDescription
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
NameDescription
project string
location string
metadataStore string
Returns
TypeDescription
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
NameDescription
project string
location string
modelDeploymentMonitoringJob string
Returns
TypeDescription
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
NameDescription
project string
location string
model string
evaluation string
Returns
TypeDescription
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
NameDescription
project string
location string
model string
evaluation string
slice string
Returns
TypeDescription
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
NameDescription
project string
location string
model string
Returns
TypeDescription
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
NameDescription
project string
location string
pipelineJob string
Returns
TypeDescription
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
NameDescription
project string
location string
dataset string
savedQuery string
Returns
TypeDescription
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
NameDescription
request IamProtos.google.iam.v1.SetIamPolicyRequest

The request object that will be sent.

options gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.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]https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html for the details.

callback Callback<IamProtos.google.iam.v1.Policy, IamProtos.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 [TestIamPermissionsResponse].

Returns
TypeDescription
Promise<IamProtos.google.iam.v1.Policy>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [TestIamPermissionsResponse]. 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
NameDescription
project string
location string
specialistPool string
Returns
TypeDescription
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
NameDescription
project string
location string
study string
Returns
TypeDescription