Represents a Collection.
Package
@google-cloud/vectorsearchConstructors
(constructor)(properties)
constructor(properties?: google.cloud.vectorsearch.v1beta.ICollection);Constructs a new Collection.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICollection
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Collection createTime.
dataSchema
public dataSchema?: (google.protobuf.IStruct|null);Collection dataSchema.
description
public description: string;Collection description.
displayName
public displayName: string;Collection displayName.
labels
public labels: { [k: string]: string };Collection labels.
name
public name: string;Collection name.
schema
public schema?: (google.protobuf.IStruct|null);Collection schema.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Collection updateTime.
vectorSchema
public vectorSchema: { [k: string]: google.cloud.vectorsearch.v1beta.IVectorField };Collection vectorSchema.
Methods
create(properties)
public static create(properties?: google.cloud.vectorsearch.v1beta.ICollection): google.cloud.vectorsearch.v1beta.Collection;Creates a new Collection instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICollection
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Collection |
Collection instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.vectorsearch.v1beta.Collection;Decodes a Collection message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Collection |
Collection |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.vectorsearch.v1beta.Collection;Decodes a Collection message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Collection |
Collection |
encode(message, writer)
public static encode(message: google.cloud.vectorsearch.v1beta.ICollection, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Collection message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICollection
Collection message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.vectorsearch.v1beta.ICollection, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Collection message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICollection
Collection message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.vectorsearch.v1beta.Collection;Creates a Collection message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Collection |
Collection |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Collection
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Collection to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.vectorsearch.v1beta.Collection, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Collection message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Collection
Collection |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Collection message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|