Class protos.google.cloud.vectorsearch.v1beta.VectorSearchService (0.6.0)

Represents a VectorSearchService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.vectorsearch.v1beta.VectorSearchService

Package

@google-cloud/vectorsearch

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new VectorSearchService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): VectorSearchService;

Creates new VectorSearchService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
VectorSearchService

RPC service. Useful where requests and/or responses are streamed.

createCollection(request, callback)

public createCollection(request: google.cloud.vectorsearch.v1beta.ICreateCollectionRequest, callback: google.cloud.vectorsearch.v1beta.VectorSearchService.CreateCollectionCallback): void;

Calls CreateCollection.

Parameters
Name Description
request ICreateCollectionRequest

CreateCollectionRequest message or plain object
callback CreateCollectionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createCollection(request)

public createCollection(request: google.cloud.vectorsearch.v1beta.ICreateCollectionRequest): Promise<google.longrunning.Operation>;

Calls CreateCollection.

Parameter
Name Description
request ICreateCollectionRequest

CreateCollectionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createIndex(request, callback)

public createIndex(request: google.cloud.vectorsearch.v1beta.ICreateIndexRequest, callback: google.cloud.vectorsearch.v1beta.VectorSearchService.CreateIndexCallback): void;

Calls CreateIndex.

Parameters
Name Description
request ICreateIndexRequest

CreateIndexRequest message or plain object
callback CreateIndexCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createIndex(request)

public createIndex(request: google.cloud.vectorsearch.v1beta.ICreateIndexRequest): Promise<google.longrunning.Operation>;

Calls CreateIndex.

Parameter
Name Description
request ICreateIndexRequest

CreateIndexRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteCollection(request, callback)

public deleteCollection(request: google.cloud.vectorsearch.v1beta.IDeleteCollectionRequest, callback: google.cloud.vectorsearch.v1beta.VectorSearchService.DeleteCollectionCallback): void;

Calls DeleteCollection.

Parameters
Name Description
request IDeleteCollectionRequest

DeleteCollectionRequest message or plain object
callback DeleteCollectionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteCollection(request)

public deleteCollection(request: google.cloud.vectorsearch.v1beta.IDeleteCollectionRequest): Promise<google.longrunning.Operation>;

Calls DeleteCollection.

Parameter
Name Description
request IDeleteCollectionRequest

DeleteCollectionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteIndex(request, callback)

public deleteIndex(request: google.cloud.vectorsearch.v1beta.IDeleteIndexRequest, callback: google.cloud.vectorsearch.v1beta.VectorSearchService.DeleteIndexCallback): void;

Calls DeleteIndex.

Parameters
Name Description
request IDeleteIndexRequest

DeleteIndexRequest message or plain object
callback DeleteIndexCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteIndex(request)

public deleteIndex(request: google.cloud.vectorsearch.v1beta.IDeleteIndexRequest): Promise<google.longrunning.Operation>;

Calls DeleteIndex.

Parameter
Name Description
request IDeleteIndexRequest

DeleteIndexRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

exportDataObjects(request, callback)

public exportDataObjects(request: google.cloud.vectorsearch.v1beta.IExportDataObjectsRequest, callback: google.cloud.vectorsearch.v1beta.VectorSearchService.ExportDataObjectsCallback): void;

Calls ExportDataObjects.

Parameters
Name Description
request IExportDataObjectsRequest

ExportDataObjectsRequest message or plain object
callback ExportDataObjectsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

exportDataObjects(request)

public exportDataObjects(request: google.cloud.vectorsearch.v1beta.IExportDataObjectsRequest): Promise<google.longrunning.Operation>;

Calls ExportDataObjects.

Parameter
Name Description
request IExportDataObjectsRequest

ExportDataObjectsRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getCollection(request, callback)

public getCollection(request: google.cloud.vectorsearch.v1beta.IGetCollectionRequest, callback: google.cloud.vectorsearch.v1beta.VectorSearchService.GetCollectionCallback): void;

Calls GetCollection.

Parameters
Name Description
request IGetCollectionRequest

GetCollectionRequest message or plain object
callback GetCollectionCallback

Node-style callback called with the error, if any, and Collection
Returns
Type Description
void

getCollection(request)

public getCollection(request: google.cloud.vectorsearch.v1beta.IGetCollectionRequest): Promise<google.cloud.vectorsearch.v1beta.Collection>;

Calls GetCollection.

Parameter
Name Description
request IGetCollectionRequest

GetCollectionRequest message or plain object
Returns
Type Description
Promise<google.cloud.vectorsearch.v1beta.Collection>

Promise

getIndex(request, callback)

public getIndex(request: google.cloud.vectorsearch.v1beta.IGetIndexRequest, callback: google.cloud.vectorsearch.v1beta.VectorSearchService.GetIndexCallback): void;

Calls GetIndex.

Parameters
Name Description
request IGetIndexRequest

GetIndexRequest message or plain object
callback GetIndexCallback

Node-style callback called with the error, if any, and Index
Returns
Type Description
void

getIndex(request)

public getIndex(request: google.cloud.vectorsearch.v1beta.IGetIndexRequest): Promise<google.cloud.vectorsearch.v1beta.Index>;

Calls GetIndex.

Parameter
Name Description
request IGetIndexRequest

GetIndexRequest message or plain object
Returns
Type Description
Promise<google.cloud.vectorsearch.v1beta.Index>

Promise

importDataObjects(request, callback)

public importDataObjects(request: google.cloud.vectorsearch.v1beta.IImportDataObjectsRequest, callback: google.cloud.vectorsearch.v1beta.VectorSearchService.ImportDataObjectsCallback): void;

Calls ImportDataObjects.

Parameters
Name Description
request IImportDataObjectsRequest

ImportDataObjectsRequest message or plain object
callback ImportDataObjectsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

importDataObjects(request)

public importDataObjects(request: google.cloud.vectorsearch.v1beta.IImportDataObjectsRequest): Promise<google.longrunning.Operation>;

Calls ImportDataObjects.

Parameter
Name Description
request IImportDataObjectsRequest

ImportDataObjectsRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

listCollections(request, callback)

public listCollections(request: google.cloud.vectorsearch.v1beta.IListCollectionsRequest, callback: google.cloud.vectorsearch.v1beta.VectorSearchService.ListCollectionsCallback): void;

Calls ListCollections.

Parameters
Name Description
request IListCollectionsRequest

ListCollectionsRequest message or plain object
callback ListCollectionsCallback

Node-style callback called with the error, if any, and ListCollectionsResponse
Returns
Type Description
void

listCollections(request)

public listCollections(request: google.cloud.vectorsearch.v1beta.IListCollectionsRequest): Promise<google.cloud.vectorsearch.v1beta.ListCollectionsResponse>;

Calls ListCollections.

Parameter
Name Description
request IListCollectionsRequest

ListCollectionsRequest message or plain object
Returns
Type Description
Promise<google.cloud.vectorsearch.v1beta.ListCollectionsResponse>

Promise

listIndexes(request, callback)

public listIndexes(request: google.cloud.vectorsearch.v1beta.IListIndexesRequest, callback: google.cloud.vectorsearch.v1beta.VectorSearchService.ListIndexesCallback): void;

Calls ListIndexes.

Parameters
Name Description
request IListIndexesRequest

ListIndexesRequest message or plain object
callback ListIndexesCallback

Node-style callback called with the error, if any, and ListIndexesResponse
Returns
Type Description
void

listIndexes(request)

public listIndexes(request: google.cloud.vectorsearch.v1beta.IListIndexesRequest): Promise<google.cloud.vectorsearch.v1beta.ListIndexesResponse>;

Calls ListIndexes.

Parameter
Name Description
request IListIndexesRequest

ListIndexesRequest message or plain object
Returns
Type Description
Promise<google.cloud.vectorsearch.v1beta.ListIndexesResponse>

Promise

updateCollection(request, callback)

public updateCollection(request: google.cloud.vectorsearch.v1beta.IUpdateCollectionRequest, callback: google.cloud.vectorsearch.v1beta.VectorSearchService.UpdateCollectionCallback): void;

Calls UpdateCollection.

Parameters
Name Description
request IUpdateCollectionRequest

UpdateCollectionRequest message or plain object
callback UpdateCollectionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateCollection(request)

public updateCollection(request: google.cloud.vectorsearch.v1beta.IUpdateCollectionRequest): Promise<google.longrunning.Operation>;

Calls UpdateCollection.

Parameter
Name Description
request IUpdateCollectionRequest

UpdateCollectionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateIndex(request, callback)

public updateIndex(request: google.cloud.vectorsearch.v1beta.IUpdateIndexRequest, callback: google.cloud.vectorsearch.v1beta.VectorSearchService.UpdateIndexCallback): void;

Calls UpdateIndex.

Parameters
Name Description
request IUpdateIndexRequest

UpdateIndexRequest message or plain object
callback UpdateIndexCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateIndex(request)

public updateIndex(request: google.cloud.vectorsearch.v1beta.IUpdateIndexRequest): Promise<google.longrunning.Operation>;

Calls UpdateIndex.

Parameter
Name Description
request IUpdateIndexRequest

UpdateIndexRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise