MetadataServiceClient

Service for reading and writing metadata entries.

Constructor

new MetadataServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of MetadataServiceClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

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: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

annotationPath(project, location, dataset, data_item, annotation) → {string}

Return a fully-qualified annotation resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`dataset`	string
`data_item`	string
`annotation`	string

Returns:

Type	Description
string	Resource name string.

annotationSpecPath(project, location, dataset, annotation_spec) → {string}

Return a fully-qualified annotationSpec resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`dataset`	string
`annotation_spec`	string

Returns:

Type	Description
string	Resource name string.

artifactPath(project, location, metadata_store, artifact) → {string}

Return a fully-qualified artifact resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`metadata_store`	string
`artifact`	string

Returns:

Type	Description
string	Resource name string.

batchPredictionJobPath(project, location, batch_prediction_job) → {string}

Return a fully-qualified batchPredictionJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`batch_prediction_job`	string

Returns:

Type	Description
string	Resource name string.

cachedContentPath(project, location, cached_content) → {string}

Return a fully-qualified cachedContent resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`cached_content`	string

Returns:

Type	Description
string	Resource name string.

cancelOperation(request, optionsopt, callbackopt) → {Promise}

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 Operations.GetOperation 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 Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be cancelled.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

(async) checkCreateMetadataStoreProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Location 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();

(async) checkDeleteArtifactProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the 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();

(async) checkDeleteContextProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the 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();

(async) checkDeleteExecutionProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the 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();

(async) checkDeleteMetadataStoreProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the 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();

(async) checkPurgeArtifactsProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The 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();

(async) checkPurgeContextsProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The 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();

(async) checkPurgeExecutionsProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The 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() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:

Type	Description
Promise	A promise that resolves when the client is closed.

contextPath(project, location, metadata_store, context) → {string}

Return a fully-qualified context resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`metadata_store`	string
`context`	string

Returns:

Type	Description
string	Resource name string.

customJobPath(project, location, custom_job) → {string}

Return a fully-qualified customJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`custom_job`	string

Returns:

Type	Description
string	Resource name string.

dataItemPath(project, location, dataset, data_item) → {string}

Return a fully-qualified dataItem resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`dataset`	string
`data_item`	string

Returns:

Type	Description
string	Resource name string.

dataLabelingJobPath(project, location, data_labeling_job) → {string}

Return a fully-qualified dataLabelingJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`data_labeling_job`	string

Returns:

Type	Description
string	Resource name string.

datasetPath(project, location, dataset) → {string}

Return a fully-qualified dataset resource name string.

Parameters:

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

Returns:

Type	Description
string	Resource name string.

datasetVersionPath(project, location, dataset, dataset_version) → {string}

Return a fully-qualified datasetVersion resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`dataset`	string
`dataset_version`	string

Returns:

Type	Description
string	Resource name string.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be deleted.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

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

deploymentResourcePoolPath(project, location, deployment_resource_pool) → {string}

Return a fully-qualified deploymentResourcePool resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`deployment_resource_pool`	string

Returns:

Type	Description
string	Resource name string.

entityTypePath(project, location, featurestore, entity_type) → {string}

Return a fully-qualified entityType resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`featurestore`	string
`entity_type`	string

Returns:

Type	Description
string	Resource name string.

executionPath(project, location, metadata_store, execution) → {string}

Return a fully-qualified execution resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`metadata_store`	string
`execution`	string

Returns:

Type	Description
string	Resource name string.

featureGroupPath(project, location, feature_group) → {string}

Return a fully-qualified featureGroup resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`feature_group`	string

Returns:

Type	Description
string	Resource name string.

featureOnlineStorePath(project, location, feature_online_store) → {string}

Return a fully-qualified featureOnlineStore resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`feature_online_store`	string

Returns:

Type	Description
string	Resource name string.

featureViewPath(project, location, feature_online_store, feature_view) → {string}

Return a fully-qualified featureView resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`feature_online_store`	string
`feature_view`	string

Returns:

Type	Description
string	Resource name string.

featureViewSyncPath(project, location, feature_online_store, feature_view) → {string}

Return a fully-qualified featureViewSync resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`feature_online_store`	string
`feature_view`	string

Returns:

Type	Description
string	Resource name string.

featurestorePath(project, location, featurestore) → {string}

Return a fully-qualified featurestore resource name string.

Parameters:

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

Returns:

Type	Description
string	Resource name string.

getIamPolicy(request, optionsopt, callbackopt) → {Promise}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Attributes Description

resource

string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

options

Object

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.

This object should have the same structure as GetPolicyOptions.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

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:

Type	Description
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, optionsopt) → {Promise}

Gets information about a location.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	Resource name for the location.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.

Example

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

getOperation(request, optionsopt, callbackopt) → {Promise}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

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.

Returns:

Type	Description
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.

Example

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

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

hyperparameterTuningJobPath(project, location, hyperparameter_tuning_job) → {string}

Return a fully-qualified hyperparameterTuningJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`hyperparameter_tuning_job`	string

Returns:

Type	Description
string	Resource name string.

indexEndpointPath(project, location, index_endpoint) → {string}

Return a fully-qualified indexEndpoint resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`index_endpoint`	string

Returns:

Type	Description
string	Resource name string.

indexPath(project, location, index) → {string}

Return a fully-qualified index resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`index`	string

Returns:

Type	Description
string	Resource name string.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:

Type	Description
Promise	A promise that resolves to an authenticated service stub.

listArtifactsAsync(request, optionsopt) → {Object}

Equivalent to listArtifacts, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`pageSize`	number	The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
`pageToken`	string	A page token, received from a previous 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.)
`filter`	string	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.<field_name>.<type_value>`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Context based filtering: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context(<context-name>)`. For example: `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
`orderBy`	string	How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. 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 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.<field_name>.<type_value>`.
   *      For example: `metadata.field_1.number_value = 10.0`
   *      In case the field name contains special characters (such as colon), one
   *      can embed it inside double quote.
   *      For example: `metadata."field:1".number_value = 10.0`
   *  *   **Context based filtering**:
   *      To filter Artifacts based on the contexts to which they belong, use the
   *      function operator with the full resource name
   *      `in_context(<context-name>)`.
   *      For example:
   *      `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`
   *  Each of the above supported filter types can be combined together using
   *  logical operators (`AND` & `OR`). Maximum nested expression depth allowed
   *  is 5.
   *  For example: `display_name = "test" AND metadata.field1.bool_value = true`.
   */
  // const filter = 'abc123'
  /**
   *  How the list of messages is ordered. Specify the values to order by and an
   *  ordering operation. The default sorting order is ascending. To specify
   *  descending order for a field, users append a " desc" suffix; for example:
   *  "foo desc, bar".
   *  Subfields are specified with a `.` character, such as foo.bar.
   *  see https://google.aip.dev/132#ordering for more details.
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListArtifacts();

listArtifactsStream(request, optionsopt) → {Stream}

Equivalent to listArtifacts, but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`pageSize`	number	The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
`pageToken`	string	A page token, received from a previous 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.)
`filter`	string	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.<field_name>.<type_value>`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Context based filtering: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context(<context-name>)`. For example: `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
`orderBy`	string	How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

options

object

Call options. See CallOptions for more details.

Returns:

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

listContextsAsync(request, optionsopt) → {Object}

Equivalent to listContexts, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`pageSize`	number	The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
`pageToken`	string	A page token, received from a previous 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.)
`filter`	string	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.<field_name>.<type_value>`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Parent Child filtering: To filter Contexts based on parent-child relationship use the HAS operator as follows: `parent_contexts: "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>" child_contexts: "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
`orderBy`	string	How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. 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 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.<field_name>.<type_value>`.
   *     For example: `metadata.field_1.number_value = 10.0`.
   *     In case the field name contains special characters (such as colon), one
   *     can embed it inside double quote.
   *     For example: `metadata."field:1".number_value = 10.0`
   *  *  **Parent Child filtering**:
   *     To filter Contexts based on parent-child relationship use the HAS
   *     operator as follows:
   *     ```
   *     parent_contexts:
   *     "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
   *     child_contexts:
   *     "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
   *     ```
   *  Each of the above supported filters can be combined together using
   *  logical operators (`AND` & `OR`). Maximum nested expression depth allowed
   *  is 5.
   *  For example: `display_name = "test" AND metadata.field1.bool_value = true`.
   */
  // const filter = 'abc123'
  /**
   *  How the list of messages is ordered. Specify the values to order by and an
   *  ordering operation. The default sorting order is ascending. To specify
   *  descending order for a field, users append a " desc" suffix; for example:
   *  "foo desc, bar".
   *  Subfields are specified with a `.` character, such as foo.bar.
   *  see https://google.aip.dev/132#ordering for more details.
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListContexts();

listContextsStream(request, optionsopt) → {Stream}

Equivalent to listContexts, but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`pageSize`	number	The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
`pageToken`	string	A page token, received from a previous 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.)
`filter`	string	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.<field_name>.<type_value>`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Parent Child filtering: To filter Contexts based on parent-child relationship use the HAS operator as follows: `parent_contexts: "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>" child_contexts: "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
`orderBy`	string	How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

options

object

Call options. See CallOptions for more details.

Returns:

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

listExecutionsAsync(request, optionsopt) → {Object}

Equivalent to listExecutions, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`pageSize`	number	The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
`pageToken`	string	A page token, received from a previous 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.)
`filter`	string	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.<field_name>.<type_value>` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Context based filtering: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context(<context-name>)`. For example: `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
`orderBy`	string	How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. 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 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.<field_name>.<type_value>`
   *     For example: `metadata.field_1.number_value = 10.0`
   *     In case the field name contains special characters (such as colon), one
   *     can embed it inside double quote.
   *     For example: `metadata."field:1".number_value = 10.0`
   *  *  **Context based filtering**:
   *     To filter Executions based on the contexts to which they belong use
   *     the function operator with the full resource name:
   *     `in_context(<context-name>)`.
   *     For example:
   *     `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")`
   *  Each of the above supported filters can be combined together using
   *  logical operators (`AND` & `OR`). Maximum nested expression depth allowed
   *  is 5.
   *  For example: `display_name = "test" AND metadata.field1.bool_value = true`.
   */
  // const filter = 'abc123'
  /**
   *  How the list of messages is ordered. Specify the values to order by and an
   *  ordering operation. The default sorting order is ascending. To specify
   *  descending order for a field, users append a " desc" suffix; for example:
   *  "foo desc, bar".
   *  Subfields are specified with a `.` character, such as foo.bar.
   *  see https://google.aip.dev/132#ordering for more details.
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListExecutions();

listExecutionsStream(request, optionsopt) → {Stream}

Equivalent to listExecutions, but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`pageSize`	number	The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
`pageToken`	string	A page token, received from a previous 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.)
`filter`	string	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.<field_name>.<type_value>` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Context based filtering: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context(<context-name>)`. For example: `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.
`orderBy`	string	How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

options

object

Call options. See CallOptions for more details.

Returns:

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

listLocationsAsync(request, optionsopt) → {Object}

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

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The resource that owns the locations collection, if applicable.
`filter`	string	The standard list filter.
`pageSize`	number	The standard list page size.
`pageToken`	string	The standard list page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. 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 for more details and examples.

Example

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

listMetadataSchemasAsync(request, optionsopt) → {Object}

Equivalent to listMetadataSchemas, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`pageSize`	number	The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
`pageToken`	string	A page token, received from a previous 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.)
`filter`	string	A query to filter available MetadataSchemas for matching results.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. 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 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 = aiplatformClient.listMetadataSchemasAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListMetadataSchemas();

listMetadataSchemasStream(request, optionsopt) → {Stream}

Equivalent to listMetadataSchemas, but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`pageSize`	number	The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
`pageToken`	string	A page token, received from a previous 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.)
`filter`	string	A query to filter available MetadataSchemas for matching results.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

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

listMetadataStoresAsync(request, optionsopt) → {Object}

Equivalent to listMetadataStores, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. The Location whose MetadataStores should be listed. Format: projects/{project}/locations/{location}

pageSize

number

The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.

pageToken

string

A page token, received from a previous 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.)

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. 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 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 = aiplatformClient.listMetadataStoresAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListMetadataStores();

listMetadataStoresStream(request, optionsopt) → {Stream}

Equivalent to listMetadataStores, but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. The Location whose MetadataStores should be listed. Format: projects/{project}/locations/{location}

pageSize

number

The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.

pageToken

string

A page token, received from a previous 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.)

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

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

listOperationsAsync(request, optionsopt) → {Object}

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

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`name`	string		The name of the operation collection.
`filter`	string		The standard list filter.
`pageSize`	number	<optional>	The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns:

Type	Description
Object	An iterable Object that conforms to iteration protocols.

Example

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

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

Returns:

Type	Description
string	Resource name string.

matchAnnotationFromAnnotationName(annotationName) → {string}

Parse the annotation from Annotation resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the annotation.

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName) → {string}

Parse the annotation_spec from AnnotationSpec resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the annotation_spec.

matchArtifactFromArtifactName(artifactName) → {string}

Parse the artifact from Artifact resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the artifact.

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName) → {string}

Parse the batch_prediction_job from BatchPredictionJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the batch_prediction_job.

matchCachedContentFromCachedContentName(cachedContentName) → {string}

Parse the cached_content from CachedContent resource.

Parameters:

Name	Type	Description
`cachedContentName`	string	A fully-qualified path representing CachedContent resource.

Returns:

Type	Description
string	A string representing the cached_content.

matchContextFromContextName(contextName) → {string}

Parse the context from Context resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the context.

matchCustomJobFromCustomJobName(customJobName) → {string}

Parse the custom_job from CustomJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the custom_job.

matchDataItemFromAnnotationName(annotationName) → {string}

Parse the data_item from Annotation resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the data_item.

matchDataItemFromDataItemName(dataItemName) → {string}

Parse the data_item from DataItem resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the data_item.

matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName) → {string}

Parse the data_labeling_job from DataLabelingJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the data_labeling_job.

matchDatasetFromAnnotationName(annotationName) → {string}

Parse the dataset from Annotation resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the dataset.

matchDatasetFromAnnotationSpecName(annotationSpecName) → {string}

Parse the dataset from AnnotationSpec resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the dataset.

matchDatasetFromDataItemName(dataItemName) → {string}

Parse the dataset from DataItem resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the dataset.

matchDatasetFromDatasetName(datasetName) → {string}

Parse the dataset from Dataset resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the dataset.

matchDatasetFromDatasetVersionName(datasetVersionName) → {string}

Parse the dataset from DatasetVersion resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the dataset.

matchDatasetFromSavedQueryName(savedQueryName) → {string}

Parse the dataset from SavedQuery resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the dataset.

matchDatasetVersionFromDatasetVersionName(datasetVersionName) → {string}

Parse the dataset_version from DatasetVersion resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the dataset_version.

matchDeploymentResourcePoolFromDeploymentResourcePoolName(deploymentResourcePoolName) → {string}

Parse the deployment_resource_pool from DeploymentResourcePool resource.

Parameters:

Name	Type	Description
`deploymentResourcePoolName`	string	A fully-qualified path representing DeploymentResourcePool resource.

Returns:

Type	Description
string	A string representing the deployment_resource_pool.

matchEndpointFromProjectLocationEndpointName(projectLocationEndpointName) → {string}

Parse the endpoint from ProjectLocationEndpoint resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the endpoint.

matchEntityTypeFromEntityTypeName(entityTypeName) → {string}

Parse the entity_type from EntityType resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the entity_type.

matchEntityTypeFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName) → {string}

Parse the entity_type from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameters:

Name	Type	Description
`projectLocationFeaturestoreEntityTypeFeaturesName`	string	A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns:

Type	Description
string	A string representing the entity_type.

matchEvaluationFromModelEvaluationName(modelEvaluationName) → {string}

Parse the evaluation from ModelEvaluation resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the evaluation.

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName) → {string}

Parse the evaluation from ModelEvaluationSlice resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the evaluation.

matchEventFromSessionEventName(sessionEventName) → {string}

Parse the event from SessionEvent resource.

Parameters:

Name	Type	Description
`sessionEventName`	string	A fully-qualified path representing SessionEvent resource.

Returns:

Type	Description
string	A string representing the event.

matchExecutionFromExecutionName(executionName) → {string}

Parse the execution from Execution resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the execution.

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName) → {string}

Parse the experiment from TensorboardExperiment resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the experiment.

matchExperimentFromTensorboardRunName(tensorboardRunName) → {string}

Parse the experiment from TensorboardRun resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the experiment.

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName) → {string}

Parse the experiment from TensorboardTimeSeries resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the experiment.

matchFeatureFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName) → {string}

Parse the feature from ProjectLocationFeatureGroupFeatures resource.

Parameters:

Name	Type	Description
`projectLocationFeatureGroupFeaturesName`	string	A fully-qualified path representing project_location_feature_group_features resource.

Returns:

Type	Description
string	A string representing the feature.

matchFeatureFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName) → {string}

Parse the feature from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameters:

Name	Type	Description
`projectLocationFeaturestoreEntityTypeFeaturesName`	string	A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns:

Type	Description
string	A string representing the feature.

matchFeatureGroupFromFeatureGroupName(featureGroupName) → {string}

Parse the feature_group from FeatureGroup resource.

Parameters:

Name	Type	Description
`featureGroupName`	string	A fully-qualified path representing FeatureGroup resource.

Returns:

Type	Description
string	A string representing the feature_group.

matchFeatureGroupFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName) → {string}

Parse the feature_group from ProjectLocationFeatureGroupFeatures resource.

Parameters:

Name	Type	Description
`projectLocationFeatureGroupFeaturesName`	string	A fully-qualified path representing project_location_feature_group_features resource.

Returns:

Type	Description
string	A string representing the feature_group.

matchFeatureOnlineStoreFromFeatureOnlineStoreName(featureOnlineStoreName) → {string}

Parse the feature_online_store from FeatureOnlineStore resource.

Parameters:

Name	Type	Description
`featureOnlineStoreName`	string	A fully-qualified path representing FeatureOnlineStore resource.

Returns:

Type	Description
string	A string representing the feature_online_store.

matchFeatureOnlineStoreFromFeatureViewName(featureViewName) → {string}

Parse the feature_online_store from FeatureView resource.

Parameters:

Name	Type	Description
`featureViewName`	string	A fully-qualified path representing FeatureView resource.

Returns:

Type	Description
string	A string representing the feature_online_store.

matchFeatureOnlineStoreFromFeatureViewSyncName(featureViewSyncName) → {string}

Parse the feature_online_store from FeatureViewSync resource.

Parameters:

Name	Type	Description
`featureViewSyncName`	string	A fully-qualified path representing FeatureViewSync resource.

Returns:

Type	Description
string	A string representing the feature_online_store.

matchFeatureViewFromFeatureViewName(featureViewName) → {string}

Parse the feature_view from FeatureView resource.

Parameters:

Name	Type	Description
`featureViewName`	string	A fully-qualified path representing FeatureView resource.

Returns:

Type	Description
string	A string representing the feature_view.

matchFeatureViewFromFeatureViewSyncName(featureViewSyncName) → {string}

Parse the feature_view from FeatureViewSync resource.

Parameters:

Name	Type	Description
`featureViewSyncName`	string	A fully-qualified path representing FeatureViewSync resource.

Returns:

Type	Description
string	A string representing the feature_view.

matchFeaturestoreFromEntityTypeName(entityTypeName) → {string}

Parse the featurestore from EntityType resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the featurestore.

matchFeaturestoreFromFeaturestoreName(featurestoreName) → {string}

Parse the featurestore from Featurestore resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the featurestore.

matchFeaturestoreFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName) → {string}

Parse the featurestore from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameters:

Name	Type	Description
`projectLocationFeaturestoreEntityTypeFeaturesName`	string	A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns:

Type	Description
string	A string representing the featurestore.

matchHyperparameterTuningJobFromHyperparameterTuningJobName(hyperparameterTuningJobName) → {string}

Parse the hyperparameter_tuning_job from HyperparameterTuningJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the hyperparameter_tuning_job.

matchIndexEndpointFromIndexEndpointName(indexEndpointName) → {string}

Parse the index_endpoint from IndexEndpoint resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the index_endpoint.

matchIndexFromIndexName(indexName) → {string}

Parse the index from Index resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the index.

matchLocationFromAnnotationName(annotationName) → {string}

Parse the location from Annotation resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromAnnotationSpecName(annotationSpecName) → {string}

Parse the location from AnnotationSpec resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromArtifactName(artifactName) → {string}

Parse the location from Artifact resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromBatchPredictionJobName(batchPredictionJobName) → {string}

Parse the location from BatchPredictionJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromCachedContentName(cachedContentName) → {string}

Parse the location from CachedContent resource.

Parameters:

Name	Type	Description
`cachedContentName`	string	A fully-qualified path representing CachedContent resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromContextName(contextName) → {string}

Parse the location from Context resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromCustomJobName(customJobName) → {string}

Parse the location from CustomJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromDataItemName(dataItemName) → {string}

Parse the location from DataItem resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromDataLabelingJobName(dataLabelingJobName) → {string}

Parse the location from DataLabelingJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromDatasetName(datasetName) → {string}

Parse the location from Dataset resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromDatasetVersionName(datasetVersionName) → {string}

Parse the location from DatasetVersion resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromDeploymentResourcePoolName(deploymentResourcePoolName) → {string}

Parse the location from DeploymentResourcePool resource.

Parameters:

Name	Type	Description
`deploymentResourcePoolName`	string	A fully-qualified path representing DeploymentResourcePool resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromEntityTypeName(entityTypeName) → {string}

Parse the location from EntityType resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromExecutionName(executionName) → {string}

Parse the location from Execution resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromFeatureGroupName(featureGroupName) → {string}

Parse the location from FeatureGroup resource.

Parameters:

Name	Type	Description
`featureGroupName`	string	A fully-qualified path representing FeatureGroup resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromFeatureOnlineStoreName(featureOnlineStoreName) → {string}

Parse the location from FeatureOnlineStore resource.

Parameters:

Name	Type	Description
`featureOnlineStoreName`	string	A fully-qualified path representing FeatureOnlineStore resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromFeatureViewName(featureViewName) → {string}

Parse the location from FeatureView resource.

Parameters:

Name	Type	Description
`featureViewName`	string	A fully-qualified path representing FeatureView resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromFeatureViewSyncName(featureViewSyncName) → {string}

Parse the location from FeatureViewSync resource.

Parameters:

Name	Type	Description
`featureViewSyncName`	string	A fully-qualified path representing FeatureViewSync resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromFeaturestoreName(featurestoreName) → {string}

Parse the location from Featurestore resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromHyperparameterTuningJobName(hyperparameterTuningJobName) → {string}

Parse the location from HyperparameterTuningJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromIndexEndpointName(indexEndpointName) → {string}

Parse the location from IndexEndpoint resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromIndexName(indexName) → {string}

Parse the location from Index resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromMetadataSchemaName(metadataSchemaName) → {string}

Parse the location from MetadataSchema resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromMetadataStoreName(metadataStoreName) → {string}

Parse the location from MetadataStore resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName) → {string}

Parse the location from ModelDeploymentMonitoringJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromModelEvaluationName(modelEvaluationName) → {string}

Parse the location from ModelEvaluation resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromModelEvaluationSliceName(modelEvaluationSliceName) → {string}

Parse the location from ModelEvaluationSlice resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromModelName(modelName) → {string}

Parse the location from Model resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromNasJobName(nasJobName) → {string}

Parse the location from NasJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromNasTrialDetailName(nasTrialDetailName) → {string}

Parse the location from NasTrialDetail resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromNotebookExecutionJobName(notebookExecutionJobName) → {string}

Parse the location from NotebookExecutionJob resource.

Parameters:

Name	Type	Description
`notebookExecutionJobName`	string	A fully-qualified path representing NotebookExecutionJob resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromNotebookRuntimeName(notebookRuntimeName) → {string}

Parse the location from NotebookRuntime resource.

Parameters:

Name	Type	Description
`notebookRuntimeName`	string	A fully-qualified path representing NotebookRuntime resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName) → {string}

Parse the location from NotebookRuntimeTemplate resource.

Parameters:

Name	Type	Description
`notebookRuntimeTemplateName`	string	A fully-qualified path representing NotebookRuntimeTemplate resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromPersistentResourceName(persistentResourceName) → {string}

Parse the location from PersistentResource resource.

Parameters:

Name	Type	Description
`persistentResourceName`	string	A fully-qualified path representing PersistentResource resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromPipelineJobName(pipelineJobName) → {string}

Parse the location from PipelineJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationEndpointName(projectLocationEndpointName) → {string}

Parse the location from ProjectLocationEndpoint resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName) → {string}

Parse the location from ProjectLocationFeatureGroupFeatures resource.

Parameters:

Name	Type	Description
`projectLocationFeatureGroupFeaturesName`	string	A fully-qualified path representing project_location_feature_group_features resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName) → {string}

Parse the location from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameters:

Name	Type	Description
`projectLocationFeaturestoreEntityTypeFeaturesName`	string	A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationPublisherModelName(projectLocationPublisherModelName) → {string}

Parse the location from ProjectLocationPublisherModel resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromRagCorpusName(ragCorpusName) → {string}

Parse the location from RagCorpus resource.

Parameters:

Name	Type	Description
`ragCorpusName`	string	A fully-qualified path representing RagCorpus resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromRagEngineConfigName(ragEngineConfigName) → {string}

Parse the location from RagEngineConfig resource.

Parameters:

Name	Type	Description
`ragEngineConfigName`	string	A fully-qualified path representing RagEngineConfig resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromRagFileName(ragFileName) → {string}

Parse the location from RagFile resource.

Parameters:

Name	Type	Description
`ragFileName`	string	A fully-qualified path representing RagFile resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromReasoningEngineName(reasoningEngineName) → {string}

Parse the location from ReasoningEngine resource.

Parameters:

Name	Type	Description
`reasoningEngineName`	string	A fully-qualified path representing ReasoningEngine resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromSavedQueryName(savedQueryName) → {string}

Parse the location from SavedQuery resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromScheduleName(scheduleName) → {string}

Parse the location from Schedule resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromSessionEventName(sessionEventName) → {string}

Parse the location from SessionEvent resource.

Parameters:

Name	Type	Description
`sessionEventName`	string	A fully-qualified path representing SessionEvent resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromSessionName(sessionName) → {string}

Parse the location from Session resource.

Parameters:

Name	Type	Description
`sessionName`	string	A fully-qualified path representing Session resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromSpecialistPoolName(specialistPoolName) → {string}

Parse the location from SpecialistPool resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromStudyName(studyName) → {string}

Parse the location from Study resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromTensorboardExperimentName(tensorboardExperimentName) → {string}

Parse the location from TensorboardExperiment resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromTensorboardName(tensorboardName) → {string}

Parse the location from Tensorboard resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromTensorboardRunName(tensorboardRunName) → {string}

Parse the location from TensorboardRun resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromTensorboardTimeSeriesName(tensorboardTimeSeriesName) → {string}

Parse the location from TensorboardTimeSeries resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromTrainingPipelineName(trainingPipelineName) → {string}

Parse the location from TrainingPipeline resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromTrialName(trialName) → {string}

Parse the location from Trial resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the location.

matchLocationFromTuningJobName(tuningJobName) → {string}

Parse the location from TuningJob resource.

Parameters:

Name	Type	Description
`tuningJobName`	string	A fully-qualified path representing TuningJob resource.

Returns:

Type	Description
string	A string representing the location.

matchMetadataSchemaFromMetadataSchemaName(metadataSchemaName) → {string}

Parse the metadata_schema from MetadataSchema resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the metadata_schema.

matchMetadataStoreFromArtifactName(artifactName) → {string}

Parse the metadata_store from Artifact resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the metadata_store.

matchMetadataStoreFromContextName(contextName) → {string}

Parse the metadata_store from Context resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the metadata_store.

matchMetadataStoreFromExecutionName(executionName) → {string}

Parse the metadata_store from Execution resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the metadata_store.

matchMetadataStoreFromMetadataSchemaName(metadataSchemaName) → {string}

Parse the metadata_store from MetadataSchema resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the metadata_store.

matchMetadataStoreFromMetadataStoreName(metadataStoreName) → {string}

Parse the metadata_store from MetadataStore resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the metadata_store.

matchModelDeploymentMonitoringJobFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName) → {string}

Parse the model_deployment_monitoring_job from ModelDeploymentMonitoringJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the model_deployment_monitoring_job.

matchModelFromModelEvaluationName(modelEvaluationName) → {string}

Parse the model from ModelEvaluation resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the model.

matchModelFromModelEvaluationSliceName(modelEvaluationSliceName) → {string}

Parse the model from ModelEvaluationSlice resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the model.

matchModelFromModelName(modelName) → {string}

Parse the model from Model resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the model.

matchModelFromProjectLocationPublisherModelName(projectLocationPublisherModelName) → {string}

Parse the model from ProjectLocationPublisherModel resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the model.

matchModelFromPublisherModelName(publisherModelName) → {string}

Parse the model from PublisherModel resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the model.

matchNasJobFromNasJobName(nasJobName) → {string}

Parse the nas_job from NasJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the nas_job.

matchNasJobFromNasTrialDetailName(nasTrialDetailName) → {string}

Parse the nas_job from NasTrialDetail resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the nas_job.

matchNasTrialDetailFromNasTrialDetailName(nasTrialDetailName) → {string}

Parse the nas_trial_detail from NasTrialDetail resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the nas_trial_detail.

matchNotebookExecutionJobFromNotebookExecutionJobName(notebookExecutionJobName) → {string}

Parse the notebook_execution_job from NotebookExecutionJob resource.

Parameters:

Name	Type	Description
`notebookExecutionJobName`	string	A fully-qualified path representing NotebookExecutionJob resource.

Returns:

Type	Description
string	A string representing the notebook_execution_job.

matchNotebookRuntimeFromNotebookRuntimeName(notebookRuntimeName) → {string}

Parse the notebook_runtime from NotebookRuntime resource.

Parameters:

Name	Type	Description
`notebookRuntimeName`	string	A fully-qualified path representing NotebookRuntime resource.

Returns:

Type	Description
string	A string representing the notebook_runtime.

matchNotebookRuntimeTemplateFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName) → {string}

Parse the notebook_runtime_template from NotebookRuntimeTemplate resource.

Parameters:

Name	Type	Description
`notebookRuntimeTemplateName`	string	A fully-qualified path representing NotebookRuntimeTemplate resource.

Returns:

Type	Description
string	A string representing the notebook_runtime_template.

matchPersistentResourceFromPersistentResourceName(persistentResourceName) → {string}

Parse the persistent_resource from PersistentResource resource.

Parameters:

Name	Type	Description
`persistentResourceName`	string	A fully-qualified path representing PersistentResource resource.

Returns:

Type	Description
string	A string representing the persistent_resource.

matchPipelineJobFromPipelineJobName(pipelineJobName) → {string}

Parse the pipeline_job from PipelineJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the pipeline_job.

matchProjectFromAnnotationName(annotationName) → {string}

Parse the project from Annotation resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromAnnotationSpecName(annotationSpecName) → {string}

Parse the project from AnnotationSpec resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromArtifactName(artifactName) → {string}

Parse the project from Artifact resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromBatchPredictionJobName(batchPredictionJobName) → {string}

Parse the project from BatchPredictionJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromCachedContentName(cachedContentName) → {string}

Parse the project from CachedContent resource.

Parameters:

Name	Type	Description
`cachedContentName`	string	A fully-qualified path representing CachedContent resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromContextName(contextName) → {string}

Parse the project from Context resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromCustomJobName(customJobName) → {string}

Parse the project from CustomJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromDataItemName(dataItemName) → {string}

Parse the project from DataItem resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromDataLabelingJobName(dataLabelingJobName) → {string}

Parse the project from DataLabelingJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromDatasetName(datasetName) → {string}

Parse the project from Dataset resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromDatasetVersionName(datasetVersionName) → {string}

Parse the project from DatasetVersion resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromDeploymentResourcePoolName(deploymentResourcePoolName) → {string}

Parse the project from DeploymentResourcePool resource.

Parameters:

Name	Type	Description
`deploymentResourcePoolName`	string	A fully-qualified path representing DeploymentResourcePool resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromEntityTypeName(entityTypeName) → {string}

Parse the project from EntityType resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromExecutionName(executionName) → {string}

Parse the project from Execution resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromFeatureGroupName(featureGroupName) → {string}

Parse the project from FeatureGroup resource.

Parameters:

Name	Type	Description
`featureGroupName`	string	A fully-qualified path representing FeatureGroup resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromFeatureOnlineStoreName(featureOnlineStoreName) → {string}

Parse the project from FeatureOnlineStore resource.

Parameters:

Name	Type	Description
`featureOnlineStoreName`	string	A fully-qualified path representing FeatureOnlineStore resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromFeatureViewName(featureViewName) → {string}

Parse the project from FeatureView resource.

Parameters:

Name	Type	Description
`featureViewName`	string	A fully-qualified path representing FeatureView resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromFeatureViewSyncName(featureViewSyncName) → {string}

Parse the project from FeatureViewSync resource.

Parameters:

Name	Type	Description
`featureViewSyncName`	string	A fully-qualified path representing FeatureViewSync resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromFeaturestoreName(featurestoreName) → {string}

Parse the project from Featurestore resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromHyperparameterTuningJobName(hyperparameterTuningJobName) → {string}

Parse the project from HyperparameterTuningJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromIndexEndpointName(indexEndpointName) → {string}

Parse the project from IndexEndpoint resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromIndexName(indexName) → {string}

Parse the project from Index resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromMetadataSchemaName(metadataSchemaName) → {string}

Parse the project from MetadataSchema resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromMetadataStoreName(metadataStoreName) → {string}

Parse the project from MetadataStore resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromModelDeploymentMonitoringJobName(modelDeploymentMonitoringJobName) → {string}

Parse the project from ModelDeploymentMonitoringJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromModelEvaluationName(modelEvaluationName) → {string}

Parse the project from ModelEvaluation resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromModelEvaluationSliceName(modelEvaluationSliceName) → {string}

Parse the project from ModelEvaluationSlice resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromModelName(modelName) → {string}

Parse the project from Model resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromNasJobName(nasJobName) → {string}

Parse the project from NasJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromNasTrialDetailName(nasTrialDetailName) → {string}

Parse the project from NasTrialDetail resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromNotebookExecutionJobName(notebookExecutionJobName) → {string}

Parse the project from NotebookExecutionJob resource.

Parameters:

Name	Type	Description
`notebookExecutionJobName`	string	A fully-qualified path representing NotebookExecutionJob resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromNotebookRuntimeName(notebookRuntimeName) → {string}

Parse the project from NotebookRuntime resource.

Parameters:

Name	Type	Description
`notebookRuntimeName`	string	A fully-qualified path representing NotebookRuntime resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromNotebookRuntimeTemplateName(notebookRuntimeTemplateName) → {string}

Parse the project from NotebookRuntimeTemplate resource.

Parameters:

Name	Type	Description
`notebookRuntimeTemplateName`	string	A fully-qualified path representing NotebookRuntimeTemplate resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromPersistentResourceName(persistentResourceName) → {string}

Parse the project from PersistentResource resource.

Parameters:

Name	Type	Description
`persistentResourceName`	string	A fully-qualified path representing PersistentResource resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromPipelineJobName(pipelineJobName) → {string}

Parse the project from PipelineJob resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationEndpointName(projectLocationEndpointName) → {string}

Parse the project from ProjectLocationEndpoint resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName) → {string}

Parse the project from ProjectLocationFeatureGroupFeatures resource.

Parameters:

Name	Type	Description
`projectLocationFeatureGroupFeaturesName`	string	A fully-qualified path representing project_location_feature_group_features resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName) → {string}

Parse the project from ProjectLocationFeaturestoreEntityTypeFeatures resource.

Parameters:

Name	Type	Description
`projectLocationFeaturestoreEntityTypeFeaturesName`	string	A fully-qualified path representing project_location_featurestore_entity_type_features resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationPublisherModelName(projectLocationPublisherModelName) → {string}

Parse the project from ProjectLocationPublisherModel resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:

Name	Type	Description
`projectName`	string	A fully-qualified path representing Project resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromRagCorpusName(ragCorpusName) → {string}

Parse the project from RagCorpus resource.

Parameters:

Name	Type	Description
`ragCorpusName`	string	A fully-qualified path representing RagCorpus resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromRagEngineConfigName(ragEngineConfigName) → {string}

Parse the project from RagEngineConfig resource.

Parameters:

Name	Type	Description
`ragEngineConfigName`	string	A fully-qualified path representing RagEngineConfig resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromRagFileName(ragFileName) → {string}

Parse the project from RagFile resource.

Parameters:

Name	Type	Description
`ragFileName`	string	A fully-qualified path representing RagFile resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromReasoningEngineName(reasoningEngineName) → {string}

Parse the project from ReasoningEngine resource.

Parameters:

Name	Type	Description
`reasoningEngineName`	string	A fully-qualified path representing ReasoningEngine resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromSavedQueryName(savedQueryName) → {string}

Parse the project from SavedQuery resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromScheduleName(scheduleName) → {string}

Parse the project from Schedule resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromSessionEventName(sessionEventName) → {string}

Parse the project from SessionEvent resource.

Parameters:

Name	Type	Description
`sessionEventName`	string	A fully-qualified path representing SessionEvent resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromSessionName(sessionName) → {string}

Parse the project from Session resource.

Parameters:

Name	Type	Description
`sessionName`	string	A fully-qualified path representing Session resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromSpecialistPoolName(specialistPoolName) → {string}

Parse the project from SpecialistPool resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromStudyName(studyName) → {string}

Parse the project from Study resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromTensorboardExperimentName(tensorboardExperimentName) → {string}

Parse the project from TensorboardExperiment resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromTensorboardName(tensorboardName) → {string}

Parse the project from Tensorboard resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromTensorboardRunName(tensorboardRunName) → {string}

Parse the project from TensorboardRun resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromTensorboardTimeSeriesName(tensorboardTimeSeriesName) → {string}

Parse the project from TensorboardTimeSeries resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromTrainingPipelineName(trainingPipelineName) → {string}

Parse the project from TrainingPipeline resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromTrialName(trialName) → {string}

Parse the project from Trial resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the project.

matchProjectFromTuningJobName(tuningJobName) → {string}

Parse the project from TuningJob resource.

Parameters:

Name	Type	Description
`tuningJobName`	string	A fully-qualified path representing TuningJob resource.

Returns:

Type	Description
string	A string representing the project.

matchPublisherFromProjectLocationPublisherModelName(projectLocationPublisherModelName) → {string}

Parse the publisher from ProjectLocationPublisherModel resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the publisher.

matchPublisherFromPublisherModelName(publisherModelName) → {string}

Parse the publisher from PublisherModel resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the publisher.

matchRagCorpusFromRagCorpusName(ragCorpusName) → {string}

Parse the rag_corpus from RagCorpus resource.

Parameters:

Name	Type	Description
`ragCorpusName`	string	A fully-qualified path representing RagCorpus resource.

Returns:

Type	Description
string	A string representing the rag_corpus.

matchRagCorpusFromRagFileName(ragFileName) → {string}

Parse the rag_corpus from RagFile resource.

Parameters:

Name	Type	Description
`ragFileName`	string	A fully-qualified path representing RagFile resource.

Returns:

Type	Description
string	A string representing the rag_corpus.

matchRagFileFromRagFileName(ragFileName) → {string}

Parse the rag_file from RagFile resource.

Parameters:

Name	Type	Description
`ragFileName`	string	A fully-qualified path representing RagFile resource.

Returns:

Type	Description
string	A string representing the rag_file.

matchReasoningEngineFromReasoningEngineName(reasoningEngineName) → {string}

Parse the reasoning_engine from ReasoningEngine resource.

Parameters:

Name	Type	Description
`reasoningEngineName`	string	A fully-qualified path representing ReasoningEngine resource.

Returns:

Type	Description
string	A string representing the reasoning_engine.

matchReasoningEngineFromSessionEventName(sessionEventName) → {string}

Parse the reasoning_engine from SessionEvent resource.

Parameters:

Name	Type	Description
`sessionEventName`	string	A fully-qualified path representing SessionEvent resource.

Returns:

Type	Description
string	A string representing the reasoning_engine.

matchReasoningEngineFromSessionName(sessionName) → {string}

Parse the reasoning_engine from Session resource.

Parameters:

Name	Type	Description
`sessionName`	string	A fully-qualified path representing Session resource.

Returns:

Type	Description
string	A string representing the reasoning_engine.

matchRunFromTensorboardRunName(tensorboardRunName) → {string}

Parse the run from TensorboardRun resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the run.

matchRunFromTensorboardTimeSeriesName(tensorboardTimeSeriesName) → {string}

Parse the run from TensorboardTimeSeries resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the run.

matchSavedQueryFromSavedQueryName(savedQueryName) → {string}

Parse the saved_query from SavedQuery resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the saved_query.

matchScheduleFromScheduleName(scheduleName) → {string}

Parse the schedule from Schedule resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the schedule.

matchSessionFromSessionEventName(sessionEventName) → {string}

Parse the session from SessionEvent resource.

Parameters:

Name	Type	Description
`sessionEventName`	string	A fully-qualified path representing SessionEvent resource.

Returns:

Type	Description
string	A string representing the session.

matchSessionFromSessionName(sessionName) → {string}

Parse the session from Session resource.

Parameters:

Name	Type	Description
`sessionName`	string	A fully-qualified path representing Session resource.

Returns:

Type	Description
string	A string representing the session.

matchSliceFromModelEvaluationSliceName(modelEvaluationSliceName) → {string}

Parse the slice from ModelEvaluationSlice resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the slice.

matchSpecialistPoolFromSpecialistPoolName(specialistPoolName) → {string}

Parse the specialist_pool from SpecialistPool resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the specialist_pool.

matchStudyFromStudyName(studyName) → {string}

Parse the study from Study resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the study.

matchStudyFromTrialName(trialName) → {string}

Parse the study from Trial resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the study.

matchTensorboardFromTensorboardExperimentName(tensorboardExperimentName) → {string}

Parse the tensorboard from TensorboardExperiment resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the tensorboard.

matchTensorboardFromTensorboardName(tensorboardName) → {string}

Parse the tensorboard from Tensorboard resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the tensorboard.

matchTensorboardFromTensorboardRunName(tensorboardRunName) → {string}

Parse the tensorboard from TensorboardRun resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the tensorboard.

matchTensorboardFromTensorboardTimeSeriesName(tensorboardTimeSeriesName) → {string}

Parse the tensorboard from TensorboardTimeSeries resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the tensorboard.

matchTimeSeriesFromTensorboardTimeSeriesName(tensorboardTimeSeriesName) → {string}

Parse the time_series from TensorboardTimeSeries resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the time_series.

matchTrainingPipelineFromTrainingPipelineName(trainingPipelineName) → {string}

Parse the training_pipeline from TrainingPipeline resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the training_pipeline.

matchTrialFromTrialName(trialName) → {string}

Parse the trial from Trial resource.

Parameters:

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

Returns:

Type	Description
string	A string representing the trial.

matchTuningJobFromTuningJobName(tuningJobName) → {string}

Parse the tuning_job from TuningJob resource.

Parameters:

Name	Type	Description
`tuningJobName`	string	A fully-qualified path representing TuningJob resource.

Returns:

Type	Description
string	A string representing the tuning_job.

metadataSchemaPath(project, location, metadata_store, metadata_schema) → {string}

Return a fully-qualified metadataSchema resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`metadata_store`	string
`metadata_schema`	string

Returns:

Type	Description
string	Resource name string.

metadataStorePath(project, location, metadata_store) → {string}

Return a fully-qualified metadataStore resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`metadata_store`	string

Returns:

Type	Description
string	Resource name string.

modelDeploymentMonitoringJobPath(project, location, model_deployment_monitoring_job) → {string}

Return a fully-qualified modelDeploymentMonitoringJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`model_deployment_monitoring_job`	string

Returns:

Type	Description
string	Resource name string.

modelEvaluationPath(project, location, model, evaluation) → {string}

Return a fully-qualified modelEvaluation resource name string.

Parameters:

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

Returns:

Type	Description
string	Resource name string.

modelEvaluationSlicePath(project, location, model, evaluation, slice) → {string}

Return a fully-qualified modelEvaluationSlice resource name string.

Parameters:

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

Returns:

Type	Description
string	Resource name string.

modelPath(project, location, model) → {string}

Return a fully-qualified model resource name string.

Parameters:

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

Returns:

Type	Description
string	Resource name string.

nasJobPath(project, location, nas_job) → {string}

Return a fully-qualified nasJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`nas_job`	string

Returns:

Type	Description
string	Resource name string.

nasTrialDetailPath(project, location, nas_job, nas_trial_detail) → {string}

Return a fully-qualified nasTrialDetail resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`nas_job`	string
`nas_trial_detail`	string

Returns:

Type	Description
string	Resource name string.

notebookExecutionJobPath(project, location, notebook_execution_job) → {string}

Return a fully-qualified notebookExecutionJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`notebook_execution_job`	string

Returns:

Type	Description
string	Resource name string.

notebookRuntimePath(project, location, notebook_runtime) → {string}

Return a fully-qualified notebookRuntime resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`notebook_runtime`	string

Returns:

Type	Description
string	Resource name string.

notebookRuntimeTemplatePath(project, location, notebook_runtime_template) → {string}

Return a fully-qualified notebookRuntimeTemplate resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`notebook_runtime_template`	string

Returns:

Type	Description
string	Resource name string.

persistentResourcePath(project, location, persistent_resource) → {string}

Return a fully-qualified persistentResource resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`persistent_resource`	string

Returns:

Type	Description
string	Resource name string.

pipelineJobPath(project, location, pipeline_job) → {string}

Return a fully-qualified pipelineJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`pipeline_job`	string

Returns:

Type	Description
string	Resource name string.

projectLocationEndpointPath(project, location, endpoint) → {string}

Return a fully-qualified projectLocationEndpoint resource name string.

Parameters:

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

Returns:

Type	Description
string	Resource name string.

projectLocationFeatureGroupFeaturesPath(project, location, feature_group, feature) → {string}

Return a fully-qualified projectLocationFeatureGroupFeatures resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`feature_group`	string
`feature`	string

Returns:

Type	Description
string	Resource name string.

projectLocationFeaturestoreEntityTypeFeaturesPath(project, location, featurestore, entity_type, feature) → {string}

Return a fully-qualified projectLocationFeaturestoreEntityTypeFeatures resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`featurestore`	string
`entity_type`	string
`feature`	string

Returns:

Type	Description
string	Resource name string.

projectLocationPublisherModelPath(project, location, publisher, model) → {string}

Return a fully-qualified projectLocationPublisherModel resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`publisher`	string
`model`	string

Returns:

Type	Description
string	Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

publisherModelPath(publisher, model) → {string}

Return a fully-qualified publisherModel resource name string.

Parameters:

Name	Type	Description
`publisher`	string
`model`	string

Returns:

Type	Description
string	Resource name string.

ragCorpusPath(project, location, rag_corpus) → {string}

Return a fully-qualified ragCorpus resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`rag_corpus`	string

Returns:

Type	Description
string	Resource name string.

ragEngineConfigPath(project, location) → {string}

Return a fully-qualified ragEngineConfig resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

Returns:

Type	Description
string	Resource name string.

ragFilePath(project, location, rag_corpus, rag_file) → {string}

Return a fully-qualified ragFile resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`rag_corpus`	string
`rag_file`	string

Returns:

Type	Description
string	Resource name string.

reasoningEnginePath(project, location, reasoning_engine) → {string}

Return a fully-qualified reasoningEngine resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`reasoning_engine`	string

Returns:

Type	Description
string	Resource name string.

savedQueryPath(project, location, dataset, saved_query) → {string}

Return a fully-qualified savedQuery resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`dataset`	string
`saved_query`	string

Returns:

Type	Description
string	Resource name string.

schedulePath(project, location, schedule) → {string}

Return a fully-qualified schedule resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`schedule`	string

Returns:

Type	Description
string	Resource name string.

sessionEventPath(project, location, reasoning_engine, session, event) → {string}

Return a fully-qualified sessionEvent resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`reasoning_engine`	string
`session`	string
`event`	string

Returns:

Type	Description
string	Resource name string.

sessionPath(project, location, reasoning_engine, session) → {string}

Return a fully-qualified session resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`reasoning_engine`	string
`session`	string

Returns:

Type	Description
string	Resource name string.

setIamPolicy(request, optionsopt, callbackopt) → {Promise}

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

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`resource`	string	REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	Array.<string>	The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TestIamPermissionsResponse.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.

specialistPoolPath(project, location, specialist_pool) → {string}

Return a fully-qualified specialistPool resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`specialist_pool`	string

Returns:

Type	Description
string	Resource name string.

studyPath(project, location, study) → {string}

Return a fully-qualified study resource name string.

Parameters:

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

Returns:

Type	Description
string	Resource name string.

tensorboardExperimentPath(project, location, tensorboard, experiment) → {string}

Return a fully-qualified tensorboardExperiment resource name string.

Parameters:

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

Returns:

Type	Description
string	Resource name string.

tensorboardPath(project, location, tensorboard) → {string}

Return a fully-qualified tensorboard resource name string.

Parameters:

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

Returns:

Type	Description
string	Resource name string.

tensorboardRunPath(project, location, tensorboard, experiment, run) → {string}

Return a fully-qualified tensorboardRun resource name string.

Parameters:

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

Returns:

Type	Description
string	Resource name string.

tensorboardTimeSeriesPath(project, location, tensorboard, experiment, run, time_series) → {string}

Return a fully-qualified tensorboardTimeSeries resource name string.

Parameters:

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

Returns:

Type	Description
string	Resource name string.

testIamPermissions(request, optionsopt, callbackopt) → {Promise}

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

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`resource`	string	REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	Array.<string>	The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TestIamPermissionsResponse.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.

trainingPipelinePath(project, location, training_pipeline) → {string}

Return a fully-qualified trainingPipeline resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`training_pipeline`	string

Returns:

Type	Description
string	Resource name string.

trialPath(project, location, study, trial) → {string}

Return a fully-qualified trial resource name string.

Parameters:

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

Returns:

Type	Description
string	Resource name string.

tuningJobPath(project, location, tuning_job) → {string}

Return a fully-qualified tuningJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`tuning_job`	string

Returns:

Type	Description
string	Resource name string.