IndexArgs class - vectorsearch library

Constructors

IndexArgs({required Input<String> collectionId, Input<IndexDedicatedInfrastructure?>? dedicatedInfrastructure, Input<String?>? deletionPolicy, Input<IndexDenseScann?>? denseScann, Input<String?>? description, Input<String?>? displayName, Input<String?>? distanceMetric, Input<List<String>?>? filterFields, required Input<String> indexField, required Input<String> indexId, Input<Map<String, String>?>? labels, required Input<String> location, Input<String?>? project, Input<List<String>?>? storeFields}): Creates a new IndexArgs. collectionId The ID of the parent Collection. dedicatedInfrastructure Dedicated infrastructure for the index. This field belongs to the deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. denseScann Dense ScaNN index configuration. This field belongs to the description User-specified description of the index displayName User-specified display name of the index distanceMetric Distance metric used for indexing. If not specified, will default to filterFields The fields to push into the index to enable fast ANN inline filtering. indexField The collection schema field to index. indexId ID of the Index to create. labels Labels as key value pairs. location Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. project The ID of the project in which the resource belongs. storeFields The fields to push into the index to enable inline data retrieval.
const
IndexArgs.fromMap(Map<String, dynamic> map): factory

Properties

collectionId → Input<String>: The ID of the parent Collection.
final
dedicatedInfrastructure → Input<IndexDedicatedInfrastructure?>?: Dedicated infrastructure for the index. This field belongs to the infraType oneof; if omitted, the server populates it with the default PERFORMANCE_OPTIMIZED mode and an autoscaling spec of min_replica_count=2, max_replica_count=2. Structure is documented below.
final
deletionPolicy → Input<String?>?: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
denseScann → Input<IndexDenseScann?>?: Dense ScaNN index configuration. This field belongs to the indexType oneof; if omitted, the server populates it with default ScaNN settings. Structure is documented below.
final
description → Input<String?>?: User-specified description of the index
final
displayName → Input<String?>?: User-specified display name of the index
final
distanceMetric → Input<String?>?: Distance metric used for indexing. If not specified, will default to DOT_PRODUCT. Possible values are: DOT_PRODUCT, COSINE_DISTANCE.
final
filterFields → Input<List<String>?>?: The fields to push into the index to enable fast ANN inline filtering.
final
hashCode → int: The hash code for this object.
no setterinherited
indexField → Input<String>: The collection schema field to index.
final
indexId → Input<String>: ID of the Index to create. The id must be 1-63 characters long, and comply with RFC1035. Specifically, it must be 1-63 characters long and match the regular expression a-z?.
final
labels → Input<Map<String, String>?>?: Labels as key value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
final
location → Input<String>: Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
final
project → Input<String?>?: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
storeFields → Input<List<String>?>?: The fields to push into the index to enable inline data retrieval.
final

Methods

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

Operators

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