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: |
↳ 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 | |