Class protos.google.cloud.aiplatform.v1.IndexEndpointService (2.6.1)

Version 2.6.1

• 3.15.0 (latest)
• 3.13.0
• 3.11.0
• 3.10.1
• 3.9.0
• 3.7.0
• 3.6.0
• 3.4.0
• 3.3.0
• 3.0.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.7.0
• 2.6.1
• 2.5.0
• 2.3.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.0
• 1.11.0
• 1.7.2

Represents an IndexEndpointService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.aiplatform.v1.IndexEndpointService

Package

@google-cloud/aiplatform

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

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

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

createIndexEndpoint(request, callback)

public createIndexEndpoint(request: google.cloud.aiplatform.v1.ICreateIndexEndpointRequest, callback: google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpointCallback): void;

Calls CreateIndexEndpoint.

Parameters

Name	Description
request	ICreateIndexEndpointRequest CreateIndexEndpointRequest message or plain object
callback	google.cloud.aiplatform.v1.IndexEndpointService.CreateIndexEndpointCallback Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

createIndexEndpoint(request)

public createIndexEndpoint(request: google.cloud.aiplatform.v1.ICreateIndexEndpointRequest): Promise<google.longrunning.Operation>;

Calls CreateIndexEndpoint.

Parameter

Name	Description
request	ICreateIndexEndpointRequest CreateIndexEndpointRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

deleteIndexEndpoint(request, callback)

public deleteIndexEndpoint(request: google.cloud.aiplatform.v1.IDeleteIndexEndpointRequest, callback: google.cloud.aiplatform.v1.IndexEndpointService.DeleteIndexEndpointCallback): void;

Calls DeleteIndexEndpoint.

Parameters

Name	Description
request	google.cloud.aiplatform.v1.IDeleteIndexEndpointRequest DeleteIndexEndpointRequest message or plain object
callback	google.cloud.aiplatform.v1.IndexEndpointService.DeleteIndexEndpointCallback Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

deleteIndexEndpoint(request)

public deleteIndexEndpoint(request: google.cloud.aiplatform.v1.IDeleteIndexEndpointRequest): Promise<google.longrunning.Operation>;

Calls DeleteIndexEndpoint.

Parameter

Name	Description
request	google.cloud.aiplatform.v1.IDeleteIndexEndpointRequest DeleteIndexEndpointRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

deployIndex(request, callback)

public deployIndex(request: google.cloud.aiplatform.v1.IDeployIndexRequest, callback: google.cloud.aiplatform.v1.IndexEndpointService.DeployIndexCallback): void;

Calls DeployIndex.

Parameters

Name	Description
request	IDeployIndexRequest DeployIndexRequest message or plain object
callback	google.cloud.aiplatform.v1.IndexEndpointService.DeployIndexCallback Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

deployIndex(request)

public deployIndex(request: google.cloud.aiplatform.v1.IDeployIndexRequest): Promise<google.longrunning.Operation>;

Calls DeployIndex.

Parameter

Name	Description
request	IDeployIndexRequest DeployIndexRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

getIndexEndpoint(request, callback)

public getIndexEndpoint(request: google.cloud.aiplatform.v1.IGetIndexEndpointRequest, callback: google.cloud.aiplatform.v1.IndexEndpointService.GetIndexEndpointCallback): void;

Calls GetIndexEndpoint.

Parameters

Name	Description
request	google.cloud.aiplatform.v1.IGetIndexEndpointRequest GetIndexEndpointRequest message or plain object
callback	google.cloud.aiplatform.v1.IndexEndpointService.GetIndexEndpointCallback Node-style callback called with the error, if any, and IndexEndpoint

Returns

Type	Description
void

getIndexEndpoint(request)

public getIndexEndpoint(request: google.cloud.aiplatform.v1.IGetIndexEndpointRequest): Promise<google.cloud.aiplatform.v1.IndexEndpoint>;

Calls GetIndexEndpoint.

Parameter

Name	Description
request	google.cloud.aiplatform.v1.IGetIndexEndpointRequest GetIndexEndpointRequest message or plain object

Returns

Type	Description
Promise<google.cloud.aiplatform.v1.IndexEndpoint>	Promise

listIndexEndpoints(request, callback)

public listIndexEndpoints(request: google.cloud.aiplatform.v1.IListIndexEndpointsRequest, callback: google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpointsCallback): void;

Calls ListIndexEndpoints.

Parameters

Name	Description
request	google.cloud.aiplatform.v1.IListIndexEndpointsRequest ListIndexEndpointsRequest message or plain object
callback	google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpointsCallback Node-style callback called with the error, if any, and ListIndexEndpointsResponse

Returns

Type	Description
void

listIndexEndpoints(request)

public listIndexEndpoints(request: google.cloud.aiplatform.v1.IListIndexEndpointsRequest): Promise<google.cloud.aiplatform.v1.ListIndexEndpointsResponse>;

Calls ListIndexEndpoints.

Parameter

Name	Description
request	google.cloud.aiplatform.v1.IListIndexEndpointsRequest ListIndexEndpointsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.aiplatform.v1.ListIndexEndpointsResponse>	Promise

mutateDeployedIndex(request, callback)

public mutateDeployedIndex(request: google.cloud.aiplatform.v1.IMutateDeployedIndexRequest, callback: google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndexCallback): void;

Calls MutateDeployedIndex.

Parameters

Name	Description
request	google.cloud.aiplatform.v1.IMutateDeployedIndexRequest MutateDeployedIndexRequest message or plain object
callback	google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndexCallback Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

mutateDeployedIndex(request)

public mutateDeployedIndex(request: google.cloud.aiplatform.v1.IMutateDeployedIndexRequest): Promise<google.longrunning.Operation>;

Calls MutateDeployedIndex.

Parameter

Name	Description
request	google.cloud.aiplatform.v1.IMutateDeployedIndexRequest MutateDeployedIndexRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

undeployIndex(request, callback)

public undeployIndex(request: google.cloud.aiplatform.v1.IUndeployIndexRequest, callback: google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndexCallback): void;

Calls UndeployIndex.

Parameters

Name	Description
request	IUndeployIndexRequest UndeployIndexRequest message or plain object
callback	google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndexCallback Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

undeployIndex(request)

public undeployIndex(request: google.cloud.aiplatform.v1.IUndeployIndexRequest): Promise<google.longrunning.Operation>;

Calls UndeployIndex.

Parameter

Name	Description
request	IUndeployIndexRequest UndeployIndexRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

updateIndexEndpoint(request, callback)

public updateIndexEndpoint(request: google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest, callback: google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpointCallback): void;

Calls UpdateIndexEndpoint.

Parameters

Name	Description
request	google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest UpdateIndexEndpointRequest message or plain object
callback	google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpointCallback Node-style callback called with the error, if any, and IndexEndpoint

Returns

Type	Description
void

updateIndexEndpoint(request)

public updateIndexEndpoint(request: google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest): Promise<google.cloud.aiplatform.v1.IndexEndpoint>;

Calls UpdateIndexEndpoint.

Parameter

Name	Description
request	google.cloud.aiplatform.v1.IUpdateIndexEndpointRequest UpdateIndexEndpointRequest message or plain object

Returns

Type	Description
Promise<google.cloud.aiplatform.v1.IndexEndpoint>	Promise