vertex_ai library

Vertex AI — Feature Store (legacy featurestore / entity type / feature) plus feature groups (BigQuery-backed), managed datasets, experiment Tensorboards (with experiments and runs), pipeline schedules, GenAI cache config, online prediction endpoints, shared deployment resource pools, and Vector Search indexes / index endpoints (plus deployed indexes). Nested config blocks (e.g. encryption_spec) are passed as structured maps.

Classes

GoogleMlEngineModel

Factory wrapper for google_ml_engine_model.

GoogleVertexAiCacheConfig

Factory wrapper for google_vertex_ai_cache_config.

GoogleVertexAiDataset

Factory wrapper for google_vertex_ai_dataset.

GoogleVertexAiDeploymentResourcePool

Factory wrapper for google_vertex_ai_deployment_resource_pool.

GoogleVertexAiEndpoint

Factory wrapper for google_vertex_ai_endpoint.

GoogleVertexAiEndpointWithModelGardenDeployment

Factory wrapper for google_vertex_ai_endpoint_with_model_garden_deployment.

GoogleVertexAiFeatureGroup

Factory wrapper for google_vertex_ai_feature_group.

GoogleVertexAiFeatureGroupFeature

Factory wrapper for google_vertex_ai_feature_group_feature.

GoogleVertexAiFeatureOnlineStore

Factory wrapper for google_vertex_ai_feature_online_store.

GoogleVertexAiFeatureOnlineStoreFeatureview

Factory wrapper for google_vertex_ai_feature_online_store_featureview.

GoogleVertexAiFeaturestore

Factory wrapper for google_vertex_ai_featurestore.

GoogleVertexAiFeaturestoreEntitytype

Factory wrapper for google_vertex_ai_featurestore_entitytype.

GoogleVertexAiFeaturestoreEntitytypeFeature

Factory wrapper for google_vertex_ai_featurestore_entitytype_feature.

GoogleVertexAiIndex

Factory wrapper for google_vertex_ai_index.

GoogleVertexAiIndexEndpoint

Factory wrapper for google_vertex_ai_index_endpoint.

GoogleVertexAiIndexEndpointDeployedIndex

Factory wrapper for google_vertex_ai_index_endpoint_deployed_index.

GoogleVertexAiPersistentResource

Factory wrapper for google_vertex_ai_persistent_resource.

GoogleVertexAiRagEngineConfig

Factory wrapper for google_vertex_ai_rag_engine_config.

GoogleVertexAiReasoningEngine

Factory wrapper for google_vertex_ai_reasoning_engine.

GoogleVertexAiReasoningEngineIamBinding

Factory wrapper for google_vertex_ai_reasoning_engine_iam_binding.

GoogleVertexAiReasoningEngineIamMember

Factory wrapper for google_vertex_ai_reasoning_engine_iam_member.

GoogleVertexAiReasoningEngineIamPolicy

Factory wrapper for google_vertex_ai_reasoning_engine_iam_policy.

GoogleVertexAiSchedule

Factory wrapper for google_vertex_ai_schedule.

GoogleVertexAiSemanticGovernancePolicyEngine

Factory wrapper for google_vertex_ai_semantic_governance_policy_engine.

GoogleVertexAiTensorboard

Factory wrapper for google_vertex_ai_tensorboard.

GoogleVertexAiTensorboardExperiment

Factory wrapper for google_vertex_ai_tensorboard_experiment.

GoogleVertexAiTensorboardRun

Factory wrapper for google_vertex_ai_tensorboard_run.

MlEngineModelDefaultVersion

Typed helper for the default_version block of google_ml_engine_model (derived from provider schema).

VertexAiDeploymentResourcePoolDedicatedResources

Typed helper for the dedicated_resources block of google_vertex_ai_deployment_resource_pool (derived from provider schema).

VertexAiDeploymentResourcePoolDedicatedResourcesAutoscalingMetricSpecs

Typed helper for the dedicated_resources.autoscaling_metric_specs block of google_vertex_ai_deployment_resource_pool (derived from provider schema).

VertexAiDeploymentResourcePoolDedicatedResourcesMachineSpec

Typed helper for the dedicated_resources.machine_spec block of google_vertex_ai_deployment_resource_pool (derived from provider schema).

VertexAiEndpointEncryptionSpec

Typed helper for the encryption_spec block of google_vertex_ai_endpoint (derived from provider schema).

VertexAiEndpointPredictRequestResponseLoggingConfig

Typed helper for the predict_request_response_logging_config block of google_vertex_ai_endpoint (derived from provider schema).

VertexAiEndpointPredictRequestResponseLoggingConfigBigqueryDestination

Typed helper for the predict_request_response_logging_config.bigquery_destination block of google_vertex_ai_endpoint (derived from provider schema).

VertexAiEndpointPrivateServiceConnectConfig

Typed helper for the private_service_connect_config block of google_vertex_ai_endpoint (derived from provider schema).

VertexAiEndpointPrivateServiceConnectConfigPscAutomationConfigs

Typed helper for the private_service_connect_config.psc_automation_configs block of google_vertex_ai_endpoint (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentDeployConfig

Typed helper for the deploy_config block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentDeployConfigDedicatedResources

Typed helper for the deploy_config.dedicated_resources block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentDeployConfigDedicatedResourcesAutoscalingMetricSpecs

Typed helper for the deploy_config.dedicated_resources.autoscaling_metric_specs block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentDeployConfigDedicatedResourcesMachineSpec

Typed helper for the deploy_config.dedicated_resources.machine_spec block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentDeployConfigDedicatedResourcesMachineSpecReservationAffinity

Typed helper for the deploy_config.dedicated_resources.machine_spec.reservation_affinity block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentEndpointConfig

Typed helper for the endpoint_config block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentEndpointConfigPrivateServiceConnectConfig

Typed helper for the endpoint_config.private_service_connect_config block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentEndpointConfigPrivateServiceConnectConfigPscAutomationConfigs

Typed helper for the endpoint_config.private_service_connect_config.psc_automation_configs block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentHuggingFaceModel

Hugging Face model id (e.g. google/gemma-2-2b-it).

VertexAiEndpointWithModelGardenDeploymentModel

Model identity for GoogleVertexAiEndpointWithModelGardenDeployment. Sealed so the MM exactly_one_of (publisher_model_name / hugging_face_model_id) is exhaustive at the type level.

VertexAiEndpointWithModelGardenDeploymentModelConfig

Typed helper for the model_config block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpec

Typed helper for the model_config.container_spec block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecEnv

Typed helper for the model_config.container_spec.env block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecGrpcPorts

Typed helper for the model_config.container_spec.grpc_ports block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecHealthProbe

Typed helper for the model_config.container_spec.health_probe block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecHealthProbeExec

Typed helper for the model_config.container_spec.health_probe.exec block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecHealthProbeGrpc

Typed helper for the model_config.container_spec.health_probe.grpc block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecHealthProbeHttpGet

Typed helper for the model_config.container_spec.health_probe.http_get block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecHealthProbeHttpGetHttpHeaders

Typed helper for the model_config.container_spec.health_probe.http_get.http_headers block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecHealthProbeTcpSocket

Typed helper for the model_config.container_spec.health_probe.tcp_socket block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecLivenessProbe

Typed helper for the model_config.container_spec.liveness_probe block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecLivenessProbeExec

Typed helper for the model_config.container_spec.liveness_probe.exec block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecLivenessProbeGrpc

Typed helper for the model_config.container_spec.liveness_probe.grpc block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecLivenessProbeHttpGet

Typed helper for the model_config.container_spec.liveness_probe.http_get block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecLivenessProbeHttpGetHttpHeaders

Typed helper for the model_config.container_spec.liveness_probe.http_get.http_headers block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecLivenessProbeTcpSocket

Typed helper for the model_config.container_spec.liveness_probe.tcp_socket block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecPorts

Typed helper for the model_config.container_spec.ports block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecStartupProbe

Typed helper for the model_config.container_spec.startup_probe block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecStartupProbeExec

Typed helper for the model_config.container_spec.startup_probe.exec block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecStartupProbeGrpc

Typed helper for the model_config.container_spec.startup_probe.grpc block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecStartupProbeHttpGet

Typed helper for the model_config.container_spec.startup_probe.http_get block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecStartupProbeHttpGetHttpHeaders

Typed helper for the model_config.container_spec.startup_probe.http_get.http_headers block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentModelConfigContainerSpecStartupProbeTcpSocket

Typed helper for the model_config.container_spec.startup_probe.tcp_socket block of google_vertex_ai_endpoint_with_model_garden_deployment (derived from provider schema).

VertexAiEndpointWithModelGardenDeploymentPublisherModel

Model Garden publisher model path (publishers/{publisher}/models/{model}@{version}).

VertexAiFeatureOnlineStoreBigtable

bigtable storage — Cloud Bigtable instance with required autoscaling.

VertexAiFeatureOnlineStoreBigtableAutoScaling

Autoscaling config under VertexAiFeatureOnlineStoreBigtable (auto_scaling list max 1).

VertexAiFeatureOnlineStoreFeatureviewBigQuerySource

big_query_source — materialize a BigQuery view on each sync.

VertexAiFeatureOnlineStoreFeatureviewFeatureGroup

One Feature Registry group entry under VertexAiFeatureOnlineStoreFeatureviewFeatureRegistrySource.

VertexAiFeatureOnlineStoreFeatureviewFeatureRegistrySource

feature_registry_source — sync selected Feature Registry features.

VertexAiFeatureOnlineStoreFeatureviewSource

Data source for GoogleVertexAiFeatureOnlineStoreFeatureview. Sealed so the MM exactly_one_of (big_query_source / feature_registry_source) is exhaustive at the type level.

VertexAiFeatureOnlineStoreFeatureviewSyncConfig

Optional sync_config block (cron and/or continuous).

VertexAiFeatureOnlineStoreOptimized

optimized storage — empty object (allow_empty_object in MM).

VertexAiFeatureOnlineStoreStorage

Online serving storage for GoogleVertexAiFeatureOnlineStore. Sealed so the MM exactly_one_of (bigtable / optimized) is exhaustive at the type level.

VertexAiFeaturestoreEncryptionSpec

Typed helper for the encryption_spec block of google_vertex_ai_featurestore (derived from provider schema).

VertexAiFeaturestoreEntitytypeMonitoringConfig

Typed helper for the monitoring_config block of google_vertex_ai_featurestore_entitytype (derived from provider schema).

VertexAiFeaturestoreEntitytypeMonitoringConfigCategoricalThresholdConfig

Typed helper for the monitoring_config.categorical_threshold_config block of google_vertex_ai_featurestore_entitytype (derived from provider schema).

VertexAiFeaturestoreEntitytypeMonitoringConfigImportFeaturesAnalysis

Typed helper for the monitoring_config.import_features_analysis block of google_vertex_ai_featurestore_entitytype (derived from provider schema).

VertexAiFeaturestoreEntitytypeMonitoringConfigNumericalThresholdConfig

Typed helper for the monitoring_config.numerical_threshold_config block of google_vertex_ai_featurestore_entitytype (derived from provider schema).

VertexAiFeaturestoreEntitytypeMonitoringConfigSnapshotAnalysis

Typed helper for the monitoring_config.snapshot_analysis block of google_vertex_ai_featurestore_entitytype (derived from provider schema).

VertexAiFeaturestoreOnlineServingConfig

Typed helper for the online_serving_config block of google_vertex_ai_featurestore (derived from provider schema).

VertexAiFeaturestoreOnlineServingConfigScaling

Typed helper for the online_serving_config.scaling block of google_vertex_ai_featurestore (derived from provider schema).

VertexAiIndexEncryptionSpec

Typed helper for the encryption_spec block of google_vertex_ai_index (derived from provider schema).

VertexAiIndexEndpointDeployedIndexAutomaticResources

Typed helper for the automatic_resources block of google_vertex_ai_index_endpoint_deployed_index (derived from provider schema).

VertexAiIndexEndpointDeployedIndexDedicatedResources

Typed helper for the dedicated_resources block of google_vertex_ai_index_endpoint_deployed_index (derived from provider schema).

VertexAiIndexEndpointDeployedIndexDedicatedResourcesMachineSpec

Typed helper for the dedicated_resources.machine_spec block of google_vertex_ai_index_endpoint_deployed_index (derived from provider schema).

VertexAiIndexEndpointDeployedIndexDeployedIndexAuthConfig

Typed helper for the deployed_index_auth_config block of google_vertex_ai_index_endpoint_deployed_index (derived from provider schema).

VertexAiIndexEndpointDeployedIndexDeployedIndexAuthConfigAuthProvider

Typed helper for the deployed_index_auth_config.auth_provider block of google_vertex_ai_index_endpoint_deployed_index (derived from provider schema).

VertexAiIndexEndpointEncryptionSpec

Typed helper for the encryption_spec block of google_vertex_ai_index_endpoint (derived from provider schema).

VertexAiIndexEndpointPrivateServiceConnectConfig

Typed helper for the private_service_connect_config block of google_vertex_ai_index_endpoint (derived from provider schema).

VertexAiIndexEndpointPrivateServiceConnectConfigPscAutomationConfigs

Typed helper for the private_service_connect_config.psc_automation_configs block of google_vertex_ai_index_endpoint (derived from provider schema).

VertexAiIndexMetadata

Typed helper for the metadata block of google_vertex_ai_index (derived from provider schema).

VertexAiIndexMetadataConfig

Typed helper for the metadata.config block of google_vertex_ai_index (derived from provider schema).

VertexAiIndexMetadataConfigAlgorithmConfig

Typed helper for the metadata.config.algorithm_config block of google_vertex_ai_index (derived from provider schema).

VertexAiIndexMetadataConfigAlgorithmConfigBruteForceConfig

Typed helper for the metadata.config.algorithm_config.brute_force_config block of google_vertex_ai_index (derived from provider schema).

VertexAiIndexMetadataConfigAlgorithmConfigTreeAhConfig

Typed helper for the metadata.config.algorithm_config.tree_ah_config block of google_vertex_ai_index (derived from provider schema).

VertexAiPersistentResourceEncryptionSpec

Typed helper for the encryption_spec block of google_vertex_ai_persistent_resource (derived from provider schema).

VertexAiPersistentResourcePscInterfaceConfig

Typed helper for the psc_interface_config block of google_vertex_ai_persistent_resource (derived from provider schema).

VertexAiPersistentResourcePscInterfaceConfigDnsPeeringConfigs

Typed helper for the psc_interface_config.dns_peering_configs block of google_vertex_ai_persistent_resource (derived from provider schema).

VertexAiPersistentResourceResourcePools

Typed helper for the resource_pools block of google_vertex_ai_persistent_resource (derived from provider schema).

VertexAiPersistentResourceResourcePoolsAutoscalingSpec

Typed helper for the resource_pools.autoscaling_spec block of google_vertex_ai_persistent_resource (derived from provider schema).

VertexAiPersistentResourceResourcePoolsDiskSpec

Typed helper for the resource_pools.disk_spec block of google_vertex_ai_persistent_resource (derived from provider schema).

VertexAiPersistentResourceResourcePoolsMachineSpec

Typed helper for the resource_pools.machine_spec block of google_vertex_ai_persistent_resource (derived from provider schema).

VertexAiPersistentResourceResourceRuntimeSpec

Typed helper for the resource_runtime_spec block of google_vertex_ai_persistent_resource (derived from provider schema).

VertexAiPersistentResourceResourceRuntimeSpecServiceAccountSpec

Typed helper for the resource_runtime_spec.service_account_spec block of google_vertex_ai_persistent_resource (derived from provider schema).

VertexAiRagEngineConfigBasic

basic tier — cost-effective default for experiments / small data.

VertexAiRagEngineConfigManagedDbTier

RagManagedDb tier for GoogleVertexAiRagEngineConfig. Sealed so the MM exactly_one_of under rag_managed_db_config is exhaustive at the type level. Each variant is an empty nested block (allow_empty_object).

VertexAiRagEngineConfigScaled

scaled tier — production-grade performance with autoscaling.

VertexAiRagEngineConfigUnprovisioned

unprovisioned — disables RAG Engine and deletes managed data.

VertexAiReasoningEngineEncryptionSpec

Typed helper for the encryption_spec block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpec

Typed helper for the spec block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecContainerSpec

Typed helper for the spec.container_spec block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecDeploymentSpec

Typed helper for the spec.deployment_spec block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecDeploymentSpecEnv

Typed helper for the spec.deployment_spec.env block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecDeploymentSpecPscInterfaceConfig

Typed helper for the spec.deployment_spec.psc_interface_config block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecDeploymentSpecPscInterfaceConfigDnsPeeringConfigs

Typed helper for the spec.deployment_spec.psc_interface_config.dns_peering_configs block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecDeploymentSpecSecretEnv

Typed helper for the spec.deployment_spec.secret_env block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecDeploymentSpecSecretEnvSecretRef

Typed helper for the spec.deployment_spec.secret_env.secret_ref block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecPackageSpec

Typed helper for the spec.package_spec block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecSourceCodeSpec

Typed helper for the spec.source_code_spec block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecSourceCodeSpecDeveloperConnectSource

Typed helper for the spec.source_code_spec.developer_connect_source block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecSourceCodeSpecDeveloperConnectSourceConfig

Typed helper for the spec.source_code_spec.developer_connect_source.config block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecSourceCodeSpecImageSpec

Typed helper for the spec.source_code_spec.image_spec block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecSourceCodeSpecInlineSource

Typed helper for the spec.source_code_spec.inline_source block of google_vertex_ai_reasoning_engine (derived from provider schema).

VertexAiReasoningEngineSpecSourceCodeSpecPythonSpec

Typed helper for the spec.source_code_spec.python_spec block of google_vertex_ai_reasoning_engine (derived from provider schema).

Enums

VertexAiReasoningEngineSpecIdentityType

identity_type — derived from the provider schema description.