GoogleVectorSearchIndex class final

Factory wrapper for google_vector_search_index.

An Index defines an approximate nearest-neighbor search structure over a field of a Vector Search Collection.

Vector Search 2.0 index — approximate nearest-neighbor structure over one GoogleVectorSearchCollection vector field.

When dedicatedInfrastructure is omitted, the API defaults to PERFORMANCE_OPTIMIZED with min_replica_count=2 / max_replica_count=2, which bills Vector Search V2 capacity units by the hour. Prefer creating the collection first (and ingesting data) before attaching an index in production workflows.

Enable vectorsearch.googleapis.com via GoogleProjectService before apply.

Constructors

GoogleVectorSearchIndex({required String localName, required TfArg<String> location, required TfArg<String> collectionId, required TfArg<String> indexId, required TfArg<String> indexField, TfArg<String>? displayName, TfArg<String>? description, TfArg<String>? distanceMetric, TfArg<List<String>>? filterFields, TfArg<List<String>>? storeFields, VectorSearchIndexDenseScann? denseScann, VectorSearchIndexDedicatedInfrastructure? dedicatedInfrastructure, TfArg<Map<String, String>>? labels, TfArg<String>? deletionPolicy, TfArg<String>? project, LifecycleOptions? lifecycle, List<DependencyTarget>? dependsOn, String? provider, TfTimeouts? timeouts})

Properties

argMap → Map<String, TfArg?>: Argument-name → TfArg map. Keys are snake_case (Terraform JSON name). Synth emits these keys directly; the factory is responsible for the camelCase → snake_case translation at construction time.
finalinherited
createTime → TfRef<String>: Reference to create_time attribute.
no setter
dependsOn → List<DependencyTarget>?: Optional depends_on = [...]. Each entry is a DependencyTarget — either a wholesale resource (rendered as bare address) or an explicit TfRef (rendered via bareAddress).
finalinherited
effectiveLabels → TfRef<Map<String, String>>: Reference to effective_labels attribute.
no setter
hashCode → int: The hash code for this object.
no setterinherited
id → TfRef<String>: Reference to id attribute.
no setter
indexIdRef → TfRef<String>: Reference to index_id attribute.
no setter
kind → ResourceKind: Always ResourceKind.resource. Overridden by Data.
no setterinherited
lifecycle → LifecycleOptions?: Optional lifecycle { ... } block.
finalinherited
localName → String: User-supplied local name within a Stack.
finalinherited
nameRef → TfRef<String>: Reference to name attribute.
no setter
provider → String?: Optional Terraform provider meta-argument: a provider name ('google-beta' on a GA type) or a name.alias pair ('google.eu').
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sensitiveFields → Set<String>: Field names that are @Sensitive per the IR-derived per-resource constant. Curated factories override with a baked-in static const Set<String> (file-private in v0.5+).
no setter
supportsDeletionProtection → bool: Capability flag: true when this resource's underlying Terraform schema has a deletion_protection boolean attribute that the synth-time devMode flow can flip to false. Defaults to false; the codegen emitter overrides this to true for wrappers whose schema includes the attribute.
no setterinherited
terraformLabels → TfRef<Map<String, String>>: Reference to terraform_labels attribute.
no setter
terraformType → String: Terraform resource type, e.g. google_pubsub_topic.
finalinherited
tfAddress → String: no setterinherited
timeouts → TfTimeouts?: Optional timeouts { ... } block: how long Terraform waits for each operation. Provider-neutral like lifecycle — synth copies the duration strings verbatim, and terraform validate decides whether this resource's schema declares the operations set here.
finalinherited
updateTime → TfRef<String>: Reference to update_time attribute.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

tfType → const String