Class v1beta1.FeatureRegistryServiceClient (5.14.0)

Version latest

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

The service that handles CRUD and List for resources for FeatureRegistry. v1beta1

Package

@google-cloud/aiplatform

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of FeatureRegistryServiceClient.

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

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

featureRegistryServiceStub

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

iamClient

iamClient: IamClient;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

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

Methods

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

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

Return a fully-qualified annotation resource name string.

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

Returns
Type	Description
string	{string} Resource name string.

annotationSpecPath(project, location, dataset, annotationSpec)

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

Return a fully-qualified annotationSpec resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
annotationSpec	string

Returns
Type	Description
string	{string} Resource name string.

artifactPath(project, location, metadataStore, artifact)

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

Return a fully-qualified artifact resource name string.

Parameters
Name	Description
project	string
location	string
metadataStore	string
artifact	string

Returns
Type	Description
string	{string} Resource name string.

batchCreateFeatures(request, options)

batchCreateFeatures(request?: protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a batch of Features in a given FeatureGroup.

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

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the EntityType/FeatureGroup to create the
   *  batch of Features under. Format:
   *  `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
   *  `projects/{project}/locations/{location}/featureGroups/{feature_group}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The request message specifying the Features to create. All
   *  Features must be created under the same parent EntityType / FeatureGroup.
   *  The `parent` field in each child request message can be omitted. If
   *  `parent` is set in a child request, then the value must match the `parent`
   *  value in this request message.
   */
  // const requests = [1,2,3,4]

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

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

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

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

  callBatchCreateFeatures();

batchCreateFeatures(request, options, callback)

batchCreateFeatures(request: protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBatchCreateFeaturesRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

batchCreateFeatures(request, callback)

batchCreateFeatures(request: protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IBatchCreateFeaturesRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesResponse, protos.google.cloud.aiplatform.v1beta1.IBatchCreateFeaturesOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

batchPredictionJobPath(project, location, batchPredictionJob)

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

Return a fully-qualified batchPredictionJob resource name string.

Parameters
Name	Description
project	string
location	string
batchPredictionJob	string

Returns
Type	Description
string	{string} Resource name string.

cachedContentPath(project, location, cachedContent)

cachedContentPath(project: string, location: string, cachedContent: string): string;

Return a fully-qualified cachedContent resource name string.

Parameters
Name	Description
project	string
location	string
cachedContent	string

Returns
Type	Description
string	{string} Resource name string.

cancelOperation(request, optionsOrCallback, callback)

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

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

Parameters
Name	Description
request	CancelOperationRequest The request object that will be sent.
optionsOrCallback	CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
callback	Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

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

Example

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

checkBatchCreateFeaturesProgress(name)

checkBatchCreateFeaturesProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.BatchCreateFeaturesResponse, protos.google.cloud.aiplatform.v1beta1.BatchCreateFeaturesOperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.BatchCreateFeaturesResponse, protos.google.cloud.aiplatform.v1beta1.BatchCreateFeaturesOperationMetadata>>	{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 EntityType/FeatureGroup to create the
   *  batch of Features under. Format:
   *  `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
   *  `projects/{project}/locations/{location}/featureGroups/{feature_group}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The request message specifying the Features to create. All
   *  Features must be created under the same parent EntityType / FeatureGroup.
   *  The `parent` field in each child request message can be omitted. If
   *  `parent` is set in a child request, then the value must match the `parent`
   *  value in this request message.
   */
  // const requests = [1,2,3,4]

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

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

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

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

  callBatchCreateFeatures();

checkCreateFeatureGroupProgress(name)

checkCreateFeatureGroupProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureGroup, protos.google.cloud.aiplatform.v1beta1.CreateFeatureGroupOperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureGroup, protos.google.cloud.aiplatform.v1beta1.CreateFeatureGroupOperationMetadata>>	{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 to create FeatureGroups.
   *  Format:
   *  `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The FeatureGroup to create.
   */
  // const featureGroup = {}
  /**
   *  Required. The ID to use for this FeatureGroup, which will become the final
   *  component of the FeatureGroup's resource name.
   *  This value may be up to 128 characters, and valid characters are
   *  `[a-z0-9_]`. The first character cannot be a number.
   *  The value must be unique within the project and location.
   */
  // const featureGroupId = 'abc123'

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

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

  async function callCreateFeatureGroup() {
    // Construct request
    const request = {
      parent,
      featureGroup,
      featureGroupId,
    };

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

  callCreateFeatureGroup();

checkCreateFeatureMonitorProgress(name)

checkCreateFeatureMonitorProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureMonitor, protos.google.cloud.aiplatform.v1beta1.CreateFeatureMonitorOperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureMonitor, protos.google.cloud.aiplatform.v1beta1.CreateFeatureMonitorOperationMetadata>>	{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 FeatureGroup to create FeatureMonitor.
   *  Format:
   *  `projects/{project}/locations/{location}/featureGroups/{featuregroup}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Monitor to create.
   */
  // const featureMonitor = {}
  /**
   *  Required. The ID to use for this FeatureMonitor, which will become the
   *  final component of the FeatureGroup's resource name.
   *  This value may be up to 60 characters, and valid characters are
   *  `[a-z0-9_]`. The first character cannot be a number.
   *  The value must be unique within the FeatureGroup.
   */
  // const featureMonitorId = 'abc123'

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

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

  async function callCreateFeatureMonitor() {
    // Construct request
    const request = {
      parent,
      featureMonitor,
      featureMonitorId,
    };

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

  callCreateFeatureMonitor();

checkCreateFeatureProgress(name)

checkCreateFeatureProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Feature, protos.google.cloud.aiplatform.v1beta1.CreateFeatureOperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Feature, protos.google.cloud.aiplatform.v1beta1.CreateFeatureOperationMetadata>>	{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 EntityType or FeatureGroup to create a
   *  Feature. Format for entity_type as parent:
   *  `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
   *  Format for feature_group as parent:
   *  `projects/{project}/locations/{location}/featureGroups/{feature_group}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Feature to create.
   */
  // const feature = {}
  /**
   *  Required. The ID to use for the Feature, which will become the final
   *  component of the Feature's resource name.
   *  This value may be up to 128 characters, and valid characters are
   *  `[a-z0-9_]`. The first character cannot be a number.
   *  The value must be unique within an EntityType/FeatureGroup.
   */
  // const featureId = 'abc123'

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

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

  async function callCreateFeature() {
    // Construct request
    const request = {
      parent,
      feature,
      featureId,
    };

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

  callCreateFeature();

checkDeleteFeatureGroupProgress(name)

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

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

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

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the FeatureGroup to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/featureGroups/{feature_group}`
   */
  // const name = 'abc123'
  /**
   *  If set to true, any Features under this FeatureGroup
   *  will also be deleted. (Otherwise, the request will only work if the
   *  FeatureGroup has no Features.)
   */
  // const force = true

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

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

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

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

  callDeleteFeatureGroup();

checkDeleteFeatureMonitorProgress(name)

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

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

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

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

Example

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

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

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

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

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

  callDeleteFeatureMonitor();

checkDeleteFeatureProgress(name)

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

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

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

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

Example

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

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

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

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

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

  callDeleteFeature();

checkUpdateFeatureGroupProgress(name)

checkUpdateFeatureGroupProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureGroup, protos.google.cloud.aiplatform.v1beta1.UpdateFeatureGroupOperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureGroup, protos.google.cloud.aiplatform.v1beta1.UpdateFeatureGroupOperationMetadata>>	{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 FeatureGroup's `name` field is used to identify the
   *  FeatureGroup to be updated. Format:
   *  `projects/{project}/locations/{location}/featureGroups/{feature_group}`
   */
  // const featureGroup = {}
  /**
   *  Field mask is used to specify the fields to be overwritten in the
   *  FeatureGroup resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then only the non-empty fields present in the
   *  request will be overwritten. Set the update_mask to `*` to override all
   *  fields.
   *  Updatable fields:
   *    * `labels`
   *    * `description`
   *    * `big_query`
   *    * `big_query.entity_id_columns`
   */
  // const updateMask = {}

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

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

  async function callUpdateFeatureGroup() {
    // Construct request
    const request = {
      featureGroup,
    };

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

  callUpdateFeatureGroup();

checkUpdateFeatureMonitorProgress(name)

checkUpdateFeatureMonitorProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureMonitor, protos.google.cloud.aiplatform.v1beta1.UpdateFeatureMonitorOperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureMonitor, protos.google.cloud.aiplatform.v1beta1.UpdateFeatureMonitorOperationMetadata>>	{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 FeatureMonitor's `name` field is used to identify the
   *  FeatureMonitor to be updated. Format:
   *  `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`
   */
  // const featureMonitor = {}
  /**
   *  Optional. Field mask is used to specify the fields to be overwritten in the
   *  FeatureMonitor resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then only the non-empty fields present in the
   *  request will be overwritten. Set the update_mask to `*` to override all
   *  fields.
   *  Updatable fields:
   *    * `labels`
   */
  // const updateMask = {}

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

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

  async function callUpdateFeatureMonitor() {
    // Construct request
    const request = {
      featureMonitor,
    };

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

  callUpdateFeatureMonitor();

checkUpdateFeatureProgress(name)

checkUpdateFeatureProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Feature, protos.google.cloud.aiplatform.v1beta1.UpdateFeatureOperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.Feature, protos.google.cloud.aiplatform.v1beta1.UpdateFeatureOperationMetadata>>	{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 Feature's `name` field is used to identify the Feature to be
   *  updated.
   *  Format:
   *  `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
   *  `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
   */
  // const feature = {}
  /**
   *  Field mask is used to specify the fields to be overwritten in the
   *  Features resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then only the non-empty fields present in the
   *  request will be overwritten. Set the update_mask to `*` to override all
   *  fields.
   *  Updatable fields:
   *    * `description`
   *    * `labels`
   *    * `disable_monitoring` (Not supported for FeatureRegistryService Feature)
   *    * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)
   */
  // const updateMask = {}

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

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

  async function callUpdateFeature() {
    // Construct request
    const request = {
      feature,
    };

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

  callUpdateFeature();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns
Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

contextPath(project, location, metadataStore, context)

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

Return a fully-qualified context resource name string.

Parameters
Name	Description
project	string
location	string
metadataStore	string
context	string

Returns
Type	Description
string	{string} Resource name string.

createFeature(request, options)

createFeature(request?: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1beta1.IFeature, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new Feature in a given FeatureGroup.

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

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.aiplatform.v1beta1.IFeature, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the EntityType or FeatureGroup to create a
   *  Feature. Format for entity_type as parent:
   *  `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
   *  Format for feature_group as parent:
   *  `projects/{project}/locations/{location}/featureGroups/{feature_group}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Feature to create.
   */
  // const feature = {}
  /**
   *  Required. The ID to use for the Feature, which will become the final
   *  component of the Feature's resource name.
   *  This value may be up to 128 characters, and valid characters are
   *  `[a-z0-9_]`. The first character cannot be a number.
   *  The value must be unique within an EntityType/FeatureGroup.
   */
  // const featureId = 'abc123'

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

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

  async function callCreateFeature() {
    // Construct request
    const request = {
      parent,
      feature,
      featureId,
    };

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

  callCreateFeature();

createFeature(request, options, callback)

createFeature(request: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeature, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFeatureRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeature, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFeature(request, callback)

createFeature(request: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeature, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFeatureRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeature, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFeatureGroup(request, options)

createFeatureGroup(request?: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureGroupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureGroup, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureGroupOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new FeatureGroup in a given project and location.

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

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureGroup, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureGroupOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Location to create FeatureGroups.
   *  Format:
   *  `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The FeatureGroup to create.
   */
  // const featureGroup = {}
  /**
   *  Required. The ID to use for this FeatureGroup, which will become the final
   *  component of the FeatureGroup's resource name.
   *  This value may be up to 128 characters, and valid characters are
   *  `[a-z0-9_]`. The first character cannot be a number.
   *  The value must be unique within the project and location.
   */
  // const featureGroupId = 'abc123'

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

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

  async function callCreateFeatureGroup() {
    // Construct request
    const request = {
      parent,
      featureGroup,
      featureGroupId,
    };

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

  callCreateFeatureGroup();

createFeatureGroup(request, options, callback)

createFeatureGroup(request: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureGroupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureGroup, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureGroupOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFeatureGroupRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureGroup, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureGroupOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFeatureGroup(request, callback)

createFeatureGroup(request: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureGroupRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureGroup, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureGroupOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFeatureGroupRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureGroup, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureGroupOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFeatureMonitor(request, options)

createFeatureMonitor(request?: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitor, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new FeatureMonitor in a given project, location and FeatureGroup.

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

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitor, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of FeatureGroup to create FeatureMonitor.
   *  Format:
   *  `projects/{project}/locations/{location}/featureGroups/{featuregroup}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Monitor to create.
   */
  // const featureMonitor = {}
  /**
   *  Required. The ID to use for this FeatureMonitor, which will become the
   *  final component of the FeatureGroup's resource name.
   *  This value may be up to 60 characters, and valid characters are
   *  `[a-z0-9_]`. The first character cannot be a number.
   *  The value must be unique within the FeatureGroup.
   */
  // const featureMonitorId = 'abc123'

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

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

  async function callCreateFeatureMonitor() {
    // Construct request
    const request = {
      parent,
      featureMonitor,
      featureMonitorId,
    };

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

  callCreateFeatureMonitor();

createFeatureMonitor(request, options, callback)

createFeatureMonitor(request: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitor, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFeatureMonitorRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitor, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFeatureMonitor(request, callback)

createFeatureMonitor(request: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitor, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFeatureMonitorRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitor, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFeatureMonitorJob(request, options)

createFeatureMonitorJob(request?: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob,
        protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorJobRequest | undefined,
        {} | undefined
    ]>;

Creates a new feature monitor job.

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

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorJobRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of FeatureMonitor to create FeatureMonitorJob.
   *  Format:
   *  `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The Monitor to create.
   */
  // const featureMonitorJob = {}
  /**
   *  Optional. Output only. System-generated ID for feature monitor job.
   */
  // const featureMonitorJobId = 1234

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

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

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

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

  callCreateFeatureMonitorJob();

createFeatureMonitorJob(request, options, callback)

createFeatureMonitorJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorJobRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFeatureMonitorJobRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorJobRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFeatureMonitorJob(request, callback)

createFeatureMonitorJob(request: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorJobRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFeatureMonitorJobRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureMonitorJobRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

customJobPath(project, location, customJob)

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

Return a fully-qualified customJob resource name string.

Parameters
Name	Description
project	string
location	string
customJob	string

Returns
Type	Description
string	{string} Resource name string.

dataItemPath(project, location, dataset, dataItem)

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

Return a fully-qualified dataItem resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
dataItem	string

Returns
Type	Description
string	{string} Resource name string.

dataLabelingJobPath(project, location, dataLabelingJob)

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

Return a fully-qualified dataLabelingJob resource name string.

Parameters
Name	Description
project	string
location	string
dataLabelingJob	string

Returns
Type	Description
string	{string} Resource name string.

datasetPath(project, location, dataset)

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

Return a fully-qualified dataset resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string

Returns
Type	Description
string	{string} Resource name string.

datasetVersionPath(project, location, dataset, datasetVersion)

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

Return a fully-qualified datasetVersion resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
datasetVersion	string

Returns
Type	Description
string	{string} Resource name string.

deleteFeature(request, options)

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

Deletes a single Feature.

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

Returns
Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

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

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

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

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

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

  callDeleteFeature();

deleteFeature(request, options, callback)

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

Parameters
Name	Description
request	IDeleteFeatureRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteFeature(request, callback)

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

Parameters
Name	Description
request	IDeleteFeatureRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteFeatureGroup(request, options)

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

Deletes a single FeatureGroup.

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

Returns
Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the FeatureGroup to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/featureGroups/{feature_group}`
   */
  // const name = 'abc123'
  /**
   *  If set to true, any Features under this FeatureGroup
   *  will also be deleted. (Otherwise, the request will only work if the
   *  FeatureGroup has no Features.)
   */
  // const force = true

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

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

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

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

  callDeleteFeatureGroup();

deleteFeatureGroup(request, options, callback)

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

Parameters
Name	Description
request	IDeleteFeatureGroupRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteFeatureGroup(request, callback)

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

Parameters
Name	Description
request	IDeleteFeatureGroupRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteFeatureMonitor(request, options)

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

Deletes a single FeatureMonitor.

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

Returns
Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

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

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

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

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

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

  callDeleteFeatureMonitor();

deleteFeatureMonitor(request, options, callback)

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

Parameters
Name	Description
request	IDeleteFeatureMonitorRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteFeatureMonitor(request, callback)

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

Parameters
Name	Description
request	IDeleteFeatureMonitorRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.aiplatform.v1beta1.IDeleteOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteOperation(request, optionsOrCallback, callback)

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

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

Parameters
Name	Description
request	DeleteOperationRequest The request object that will be sent.
optionsOrCallback	CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
callback	Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

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

Example

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

deploymentResourcePoolPath(project, location, deploymentResourcePool)

deploymentResourcePoolPath(project: string, location: string, deploymentResourcePool: string): string;

Return a fully-qualified deploymentResourcePool resource name string.

Parameters
Name	Description
project	string
location	string
deploymentResourcePool	string

Returns
Type	Description
string	{string} Resource name string.

entityTypePath(project, location, featurestore, entityType)

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

Return a fully-qualified entityType resource name string.

Parameters
Name	Description
project	string
location	string
featurestore	string
entityType	string

Returns
Type	Description
string	{string} Resource name string.

exampleStorePath(project, location, exampleStore)

exampleStorePath(project: string, location: string, exampleStore: string): string;

Return a fully-qualified exampleStore resource name string.

Parameters
Name	Description
project	string
location	string
exampleStore	string

Returns
Type	Description
string	{string} Resource name string.

executionPath(project, location, metadataStore, execution)

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

Return a fully-qualified execution resource name string.

Parameters
Name	Description
project	string
location	string
metadataStore	string
execution	string

Returns
Type	Description
string	{string} Resource name string.

extensionPath(project, location, extension)

extensionPath(project: string, location: string, extension: string): string;

Return a fully-qualified extension resource name string.

Parameters
Name	Description
project	string
location	string
extension	string

Returns
Type	Description
string	{string} Resource name string.

featureGroupPath(project, location, featureGroup)

featureGroupPath(project: string, location: string, featureGroup: string): string;

Return a fully-qualified featureGroup resource name string.

Parameters
Name	Description
project	string
location	string
featureGroup	string

Returns
Type	Description
string	{string} Resource name string.

featureMonitorJobPath(project, location, featureGroup, featureMonitor, featureMonitorJob)

featureMonitorJobPath(project: string, location: string, featureGroup: string, featureMonitor: string, featureMonitorJob: string): string;

Return a fully-qualified featureMonitorJob resource name string.

Parameters
Name	Description
project	string
location	string
featureGroup	string
featureMonitor	string
featureMonitorJob	string

Returns
Type	Description
string	{string} Resource name string.

featureMonitorPath(project, location, featureGroup, featureMonitor)

featureMonitorPath(project: string, location: string, featureGroup: string, featureMonitor: string): string;

Return a fully-qualified featureMonitor resource name string.

Parameters
Name	Description
project	string
location	string
featureGroup	string
featureMonitor	string

Returns
Type	Description
string	{string} Resource name string.

featureOnlineStorePath(project, location, featureOnlineStore)

featureOnlineStorePath(project: string, location: string, featureOnlineStore: string): string;

Return a fully-qualified featureOnlineStore resource name string.

Parameters
Name	Description
project	string
location	string
featureOnlineStore	string

Returns
Type	Description
string	{string} Resource name string.

featurestorePath(project, location, featurestore)

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

Return a fully-qualified featurestore resource name string.

Parameters
Name	Description
project	string
location	string
featurestore	string

Returns
Type	Description
string	{string} Resource name string.

featureViewPath(project, location, featureOnlineStore, featureView)

featureViewPath(project: string, location: string, featureOnlineStore: string, featureView: string): string;

Return a fully-qualified featureView resource name string.

Parameters
Name	Description
project	string
location	string
featureOnlineStore	string
featureView	string

Returns
Type	Description
string	{string} Resource name string.

featureViewSyncPath(project, location, featureOnlineStore, featureView)

featureViewSyncPath(project: string, location: string, featureOnlineStore: string, featureView: string): string;

Return a fully-qualified featureViewSync resource name string.

Parameters
Name	Description
project	string
location	string
featureOnlineStore	string
featureView	string

Returns
Type	Description
string	{string} Resource name string.

getFeature(request, options)

getFeature(request?: protos.google.cloud.aiplatform.v1beta1.IGetFeatureRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IFeature,
        protos.google.cloud.aiplatform.v1beta1.IGetFeatureRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single Feature.

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

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IFeature, protos.google.cloud.aiplatform.v1beta1.IGetFeatureRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Feature resource.
   *  Format for entity_type as parent:
   *  `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
   *  Format for feature_group as parent:
   *  `projects/{project}/locations/{location}/featureGroups/{feature_group}`
   */
  // const name = 'abc123'
  /**
   *  Optional. Only applicable for Vertex AI Feature Store.
   *  If set, retrieves FeatureStatsAndAnomaly generated by FeatureMonitors based
   *  on this spec.
   */
  // const featureStatsAndAnomalySpec = {}

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

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

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

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

  callGetFeature();

getFeature(request, options, callback)

getFeature(request: protos.google.cloud.aiplatform.v1beta1.IGetFeatureRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeature, protos.google.cloud.aiplatform.v1beta1.IGetFeatureRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFeatureRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IFeature, protos.google.cloud.aiplatform.v1beta1.IGetFeatureRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getFeature(request, callback)

getFeature(request: protos.google.cloud.aiplatform.v1beta1.IGetFeatureRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeature, protos.google.cloud.aiplatform.v1beta1.IGetFeatureRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFeatureRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IFeature, protos.google.cloud.aiplatform.v1beta1.IGetFeatureRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getFeatureGroup(request, options)

getFeatureGroup(request?: protos.google.cloud.aiplatform.v1beta1.IGetFeatureGroupRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IFeatureGroup,
        protos.google.cloud.aiplatform.v1beta1.IGetFeatureGroupRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single FeatureGroup.

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

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IFeatureGroup, protos.google.cloud.aiplatform.v1beta1.IGetFeatureGroupRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

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

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

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

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

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

  callGetFeatureGroup();

getFeatureGroup(request, options, callback)

getFeatureGroup(request: protos.google.cloud.aiplatform.v1beta1.IGetFeatureGroupRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureGroup, protos.google.cloud.aiplatform.v1beta1.IGetFeatureGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFeatureGroupRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureGroup, protos.google.cloud.aiplatform.v1beta1.IGetFeatureGroupRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getFeatureGroup(request, callback)

getFeatureGroup(request: protos.google.cloud.aiplatform.v1beta1.IGetFeatureGroupRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureGroup, protos.google.cloud.aiplatform.v1beta1.IGetFeatureGroupRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFeatureGroupRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureGroup, protos.google.cloud.aiplatform.v1beta1.IGetFeatureGroupRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getFeatureMonitor(request, options)

getFeatureMonitor(request?: protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IFeatureMonitor,
        protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single FeatureMonitor.

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

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IFeatureMonitor, protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing FeatureMonitor. Please see the documentation for more details and examples.

Example

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

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

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

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

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

  callGetFeatureMonitor();

getFeatureMonitor(request, options, callback)

getFeatureMonitor(request: protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitor, protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFeatureMonitorRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitor, protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getFeatureMonitor(request, callback)

getFeatureMonitor(request: protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitor, protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFeatureMonitorRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitor, protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getFeatureMonitorJob(request, options)

getFeatureMonitorJob(request?: protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob,
        protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorJobRequest | undefined,
        {} | undefined
    ]>;

Get a feature monitor job.

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

Returns
Type	Description
Promise<[ protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob, protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorJobRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

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

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

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

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

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

  callGetFeatureMonitorJob();

getFeatureMonitorJob(request, options, callback)

getFeatureMonitorJob(request: protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob, protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorJobRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFeatureMonitorJobRequest
options	CallOptions
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob, protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorJobRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getFeatureMonitorJob(request, callback)

getFeatureMonitorJob(request: protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorJobRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob, protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorJobRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFeatureMonitorJobRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob, protos.google.cloud.aiplatform.v1beta1.IGetFeatureMonitorJobRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getIamPolicy(request, options, callback)

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

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

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

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

getLocation(request, options, callback)

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

Gets information about a location.

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

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

Example

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

getOperation(request, optionsOrCallback, callback)

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

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

Parameters
Name	Description
request	GetOperationRequest The request object that will be sent.
optionsOrCallback	CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
callback	Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

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

Example

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

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
Promise<string>

getProjectId(callback)

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

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

Returns
Type	Description
void

hyperparameterTuningJobPath(project, location, hyperparameterTuningJob)

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

Return a fully-qualified hyperparameterTuningJob resource name string.

Parameters
Name	Description
project	string
location	string
hyperparameterTuningJob	string

Returns
Type	Description
string	{string} Resource name string.

indexEndpointPath(project, location, indexEndpoint)

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

Return a fully-qualified indexEndpoint resource name string.

Parameters
Name	Description
project	string
location	string
indexEndpoint	string

Returns
Type	Description
string	{string} Resource name string.

indexPath(project, location, index)

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

Return a fully-qualified index resource name string.

Parameters
Name	Description
project	string
location	string
index	string

Returns
Type	Description
string	{string} Resource name string.

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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

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

Returns
Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listFeatureGroups(request, options)

listFeatureGroups(request?: protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IFeatureGroup[],
        protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsRequest | null,
        protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsResponse
    ]>;

Lists FeatureGroups in a given project and location.

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

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

listFeatureGroups(request, options, callback)

listFeatureGroups(request: protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureGroup>): void;

Parameters
Name	Description
request	IListFeatureGroupsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureGroup>

Returns
Type	Description
void

listFeatureGroups(request, callback)

listFeatureGroups(request: protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureGroup>): void;

Parameters
Name	Description
request	IListFeatureGroupsRequest
callback	PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureGroup>

Returns
Type	Description
void

listFeatureGroupsAsync(request, options)

listFeatureGroupsAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IFeatureGroup>;

Equivalent to listFeatureGroups, but returns an iterable object.

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

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

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Location to list FeatureGroups.
   *  Format:
   *  `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Lists the FeatureGroups that match the filter expression. The
   *  following fields are supported:
   *  * `create_time`: Supports `=`, `!=`, `<`, `="">`, `<=`, and="" `="">=` comparisons.
   *  Values must be
   *    in RFC 3339 format.
   *  * `update_time`: Supports `=`, `!=`, `<`, `="">`, `<=`, and="" `="">=` comparisons.
   *  Values must be
   *    in RFC 3339 format.
   *  * `labels`: Supports key-value equality and key presence.
   *  Examples:
   *  * `create_time > "2020-01-01" OR update_time > "2020-01-01"`
   *     FeatureGroups created or updated after 2020-01-01.
   *  * `labels.env = "prod"`
   *     FeatureGroups with label "env" set to "prod".
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of FeatureGroups to return. The service may return
   *  fewer than this value. If unspecified, at most 100 FeatureGroups will
   *  be returned. The maximum value is 100; any value greater than 100 will be
   *  coerced to 100.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous
   *  FeatureGroupAdminService.ListFeatureGroups   call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  FeatureGroupAdminService.ListFeatureGroups   must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  A comma-separated list of fields to order by, sorted in ascending order.
   *  Use "desc" after a field name for descending.
   *  Supported Fields:
   *    * `create_time`
   *    * `update_time`
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListFeatureGroups();

listFeatureGroupsStream(request, options)

listFeatureGroupsStream(request?: protos.google.cloud.aiplatform.v1beta1.IListFeatureGroupsRequest, options?: CallOptions): Transform;

Equivalent to listFeatureGroups, but returns a NodeJS Stream object.

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

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

listFeatureMonitorJobs(request, options)

listFeatureMonitorJobs(request?: protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob[],
        protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsRequest | null,
        protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsResponse
    ]>;

List feature monitor jobs.

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

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

listFeatureMonitorJobs(request, options, callback)

listFeatureMonitorJobs(request: protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob>): void;

Parameters
Name	Description
request	IListFeatureMonitorJobsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob>

Returns
Type	Description
void

listFeatureMonitorJobs(request, callback)

listFeatureMonitorJobs(request: protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob>): void;

Parameters
Name	Description
request	IListFeatureMonitorJobsRequest
callback	PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob>

Returns
Type	Description
void

listFeatureMonitorJobsAsync(request, options)

listFeatureMonitorJobsAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListFeatureMonitorJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IFeatureMonitorJob>;

Equivalent to listFeatureMonitorJobs, but returns an iterable object.

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

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

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

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the FeatureMonitor to list
   *  FeatureMonitorJobs. Format:
   *  `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. Lists the FeatureMonitorJobs that match the filter expression.
   *  The following fields are supported:
   *  * `create_time`: Supports `=`, `!=`, `<`, `="">`, `<=`, and="" `="">=` comparisons.
   *  Values must be
   *  Examples:
   *  * `create_time > "2020-01-01"`
   *     FeatureMonitorJobs created after 2020-01-01.
   */
  // const filter = 'abc123'
  /**
   *  Optional. The maximum number of FeatureMonitorJobs to return. The service
   *  may return fewer than this value. If unspecified, at most 100
   *  FeatureMonitorJobs will be returned. The maximum value is 100; any value
   *  greater than 100 will be coerced to 100.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous
   *  FeatureRegistryService.ListFeatureMonitorJobs google.cloud.aiplatform.v1beta1.FeatureRegistryService.ListFeatureMonitorJobs 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  FeatureRegistryService.ListFeatureMonitorJobs google.cloud.aiplatform.v1beta1.FeatureRegistryService.ListFeatureMonitorJobs 
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. A comma-separated list of fields to order by, sorted in ascending
   *  order. Use "desc" after a field name for descending. Supported Fields:
   *    * `create_time`
   */
  // const orderBy = 'abc123'

  // Imports the Aiplatform library
  const {