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

Version 0.10.0

• 1.13.1 (latest)
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.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

__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}

Generated from protobuf field string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

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}

Generated from protobuf field string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDeployedIndex

Required. The DeployedIndex to be created within the IndexEndpoint.

Generated from protobuf field .google.cloud.aiplatform.v1.DeployedIndex deployed_index = 2 [(.google.api.field_behavior) = REQUIRED];

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

hasDeployedIndex

clearDeployedIndex

setDeployedIndex

Required. The DeployedIndex to be created within the IndexEndpoint.

Generated from protobuf field .google.cloud.aiplatform.v1.DeployedIndex deployed_index = 2 [(.google.api.field_behavior) = REQUIRED];

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

Returns
Type	Description
$this