Class v1beta1.FeatureOnlineStoreAdminServiceClient (5.14.0)

Version latest

• 6.0.0 (latest)
• 5.14.0
• 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 FeatureOnlineStore. v1beta1

Package

@google-cloud/aiplatform

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of FeatureOnlineStoreAdminServiceClient.

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

featureOnlineStoreAdminServiceStub

featureOnlineStoreAdminServiceStub?: 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.

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

checkCreateFeatureOnlineStoreProgress(name)

checkCreateFeatureOnlineStoreProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureOnlineStore, protos.google.cloud.aiplatform.v1beta1.CreateFeatureOnlineStoreOperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureOnlineStore, protos.google.cloud.aiplatform.v1beta1.CreateFeatureOnlineStoreOperationMetadata>>	{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 FeatureOnlineStores.
   *  Format:
   *  `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The FeatureOnlineStore to create.
   */
  // const featureOnlineStore = {}
  /**
   *  Required. The ID to use for this FeatureOnlineStore, which will become the
   *  final component of the FeatureOnlineStore'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 project and location.
   */
  // const featureOnlineStoreId = 'abc123'

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

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

  async function callCreateFeatureOnlineStore() {
    // Construct request
    const request = {
      parent,
      featureOnlineStore,
      featureOnlineStoreId,
    };

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

  callCreateFeatureOnlineStore();

checkCreateFeatureViewProgress(name)

checkCreateFeatureViewProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureView, protos.google.cloud.aiplatform.v1beta1.CreateFeatureViewOperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureView, protos.google.cloud.aiplatform.v1beta1.CreateFeatureViewOperationMetadata>>	{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 FeatureOnlineStore to create
   *  FeatureViews. Format:
   *  `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The FeatureView to create.
   */
  // const featureView = {}
  /**
   *  Required. The ID to use for the FeatureView, which will become the final
   *  component of the FeatureView'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 a FeatureOnlineStore.
   */
  // const featureViewId = 'abc123'
  /**
   *  Immutable. If set to true, one on demand sync will be run immediately,
   *  regardless whether the
   *  FeatureView.sync_config google.cloud.aiplatform.v1beta1.FeatureView.sync_config 
   *  is configured or not.
   */
  // const runSyncImmediately = true

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

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

  async function callCreateFeatureView() {
    // Construct request
    const request = {
      parent,
      featureView,
      featureViewId,
      runSyncImmediately,
    };

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

  callCreateFeatureView();

checkDeleteFeatureOnlineStoreProgress(name)

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

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

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 FeatureOnlineStore to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
   */
  // const name = 'abc123'
  /**
   *  If set to true, any FeatureViews and Features for this FeatureOnlineStore
   *  will also be deleted. (Otherwise, the request will only work if the
   *  FeatureOnlineStore has no FeatureViews.)
   */
  // const force = true

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

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

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

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

  callDeleteFeatureOnlineStore();

checkDeleteFeatureViewProgress(name)

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

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

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 FeatureView to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteFeatureView();

checkUpdateFeatureOnlineStoreProgress(name)

checkUpdateFeatureOnlineStoreProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureOnlineStore, protos.google.cloud.aiplatform.v1beta1.UpdateFeatureOnlineStoreOperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureOnlineStore, protos.google.cloud.aiplatform.v1beta1.UpdateFeatureOnlineStoreOperationMetadata>>	{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 FeatureOnlineStore's `name` field is used to identify the
   *  FeatureOnlineStore to be updated. Format:
   *  `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
   */
  // const featureOnlineStore = {}
  /**
   *  Field mask is used to specify the fields to be overwritten in the
   *  FeatureOnlineStore 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`
   *    * `bigtable`
   *    * `bigtable.auto_scaling`
   *    * `bigtable.enable_multi_region_replica`
   */
  // const updateMask = {}

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

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

  async function callUpdateFeatureOnlineStore() {
    // Construct request
    const request = {
      featureOnlineStore,
    };

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

  callUpdateFeatureOnlineStore();

checkUpdateFeatureViewProgress(name)

checkUpdateFeatureViewProgress(name: string): Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureView, protos.google.cloud.aiplatform.v1beta1.UpdateFeatureViewOperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.aiplatform.v1beta1.FeatureView, protos.google.cloud.aiplatform.v1beta1.UpdateFeatureViewOperationMetadata>>	{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 FeatureView's `name` field is used to identify the
   *  FeatureView to be updated. Format:
   *  `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
   */
  // const featureView = {}
  /**
   *  Field mask is used to specify the fields to be overwritten in the
   *  FeatureView 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`
   *    * `service_agent_type`
   *    * `big_query_source`
   *    * `big_query_source.uri`
   *    * `big_query_source.entity_id_columns`
   *    * `feature_registry_source`
   *    * `feature_registry_source.feature_groups`
   *    * `sync_config`
   *    * `sync_config.cron`
   */
  // const updateMask = {}

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

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

  async function callUpdateFeatureView() {
    // Construct request
    const request = {
      featureView,
    };

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

  callUpdateFeatureView();

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.

createFeatureOnlineStore(request, options)

createFeatureOnlineStore(request?: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOnlineStoreRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureOnlineStore, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOnlineStoreOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new FeatureOnlineStore in a given project and location.

Parameters
Name	Description
request	ICreateFeatureOnlineStoreRequest 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.IFeatureOnlineStore, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOnlineStoreOperationMetadata>, 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 FeatureOnlineStores.
   *  Format:
   *  `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The FeatureOnlineStore to create.
   */
  // const featureOnlineStore = {}
  /**
   *  Required. The ID to use for this FeatureOnlineStore, which will become the
   *  final component of the FeatureOnlineStore'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 project and location.
   */
  // const featureOnlineStoreId = 'abc123'

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

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

  async function callCreateFeatureOnlineStore() {
    // Construct request
    const request = {
      parent,
      featureOnlineStore,
      featureOnlineStoreId,
    };

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

  callCreateFeatureOnlineStore();

createFeatureOnlineStore(request, options, callback)

createFeatureOnlineStore(request: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOnlineStoreRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureOnlineStore, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOnlineStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
void

createFeatureOnlineStore(request, callback)

createFeatureOnlineStore(request: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOnlineStoreRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureOnlineStore, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOnlineStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFeatureOnlineStoreRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureOnlineStore, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureOnlineStoreOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFeatureView(request, options)

createFeatureView(request?: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureViewRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureView, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureViewOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new FeatureView in a given FeatureOnlineStore.

Parameters
Name	Description
request	ICreateFeatureViewRequest 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.IFeatureView, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureViewOperationMetadata>, 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 FeatureOnlineStore to create
   *  FeatureViews. Format:
   *  `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The FeatureView to create.
   */
  // const featureView = {}
  /**
   *  Required. The ID to use for the FeatureView, which will become the final
   *  component of the FeatureView'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 a FeatureOnlineStore.
   */
  // const featureViewId = 'abc123'
  /**
   *  Immutable. If set to true, one on demand sync will be run immediately,
   *  regardless whether the
   *  FeatureView.sync_config google.cloud.aiplatform.v1beta1.FeatureView.sync_config 
   *  is configured or not.
   */
  // const runSyncImmediately = true

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

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

  async function callCreateFeatureView() {
    // Construct request
    const request = {
      parent,
      featureView,
      featureViewId,
      runSyncImmediately,
    };

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

  callCreateFeatureView();

createFeatureView(request, options, callback)

createFeatureView(request: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureViewRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureView, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureViewOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
void

createFeatureView(request, callback)

createFeatureView(request: protos.google.cloud.aiplatform.v1beta1.ICreateFeatureViewRequest, callback: Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureView, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureViewOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFeatureViewRequest
callback	Callback<LROperation<protos.google.cloud.aiplatform.v1beta1.IFeatureView, protos.google.cloud.aiplatform.v1beta1.ICreateFeatureViewOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

customJobPath(project, location, customJob)

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

Return a fully-qualified customJob resource name string.

Parameters
Name	Description
project	string
location	string
customJob	string

Returns
Type	Description
string	{string} Resource name string.

dataItemPath(project, location, dataset, dataItem)

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

Return a fully-qualified dataItem resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
dataItem	string

Returns
Type	Description
string	{string} Resource name string.

dataLabelingJobPath(project, location, dataLabelingJob)

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

Return a fully-qualified dataLabelingJob resource name string.

Parameters
Name	Description
project	string
location	string
dataLabelingJob	string

Returns
Type	Description
string	{string} Resource name string.

datasetPath(project, location, dataset)

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

Return a fully-qualified dataset resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string

Returns
Type	Description
string	{string} Resource name string.

datasetVersionPath(project, location, dataset, datasetVersion)

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

Return a fully-qualified datasetVersion resource name string.

Parameters
Name	Description
project	string
location	string
dataset	string
datasetVersion	string

Returns
Type	Description
string	{string} Resource name string.

deleteFeatureOnlineStore(request, options)

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

Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.

Parameters
Name	Description
request	IDeleteFeatureOnlineStoreRequest 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 FeatureOnlineStore to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
   */
  // const name = 'abc123'
  /**
   *  If set to true, any FeatureViews and Features for this FeatureOnlineStore
   *  will also be deleted. (Otherwise, the request will only work if the
   *  FeatureOnlineStore has no FeatureViews.)
   */
  // const force = true

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

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

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

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

  callDeleteFeatureOnlineStore();

deleteFeatureOnlineStore(request, options, callback)

deleteFeatureOnlineStore(request: protos.google.cloud.aiplatform.v1beta1.IDeleteFeatureOnlineStoreRequest, 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	IDeleteFeatureOnlineStoreRequest
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

deleteFeatureOnlineStore(request, callback)

deleteFeatureOnlineStore(request: protos.google.cloud.aiplatform.v1beta1.IDeleteFeatureOnlineStoreRequest, 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	IDeleteFeatureOnlineStoreRequest
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

deleteFeatureView(request, options)

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

Deletes a single FeatureView.

Parameters
Name	Description
request	IDeleteFeatureViewRequest 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 FeatureView to be deleted.
   *  Format:
   *  `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteFeatureView();

deleteFeatureView(request, options, callback)

deleteFeatureView(request: protos.google.cloud.aiplatform.v1beta1.IDeleteFeatureViewRequest, 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	IDeleteFeatureViewRequest
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

deleteFeatureView(request, callback)

deleteFeatureView(request: protos.google.cloud.aiplatform.v1beta1.IDeleteFeatureViewRequest, 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	IDeleteFeatureViewRequest
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.

getFeatureOnlineStore(request, options)

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

Gets details of a single FeatureOnlineStore.

Parameters
Name	Description
request	IGetFeatureOnlineStoreRequest 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.IFeatureOnlineStore, protos.google.cloud.aiplatform.v1beta1.IGetFeatureOnlineStoreRequest | 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 FeatureOnlineStore resource.
   */
  // const name = 'abc123'

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

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

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

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

  callGetFeatureOnlineStore();

getFeatureOnlineStore(request, options, callback)

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

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

Returns
Type	Description
void

getFeatureOnlineStore(request, callback)

getFeatureOnlineStore(request: protos.google.cloud.aiplatform.v1beta1.IGetFeatureOnlineStoreRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureOnlineStore, protos.google.cloud.aiplatform.v1beta1.IGetFeatureOnlineStoreRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
void

getFeatureView(request, options)

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

Gets details of a single FeatureView.

Parameters
Name	Description
request	IGetFeatureViewRequest 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.IFeatureView, protos.google.cloud.aiplatform.v1beta1.IGetFeatureViewRequest | 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 FeatureView resource.
   *  Format:
   *  `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetFeatureView();

getFeatureView(request, options, callback)

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

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

Returns
Type	Description
void

getFeatureView(request, callback)

getFeatureView(request: protos.google.cloud.aiplatform.v1beta1.IGetFeatureViewRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureView, protos.google.cloud.aiplatform.v1beta1.IGetFeatureViewRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
void

getFeatureViewSync(request, options)

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

Gets details of a single FeatureViewSync.

Parameters
Name	Description
request	IGetFeatureViewSyncRequest 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.IFeatureViewSync, protos.google.cloud.aiplatform.v1beta1.IGetFeatureViewSyncRequest | 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 FeatureViewSync resource.
   *  Format:
   *  `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetFeatureViewSync();

getFeatureViewSync(request, options, callback)

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

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

Returns
Type	Description
void

getFeatureViewSync(request, callback)

getFeatureViewSync(request: protos.google.cloud.aiplatform.v1beta1.IGetFeatureViewSyncRequest, callback: Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureViewSync, protos.google.cloud.aiplatform.v1beta1.IGetFeatureViewSyncRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFeatureViewSyncRequest
callback	Callback<protos.google.cloud.aiplatform.v1beta1.IFeatureViewSync, protos.google.cloud.aiplatform.v1beta1.IGetFeatureViewSyncRequest | 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.

listFeatureOnlineStores(request, options)

listFeatureOnlineStores(request?: protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IFeatureOnlineStore[],
        protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresRequest | null,
        protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresResponse
    ]>;

Lists FeatureOnlineStores in a given project and location.

Parameters
Name	Description
request	IListFeatureOnlineStoresRequest 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.IFeatureOnlineStore[], protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresRequest | null, protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresResponse ]>	{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 listFeatureOnlineStoresAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFeatureOnlineStores(request, options, callback)

listFeatureOnlineStores(request: protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureOnlineStore>): void;

Parameters
Name	Description
request	IListFeatureOnlineStoresRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureOnlineStore>

Returns
Type	Description
void

listFeatureOnlineStores(request, callback)

listFeatureOnlineStores(request: protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureOnlineStore>): void;

Parameters
Name	Description
request	IListFeatureOnlineStoresRequest
callback	PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureOnlineStore>

Returns
Type	Description
void

listFeatureOnlineStoresAsync(request, options)

listFeatureOnlineStoresAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListFeatureOnlineStoresRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IFeatureOnlineStore>;

Equivalent to listFeatureOnlineStores, but returns an iterable object.

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

Parameters
Name	Description
request	IListFeatureOnlineStoresRequest 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.IFeatureOnlineStore>	{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 FeatureOnlineStores.
   *  Format:
   *  `projects/{project}/locations/{location}`
   */
  // const parent = 'abc123'
  /**
   *  Lists the FeatureOnlineStores 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"`
   *     FeatureOnlineStores created or updated after 2020-01-01.
   *  * `labels.env = "prod"`
   *     FeatureOnlineStores with label "env" set to "prod".
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of FeatureOnlineStores to return. The service may return
   *  fewer than this value. If unspecified, at most 100 FeatureOnlineStores 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
   *  FeatureOnlineStoreAdminService.ListFeatureOnlineStores google.cloud.aiplatform.v1beta1.FeatureOnlineStoreAdminService.ListFeatureOnlineStores 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  FeatureOnlineStoreAdminService.ListFeatureOnlineStores google.cloud.aiplatform.v1beta1.FeatureOnlineStoreAdminService.ListFeatureOnlineStores 
   *  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 {FeatureOnlineStoreAdminServiceClient} = require('@google-cloud/aiplatform').v1beta1;

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

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

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

  callListFeatureOnlineStores();

listFeatureOnlineStoresStream(request, options)

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

Equivalent to listFeatureOnlineStores, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListFeatureOnlineStoresRequest 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 listFeatureOnlineStoresAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFeatureViews(request, options)

listFeatureViews(request?: protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IFeatureView[],
        protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsRequest | null,
        protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsResponse
    ]>;

Lists FeatureViews in a given FeatureOnlineStore.

Parameters
Name	Description
request	IListFeatureViewsRequest 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.IFeatureView[], protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsRequest | null, protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsResponse ]>	{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 listFeatureViewsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFeatureViews(request, options, callback)

listFeatureViews(request: protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureView>): void;

Parameters
Name	Description
request	IListFeatureViewsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureView>

Returns
Type	Description
void

listFeatureViews(request, callback)

listFeatureViews(request: protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureView>): void;

Parameters
Name	Description
request	IListFeatureViewsRequest
callback	PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureView>

Returns
Type	Description
void

listFeatureViewsAsync(request, options)

listFeatureViewsAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListFeatureViewsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IFeatureView>;

Equivalent to listFeatureViews, but returns an iterable object.

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

Parameters
Name	Description
request	IListFeatureViewsRequest 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.IFeatureView>	{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 FeatureOnlineStore to list FeatureViews.
   *  Format:
   *  `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
   */
  // const parent = 'abc123'
  /**
   *  Lists the FeatureViews that match the filter expression. The following
   *  filters 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="" as="" well="" as="" key="" presence.="" *="" examples:="" *="" *="" `create_time=""> \"2020-01-31T15:30:00.000000Z\" OR
   *       update_time > \"2020-01-31T15:30:00.000000Z\"` --> FeatureViews
   *       created or updated after 2020-01-31T15:30:00.000000Z.
   *  * `labels.active = yes AND labels.env = prod` --> FeatureViews having both
   *      (active: yes) and (env: prod) labels.
   *  * `labels.env: *` --> Any FeatureView which has a label with 'env' as the
   *    key.
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of FeatureViews to return. The service may return fewer
   *  than this value. If unspecified, at most 1000 FeatureViews will be
   *  returned. The maximum value is 1000; any value greater than 1000 will be
   *  coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous
   *  FeatureOnlineStoreAdminService.ListFeatureViews google.cloud.aiplatform.v1beta1.FeatureOnlineStoreAdminService.ListFeatureViews 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  FeatureOnlineStoreAdminService.ListFeatureViews google.cloud.aiplatform.v1beta1.FeatureOnlineStoreAdminService.ListFeatureViews 
   *  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:
   *    * `feature_view_id`
   *    * `create_time`
   *    * `update_time`
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListFeatureViews();

listFeatureViewsStream(request, options)

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

Equivalent to listFeatureViews, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListFeatureViewsRequest 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 listFeatureViewsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFeatureViewSyncs(request, options)

listFeatureViewSyncs(request?: protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.aiplatform.v1beta1.IFeatureViewSync[],
        protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsRequest | null,
        protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsResponse
    ]>;

Lists FeatureViewSyncs in a given FeatureView.

Parameters
Name	Description
request	IListFeatureViewSyncsRequest 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.IFeatureViewSync[], protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsRequest | null, protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsResponse ]>	{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 listFeatureViewSyncsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFeatureViewSyncs(request, options, callback)

listFeatureViewSyncs(request: protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureViewSync>): void;

Parameters
Name	Description
request	IListFeatureViewSyncsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureViewSync>

Returns
Type	Description
void

listFeatureViewSyncs(request, callback)

listFeatureViewSyncs(request: protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsRequest, callback: PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureViewSync>): void;

Parameters
Name	Description
request	IListFeatureViewSyncsRequest
callback	PaginationCallback<protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsRequest, protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsResponse | null | undefined, protos.google.cloud.aiplatform.v1beta1.IFeatureViewSync>

Returns
Type	Description
void

listFeatureViewSyncsAsync(request, options)

listFeatureViewSyncsAsync(request?: protos.google.cloud.aiplatform.v1beta1.IListFeatureViewSyncsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.aiplatform.v1beta1.IFeatureViewSync>;

Equivalent to listFeatureViewSyncs, but returns an iterable object.

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

Parameters
Name	Description
request	IListFeatureViewSyncsRequest 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.IFeatureViewSync>	{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 FeatureView to list FeatureViewSyncs.
   *  Format:
   *  `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
   */
  // const parent = 'abc123'
  /**
   *  Lists the FeatureViewSyncs that match the filter expression. The following
   *  filters are supported:
   *  * `create_time`: Supports `=`, `!=`, `<`, `="">`, `>=`, and `<=` comparisons.="" *="" values="" must="" be="" in="" rfc="" 3339="" format.="" *="" examples:="" *="" *="" `create_time=""> \"2020-01-31T15:30:00.000000Z\"` --> FeatureViewSyncs
   *       created after 2020-01-31T15:30:00.000000Z.
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of FeatureViewSyncs to return. The service may return
   *  fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will
   *  be returned. The maximum value is 1000; any value greater than 1000 will be
   *  coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous
   *  FeatureOnlineStoreAdminService.ListFeatureViewSyncs google.cloud.aiplatform.v1beta1.FeatureOnlineStoreAdminService.ListFeatureViewSyncs 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  FeatureOnlineStoreAdminService.ListFeatureViewSyncs google.cloud.aiplatform.v1beta1.FeatureOnlineStoreAdminService.ListFeatureViewSyncs 
   *  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`
   */
  // const orderBy = 'abc123'

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

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

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

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

  callListFeatureViewSyncs();

listFeatureViewSyncsStream(request, options)

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

Equivalent to listFeatureViewSyncs, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListFeatureViewSyncsRequest 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 listFeatureViewSyncsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, options)

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

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

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

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

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

Example

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

listOperationsAsync(request, options)

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

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

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

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

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

Example

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

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	{string} Resource name string.

matchAnnotationFromAnnotationName(annotationName)

matchAnnotationFromAnnotationName(annotationName: string): string | number;

Parse the annotation from Annotation resource.

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

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

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName)

matchAnnotationSpecFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the annotation_spec from AnnotationSpec resource.

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

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

matchArtifactFromArtifactName(artifactName)

matchArtifactFromArtifactName(artifactName: string): string | number;

Parse the artifact from Artifact resource.

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

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

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName)

matchBatchPredictionJobFromBatchPredictionJobName(batchPredictionJobName: string): string | number;

Parse the batch_prediction_job from BatchPredictionJob resource.

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

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

matchCachedContentFromCachedContentName(cachedContentName)

matchCachedContentFromCachedContentName(cachedContentName: string): string | number;

Parse the cached_content from CachedContent resource.

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

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

matchContextFromContextName(contextName)

matchContextFromContextName(contextName: string): string | number;

Parse the context from Context resource.

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

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

matchCustomJobFromCustomJobName(customJobName)

matchCustomJobFromCustomJobName(customJobName: string): string | number;

Parse the custom_job from CustomJob resource.

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

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

matchDataItemFromAnnotationName(annotationName)

matchDataItemFromAnnotationName(annotationName: string): string | number;

Parse the data_item from Annotation resource.

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

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

matchDataItemFromDataItemName(dataItemName)

matchDataItemFromDataItemName(dataItemName: string): string | number;

Parse the data_item from DataItem resource.

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

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

matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName)

matchDataLabelingJobFromDataLabelingJobName(dataLabelingJobName: string): string | number;

Parse the data_labeling_job from DataLabelingJob resource.

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

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

matchDatasetFromAnnotationName(annotationName)

matchDatasetFromAnnotationName(annotationName: string): string | number;

Parse the dataset from Annotation resource.

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

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

matchDatasetFromAnnotationSpecName(annotationSpecName)

matchDatasetFromAnnotationSpecName(annotationSpecName: string): string | number;

Parse the dataset from AnnotationSpec resource.

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

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

matchDatasetFromDataItemName(dataItemName)

matchDatasetFromDataItemName(dataItemName: string): string | number;

Parse the dataset from DataItem resource.

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

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

matchDatasetFromDatasetName(datasetName)

matchDatasetFromDatasetName(datasetName: string): string | number;

Parse the dataset from Dataset resource.

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

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

matchDatasetFromDatasetVersionName(datasetVersionName)

matchDatasetFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the dataset from DatasetVersion resource.

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

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

matchDatasetFromSavedQueryName(savedQueryName)

matchDatasetFromSavedQueryName(savedQueryName: string): string | number;

Parse the dataset from SavedQuery resource.

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

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

matchDatasetVersionFromDatasetVersionName(datasetVersionName)

matchDatasetVersionFromDatasetVersionName(datasetVersionName: string): string | number;

Parse the dataset_version from DatasetVersion resource.

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

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

matchDeploymentResourcePoolFromDeploymentResourcePoolName(deploymentResourcePoolName)

matchDeploymentResourcePoolFromDeploymentResourcePoolName(deploymentResourcePoolName: string): string | number;

Parse the deployment_resource_pool from DeploymentResourcePool resource.

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

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

matchEndpointFromProjectLocationEndpointName(projectLocationEndpointName)

matchEndpointFromProjectLocationEndpointName(projectLocationEndpointName: string): string | number;

Parse the endpoint from ProjectLocationEndpoint resource.

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

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

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

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

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

matchEntityTypeFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName)

matchEntityTypeFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName: string): string | number;

Parse the entity_type from ProjectLocationFeaturestoreEntityTypeFeatures resource.

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

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

matchEvaluationFromModelEvaluationName(modelEvaluationName)

matchEvaluationFromModelEvaluationName(modelEvaluationName: string): string | number;

Parse the evaluation from ModelEvaluation resource.

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

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

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName)

matchEvaluationFromModelEvaluationSliceName(modelEvaluationSliceName: string): string | number;

Parse the evaluation from ModelEvaluationSlice resource.

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

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

matchEventFromSessionEventName(sessionEventName)

matchEventFromSessionEventName(sessionEventName: string): string | number;

Parse the event from SessionEvent resource.

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

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

matchExampleStoreFromExampleStoreName(exampleStoreName)

matchExampleStoreFromExampleStoreName(exampleStoreName: string): string | number;

Parse the example_store from ExampleStore resource.

Parameter
Name	Description
exampleStoreName	string A fully-qualified path representing ExampleStore resource.

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

matchExecutionFromExecutionName(executionName)

matchExecutionFromExecutionName(executionName: string): string | number;

Parse the execution from Execution resource.

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

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

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName)

matchExperimentFromTensorboardExperimentName(tensorboardExperimentName: string): string | number;

Parse the experiment from TensorboardExperiment resource.

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

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

matchExperimentFromTensorboardRunName(tensorboardRunName)

matchExperimentFromTensorboardRunName(tensorboardRunName: string): string | number;

Parse the experiment from TensorboardRun resource.

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

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

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName)

matchExperimentFromTensorboardTimeSeriesName(tensorboardTimeSeriesName: string): string | number;

Parse the experiment from TensorboardTimeSeries resource.

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

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

matchExtensionFromExtensionName(extensionName)

matchExtensionFromExtensionName(extensionName: string): string | number;

Parse the extension from Extension resource.

Parameter
Name	Description
extensionName	string A fully-qualified path representing Extension resource.

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

matchFeatureFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName)

matchFeatureFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName: string): string | number;

Parse the feature from ProjectLocationFeatureGroupFeatures resource.

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

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

matchFeatureFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName)

matchFeatureFromProjectLocationFeaturestoreEntityTypeFeaturesName(projectLocationFeaturestoreEntityTypeFeaturesName: string): string | number;

Parse the feature from ProjectLocationFeaturestoreEntityTypeFeatures resource.

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

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

matchFeatureGroupFromFeatureGroupName(featureGroupName)

matchFeatureGroupFromFeatureGroupName(featureGroupName: string): string | number;

Parse the feature_group from FeatureGroup resource.

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

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

matchFeatureGroupFromFeatureMonitorJobName(featureMonitorJobName)

matchFeatureGroupFromFeatureMonitorJobName(featureMonitorJobName: string): string | number;

Parse the feature_group from FeatureMonitorJob resource.

Parameter
Name	Description
featureMonitorJobName	string A fully-qualified path representing FeatureMonitorJob resource.

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

matchFeatureGroupFromFeatureMonitorName(featureMonitorName)

matchFeatureGroupFromFeatureMonitorName(featureMonitorName: string): string | number;

Parse the feature_group from FeatureMonitor resource.

Parameter
Name	Description
featureMonitorName	string A fully-qualified path representing FeatureMonitor resource.

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

matchFeatureGroupFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName)

matchFeatureGroupFromProjectLocationFeatureGroupFeaturesName(projectLocationFeatureGroupFeaturesName: string): string | number;

Parse the feature_group from ProjectLocationFeatureGroupFeatures resource.

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

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

matchFeatureMonitorFromFeatureMonitorJobName(featureMonitorJobName)

matchFeatureMonitorFromFeatureMonitorJobName(featureMonitorJobName: string): string | number;

Parse the feature_monitor from FeatureMonitorJob resource.

Parameter
Name	Description
featureMonitorJobName	string A fully-qualified path representing FeatureMonitorJob resource.

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

matchFeatureMonitorFromFeatureMonitorName(featureMonitorName)

matchFeatureMonitorFromFeatureMonitorName(featureMonitorName: string): string | number;

Parse the feature_monitor from FeatureMonitor resource.

Parameter
Name	Description
featureMonitorName	string A fully-qualified path representing FeatureMonitor resource.

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

matchFeatureMonitorJobFromFeatureMonitorJobName(featureMonitorJobName)

matchFeatureMonitorJobFromFeatureMonitorJobName(featureMonitorJobName: string): string | number;

Parse the feature_monitor_job from FeatureMonitorJob resource.

Parameter
Name	Description
featureMonitorJobName	string A fully-qualified path representing FeatureMonitorJob resource.

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

matchFeatureOnlineStoreFromFeatureOnlineStoreName(featureOnlineStoreName)

matchFeatureOnlineStoreFromFeatureOnlineStoreName(featureOnlineStoreName: string): string | number;

Parse the feature_online_store from FeatureOnlineStore resource.

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

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

matchFeatureOnlineStoreFromFeatureViewName(featureViewName)

matchFeatureOnlineStoreFromFeatureViewName(featureViewName: string): string | number;

Parse the feature_online_store from FeatureView resource.

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

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

matchFeatureOnlineStoreFromFeatureViewSyncName(featureViewSyncName)

matchFeatureOnlineStoreFromFeatureViewSyncName(featureViewSyncName: string): string | number;

Parse the feature_online_store from FeatureViewSync resource.

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

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

matchFeaturestoreFromEntityTypeName(entityTypeName)

matchFeaturestoreFromEntityTypeName(entityTypeName: string): string | number;

Parse the featurestore from EntityType resource.

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

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

matchFeaturestoreFromFeaturestoreName(featurestoreName)

matchFeaturestoreFromFeaturestoreName(featurestoreName: string): string | number;

Parse the featurestore from Featurestore resource.

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

Returns
Type	Description