Vector Search v1 API - Class Collection (1.0.0-beta05)

public sealed class Collection : IMessage<Collection>, IEquatable<Collection>, IDeepCloneable<Collection>, IBufferMessage, IMessage

Reference documentation and code samples for the Vector Search v1 API class Collection.

Message describing Collection object

Inheritance

object > Collection

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

Collection()

public Collection()

Collection(Collection)

public Collection(Collection other)
Parameter
Name Description
other Collection

Properties

CollectionName

public CollectionName CollectionName { get; set; }

CollectionName-typed view over the Name resource name property.

Property Value
Type Description
CollectionName

CreateTime

public Timestamp CreateTime { get; set; }

Output only. [Output only] Create time stamp

Property Value
Type Description
Timestamp

DataSchema

public Struct DataSchema { get; set; }

Optional. JSON Schema for data. Field names must contain only alphanumeric characters, underscores, and hyphens. The schema must be compliant with JSON Schema Draft 7.

Property Value
Type Description
Struct

Description

public string Description { get; set; }

Optional. User-specified description of the collection

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Optional. User-specified display name of the collection

Property Value
Type Description
string

EncryptionSpec

public EncryptionSpec EncryptionSpec { get; set; }

Optional. Immutable. Specifies the customer-managed encryption key spec for a Collection. If set, this Collection and all sub-resources of this Collection will be secured by this key.

Property Value
Type Description
EncryptionSpec

Labels

public MapField<string, string> Labels { get; }

Optional. Labels as key value pairs.

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

Identifier. name of resource

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. [Output only] Update time stamp

Property Value
Type Description
Timestamp

VectorSchema

public MapField<string, VectorField> VectorSchema { get; }

Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens.

Property Value
Type Description
MapFieldstringVectorField