- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 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 DeployedIndex.
A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.
Generated from protobuf message google.cloud.aiplatform.v1.DeployedIndex
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ id
string
Required. The user specified ID of the DeployedIndex. The ID can be up to 128 characters long and must start with a letter and only contain letters, numbers, and underscores. The ID must be unique within the project it is created in.
↳ index
string
Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's "original" Index.
↳ display_name
string
The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
↳ create_time
Google\Protobuf\Timestamp
Output only. Timestamp when the DeployedIndex was created.
↳ private_endpoints
Google\Cloud\AIPlatform\V1\IndexPrivateEndpoints
Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.
↳ index_sync_time
Google\Protobuf\Timestamp
Output only. The DeployedIndex may depend on various data on its original Index. Additionally when certain changes to the original Index are being done (e.g. when what the Index contains is being changed) the DeployedIndex may be asynchronously updated in the background to reflect this changes. If this timestamp's value is at least the Index.update_time of the original Index, it means that this DeployedIndex and the original Index are in sync. If this timestamp is older, then to see which updates this DeployedIndex already contains (and which not), one must list Operations working on the original Index. Only the successfully completed Operations with [Operations.metadata.generic_metadata.update_time] [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] equal or before this sync time are contained in this DeployedIndex.
↳ automatic_resources
Google\Cloud\AIPlatform\V1\AutomaticResources
Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000.
↳ dedicated_resources
Google\Cloud\AIPlatform\V1\DedicatedResources
Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types: n1-standard-16 n1-standard-32
↳ enable_access_logging
bool
Optional. If true, private endpoint's access logs are sent to StackDriver Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that Stackdriver logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
↳ deployed_index_auth_config
Google\Cloud\AIPlatform\V1\DeployedIndexAuthConfig
Optional. If set, the authentication is enabled for the private endpoint.
↳ reserved_ip_ranges
array
Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value sohuld be the name of the address ( https://cloud.google.com/compute/docs/reference/rest/v1/addresses ) Example: 'vertex-ai-ip-range'.
↳ deployment_group
string
Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating deployment_groups
with reserved_ip_ranges
is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').
getId
Required. The user specified ID of the DeployedIndex.
The ID can be up to 128 characters long and must start with a letter and only contain letters, numbers, and underscores. The ID must be unique within the project it is created in.
Generated from protobuf field string id = 1 [(.google.api.field_behavior) = REQUIRED];
string
setId
Required. The user specified ID of the DeployedIndex.
The ID can be up to 128 characters long and must start with a letter and only contain letters, numbers, and underscores. The ID must be unique within the project it is created in.
Generated from protobuf field string id = 1 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getIndex
Required. The name of the Index this is the deployment of.
We may refer to this Index as the DeployedIndex's "original" Index.
Generated from protobuf field string index = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
string
setIndex
Required. The name of the Index this is the deployment of.
We may refer to this Index as the DeployedIndex's "original" Index.
Generated from protobuf field string index = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
var
string
$this
getDisplayName
The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
Generated from protobuf field string display_name = 3;
string
setDisplayName
The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
Generated from protobuf field string display_name = 3;
var
string
$this
getCreateTime
Output only. Timestamp when the DeployedIndex was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when the DeployedIndex was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getPrivateEndpoints
Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.
Generated from protobuf field .google.cloud.aiplatform.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasPrivateEndpoints
clearPrivateEndpoints
setPrivateEndpoints
Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.
Generated from protobuf field .google.cloud.aiplatform.v1.IndexPrivateEndpoints private_endpoints = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
$this
getIndexSyncTime
Output only. The DeployedIndex may depend on various data on its original Index.
Additionally when certain changes to the original Index are being done (e.g. when what the Index contains is being changed) the DeployedIndex may be asynchronously updated in the background to reflect this changes. If this timestamp's value is at least the Index.update_time of the original Index, it means that this DeployedIndex and the original Index are in sync. If this timestamp is older, then to see which updates this DeployedIndex already contains (and which not), one must list Operations working on the original Index. Only the successfully completed Operations with [Operations.metadata.generic_metadata.update_time] [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] equal or before this sync time are contained in this DeployedIndex.
Generated from protobuf field .google.protobuf.Timestamp index_sync_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasIndexSyncTime
clearIndexSyncTime
setIndexSyncTime
Output only. The DeployedIndex may depend on various data on its original Index.
Additionally when certain changes to the original Index are being done (e.g. when what the Index contains is being changed) the DeployedIndex may be asynchronously updated in the background to reflect this changes. If this timestamp's value is at least the Index.update_time of the original Index, it means that this DeployedIndex and the original Index are in sync. If this timestamp is older, then to see which updates this DeployedIndex already contains (and which not), one must list Operations working on the original Index. Only the successfully completed Operations with [Operations.metadata.generic_metadata.update_time] [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] equal or before this sync time are contained in this DeployedIndex.
Generated from protobuf field .google.protobuf.Timestamp index_sync_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getAutomaticResources
Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration.
If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000.
Generated from protobuf field .google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
hasAutomaticResources
clearAutomaticResources
setAutomaticResources
Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration.
If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000.
Generated from protobuf field .google.cloud.aiplatform.v1.AutomaticResources automatic_resources = 7 [(.google.api.field_behavior) = OPTIONAL];
$this
getDedicatedResources
Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration.
If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types: n1-standard-16 n1-standard-32
Generated from protobuf field .google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
hasDedicatedResources
clearDedicatedResources
setDedicatedResources
Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration.
If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types: n1-standard-16 n1-standard-32
Generated from protobuf field .google.cloud.aiplatform.v1.DedicatedResources dedicated_resources = 16 [(.google.api.field_behavior) = OPTIONAL];
$this
getEnableAccessLogging
Optional. If true, private endpoint's access logs are sent to StackDriver Logging.
These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that Stackdriver logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
Generated from protobuf field bool enable_access_logging = 8 [(.google.api.field_behavior) = OPTIONAL];
bool
setEnableAccessLogging
Optional. If true, private endpoint's access logs are sent to StackDriver Logging.
These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that Stackdriver logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.
Generated from protobuf field bool enable_access_logging = 8 [(.google.api.field_behavior) = OPTIONAL];
var
bool
$this
getDeployedIndexAuthConfig
Optional. If set, the authentication is enabled for the private endpoint.
Generated from protobuf field .google.cloud.aiplatform.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];
hasDeployedIndexAuthConfig
clearDeployedIndexAuthConfig
setDeployedIndexAuthConfig
Optional. If set, the authentication is enabled for the private endpoint.
Generated from protobuf field .google.cloud.aiplatform.v1.DeployedIndexAuthConfig deployed_index_auth_config = 9 [(.google.api.field_behavior) = OPTIONAL];
$this
getReservedIpRanges
Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex.
If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value sohuld be the name of the address ( https://cloud.google.com/compute/docs/reference/rest/v1/addresses ) Example: 'vertex-ai-ip-range'.
Generated from protobuf field repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\RepeatedField
setReservedIpRanges
Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex.
If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value sohuld be the name of the address ( https://cloud.google.com/compute/docs/reference/rest/v1/addresses ) Example: 'vertex-ai-ip-range'.
Generated from protobuf field repeated string reserved_ip_ranges = 10 [(.google.api.field_behavior) = OPTIONAL];
var
string[]
$this
getDeploymentGroup
Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group.
Creating deployment_groups
with reserved_ip_ranges
is a recommended
practice when the peered network has multiple peering ranges. This creates
your deployments from predictable IP spaces for easier traffic
administration. Also, one deployment_group (except 'default') can only be
used with the same reserved_ip_ranges which means if the deployment_group
has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or
[d, e] is disallowed.
Note: we only support up to 5 deployment groups(not including 'default').
Generated from protobuf field string deployment_group = 11 [(.google.api.field_behavior) = OPTIONAL];
string
setDeploymentGroup
Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group.
Creating deployment_groups
with reserved_ip_ranges
is a recommended
practice when the peered network has multiple peering ranges. This creates
your deployments from predictable IP spaces for easier traffic
administration. Also, one deployment_group (except 'default') can only be
used with the same reserved_ip_ranges which means if the deployment_group
has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or
[d, e] is disallowed.
Note: we only support up to 5 deployment groups(not including 'default').
Generated from protobuf field string deployment_group = 11 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
