Google Cloud Ai Platform V1 Client - Class ReadIndexDatapointsRequest (0.17.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ReadIndexDatapointsRequest.

The request message for MatchService.ReadIndexDatapoints.

Generated from protobuf message google.cloud.aiplatform.v1.ReadIndexDatapointsRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ index_endpoint string

Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

↳ deployed_index_id string

The ID of the DeployedIndex that will serve the request.

↳ ids array

IDs of the datapoints to be searched for.

getIndexEndpoint

Required. The name of the index endpoint.

Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Returns
TypeDescription
string

setIndexEndpoint

Required. The name of the index endpoint.

Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDeployedIndexId

The ID of the DeployedIndex that will serve the request.

Returns
TypeDescription
string

setDeployedIndexId

The ID of the DeployedIndex that will serve the request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIds

IDs of the datapoints to be searched for.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIds

IDs of the datapoints to be searched for.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this