Google Cloud Ai Platform V1 Client - Class DeployIndexRequest (0.16.0)

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

Request message for IndexEndpointService.DeployIndex.

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

Methods

build

Parameters
Name	Description
`indexEndpoint`	`string` Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{___location}/indexEndpoints/{index_endpoint}` Please see {@see \Google\Cloud\AIPlatform\V1\IndexEndpointServiceClient::indexEndpointName()} for help formatting this field.
`deployedIndex`	`Google\Cloud\AIPlatform\V1\DeployedIndex` Required. The DeployedIndex to be created within the IndexEndpoint.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\DeployIndexRequest`

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ index_endpoint`	`string` Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{___location}/indexEndpoints/{index_endpoint}`
`↳ deployed_index`	`Google\Cloud\AIPlatform\V1\DeployedIndex` Required. The DeployedIndex to be created within the IndexEndpoint.

getIndexEndpoint

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{___location}/indexEndpoints/{index_endpoint}

Returns
Type	Description
`string`

setIndexEndpoint

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{___location}/indexEndpoints/{index_endpoint}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDeployedIndex

Required. The DeployedIndex to be created within the IndexEndpoint.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\DeployedIndex\|null`

hasDeployedIndex

clearDeployedIndex

setDeployedIndex