Class v1.MetadataServiceClient (2.3.0)

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

Service for reading and writing metadata entries. v1

Package

@google-cloud/aiplatform

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of MetadataServiceClient.

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

metadataServiceStub

metadataServiceStub?: 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

addContextArtifactsAndExecutions(request, options)

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

Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsResponse, (protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AddContextArtifactsAndExecutionsResponse]. 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 resource name of the Context that the Artifacts and Executions
   *  belong to.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
   */
  // const context = 'abc123'
  /**
   *  The resource names of the Artifacts to attribute to the Context.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
   */
  // const artifacts = 'abc123'
  /**
   *  The resource names of the Executions to associate with the
   *  Context.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
   */
  // const executions = 'abc123'

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

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

  async function callAddContextArtifactsAndExecutions() {
    // Construct request
    const request = {
      context,
    };

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

  callAddContextArtifactsAndExecutions();

addContextArtifactsAndExecutions(request, options, callback)

addContextArtifactsAndExecutions(request: protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsResponse, protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsResponse, protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

addContextArtifactsAndExecutions(request, callback)

addContextArtifactsAndExecutions(request: protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsResponse, protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsRequest
callback Callback<protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsResponse, protos.google.cloud.aiplatform.v1.IAddContextArtifactsAndExecutionsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

addContextChildren(request, options)

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

Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IAddContextChildrenResponse, protos.google.cloud.aiplatform.v1.IAddContextChildrenRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AddContextChildrenResponse]. 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 resource name of the parent Context.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
   */
  // const context = 'abc123'
  /**
   *  The resource names of the child Contexts.
   */
  // const childContexts = 'abc123'

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

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

  async function callAddContextChildren() {
    // Construct request
    const request = {
      context,
    };

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

  callAddContextChildren();

addContextChildren(request, options, callback)

addContextChildren(request: protos.google.cloud.aiplatform.v1.IAddContextChildrenRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IAddContextChildrenResponse, protos.google.cloud.aiplatform.v1.IAddContextChildrenRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IAddContextChildrenRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1.IAddContextChildrenResponse, protos.google.cloud.aiplatform.v1.IAddContextChildrenRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

addContextChildren(request, callback)

addContextChildren(request: protos.google.cloud.aiplatform.v1.IAddContextChildrenRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IAddContextChildrenResponse, protos.google.cloud.aiplatform.v1.IAddContextChildrenRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IAddContextChildrenRequest
callback Callback<protos.google.cloud.aiplatform.v1.IAddContextChildrenResponse, protos.google.cloud.aiplatform.v1.IAddContextChildrenRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

addExecutionEvents(request, options)

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

Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IAddExecutionEventsResponse, protos.google.cloud.aiplatform.v1.IAddExecutionEventsRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AddExecutionEventsResponse]. 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 resource name of the Execution that the Events connect
   *  Artifacts with.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
   */
  // const execution = 'abc123'
  /**
   *  The Events to create and add.
   */
  // const events = 1234

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

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

  async function callAddExecutionEvents() {
    // Construct request
    const request = {
      execution,
    };

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

  callAddExecutionEvents();

addExecutionEvents(request, options, callback)

addExecutionEvents(request: protos.google.cloud.aiplatform.v1.IAddExecutionEventsRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IAddExecutionEventsResponse, protos.google.cloud.aiplatform.v1.IAddExecutionEventsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IAddExecutionEventsRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1.IAddExecutionEventsResponse, protos.google.cloud.aiplatform.v1.IAddExecutionEventsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

addExecutionEvents(request, callback)

addExecutionEvents(request: protos.google.cloud.aiplatform.v1.IAddExecutionEventsRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IAddExecutionEventsResponse, protos.google.cloud.aiplatform.v1.IAddExecutionEventsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IAddExecutionEventsRequest
callback Callback<protos.google.cloud.aiplatform.v1.IAddExecutionEventsResponse, protos.google.cloud.aiplatform.v1.IAddExecutionEventsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

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.

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: ''});

checkCreateMetadataStoreProgress(name)

checkCreateMetadataStoreProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.MetadataStore, protos.google.cloud.aiplatform.v1.CreateMetadataStoreOperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.aiplatform.v1.MetadataStore, protos.google.cloud.aiplatform.v1.CreateMetadataStoreOperationMetadata>>

{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 where the MetadataStore should
   *  be created.
   *  Format: `projects/{project}/locations/{location}/`
   */
  // const parent = 'abc123'
  /**
   *  Required. The MetadataStore to create.
   */
  // const metadataStore = {}
  /**
   *  The {metadatastore} portion of the resource name with the format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   *  If not provided, the MetadataStore's ID will be a UUID generated by the
   *  service.
   *  Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
   *  Must be unique across all MetadataStores in the parent Location.
   *  (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
   *  if the caller can't view the preexisting MetadataStore.)
   */
  // const metadataStoreId = 'abc123'

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

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

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

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

  callCreateMetadataStore();

checkDeleteArtifactProgress(name)

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

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

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 resource name of the Artifact to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
   */
  // const name = 'abc123'
  /**
   *  Optional. The etag of the Artifact to delete.
   *  If this is provided, it must match the server's etag. Otherwise, the
   *  request will fail with a FAILED_PRECONDITION.
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteArtifact();

checkDeleteContextProgress(name)

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

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

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 resource name of the Context to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
   */
  // const name = 'abc123'
  /**
   *  The force deletion semantics is still undefined.
   *  Users should not use this field.
   */
  // const force = true
  /**
   *  Optional. The etag of the Context to delete.
   *  If this is provided, it must match the server's etag. Otherwise, the
   *  request will fail with a FAILED_PRECONDITION.
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteContext();

checkDeleteExecutionProgress(name)

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

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

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 resource name of the Execution to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
   */
  // const name = 'abc123'
  /**
   *  Optional. The etag of the Execution to delete.
   *  If this is provided, it must match the server's etag. Otherwise, the
   *  request will fail with a FAILED_PRECONDITION.
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteExecution();

checkDeleteMetadataStoreProgress(name)

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

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

Parameter
NameDescription
name string

The operation name that will be passed.

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

{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 MetadataStore to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteMetadataStore();

checkPurgeArtifactsProgress(name)

checkPurgeArtifactsProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.PurgeArtifactsResponse, protos.google.cloud.aiplatform.v1.PurgeArtifactsMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.aiplatform.v1.PurgeArtifactsResponse, protos.google.cloud.aiplatform.v1.PurgeArtifactsMetadata>>

{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 metadata store to purge Artifacts from.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const parent = 'abc123'
  /**
   *  Required. A required filter matching the Artifacts to be purged.
   *  E.g., `update_time <= 2020-11-19t11:30:00-04:00`.="" */="" const="" filter='abc123' *="" *="" optional.="" flag="" to="" indicate="" to="" actually="" perform="" the="" purge.="" *="" if="" `force`="" is="" set="" to="" false,="" the="" method="" will="" return="" a="" sample="" of="" *="" artifact="" names="" that="" would="" be="" deleted.="" */="" const="" force="true" imports="" the="" aiplatform="" library="" const="" {metadataserviceclient}="require('@google-cloud/aiplatform').v1;" instantiates="" a="" client="" const="" aiplatformclient="new" metadataserviceclient();="" async="" function="" callpurgeartifacts()="" {="" construct="" request="" const="" request="{" parent,="" filter,="" };="" run="" request="" const="" [operation]="await" aiplatformclient.purgeartifacts(request);="" const="" [response]="await" operation.promise();="" console.log(response);="" }="" callpurgeartifacts();="">

checkPurgeContextsProgress(name)

checkPurgeContextsProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.PurgeContextsResponse, protos.google.cloud.aiplatform.v1.PurgeContextsMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.aiplatform.v1.PurgeContextsResponse, protos.google.cloud.aiplatform.v1.PurgeContextsMetadata>>

{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 metadata store to purge Contexts from.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const parent = 'abc123'
  /**
   *  Required. A required filter matching the Contexts to be purged.
   *  E.g., `update_time <= 2020-11-19t11:30:00-04:00`.="" */="" const="" filter='abc123' *="" *="" optional.="" flag="" to="" indicate="" to="" actually="" perform="" the="" purge.="" *="" if="" `force`="" is="" set="" to="" false,="" the="" method="" will="" return="" a="" sample="" of="" *="" context="" names="" that="" would="" be="" deleted.="" */="" const="" force="true" imports="" the="" aiplatform="" library="" const="" {metadataserviceclient}="require('@google-cloud/aiplatform').v1;" instantiates="" a="" client="" const="" aiplatformclient="new" metadataserviceclient();="" async="" function="" callpurgecontexts()="" {="" construct="" request="" const="" request="{" parent,="" filter,="" };="" run="" request="" const="" [operation]="await" aiplatformclient.purgecontexts(request);="" const="" [response]="await" operation.promise();="" console.log(response);="" }="" callpurgecontexts();="">

checkPurgeExecutionsProgress(name)

checkPurgeExecutionsProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1.PurgeExecutionsResponse, protos.google.cloud.aiplatform.v1.PurgeExecutionsMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.aiplatform.v1.PurgeExecutionsResponse, protos.google.cloud.aiplatform.v1.PurgeExecutionsMetadata>>

{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 metadata store to purge Executions from.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const parent = 'abc123'
  /**
   *  Required. A required filter matching the Executions to be purged.
   *  E.g., `update_time <= 2020-11-19t11:30:00-04:00`.="" */="" const="" filter='abc123' *="" *="" optional.="" flag="" to="" indicate="" to="" actually="" perform="" the="" purge.="" *="" if="" `force`="" is="" set="" to="" false,="" the="" method="" will="" return="" a="" sample="" of="" *="" execution="" names="" that="" would="" be="" deleted.="" */="" const="" force="true" imports="" the="" aiplatform="" library="" const="" {metadataserviceclient}="require('@google-cloud/aiplatform').v1;" instantiates="" a="" client="" const="" aiplatformclient="new" metadataserviceclient();="" async="" function="" callpurgeexecutions()="" {="" construct="" request="" const="" request="{" parent,="" filter,="" };="" run="" request="" const="" [operation]="await" aiplatformclient.purgeexecutions(request);="" const="" [response]="await" operation.promise();="" console.log(response);="" }="" callpurgeexecutions();="">

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.

createArtifact(request, options)

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

Creates an Artifact associated with a MetadataStore.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IArtifact, protos.google.cloud.aiplatform.v1.ICreateArtifactRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Artifact]. 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 resource name of the MetadataStore where the Artifact should
   *  be created.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Artifact to create.
   */
  // const artifact = {}
  /**
   *  The {artifact} portion of the resource name with the format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
   *  If not provided, the Artifact's ID will be a UUID generated by the service.
   *  Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
   *  Must be unique across all Artifacts in the parent MetadataStore. (Otherwise
   *  the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the
   *  caller can't view the preexisting Artifact.)
   */
  // const artifactId = 'abc123'

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

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

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

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

  callCreateArtifact();

createArtifact(request, options, callback)

createArtifact(request: protos.google.cloud.aiplatform.v1.ICreateArtifactRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IArtifact, protos.google.cloud.aiplatform.v1.ICreateArtifactRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.ICreateArtifactRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1.IArtifact, protos.google.cloud.aiplatform.v1.ICreateArtifactRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createArtifact(request, callback)

createArtifact(request: protos.google.cloud.aiplatform.v1.ICreateArtifactRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IArtifact, protos.google.cloud.aiplatform.v1.ICreateArtifactRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.ICreateArtifactRequest
callback Callback<protos.google.cloud.aiplatform.v1.IArtifact, protos.google.cloud.aiplatform.v1.ICreateArtifactRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createContext(request, options)

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

Creates a Context associated with a MetadataStore.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IContext, protos.google.cloud.aiplatform.v1.ICreateContextRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Context]. 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 resource name of the MetadataStore where the Context should be
   *  created.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Context to create.
   */
  // const context = {}
  /**
   *  The {context} portion of the resource name with the format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`.
   *  If not provided, the Context's ID will be a UUID generated by the service.
   *  Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
   *  Must be unique across all Contexts in the parent MetadataStore. (Otherwise
   *  the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the
   *  caller can't view the preexisting Context.)
   */
  // const contextId = 'abc123'

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

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

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

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

  callCreateContext();

createContext(request, options, callback)

createContext(request: protos.google.cloud.aiplatform.v1.ICreateContextRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IContext, protos.google.cloud.aiplatform.v1.ICreateContextRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.ICreateContextRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1.IContext, protos.google.cloud.aiplatform.v1.ICreateContextRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createContext(request, callback)

createContext(request: protos.google.cloud.aiplatform.v1.ICreateContextRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IContext, protos.google.cloud.aiplatform.v1.ICreateContextRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.ICreateContextRequest
callback Callback<protos.google.cloud.aiplatform.v1.IContext, protos.google.cloud.aiplatform.v1.ICreateContextRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createExecution(request, options)

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

Creates an Execution associated with a MetadataStore.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IExecution, protos.google.cloud.aiplatform.v1.ICreateExecutionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Execution]. 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 resource name of the MetadataStore where the Execution should
   *  be created.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Execution to create.
   */
  // const execution = {}
  /**
   *  The {execution} portion of the resource name with the format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
   *  If not provided, the Execution's ID will be a UUID generated by the
   *  service.
   *  Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
   *  Must be unique across all Executions in the parent MetadataStore.
   *  (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
   *  if the caller can't view the preexisting Execution.)
   */
  // const executionId = 'abc123'

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

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

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

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

  callCreateExecution();

createExecution(request, options, callback)

createExecution(request: protos.google.cloud.aiplatform.v1.ICreateExecutionRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IExecution, protos.google.cloud.aiplatform.v1.ICreateExecutionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.ICreateExecutionRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1.IExecution, protos.google.cloud.aiplatform.v1.ICreateExecutionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createExecution(request, callback)

createExecution(request: protos.google.cloud.aiplatform.v1.ICreateExecutionRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IExecution, protos.google.cloud.aiplatform.v1.ICreateExecutionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.ICreateExecutionRequest
callback Callback<protos.google.cloud.aiplatform.v1.IExecution, protos.google.cloud.aiplatform.v1.ICreateExecutionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createMetadataSchema(request, options)

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

Creates a MetadataSchema.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IMetadataSchema, (protos.google.cloud.aiplatform.v1.ICreateMetadataSchemaRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [MetadataSchema]. 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 resource name of the MetadataStore where the MetadataSchema should
   *  be created.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The MetadataSchema to create.
   */
  // const metadataSchema = {}
  /**
   *  The {metadata_schema} portion of the resource name with the format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
   *  If not provided, the MetadataStore's ID will be a UUID generated by the
   *  service.
   *  Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
   *  Must be unique across all MetadataSchemas in the parent Location.
   *  (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
   *  if the caller can't view the preexisting MetadataSchema.)
   */
  // const metadataSchemaId = 'abc123'

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

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

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

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

  callCreateMetadataSchema();

createMetadataSchema(request, options, callback)

createMetadataSchema(request: protos.google.cloud.aiplatform.v1.ICreateMetadataSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IMetadataSchema, protos.google.cloud.aiplatform.v1.ICreateMetadataSchemaRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.ICreateMetadataSchemaRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1.IMetadataSchema, protos.google.cloud.aiplatform.v1.ICreateMetadataSchemaRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createMetadataSchema(request, callback)

createMetadataSchema(request: protos.google.cloud.aiplatform.v1.ICreateMetadataSchemaRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IMetadataSchema, protos.google.cloud.aiplatform.v1.ICreateMetadataSchemaRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.ICreateMetadataSchemaRequest
callback Callback<protos.google.cloud.aiplatform.v1.IMetadataSchema, protos.google.cloud.aiplatform.v1.ICreateMetadataSchemaRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createMetadataStore(request, options)

createMetadataStore(request?: protos.google.cloud.aiplatform.v1.ICreateMetadataStoreRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1.IMetadataStore, protos.google.cloud.aiplatform.v1.ICreateMetadataStoreOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Initializes a MetadataStore, including allocation of resources.

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

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.IMetadataStore, protos.google.cloud.aiplatform.v1.ICreateMetadataStoreOperationMetadata>, 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 Location where the MetadataStore should
   *  be created.
   *  Format: `projects/{project}/locations/{location}/`
   */
  // const parent = 'abc123'
  /**
   *  Required. The MetadataStore to create.
   */
  // const metadataStore = {}
  /**
   *  The {metadatastore} portion of the resource name with the format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   *  If not provided, the MetadataStore's ID will be a UUID generated by the
   *  service.
   *  Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
   *  Must be unique across all MetadataStores in the parent Location.
   *  (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
   *  if the caller can't view the preexisting MetadataStore.)
   */
  // const metadataStoreId = 'abc123'

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

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

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

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

  callCreateMetadataStore();

createMetadataStore(request, options, callback)

createMetadataStore(request: protos.google.cloud.aiplatform.v1.ICreateMetadataStoreRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IMetadataStore, protos.google.cloud.aiplatform.v1.ICreateMetadataStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.ICreateMetadataStoreRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.aiplatform.v1.IMetadataStore, protos.google.cloud.aiplatform.v1.ICreateMetadataStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createMetadataStore(request, callback)

createMetadataStore(request: protos.google.cloud.aiplatform.v1.ICreateMetadataStoreRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1.IMetadataStore, protos.google.cloud.aiplatform.v1.ICreateMetadataStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.ICreateMetadataStoreRequest
callback Callback<LROperation<protos.google.cloud.aiplatform.v1.IMetadataStore, protos.google.cloud.aiplatform.v1.ICreateMetadataStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

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.

deleteArtifact(request, options)

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

Deletes an Artifact.

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

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 resource name of the Artifact to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
   */
  // const name = 'abc123'
  /**
   *  Optional. The etag of the Artifact to delete.
   *  If this is provided, it must match the server's etag. Otherwise, the
   *  request will fail with a FAILED_PRECONDITION.
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteArtifact();

deleteArtifact(request, options, callback)

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

deleteArtifact(request, callback)

deleteArtifact(request: protos.google.cloud.aiplatform.v1.IDeleteArtifactRequest, 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.IDeleteArtifactRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteContext(request, options)

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

Deletes a stored Context.

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

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 resource name of the Context to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
   */
  // const name = 'abc123'
  /**
   *  The force deletion semantics is still undefined.
   *  Users should not use this field.
   */
  // const force = true
  /**
   *  Optional. The etag of the Context to delete.
   *  If this is provided, it must match the server's etag. Otherwise, the
   *  request will fail with a FAILED_PRECONDITION.
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteContext();

deleteContext(request, options, callback)

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

deleteContext(request, callback)

deleteContext(request: protos.google.cloud.aiplatform.v1.IDeleteContextRequest, 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.IDeleteContextRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteExecution(request, options)

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

Deletes an Execution.

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

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 resource name of the Execution to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
   */
  // const name = 'abc123'
  /**
   *  Optional. The etag of the Execution to delete.
   *  If this is provided, it must match the server's etag. Otherwise, the
   *  request will fail with a FAILED_PRECONDITION.
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteExecution();

deleteExecution(request, options, callback)

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

deleteExecution(request, callback)

deleteExecution(request: protos.google.cloud.aiplatform.v1.IDeleteExecutionRequest, 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.IDeleteExecutionRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteMetadataStore(request, options)

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

Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).

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

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.IDeleteMetadataStoreOperationMetadata>, 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 MetadataStore to delete.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteMetadataStore();

deleteMetadataStore(request, options, callback)

deleteMetadataStore(request: protos.google.cloud.aiplatform.v1.IDeleteMetadataStoreRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteMetadataStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IDeleteMetadataStoreRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteMetadataStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteMetadataStore(request, callback)

deleteMetadataStore(request: protos.google.cloud.aiplatform.v1.IDeleteMetadataStoreRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteMetadataStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IDeleteMetadataStoreRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1.IDeleteMetadataStoreOperationMetadata>, 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.

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.

getArtifact(request, options)

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

Retrieves a specific Artifact.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IArtifact, protos.google.cloud.aiplatform.v1.IGetArtifactRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Artifact]. 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 resource name of the Artifact to retrieve.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetArtifact();

getArtifact(request, options, callback)

getArtifact(request: protos.google.cloud.aiplatform.v1.IGetArtifactRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IArtifact, protos.google.cloud.aiplatform.v1.IGetArtifactRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IGetArtifactRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1.IArtifact, protos.google.cloud.aiplatform.v1.IGetArtifactRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getArtifact(request, callback)

getArtifact(request: protos.google.cloud.aiplatform.v1.IGetArtifactRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IArtifact, protos.google.cloud.aiplatform.v1.IGetArtifactRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IGetArtifactRequest
callback Callback<protos.google.cloud.aiplatform.v1.IArtifact, protos.google.cloud.aiplatform.v1.IGetArtifactRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getContext(request, options)

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

Retrieves a specific Context.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IContext, protos.google.cloud.aiplatform.v1.IGetContextRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Context]. 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 resource name of the Context to retrieve.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetContext();

getContext(request, options, callback)

getContext(request: protos.google.cloud.aiplatform.v1.IGetContextRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IContext, protos.google.cloud.aiplatform.v1.IGetContextRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IGetContextRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1.IContext, protos.google.cloud.aiplatform.v1.IGetContextRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getContext(request, callback)

getContext(request: protos.google.cloud.aiplatform.v1.IGetContextRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IContext, protos.google.cloud.aiplatform.v1.IGetContextRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IGetContextRequest
callback Callback<protos.google.cloud.aiplatform.v1.IContext, protos.google.cloud.aiplatform.v1.IGetContextRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getExecution(request, options)

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

Retrieves a specific Execution.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IExecution, protos.google.cloud.aiplatform.v1.IGetExecutionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Execution]. 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 resource name of the Execution to retrieve.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetExecution();

getExecution(request, options, callback)

getExecution(request: protos.google.cloud.aiplatform.v1.IGetExecutionRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IExecution, protos.google.cloud.aiplatform.v1.IGetExecutionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IGetExecutionRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1.IExecution, protos.google.cloud.aiplatform.v1.IGetExecutionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getExecution(request, callback)

getExecution(request: protos.google.cloud.aiplatform.v1.IGetExecutionRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IExecution, protos.google.cloud.aiplatform.v1.IGetExecutionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IGetExecutionRequest
callback Callback<protos.google.cloud.aiplatform.v1.IExecution, protos.google.cloud.aiplatform.v1.IGetExecutionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

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);

getMetadataSchema(request, options)

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

Retrieves a specific MetadataSchema.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IMetadataSchema, protos.google.cloud.aiplatform.v1.IGetMetadataSchemaRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [MetadataSchema]. 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 resource name of the MetadataSchema to retrieve.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetMetadataSchema();

getMetadataSchema(request, options, callback)

getMetadataSchema(request: protos.google.cloud.aiplatform.v1.IGetMetadataSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IMetadataSchema, protos.google.cloud.aiplatform.v1.IGetMetadataSchemaRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IGetMetadataSchemaRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1.IMetadataSchema, protos.google.cloud.aiplatform.v1.IGetMetadataSchemaRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getMetadataSchema(request, callback)

getMetadataSchema(request: protos.google.cloud.aiplatform.v1.IGetMetadataSchemaRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IMetadataSchema, protos.google.cloud.aiplatform.v1.IGetMetadataSchemaRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IGetMetadataSchemaRequest
callback Callback<protos.google.cloud.aiplatform.v1.IMetadataSchema, protos.google.cloud.aiplatform.v1.IGetMetadataSchemaRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getMetadataStore(request, options)

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

Retrieves a specific MetadataStore.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IMetadataStore, protos.google.cloud.aiplatform.v1.IGetMetadataStoreRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [MetadataStore]. 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 resource name of the MetadataStore to retrieve.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetMetadataStore();

getMetadataStore(request, options, callback)

getMetadataStore(request: protos.google.cloud.aiplatform.v1.IGetMetadataStoreRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1.IMetadataStore, protos.google.cloud.aiplatform.v1.IGetMetadataStoreRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IGetMetadataStoreRequest
options CallOptions
callback Callback<protos.google.cloud.aiplatform.v1.IMetadataStore, protos.google.cloud.aiplatform.v1.IGetMetadataStoreRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getMetadataStore(request, callback)

getMetadataStore(request: protos.google.cloud.aiplatform.v1.IGetMetadataStoreRequest, callback: Callback<protos.google.cloud.aiplatform.v1.IMetadataStore, protos.google.cloud.aiplatform.v1.IGetMetadataStoreRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IGetMetadataStoreRequest
callback Callback<protos.google.cloud.aiplatform.v1.IMetadataStore, protos.google.cloud.aiplatform.v1.IGetMetadataStoreRequest | 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.

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.

listArtifacts(request, options)

listArtifacts(request?: protos.google.cloud.aiplatform.v1.IListArtifactsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IArtifact[],
        protos.google.cloud.aiplatform.v1.IListArtifactsRequest | null,
        protos.google.cloud.aiplatform.v1.IListArtifactsResponse
    ]>;

Lists Artifacts in the MetadataStore.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IArtifact[], protos.google.cloud.aiplatform.v1.IListArtifactsRequest | null, protos.google.cloud.aiplatform.v1.IListArtifactsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Artifact]. 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 listArtifactsAsync() 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.

listArtifacts(request, options, callback)

listArtifacts(request: protos.google.cloud.aiplatform.v1.IListArtifactsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListArtifactsRequest, protos.google.cloud.aiplatform.v1.IListArtifactsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IArtifact>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IListArtifactsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.aiplatform.v1.IListArtifactsRequest, protos.google.cloud.aiplatform.v1.IListArtifactsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IArtifact>
Returns
TypeDescription
void

listArtifacts(request, callback)

listArtifacts(request: protos.google.cloud.aiplatform.v1.IListArtifactsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListArtifactsRequest, protos.google.cloud.aiplatform.v1.IListArtifactsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IArtifact>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IListArtifactsRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1.IListArtifactsRequest, protos.google.cloud.aiplatform.v1.IListArtifactsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IArtifact>
Returns
TypeDescription
void

listArtifactsAsync(request, options)

listArtifactsAsync(request?: protos.google.cloud.aiplatform.v1.IListArtifactsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IArtifact>;

Equivalent to listArtifacts, 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.IListArtifactsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{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 [Artifact]. 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 MetadataStore whose Artifacts should be listed.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of Artifacts to return. The service may return fewer.
   *  Must be in range 1-1000, inclusive. Defaults to 100.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous MetadataService.ListArtifacts google.cloud.aiplatform.v1.MetadataService.ListArtifacts 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other provided parameters must match the call that
   *  provided the page token. (Otherwise the request will fail with
   *  INVALID_ARGUMENT error.)
   */
  // const pageToken = 'abc123'
  /**
   *  Filter specifying the boolean condition for the Artifacts to satisfy in
   *  order to be part of the result set.
   *  The syntax to define filter query is based on https://google.aip.dev/160.
   *  The supported set of filters include the following:
   *  *   **Attribute filtering**:
   *      For example: `display_name = "test"`.
   *      Supported fields include: `name`, `display_name`, `uri`, `state`,
   *      `schema_title`, `create_time`, and `update_time`.
   *      Time fields, such as `create_time` and `update_time`, require values
   *      specified in RFC-3339 format.
   *      For example: `create_time = "2020-11-19T11:30:00-04:00"`
   *  *   **Metadata field**:
   *      To filter on metadata fields use traversal operation as follows:
   *      `metadata.

listArtifactsStream(request, options)

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

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

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

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 [Artifact] 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 listArtifactsAsync() 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.

listContexts(request, options)

listContexts(request?: protos.google.cloud.aiplatform.v1.IListContextsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IContext[],
        protos.google.cloud.aiplatform.v1.IListContextsRequest | null,
        protos.google.cloud.aiplatform.v1.IListContextsResponse
    ]>;

Lists Contexts on the MetadataStore.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IContext[], protos.google.cloud.aiplatform.v1.IListContextsRequest | null, protos.google.cloud.aiplatform.v1.IListContextsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Context]. 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 listContextsAsync() 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.

listContexts(request, options, callback)

listContexts(request: protos.google.cloud.aiplatform.v1.IListContextsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListContextsRequest, protos.google.cloud.aiplatform.v1.IListContextsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IContext>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IListContextsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.aiplatform.v1.IListContextsRequest, protos.google.cloud.aiplatform.v1.IListContextsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IContext>
Returns
TypeDescription
void

listContexts(request, callback)

listContexts(request: protos.google.cloud.aiplatform.v1.IListContextsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListContextsRequest, protos.google.cloud.aiplatform.v1.IListContextsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IContext>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IListContextsRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1.IListContextsRequest, protos.google.cloud.aiplatform.v1.IListContextsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IContext>
Returns
TypeDescription
void

listContextsAsync(request, options)

listContextsAsync(request?: protos.google.cloud.aiplatform.v1.IListContextsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IContext>;

Equivalent to listContexts, 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.IListContextsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{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 [Context]. 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 MetadataStore whose Contexts should be listed.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of Contexts to return. The service may return fewer.
   *  Must be in range 1-1000, inclusive. Defaults to 100.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous MetadataService.ListContexts google.cloud.aiplatform.v1.MetadataService.ListContexts 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other provided parameters must match the call that
   *  provided the page token. (Otherwise the request will fail with
   *  INVALID_ARGUMENT error.)
   */
  // const pageToken = 'abc123'
  /**
   *  Filter specifying the boolean condition for the Contexts to satisfy in
   *  order to be part of the result set.
   *  The syntax to define filter query is based on https://google.aip.dev/160.
   *  Following are the supported set of filters:
   *  *  **Attribute filtering**:
   *     For example: `display_name = "test"`.
   *     Supported fields include: `name`, `display_name`, `schema_title`,
   *     `create_time`, and `update_time`.
   *     Time fields, such as `create_time` and `update_time`, require values
   *     specified in RFC-3339 format.
   *     For example: `create_time = "2020-11-19T11:30:00-04:00"`.
   *  *  **Metadata field**:
   *     To filter on metadata fields use traversal operation as follows:
   *     `metadata.

listContextsStream(request, options)

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

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

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

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 [Context] 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 listContextsAsync() 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.

listExecutions(request, options)

listExecutions(request?: protos.google.cloud.aiplatform.v1.IListExecutionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IExecution[],
        protos.google.cloud.aiplatform.v1.IListExecutionsRequest | null,
        protos.google.cloud.aiplatform.v1.IListExecutionsResponse
    ]>;

Lists Executions in the MetadataStore.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IExecution[], protos.google.cloud.aiplatform.v1.IListExecutionsRequest | null, protos.google.cloud.aiplatform.v1.IListExecutionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Execution]. 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 listExecutionsAsync() 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.

listExecutions(request, options, callback)

listExecutions(request: protos.google.cloud.aiplatform.v1.IListExecutionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListExecutionsRequest, protos.google.cloud.aiplatform.v1.IListExecutionsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IExecution>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IListExecutionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.aiplatform.v1.IListExecutionsRequest, protos.google.cloud.aiplatform.v1.IListExecutionsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IExecution>
Returns
TypeDescription
void

listExecutions(request, callback)

listExecutions(request: protos.google.cloud.aiplatform.v1.IListExecutionsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListExecutionsRequest, protos.google.cloud.aiplatform.v1.IListExecutionsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IExecution>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IListExecutionsRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1.IListExecutionsRequest, protos.google.cloud.aiplatform.v1.IListExecutionsResponse | null | undefined, protos.google.cloud.aiplatform.v1.IExecution>
Returns
TypeDescription
void

listExecutionsAsync(request, options)

listExecutionsAsync(request?: protos.google.cloud.aiplatform.v1.IListExecutionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IExecution>;

Equivalent to listExecutions, 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.IListExecutionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{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 [Execution]. 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 MetadataStore whose Executions should be listed.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of Executions to return. The service may return fewer.
   *  Must be in range 1-1000, inclusive. Defaults to 100.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous MetadataService.ListExecutions google.cloud.aiplatform.v1.MetadataService.ListExecutions 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other provided parameters must match the call that
   *  provided the page token. (Otherwise the request will fail with an
   *  INVALID_ARGUMENT error.)
   */
  // const pageToken = 'abc123'
  /**
   *  Filter specifying the boolean condition for the Executions to satisfy in
   *  order to be part of the result set.
   *  The syntax to define filter query is based on https://google.aip.dev/160.
   *  Following are the supported set of filters:
   *  *  **Attribute filtering**:
   *     For example: `display_name = "test"`.
   *     Supported fields include: `name`, `display_name`, `state`,
   *     `schema_title`, `create_time`, and `update_time`.
   *     Time fields, such as `create_time` and `update_time`, require values
   *     specified in RFC-3339 format.
   *     For example: `create_time = "2020-11-19T11:30:00-04:00"`.
   *  *  **Metadata field**:
   *     To filter on metadata fields use traversal operation as follows:
   *     `metadata.

listExecutionsStream(request, options)

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

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

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

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 [Execution] 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 listExecutionsAsync() 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.

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
}

listMetadataSchemas(request, options)

listMetadataSchemas(request?: protos.google.cloud.aiplatform.v1.IListMetadataSchemasRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IMetadataSchema[],
        protos.google.cloud.aiplatform.v1.IListMetadataSchemasRequest | null,
        protos.google.cloud.aiplatform.v1.IListMetadataSchemasResponse
    ]>;

Lists MetadataSchemas.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IMetadataSchema[], protos.google.cloud.aiplatform.v1.IListMetadataSchemasRequest | null, protos.google.cloud.aiplatform.v1.IListMetadataSchemasResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [MetadataSchema]. 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 listMetadataSchemasAsync() 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.

listMetadataSchemas(request, options, callback)

listMetadataSchemas(request: protos.google.cloud.aiplatform.v1.IListMetadataSchemasRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListMetadataSchemasRequest, protos.google.cloud.aiplatform.v1.IListMetadataSchemasResponse | null | undefined, protos.google.cloud.aiplatform.v1.IMetadataSchema>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IListMetadataSchemasRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.aiplatform.v1.IListMetadataSchemasRequest, protos.google.cloud.aiplatform.v1.IListMetadataSchemasResponse | null | undefined, protos.google.cloud.aiplatform.v1.IMetadataSchema>
Returns
TypeDescription
void

listMetadataSchemas(request, callback)

listMetadataSchemas(request: protos.google.cloud.aiplatform.v1.IListMetadataSchemasRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListMetadataSchemasRequest, protos.google.cloud.aiplatform.v1.IListMetadataSchemasResponse | null | undefined, protos.google.cloud.aiplatform.v1.IMetadataSchema>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IListMetadataSchemasRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1.IListMetadataSchemasRequest, protos.google.cloud.aiplatform.v1.IListMetadataSchemasResponse | null | undefined, protos.google.cloud.aiplatform.v1.IMetadataSchema>
Returns
TypeDescription
void

listMetadataSchemasAsync(request, options)

listMetadataSchemasAsync(request?: protos.google.cloud.aiplatform.v1.IListMetadataSchemasRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IMetadataSchema>;

Equivalent to listMetadataSchemas, 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.IListMetadataSchemasRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{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 [MetadataSchema]. 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 MetadataStore whose MetadataSchemas should be listed.
   *  Format:
   *  `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of MetadataSchemas to return. The service may return
   *  fewer.
   *  Must be in range 1-1000, inclusive. Defaults to 100.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous
   *  MetadataService.ListMetadataSchemas google.cloud.aiplatform.v1.MetadataService.ListMetadataSchemas  call. Provide this to retrieve the
   *  next page.
   *  When paginating, all other provided parameters must match the call that
   *  provided the page token. (Otherwise the request will fail with
   *  INVALID_ARGUMENT error.)
   */
  // const pageToken = 'abc123'
  /**
   *  A query to filter available MetadataSchemas for matching results.
   */
  // const filter = 'abc123'

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

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

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

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

  callListMetadataSchemas();

listMetadataSchemasStream(request, options)

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

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

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

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 [MetadataSchema] 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 listMetadataSchemasAsync() 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.

listMetadataStores(request, options)

listMetadataStores(request?: protos.google.cloud.aiplatform.v1.IListMetadataStoresRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1.IMetadataStore[],
        protos.google.cloud.aiplatform.v1.IListMetadataStoresRequest | null,
        protos.google.cloud.aiplatform.v1.IListMetadataStoresResponse
    ]>;

Lists MetadataStores for a Location.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.aiplatform.v1.IMetadataStore[], protos.google.cloud.aiplatform.v1.IListMetadataStoresRequest | null, protos.google.cloud.aiplatform.v1.IListMetadataStoresResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [MetadataStore]. 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 listMetadataStoresAsync() 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.

listMetadataStores(request, options, callback)

listMetadataStores(request: protos.google.cloud.aiplatform.v1.IListMetadataStoresRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListMetadataStoresRequest, protos.google.cloud.aiplatform.v1.IListMetadataStoresResponse | null | undefined, protos.google.cloud.aiplatform.v1.IMetadataStore>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IListMetadataStoresRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.aiplatform.v1.IListMetadataStoresRequest, protos.google.cloud.aiplatform.v1.IListMetadataStoresResponse | null | undefined, protos.google.cloud.aiplatform.v1.IMetadataStore>
Returns
TypeDescription
void

listMetadataStores(request, callback)

listMetadataStores(request: protos.google.cloud.aiplatform.v1.IListMetadataStoresRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1.IListMetadataStoresRequest, protos.google.cloud.aiplatform.v1.IListMetadataStoresResponse | null | undefined, protos.google.cloud.aiplatform.v1.IMetadataStore>): void;
Parameters
NameDescription
request protos.google.cloud.aiplatform.v1.IListMetadataStoresRequest
callback PaginationCallback<protos.google.cloud.aiplatform.v1.IListMetadataStoresRequest, protos.google.cloud.aiplatform.v1.IListMetadataStoresResponse | null | undefined, protos.google.cloud.aiplatform.v1.IMetadataStore>
Returns
TypeDescription
void

listMetadataStoresAsync(request, options)

listMetadataStoresAsync(request?: protos.google.cloud.aiplatform.v1.IListMetadataStoresRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1.IMetadataStore>;

Equivalent to listMetadataStores, 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.IListMetadataStoresRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{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 [MetadataStore]. 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 Location whose MetadataStores should be listed.
   *  Format:
   *  `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of Metadata Stores to return. The service may return
   *  fewer.
   *  Must be in range 1-1000, inclusive. Defaults to 100.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous
   *  MetadataService.ListMetadataStores google.cloud.aiplatform.v1.MetadataService.ListMetadataStores  call. Provide this to retrieve the
   *  subsequent page.
   *  When paginating, all other provided parameters must match the call that
   *  provided the page token. (Otherwise the request will fail with
   *  INVALID_ARGUMENT error.)
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListMetadataStores();

listMetadataStoresStream(request, options)

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

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

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

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 [MetadataStore] 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 listMetadataStoresAsync() 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.

matchEvaluati