google.cloud.gcp_vertexai_feature_online_store_info module – List VertexAI.FeatureOnlineStore resources

Note

This module is part of the google.cloud collection (version 1.15.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install google.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: google.cloud.gcp_vertexai_feature_online_store_info.

Synopsis

  • Vertex AI Feature Online Store provides a centralized repository for serving ML features and embedding indexes at low latency. The Feature Online Store is a top-level container.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.8

  • requests >= 2.18.4

  • google-auth >= 2.25.1

Parameters

Parameter

Comments

access_token

string

The access token used to authenticate.

auth_kind

string / required

The type of credential used.

Choices:

  • "accesstoken"

  • "application"

  • "machineaccount"

  • "serviceaccount"

env_type

string

Specifies which Ansible environment you’re running this module within.

This should not be set unless you know what you’re doing.

This only alters the User Agent string for any API requests.

filters

list / elements=string

A list of filter expression strings used to filter the resources returned by the API.

Each string is a filter expression (e.g. some_field = "SOME_VALUE").

Multiple expressions are combined with a logical AND.

Refer to the filter topic documentation https://cloud.google.com/sdk/gcloud/reference/topic/filters.

Refer to the AIP-160 filter syntax documentation https://google.aip.dev/160.

project

string

The Google Cloud Platform project to use.

region

string

The region of feature online store.

eg us-central1.

scopes

list / elements=string

Array of scopes to be used.

service_account_contents

jsonarg

The contents of a Service Account JSON file,

either in a dictionary or as a JSON string that represents it.

service_account_email

string

An optional service account email address if machineaccount is

selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount

is selected as type.

Notes

Note

Examples

- name: List all gcp_vertexai_feature_online_store_info resources
  google.cloud.gcp_vertexai_feature_online_store_info:
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
  register: result

- name: List gcp_vertexai_feature_online_store_info resources matching given filters
  google.cloud.gcp_vertexai_feature_online_store_info:
    filters:
      - display_name = "my-resource"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Whether any changes were made (always false for info modules).

Returned: always

resources

list / elements=dictionary

List of VertexAI.FeatureOnlineStore resources matching the supplied filters. May be empty, contain a single resource, or multiple resources.

Returned: always

bigtable

dictionary

Settings for Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore.

Returned: when set

autoScaling

dictionary

Autoscaling config applied to Bigtable Instance.

Returned: always

cpuUtilizationTarget

integer

A percentage of the cluster’s CPU capacity.

Can be from 10% to 80%.

When a cluster’s CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster.

When CPU utilization is substantially lower than the target, Bigtable removes nodes.

If not set will default to 50%.

Returned: when set

maxNodeCount

integer

The maximum number of nodes to scale up to.

Must be greater than or equal to minNodeCount, and less than or equal to 10 times of ‘minNodeCount’.

Returned: always

minNodeCount

integer

The minimum number of nodes to scale down to.

Must be greater than or equal to 1.

Returned: always

enableDirectBigtableAccess

boolean

If true, enable direct access to the Bigtable instance.

Returned: when set

zone

string

The zone where the Bigtable instance will be created.

Returned: when set

createTime

string

The timestamp of when the feature online store was created in RFC3339 UTC “Zulu” format, with nanosecond resolution and up to nine fractional digits.

Returned: success

dedicatedServingEndpoint

dictionary

The dedicated serving endpoint for this FeatureOnlineStore, which is different from common vertex service endpoint.

Only need to be set when you choose Optimized storage type or enable EmbeddingManagement.

Will use public endpoint by default.

Returned: when set

privateServiceConnectConfig

dictionary

Private service connect config.

Returned: when set

enablePrivateServiceConnect

boolean

If set to true, customers will use private service connection to send request.

Otherwise, the connection will set to public endpoint.

Returned: always

projectAllowlist

list / elements=string

A list of Projects from which the forwarding rule will target the service attachment.

Returned: when set

publicEndpointDomainName

string

Domain name to use for this FeatureOnlineStore.

Returned: success

serviceAttachment

string

Name of the service attachment resource.

Applicable only if private service connect is enabled and after FeatureViewSync is created.

Returned: success

embeddingManagement

dictionary

The settings for embedding management in FeatureOnlineStore.

Embedding management can only be set for BigTable.

It is enabled by default for optimized storagetype.

Returned: when set

enabled

boolean

Enable embedding management.

Returned: when set

encryptionSpec

dictionary

If set, both of the online and offline data storage will be secured by this key.

Returned: when set

kmsKeyName

string

The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource.

Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key.

The key needs to be in the same region as where the compute resource is created.

Returned: always

labels

dictionary

The labels with user-defined metadata to organize your feature online stores.

**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.

Returned: when set

optimized

dictionary

Settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore.

Returned: when set

state

string

The state of the Feature Online Store.

See the possible states in [this link](https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.featureOnlineStores#state).

Returned: success

updateTime

string

The timestamp of when the feature online store was last updated in RFC3339 UTC “Zulu” format, with nanosecond resolution and up to nine fractional digits.

Returned: success

Authors

  • Google Inc. (@googlecloudplatform)