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

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 DeployedIndex

Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are DeployedIndex.automatic_resources and DeployedIndex.dedicated_resources

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.automatic_resources and DeployedIndex.dedicated_resources

Returns
Type Description
DeployedIndex|null

hasDeployedIndex

clearDeployedIndex

setDeployedIndex

Required. The DeployedIndex to be updated within the IndexEndpoint.

Currently, the updatable fields are DeployedIndex.automatic_resources and DeployedIndex.dedicated_resources

Parameter
Name Description
var 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 IndexEndpointServiceClient::indexEndpointName() for help formatting this field.

deployedIndex DeployedIndex

Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are DeployedIndex.automatic_resources and DeployedIndex.dedicated_resources

Returns
Type Description
MutateDeployedIndexRequest

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月08日 UTC.