Class protos.google.cloud.aiplatform.v1beta1.IndexService (2.3.0)

Represents an IndexService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.aiplatform.v1beta1.IndexService

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new IndexService 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): IndexService;

Creates new IndexService 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
IndexService	RPC service. Useful where requests and/or responses are streamed.

createIndex(request, callback)

public createIndex(request: google.cloud.aiplatform.v1beta1.ICreateIndexRequest, callback: google.cloud.aiplatform.v1beta1.IndexService.CreateIndexCallback): void;

Calls CreateIndex.

Parameters

Name	Description
request	`ICreateIndexRequest` CreateIndexRequest message or plain object
callback	`google.cloud.aiplatform.v1beta1.IndexService.CreateIndexCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

createIndex(request)

public createIndex(request: google.cloud.aiplatform.v1beta1.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

deleteIndex(request, callback)

public deleteIndex(request: google.cloud.aiplatform.v1beta1.IDeleteIndexRequest, callback: google.cloud.aiplatform.v1beta1.IndexService.DeleteIndexCallback): void;

Calls DeleteIndex.

Parameters

Name	Description
request	`IDeleteIndexRequest` DeleteIndexRequest message or plain object
callback	`google.cloud.aiplatform.v1beta1.IndexService.DeleteIndexCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

deleteIndex(request)

public deleteIndex(request: google.cloud.aiplatform.v1beta1.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

getIndex(request, callback)

public getIndex(request: google.cloud.aiplatform.v1beta1.IGetIndexRequest, callback: google.cloud.aiplatform.v1beta1.IndexService.GetIndexCallback): void;

Calls GetIndex.

Parameters

Name	Description
request	`google.cloud.aiplatform.v1beta1.IGetIndexRequest` GetIndexRequest message or plain object
callback	`google.cloud.aiplatform.v1beta1.IndexService.GetIndexCallback` Node-style callback called with the error, if any, and Index

Returns

Type	Description
void

getIndex(request)

public getIndex(request: google.cloud.aiplatform.v1beta1.IGetIndexRequest): Promise<google.cloud.aiplatform.v1beta1.Index>;

Calls GetIndex.

Parameter

Name	Description
request	`google.cloud.aiplatform.v1beta1.IGetIndexRequest` GetIndexRequest message or plain object

Returns

Type	Description
Promise<google.cloud.aiplatform.v1beta1.Index>	Promise

listIndexes(request, callback)

public listIndexes(request: google.cloud.aiplatform.v1beta1.IListIndexesRequest, callback: google.cloud.aiplatform.v1beta1.IndexService.ListIndexesCallback): void;

Calls ListIndexes.

Parameters

Name	Description
request	`IListIndexesRequest` ListIndexesRequest message or plain object
callback	`google.cloud.aiplatform.v1beta1.IndexService.ListIndexesCallback` Node-style callback called with the error, if any, and ListIndexesResponse

Returns

Type	Description
void

listIndexes(request)

public listIndexes(request: google.cloud.aiplatform.v1beta1.IListIndexesRequest): Promise<google.cloud.aiplatform.v1beta1.ListIndexesResponse>;

Calls ListIndexes.

Parameter

Name	Description
request	`IListIndexesRequest` ListIndexesRequest message or plain object

Returns

Type	Description
Promise<google.cloud.aiplatform.v1beta1.ListIndexesResponse>	Promise

removeDatapoints(request, callback)

public removeDatapoints(request: google.cloud.aiplatform.v1beta1.IRemoveDatapointsRequest, callback: google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapointsCallback): void;

Calls RemoveDatapoints.

Parameters

Name	Description
request	`IRemoveDatapointsRequest` RemoveDatapointsRequest message or plain object
callback	`google.cloud.aiplatform.v1beta1.IndexService.RemoveDatapointsCallback` Node-style callback called with the error, if any, and RemoveDatapointsResponse

Returns

Type	Description
void

removeDatapoints(request)

public removeDatapoints(request: google.cloud.aiplatform.v1beta1.IRemoveDatapointsRequest): Promise<google.cloud.aiplatform.v1beta1.RemoveDatapointsResponse>;

Calls RemoveDatapoints.

Parameter

Name	Description
request	`IRemoveDatapointsRequest` RemoveDatapointsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.aiplatform.v1beta1.RemoveDatapointsResponse>	Promise

updateIndex(request, callback)

public updateIndex(request: google.cloud.aiplatform.v1beta1.IUpdateIndexRequest, callback: google.cloud.aiplatform.v1beta1.IndexService.UpdateIndexCallback): void;

Calls UpdateIndex.

Parameters

Name	Description
request	`IUpdateIndexRequest` UpdateIndexRequest message or plain object
callback	`google.cloud.aiplatform.v1beta1.IndexService.UpdateIndexCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

updateIndex(request)

public updateIndex(request: google.cloud.aiplatform.v1beta1.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

upsertDatapoints(request, callback)

public upsertDatapoints(request: google.cloud.aiplatform.v1beta1.IUpsertDatapointsRequest, callback: google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapointsCallback): void;

Calls UpsertDatapoints.

Parameters

Name	Description
request	`IUpsertDatapointsRequest` UpsertDatapointsRequest message or plain object
callback	`google.cloud.aiplatform.v1beta1.IndexService.UpsertDatapointsCallback` Node-style callback called with the error, if any, and UpsertDatapointsResponse

Returns

Type	Description
void

upsertDatapoints(request)

public upsertDatapoints(request: google.cloud.aiplatform.v1beta1.IUpsertDatapointsRequest): Promise<google.cloud.aiplatform.v1beta1.UpsertDatapointsResponse>;

Calls UpsertDatapoints.

Parameter

Name	Description
request	`IUpsertDatapointsRequest` UpsertDatapointsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.aiplatform.v1beta1.UpsertDatapointsResponse>	Promise