Google Cloud Ai Platform V1 Client - Class MutateDeployedIndexRequest (0.39.0)

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

Request message for IndexEndpointService.MutateDeployedIndex.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__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 updated within the IndexEndpoint. Currently, the updatable fields are DeployedIndex and DeployedIndex

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 updated within the IndexEndpoint.

Currently, the updatable fields are DeployedIndex and DeployedIndex

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

hasDeployedIndex

clearDeployedIndex

setDeployedIndex

Required. The DeployedIndex to be updated within the IndexEndpoint.

Currently, the updatable fields are DeployedIndex and DeployedIndex

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\DeployedIndex`

Returns
Type	Description
`$this`

static::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 Google\Cloud\AIPlatform\V1\IndexEndpointServiceClient::indexEndpointName() for help formatting this field.
`deployedIndex`	`Google\Cloud\AIPlatform\V1\DeployedIndex` Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are DeployedIndex and DeployedIndex

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