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
-
AppConstant<
T> -
A value the Stack hands to application code as a
static constin the generated AppExports file — known when synth runs, so the app compiles against it. - AppExports
-
Where synth writes the Dart file application code imports: the Stack's
constants, as the
static constmembers of<name>Constants, and a typed reader of its Terraform outputs,<name>Outputs. -
AttributeRef<
T> -
Public for sealed pattern matching, but constructor is private — only
TfRef.attribute()may construct instances. - DartDefineOutput
-
An
outputwhose value is the client build's--dart-definefile, registered withStack.addDartDefineOutput. - Data
-
Base of every user-instantiable Terraform
datablock. - DataGoogleVertexAiIndex
-
Factory wrapper for
google_vertex_ai_index. - DataGoogleVertexAiReasoningEngineIamPolicy
-
Factory wrapper for
google_vertex_ai_reasoning_engine_iam_policy. - DataGoogleVertexAiReasoningEngineQuery
-
Factory wrapper for
google_vertex_ai_reasoning_engine_query. -
DataRef<
T> -
Public for sealed pattern matching, but constructor is private — only
TfRef.data()may construct instances. - EnvironmentConstant
- The AppConstant.fromEnvironment choice.
- GcsBackend
-
terraform { backend "gcs" { ... } }configuration. - 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. - GoogleVertexAiEvaluationMetric
-
Factory wrapper for
google_vertex_ai_evaluation_metric. - 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. - GoogleVertexAiRagCorpus
-
Factory wrapper for
google_vertex_ai_rag_corpus. - 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. - 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. - IgnoreAllChanges
- IgnoreChanges.all.
- IgnoreAttributes
- IgnoreChanges.of.
- IgnoreChanges
-
What
ignore_changescovers: every attribute, or the listed ones. - InvalidDartDefineOutput
-
An output of
Stack.addDartDefineOutputthat cannot carry what it names: an output that is not registered, is sensitive or has no environment value, two outputs read from one variable, or no output at all. - InvalidLifecycle
-
A
lifecycleblock Terraform rejects: a data source (or one of its attributes) inreplaceTriggeredBy,allinside IgnoreChanges.of, or a condition with an empty error message. - InvalidMoveTarget
-
A
movedblock whosetonames no resource of the Stack. - InvalidTimeout
-
A negative
timeoutsduration. - LifecycleCondition
-
A
preconditionorpostconditionblock: Terraform fails the plan (LifecycleCondition.pre) or the apply (LifecycleCondition.post) with errorMessage when condition is false. - LifecycleOptions
-
lifecycle { ... }block on a resource. - LocalBackend
-
terraform { backend "local" { ... } }configuration. - MissingProvider
-
A block needs a provider configuration the Stack does not register:
the provider its type implies (
googleforgoogle_pubsub_topic), the one itsprovidermeta-argument names, or one a module call passes on. - ModuleCall
-
A
module "<localName>" { ... }call as a Dart value. - NoProviders
- The Stack registers no provider, but declares resources or data sources.
- ProviderConflict
- Two provider registrations Terraform rejects together: two defaults of one name, a repeated alias, an alias that is not an identifier, or configurations of one name with different source / version constraints.
-
RefConstant<
T> - The AppConstant.ref choice.
- ReplaceTrigger
-
What
lifecycle.replaceTriggeredBylists: a resource of the Stack or an attribute getter of one.Resourceand TfRef implement it; synth reports a data source or a data-source attribute as anInvalidLifecycle. - Resource
- Base of every user-instantiable Terraform resource.
- ResourceRef
-
Public for sealed pattern matching, but constructor is private — only
TfRef.resource()may construct instances. - S3Backend
-
terraform { backend "s3" { ... } }configuration. -
Sensitive<
T> -
What an argument Terraform marks sensitive takes: a variable, an
expression or an attribute getter — a value Terraform resolves, never a
Dart literal that would be written into
main.tf.json. - SensitiveLiteral
-
A sensitive field is set to a literal, which would write the secret in
plain text into
main.tf.json. - Stack
- User-extended IaC composition root.
- StackBackend
-
Lightweight backend hook. Core ships
GcsBackend,S3Backend, andLocalBackend; anything else implements this interface in the caller. TheStackonly stores the value and exposes a discriminator for synth'sterraform { backend ... }emitter. - StackProvider
-
Coordination interface between
Stack(in this package) and concrete providers (e.g.GoogleProviderinterradart_google). Concrete providers implement every getter using their baked-in constants from Stage 2 codegen. - SynthIssue
- One reason a Stack cannot be synthesized.
- SynthResult
-
Bundle returned by
StackSynth.synth. - TfAddressed
-
Anything that exposes a Terraform address, e.g.
google_pubsub_topic.orders. -
TfArg<
T> - A Terraform argument: a Dart-side literal, a reference to another block's attribute (TfRef), a variable or a raw expression.
-
TfArgExpression<
T> - A raw Terraform expression — the tf.json template string, verbatim.
-
TfArgLiteral<
T> -
TfArgVariable<
T> - TfCollectionType
-
list(...),set(...)ormap(...). - TfMoved
-
One
moved { from = ... to = ... }block: the state object at from now belongs to the resource at to, so a rename does not become a destroy-and-create. - TfObjectType
-
object({ ... }). - TfOptionalType
-
optional(<type>[, <default>]). -
TfOutput<
T> -
An
output "<name>" { value = ... }block, registered withStack.addOutput. - TfPrimitiveType
-
string,number,boolorany. -
TfRef<
T> - A Terraform-side reference: an attribute of a resource (AttributeRef) or a data source (DataRef), or a whole resource (ResourceRef).
- TfTimeouts
-
timeouts { ... }on a resource or data source: how long Terraform waits for each operation before giving up. - TfTupleType
-
tuple([...]). - TfType
-
A Terraform type constraint:
string,list(number),object({ name = string }). - TfVariable
-
One
variable "<name>" { ... }declaration. - UndeclaredVariable
-
A
TfArg.variableorvar.<name>in an expression names a variable the Stack does not declare. - UnregisteredReference
-
A block references another block that was never registered on the
Stack: built, but not passed to
add(...)/addModule(...). - UnresolvableConstant
-
An
AppConstant.refwhose value is not known at synth: the attribute is not set to a literal, is sensitive, does not match the constant's type, or belongs to a block that is not registered. -
ValueConstant<
T> - The AppConstant.value choice.
- VertexAiDatasetEncryptionSpec
-
Typed helper for the
encryption_specblock ofgoogle_vertex_ai_dataset(derived from provider schema). - VertexAiDeploymentResourcePoolAutoscalingMetricSpecs
-
Typed helper for the
dedicated_resources.autoscaling_metric_specsblock ofgoogle_vertex_ai_deployment_resource_pool(derived from provider schema). - VertexAiDeploymentResourcePoolDedicatedResources
-
Typed helper for the
dedicated_resourcesblock ofgoogle_vertex_ai_deployment_resource_pool(derived from provider schema). - VertexAiDeploymentResourcePoolMachineSpec
-
Typed helper for the
dedicated_resources.machine_specblock ofgoogle_vertex_ai_deployment_resource_pool(derived from provider schema). - VertexAiEndpointBigqueryDestination
-
Typed helper for the
predict_request_response_logging_config.bigquery_destinationblock ofgoogle_vertex_ai_endpoint(derived from provider schema). - VertexAiEndpointEncryptionSpec
-
Typed helper for the
encryption_specblock ofgoogle_vertex_ai_endpoint(derived from provider schema). - VertexAiEndpointPredictRequestResponseLoggingConfig
-
Typed helper for the
predict_request_response_logging_configblock ofgoogle_vertex_ai_endpoint(derived from provider schema). - VertexAiEndpointPrivateServiceConnectConfig
-
Typed helper for the
private_service_connect_configblock ofgoogle_vertex_ai_endpoint(derived from provider schema). - VertexAiEndpointPscAutomationConfigs
-
Typed helper for the
private_service_connect_config.psc_automation_configsblock ofgoogle_vertex_ai_endpoint(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentAutoscalingMetricSpecs
-
Typed helper for the
deploy_config.dedicated_resources.autoscaling_metric_specsblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentContainerSpec
-
Typed helper for the
model_config.container_specblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentDedicatedResources
-
Typed helper for the
deploy_config.dedicated_resourcesblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentDeployConfig
-
Typed helper for the
deploy_configblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentEndpointConfig
-
Typed helper for the
endpoint_configblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentEnv
-
Typed helper for the
model_config.container_spec.envblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentExec
-
Typed helper for the
model_config.container_spec.health_probe.execblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). Shared by every block of this shape in the resource. - VertexAiEndpointWithModelGardenDeploymentGrpc
-
Typed helper for the
model_config.container_spec.health_probe.grpcblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). Shared by every block of this shape in the resource. - VertexAiEndpointWithModelGardenDeploymentGrpcPorts
-
Typed helper for the
model_config.container_spec.grpc_portsblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentHealthProbe
-
Typed helper for the
model_config.container_spec.health_probeblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentHttpGet
-
Typed helper for the
model_config.container_spec.health_probe.http_getblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). Shared by every block of this shape in the resource. - VertexAiEndpointWithModelGardenDeploymentHttpHeaders
-
Typed helper for the
model_config.container_spec.health_probe.http_get.http_headersblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). Shared by every block of this shape in the resource. - VertexAiEndpointWithModelGardenDeploymentHuggingFaceModel
-
Hugging Face model id (e.g.
google/gemma-2-2b-it). - VertexAiEndpointWithModelGardenDeploymentLivenessProbe
-
Typed helper for the
model_config.container_spec.liveness_probeblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentMachineSpec
-
Typed helper for the
deploy_config.dedicated_resources.machine_specblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - 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_configblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentPorts
-
Typed helper for the
model_config.container_spec.portsblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentPrivateServiceConnectConfig
-
Typed helper for the
endpoint_config.private_service_connect_configblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentPscAutomationConfigs
-
Typed helper for the
endpoint_config.private_service_connect_config.psc_automation_configsblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentPublisherModel
-
Model Garden publisher model path
(
publishers/{publisher}/models/{model}@{version}). - VertexAiEndpointWithModelGardenDeploymentReservationAffinity
-
Typed helper for the
deploy_config.dedicated_resources.machine_spec.reservation_affinityblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentStartupProbe
-
Typed helper for the
model_config.container_spec.startup_probeblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). - VertexAiEndpointWithModelGardenDeploymentTcpSocket
-
Typed helper for the
model_config.container_spec.health_probe.tcp_socketblock ofgoogle_vertex_ai_endpoint_with_model_garden_deployment(derived from provider schema). Shared by every block of this shape in the resource. - VertexAiEvaluationMetricEncryptionSpec
-
Typed helper for the
encryption_specblock ofgoogle_vertex_ai_evaluation_metric(derived from provider schema). - VertexAiFeatureGroupBigQuery
-
Typed helper for the
big_queryblock ofgoogle_vertex_ai_feature_group(derived from provider schema). - VertexAiFeatureGroupBigQuerySource
-
Typed helper for the
big_query.big_query_sourceblock ofgoogle_vertex_ai_feature_group(derived from provider schema). - VertexAiFeatureOnlineStoreBigtable
-
bigtablestorage — Cloud Bigtable instance with required autoscaling. - VertexAiFeatureOnlineStoreBigtableAutoScaling
-
Autoscaling config under VertexAiFeatureOnlineStoreBigtable
(
auto_scalinglist max 1). - VertexAiFeatureOnlineStoreDedicatedServingEndpoint
-
Typed helper for the
dedicated_serving_endpointblock ofgoogle_vertex_ai_feature_online_store(derived from provider schema). - VertexAiFeatureOnlineStoreEncryptionSpec
-
Typed helper for the
encryption_specblock ofgoogle_vertex_ai_feature_online_store(derived from provider schema). - VertexAiFeatureOnlineStoreFeatureviewBigQuerySource
-
Typed helper for the
big_query_sourceblock ofgoogle_vertex_ai_feature_online_store_featureview(derived from provider schema). - VertexAiFeatureOnlineStoreFeatureviewBigQuerySourceChoice
-
The VertexAiFeatureOnlineStoreFeatureviewSource.bigQuerySource choice: sets
big_query_source. - VertexAiFeatureOnlineStoreFeatureviewFeatureGroups
-
Typed helper for the
feature_registry_source.feature_groupsblock ofgoogle_vertex_ai_feature_online_store_featureview(derived from provider schema). - VertexAiFeatureOnlineStoreFeatureviewFeatureRegistrySource
-
Typed helper for the
feature_registry_sourceblock ofgoogle_vertex_ai_feature_online_store_featureview(derived from provider schema). - VertexAiFeatureOnlineStoreFeatureviewFeatureRegistrySourceChoice
-
The VertexAiFeatureOnlineStoreFeatureviewSource.featureRegistrySource choice: sets
feature_registry_source. - VertexAiFeatureOnlineStoreFeatureviewSource
-
Exactly one of
big_query_source,feature_registry_sourceongoogle_vertex_ai_feature_online_store_featureview: the provider rejects none and more than one, so each variant sets one of them. - VertexAiFeatureOnlineStoreFeatureviewSyncConfig
-
At most one of
cron,continuouson thesync_configblock ofgoogle_vertex_ai_feature_online_store_featureview: the provider rejects more than one, so each variant sets one of them and a null choice sets none. - VertexAiFeatureOnlineStoreFeatureviewSyncConfigContinuous
-
The VertexAiFeatureOnlineStoreFeatureviewSyncConfig.continuous choice: sets
continuous. - VertexAiFeatureOnlineStoreFeatureviewSyncConfigCron
-
The VertexAiFeatureOnlineStoreFeatureviewSyncConfig.cron choice: sets
cron. - VertexAiFeatureOnlineStoreOptimized
-
optimizedstorage — empty object (allow_empty_objectin MM). - VertexAiFeatureOnlineStorePrivateServiceConnectConfig
-
Typed helper for the
dedicated_serving_endpoint.private_service_connect_configblock ofgoogle_vertex_ai_feature_online_store(derived from provider schema). - 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_specblock ofgoogle_vertex_ai_featurestore(derived from provider schema). - VertexAiFeaturestoreEntitytypeCategoricalThresholdConfig
-
Typed helper for the
monitoring_config.categorical_threshold_configblock ofgoogle_vertex_ai_featurestore_entitytype(derived from provider schema). - VertexAiFeaturestoreEntitytypeImportFeaturesAnalysis
-
Typed helper for the
monitoring_config.import_features_analysisblock ofgoogle_vertex_ai_featurestore_entitytype(derived from provider schema). - VertexAiFeaturestoreEntitytypeMonitoringConfig
-
Typed helper for the
monitoring_configblock ofgoogle_vertex_ai_featurestore_entitytype(derived from provider schema). - VertexAiFeaturestoreEntitytypeNumericalThresholdConfig
-
Typed helper for the
monitoring_config.numerical_threshold_configblock ofgoogle_vertex_ai_featurestore_entitytype(derived from provider schema). - VertexAiFeaturestoreEntitytypeSnapshotAnalysis
-
Typed helper for the
monitoring_config.snapshot_analysisblock ofgoogle_vertex_ai_featurestore_entitytype(derived from provider schema). - VertexAiFeaturestoreOnlineServingConfig
-
Exactly one of
fixed_node_count,scalingon theonline_serving_configblock ofgoogle_vertex_ai_featurestore: the provider rejects none and more than one, so each variant sets one of them. - VertexAiFeaturestoreOnlineServingConfigFixedNodeCount
-
The VertexAiFeaturestoreOnlineServingConfig.fixedNodeCount choice: sets
fixed_node_count. - VertexAiFeaturestoreOnlineServingConfigScaling
-
The VertexAiFeaturestoreOnlineServingConfig.scaling choice: sets
scaling. - VertexAiFeaturestoreScaling
-
Typed helper for the
online_serving_config.scalingblock ofgoogle_vertex_ai_featurestore(derived from provider schema). - VertexAiIndexAlgorithmConfig
-
Exactly one of
tree_ah_config,brute_force_configon themetadata.config.algorithm_configblock ofgoogle_vertex_ai_index: the provider rejects none and more than one, so each variant sets one of them. - VertexAiIndexAlgorithmConfigBruteForceConfig
-
The VertexAiIndexAlgorithmConfig.bruteForceConfig choice: sets
brute_force_config. - VertexAiIndexAlgorithmConfigTreeAhConfig
-
The VertexAiIndexAlgorithmConfig.treeAhConfig choice: sets
tree_ah_config. - VertexAiIndexBruteForceConfig
-
Typed helper for the
metadata.config.algorithm_config.brute_force_configblock ofgoogle_vertex_ai_index(derived from provider schema). - VertexAiIndexConfig
-
Typed helper for the
metadata.configblock ofgoogle_vertex_ai_index(derived from provider schema). - VertexAiIndexEncryptionSpec
-
Typed helper for the
encryption_specblock ofgoogle_vertex_ai_index(derived from provider schema). - VertexAiIndexEndpointConnectivity
-
At most one of
network,private_service_connect_configongoogle_vertex_ai_index_endpoint: the provider rejects more than one, so each variant sets one of them and a null choice sets none. - VertexAiIndexEndpointConnectivityNetwork
-
The VertexAiIndexEndpointConnectivity.network choice: sets
network. - VertexAiIndexEndpointConnectivityPrivateServiceConnectConfig
-
The VertexAiIndexEndpointConnectivity.privateServiceConnectConfig choice: sets
private_service_connect_config. - VertexAiIndexEndpointDeployedIndexAuthConfig
-
Typed helper for the
deployed_index_auth_configblock ofgoogle_vertex_ai_index_endpoint_deployed_index(derived from provider schema). - VertexAiIndexEndpointDeployedIndexAuthProvider
-
Typed helper for the
deployed_index_auth_config.auth_providerblock ofgoogle_vertex_ai_index_endpoint_deployed_index(derived from provider schema). - VertexAiIndexEndpointDeployedIndexAutomaticResources
-
Typed helper for the
automatic_resourcesblock ofgoogle_vertex_ai_index_endpoint_deployed_index(derived from provider schema). - VertexAiIndexEndpointDeployedIndexDedicatedResources
-
Typed helper for the
dedicated_resourcesblock ofgoogle_vertex_ai_index_endpoint_deployed_index(derived from provider schema). - VertexAiIndexEndpointDeployedIndexMachineSpec
-
Typed helper for the
dedicated_resources.machine_specblock ofgoogle_vertex_ai_index_endpoint_deployed_index(derived from provider schema). - VertexAiIndexEndpointEncryptionSpec
-
Typed helper for the
encryption_specblock ofgoogle_vertex_ai_index_endpoint(derived from provider schema). - VertexAiIndexEndpointPrivateServiceConnectConfig
-
Typed helper for the
private_service_connect_configblock ofgoogle_vertex_ai_index_endpoint(derived from provider schema). - VertexAiIndexEndpointPscAutomationConfigs
-
Typed helper for the
private_service_connect_config.psc_automation_configsblock ofgoogle_vertex_ai_index_endpoint(derived from provider schema). - VertexAiIndexMetadata
-
Typed helper for the
metadatablock ofgoogle_vertex_ai_index(derived from provider schema). - VertexAiIndexTreeAhConfig
-
Typed helper for the
metadata.config.algorithm_config.tree_ah_configblock ofgoogle_vertex_ai_index(derived from provider schema). - VertexAiPersistentResourceAutoscalingSpec
-
Typed helper for the
resource_pools.autoscaling_specblock ofgoogle_vertex_ai_persistent_resource(derived from provider schema). - VertexAiPersistentResourceDiskSpec
-
Typed helper for the
resource_pools.disk_specblock ofgoogle_vertex_ai_persistent_resource(derived from provider schema). - VertexAiPersistentResourceDnsPeeringConfigs
-
Typed helper for the
psc_interface_config.dns_peering_configsblock ofgoogle_vertex_ai_persistent_resource(derived from provider schema). - VertexAiPersistentResourceEncryptionSpec
-
Typed helper for the
encryption_specblock ofgoogle_vertex_ai_persistent_resource(derived from provider schema). - VertexAiPersistentResourceMachineSpec
-
Typed helper for the
resource_pools.machine_specblock ofgoogle_vertex_ai_persistent_resource(derived from provider schema). - VertexAiPersistentResourcePools
-
Typed helper for the
resource_poolsblock ofgoogle_vertex_ai_persistent_resource(derived from provider schema). - VertexAiPersistentResourcePscInterfaceConfig
-
Typed helper for the
psc_interface_configblock ofgoogle_vertex_ai_persistent_resource(derived from provider schema). - VertexAiPersistentResourceRuntimeSpec
-
Typed helper for the
resource_runtime_specblock ofgoogle_vertex_ai_persistent_resource(derived from provider schema). - VertexAiPersistentResourceServiceAccountSpec
-
Typed helper for the
resource_runtime_spec.service_account_specblock ofgoogle_vertex_ai_persistent_resource(derived from provider schema). - VertexAiRagCorpusAnn
-
Typed helper for the
vector_db_config.rag_managed_db.annblock ofgoogle_vertex_ai_rag_corpus(derived from provider schema). - VertexAiRagCorpusApiAuth
-
Typed helper for the
vector_db_config.api_authblock ofgoogle_vertex_ai_rag_corpus(derived from provider schema). - VertexAiRagCorpusApiKeyConfig
-
Exactly one of
api_key_secret_version,api_key_stringon thevector_db_config.api_auth.api_key_configblock ofgoogle_vertex_ai_rag_corpus: the provider rejects none and more than one, so each variant sets one of them. - VertexAiRagCorpusApiKeyConfigApiKeySecretVersion
-
The VertexAiRagCorpusApiKeyConfig.apiKeySecretVersion choice: sets
api_key_secret_version. - VertexAiRagCorpusApiKeyConfigApiKeyString
-
The VertexAiRagCorpusApiKeyConfig.apiKeyString choice: sets
api_key_string. - VertexAiRagCorpusBackend
-
At most one of
vector_db_config,vertex_ai_search_configongoogle_vertex_ai_rag_corpus: the provider rejects more than one, so each variant sets one of them and a null choice sets none. - VertexAiRagCorpusBackendVectorDbConfig
-
The VertexAiRagCorpusBackend.vectorDbConfig choice: sets
vector_db_config. - VertexAiRagCorpusBackendVertexAiSearchConfig
-
The VertexAiRagCorpusBackend.vertexAiSearchConfig choice: sets
vertex_ai_search_config. - VertexAiRagCorpusEncryptionSpec
-
Typed helper for the
encryption_specblock ofgoogle_vertex_ai_rag_corpus(derived from provider schema). - VertexAiRagCorpusKnn
-
Typed helper for the
vector_db_config.rag_managed_db.knnblock ofgoogle_vertex_ai_rag_corpus(derived from provider schema). - VertexAiRagCorpusPinecone
-
Typed helper for the
vector_db_config.pineconeblock ofgoogle_vertex_ai_rag_corpus(derived from provider schema). - VertexAiRagCorpusRagEmbeddingModelConfig
-
Typed helper for the
vector_db_config.rag_embedding_model_configblock ofgoogle_vertex_ai_rag_corpus(derived from provider schema). - VertexAiRagCorpusRagManagedDb
-
Exactly one of
knn,annon thevector_db_config.rag_managed_dbblock ofgoogle_vertex_ai_rag_corpus: the provider rejects none and more than one, so each variant sets one of them. - VertexAiRagCorpusRagManagedDbAnn
-
The VertexAiRagCorpusRagManagedDb.ann choice: sets
ann. - VertexAiRagCorpusRagManagedDbKnn
-
The VertexAiRagCorpusRagManagedDb.knn choice: sets
knn. - VertexAiRagCorpusVectorDbConfig
-
Typed helper for the
vector_db_configblock ofgoogle_vertex_ai_rag_corpus(derived from provider schema). - VertexAiRagCorpusVectorDbConfigBackend
-
At most one of
rag_managed_db,pinecone,vertex_vector_searchon thevector_db_configblock ofgoogle_vertex_ai_rag_corpus: the provider rejects more than one, so each variant sets one of them and a null choice sets none. - VertexAiRagCorpusVectorDbConfigBackendPinecone
-
The VertexAiRagCorpusVectorDbConfigBackend.pinecone choice: sets
pinecone. - VertexAiRagCorpusVectorDbConfigBackendRagManagedDb
-
The VertexAiRagCorpusVectorDbConfigBackend.ragManagedDb choice: sets
rag_managed_db. - VertexAiRagCorpusVectorDbConfigBackendVertexVectorSearch
-
The VertexAiRagCorpusVectorDbConfigBackend.vertexVectorSearch choice: sets
vertex_vector_search. - VertexAiRagCorpusVertexAiSearchConfig
-
Typed helper for the
vertex_ai_search_configblock ofgoogle_vertex_ai_rag_corpus(derived from provider schema). - VertexAiRagCorpusVertexPredictionEndpoint
-
Typed helper for the
vector_db_config.rag_embedding_model_config.vertex_prediction_endpointblock ofgoogle_vertex_ai_rag_corpus(derived from provider schema). - VertexAiRagCorpusVertexVectorSearch
-
Typed helper for the
vector_db_config.vertex_vector_searchblock ofgoogle_vertex_ai_rag_corpus(derived from provider schema). - VertexAiRagEngineConfigBasic
-
Typed helper for the
rag_managed_db_config.basicblock ofgoogle_vertex_ai_rag_engine_config(derived from provider schema). - VertexAiRagEngineConfigRagManagedDbConfig
-
Exactly one of
scaled,basic,unprovisionedon therag_managed_db_configblock ofgoogle_vertex_ai_rag_engine_config: the provider rejects none and more than one, so each variant sets one of them. - VertexAiRagEngineConfigRagManagedDbConfigBasic
-
The VertexAiRagEngineConfigRagManagedDbConfig.basic choice: sets
basic. - VertexAiRagEngineConfigRagManagedDbConfigScaled
-
The VertexAiRagEngineConfigRagManagedDbConfig.scaled choice: sets
scaled. - VertexAiRagEngineConfigRagManagedDbConfigUnprovisioned
-
The VertexAiRagEngineConfigRagManagedDbConfig.unprovisioned choice: sets
unprovisioned. - VertexAiRagEngineConfigScaled
-
Typed helper for the
rag_managed_db_config.scaledblock ofgoogle_vertex_ai_rag_engine_config(derived from provider schema). - VertexAiRagEngineConfigUnprovisioned
-
Typed helper for the
rag_managed_db_config.unprovisionedblock ofgoogle_vertex_ai_rag_engine_config(derived from provider schema). - VertexAiReasoningEngineAdkConfig
-
Typed helper for the
spec.source_code_spec.agent_config_source.adk_configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineAgentConfigSource
-
Typed helper for the
spec.source_code_spec.agent_config_sourceblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineAgentConfigSourceInlineSource
-
Typed helper for the
spec.source_code_spec.agent_config_source.inline_sourceblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineAgentGatewayConfig
-
Typed helper for the
spec.deployment_spec.agent_gateway_configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineAgentToAnywhereConfig
-
Typed helper for the
spec.deployment_spec.agent_gateway_config.agent_to_anywhere_configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineAudioTranscription
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_source.events.content.parts.audio_transcriptionblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineBuildSpec
-
Typed helper for the
spec.build_specblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineClientToAgentConfig
-
Typed helper for the
spec.deployment_spec.agent_gateway_config.client_to_agent_configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineCodeExecutionResult
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_source.events.content.parts.code_execution_resultblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineConfig
-
Typed helper for the
spec.source_code_spec.developer_connect_source.configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineConsolidationConfig
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.consolidation_configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineContainerSpec
-
Typed helper for the
spec.container_specblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineContent
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_source.events.contentblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineContextSpec
-
Typed helper for the
context_specblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineConversationSource
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_sourceblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineCustomizationConfigs
-
Typed helper for the
context_spec.memory_bank_config.customization_configsblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineCustomMemoryTopic
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.memory_topics.custom_memory_topicblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineDeployment
-
At most one of
container_spec,source_code_specon thespecblock ofgoogle_vertex_ai_reasoning_engine: the provider rejects more than one, so each variant sets one of them and a null choice sets none. - VertexAiReasoningEngineDeploymentContainerSpec
-
The VertexAiReasoningEngineDeployment.containerSpec choice: sets
container_spec. - VertexAiReasoningEngineDeploymentSourceCodeSpec
-
The VertexAiReasoningEngineDeployment.sourceCodeSpec choice: sets
source_code_spec. - VertexAiReasoningEngineDeploymentSpec
-
Typed helper for the
spec.deployment_specblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineDeveloperConnectSource
-
Typed helper for the
spec.source_code_spec.developer_connect_sourceblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineDnsPeeringConfigs
-
Typed helper for the
spec.deployment_spec.psc_interface_config.dns_peering_configsblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineEncryptionSpec
-
Typed helper for the
encryption_specblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineEnv
-
Typed helper for the
spec.deployment_spec.envblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineEvents
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_source.eventsblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineExecutableCode
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_source.events.content.parts.executable_codeblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineFileData
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_source.events.content.parts.file_datablock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineFunctionCall
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_source.events.content.parts.function_callblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineFunctionResponse
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_source.events.content.parts.function_responseblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineGeneratedMemories
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.generated_memoriesblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineGenerateMemoriesExamples
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examplesblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineGenerationConfig
-
Typed helper for the
context_spec.memory_bank_config.generation_configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineGenerationRule
-
Typed helper for the
context_spec.memory_bank_config.generation_config.generation_trigger_config.generation_ruleblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineGenerationTriggerConfig
-
Typed helper for the
context_spec.memory_bank_config.generation_config.generation_trigger_configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineGranularTtlConfig
-
Typed helper for the
context_spec.memory_bank_config.ttl_config.granular_ttl_configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineIamBindingCondition
-
Typed helper for the
conditionblock ofgoogle_vertex_ai_reasoning_engine_iam_binding(derived from provider schema). - VertexAiReasoningEngineIamMemberCondition
-
Typed helper for the
conditionblock ofgoogle_vertex_ai_reasoning_engine_iam_member(derived from provider schema). - VertexAiReasoningEngineImageSpec
-
Typed helper for the
spec.source_code_spec.image_specblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineInlineData
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_source.events.content.parts.inline_datablock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineInlineSource
-
Typed helper for the
spec.source_code_spec.inline_sourceblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineManagedMemoryTopic
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.memory_topics.managed_memory_topicblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineMemoryBankConfig
-
Typed helper for the
context_spec.memory_bank_configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineMemoryTopics
-
Exactly one of
managed_memory_topic,custom_memory_topicon thecontext_spec.memory_bank_config.customization_configs.memory_topicsblock ofgoogle_vertex_ai_reasoning_engine: the provider rejects none and more than one, so each variant sets one of them. - VertexAiReasoningEngineMemoryTopicsCustomMemoryTopic
-
The VertexAiReasoningEngineMemoryTopics.customMemoryTopic choice: sets
custom_memory_topic. - VertexAiReasoningEngineMemoryTopicsManagedMemoryTopic
-
The VertexAiReasoningEngineMemoryTopics.managedMemoryTopic choice: sets
managed_memory_topic. - VertexAiReasoningEnginePackageSpec
-
Typed helper for the
spec.package_specblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineParts
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_source.events.content.partsblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEnginePolicy
-
Exactly one of
default_ttl,granular_ttl_configon thecontext_spec.memory_bank_config.ttl_configblock ofgoogle_vertex_ai_reasoning_engine: the provider rejects none and more than one, so each variant sets one of them. - VertexAiReasoningEnginePolicyDefaultTtl
-
The VertexAiReasoningEnginePolicy.defaultTtl choice: sets
default_ttl. - VertexAiReasoningEnginePolicyGranularTtlConfig
-
The VertexAiReasoningEnginePolicy.granularTtlConfig choice: sets
granular_ttl_config. - VertexAiReasoningEnginePscInterfaceConfig
-
Typed helper for the
spec.deployment_spec.psc_interface_configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEnginePythonSpec
-
Typed helper for the
spec.source_code_spec.python_specblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineRuntime
-
At most one of
image_spec,python_specon thespec.source_code_specblock ofgoogle_vertex_ai_reasoning_engine: the provider rejects more than one, so each variant sets one of them and a null choice sets none. - VertexAiReasoningEngineRuntimeImageSpec
-
The VertexAiReasoningEngineRuntime.imageSpec choice: sets
image_spec. - VertexAiReasoningEngineRuntimePythonSpec
-
The VertexAiReasoningEngineRuntime.pythonSpec choice: sets
python_spec. - VertexAiReasoningEngineSchemaConfigs
-
Typed helper for the
context_spec.memory_bank_config.structured_memory_configs.schema_configsblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineSecretEnv
-
Typed helper for the
spec.deployment_spec.secret_envblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineSecretRef
-
Typed helper for the
spec.deployment_spec.secret_env.secret_refblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineSimilaritySearchConfig
-
Typed helper for the
context_spec.memory_bank_config.similarity_search_configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineSourceCodeSpec
-
Typed helper for the
spec.source_code_specblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineSpec
-
Typed helper for the
specblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineStructuredMemoryConfigs
-
Typed helper for the
context_spec.memory_bank_config.structured_memory_configsblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineTopics
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.generated_memories.topicsblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineTtlConfig
-
Typed helper for the
context_spec.memory_bank_config.ttl_configblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineVideoMetadata
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_source.events.content.parts.video_metadatablock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiReasoningEngineWords
-
Typed helper for the
context_spec.memory_bank_config.customization_configs.generate_memories_examples.conversation_source.events.content.parts.audio_transcription.wordsblock ofgoogle_vertex_ai_reasoning_engine(derived from provider schema). - VertexAiSemanticGovernancePolicyEngineGatewayConfigs
-
Typed helper for the
gateway_configsblock ofgoogle_vertex_ai_semantic_governance_policy_engine(derived from provider schema). - VertexAiTensorboardEncryptionSpec
-
Typed helper for the
encryption_specblock ofgoogle_vertex_ai_tensorboard(derived from provider schema).
Enums
- ResourceKind
-
Whether a Stack entry is a
resourceblock or adatablock in Terraform JSON.
Extension Types
- OutputEnvironment
-
The environment
Stack.outputEnvironmentreturns: each variable and its value, in registration order. - RefTo
-
A reference to a resource of type
R, for an argument that names another resource (network,vpc_id,role_arn, ...). - VertexAiReasoningEngineIdentityType
-
identity_type— derived from the provider schema description. - VertexAiReasoningEngineLanguage
-
language— derived from the provider schema description. - VertexAiReasoningEngineOutcome
-
outcome— derived from the provider schema description. - VertexAiReasoningEngineTopicsManagedMemoryTopic
-
managed_memory_topic— derived from the provider schema description.
Extensions
-
RefToList
on TfArg<
List< RefTo< >R> > -
A list-valued reference argument (
security_group_ids,subnet_ids): a literal list of RefTos, or one value that is the whole list (TfArg.variable('subnet_ids'),TfArg.expression(...)). - TerraformDurationExt on Duration
- Converts a Dart Duration into a Terraform duration string ("604800s").
Constants
- terradartManifestVariable → const String
-
The environment variable the
terradartcommand sets to the file runStack and runEnvironments describe what they wrote in.
Functions
-
runEnvironments<
E extends Enum> (List< String> args, List<E> environments, Stack build(E env), {String dir(E env)?, String? workspace(E env)?, List<String> backendConfig(E env)?, E? defaultEnv}) → Future<void> -
The entry point of a project with one Stack per environment. The
environments are the members of an enum of the project's own — any
names, each carrying its values — so the Stack takes a typed
envand derives everything per environment from it, its backend included: -
runStack(
List< String> args, Stack build(), {String out = 'tf-out'}) → Future<void> -
The entry point of a project with one Stack: writes it to
out.
Exceptions / Errors
- DuplicateModuleError
-
A
ModuleCallregistered twice under one name. - DuplicateResourceError
-
Thrown by
Stack.addwhen an entry with the same(kind, terraformType, localName)triple is registered twice. - SynthException
-
Thrown by
Stack.synth()andStack.writeTo()when the Stack has one or more SynthIssues. Nothing is written.