CollectionArgs class - vectorsearch library

Constructors

CollectionArgs({required Input<String> collectionId, Input<String?>? dataSchema, Input<String?>? deletionPolicy, Input<String?>? description, Input<String?>? displayName, Input<CollectionEncryptionSpec?>? encryptionSpec, Input<Map<String, String>?>? labels, required Input<String> location, Input<String?>? project, Input<List<CollectionVectorSchema>?>? vectorSchemas}): Creates a new CollectionArgs. collectionId ID of the Collection to create. dataSchema JSON Schema for data. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description User-specified description of the collection displayName User-specified display name of the collection encryptionSpec Represents a customer-managed encryption key specification that can be 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. vectorSchemas Schema for vector fields. Only vector fields in this schema will be
const
CollectionArgs.fromMap(Map<String, dynamic> map): factory

Properties

collectionId → Input<String>: ID of the Collection 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
dataSchema → Input<String?>?: JSON Schema for data. Field names must contain only alphanumeric characters, underscores, and hyphens.
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
description → Input<String?>?: User-specified description of the collection
final
displayName → Input<String?>?: User-specified display name of the collection
final
encryptionSpec → Input<CollectionEncryptionSpec?>?: Represents a customer-managed encryption key specification that can be applied to a Vector Search collection. Structure is documented below.
final
hashCode → int: The hash code for this object.
no setterinherited
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
vectorSchemas → Input<List<CollectionVectorSchema>?>?: Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens. Structure is documented below.
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