Google Cloud Ai Platform V1 Client - Class DeployedIndex (0.21.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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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 these 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 it does not), one must list the operations that are running on the original Index. Only the successfully completed Operations with 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 for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency.
`↳ enable_access_logging`	`bool` Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that 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 should 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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.

Returns
Type	Description
`string`

setDisplayName

The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Timestamp when the DeployedIndex was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when the DeployedIndex was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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.

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

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.

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

Returns
Type	Description
`$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 these 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 it does not), one must list the operations that are running on the original Index. Only the successfully completed Operations with update_time equal or before this sync time are contained in this DeployedIndex.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasIndexSyncTime

clearIndexSyncTime

setIndexSyncTime

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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.

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

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.

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

Returns
Type	Description
`$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 for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency.

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

hasDedicatedResources

clearDedicatedResources

setDedicatedResources

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

Returns
Type	Description
`$this`

getEnableAccessLogging

Optional. If true, private endpoint's access logs are sent to Cloud Logging.

These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that 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.

Returns
Type	Description
`bool`

setEnableAccessLogging

Optional. If true, private endpoint's access logs are sent to Cloud Logging.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getDeployedIndexAuthConfig

Optional. If set, the authentication is enabled for the private endpoint.

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

hasDeployedIndexAuthConfig

clearDeployedIndexAuthConfig

setDeployedIndexAuthConfig

Optional. If set, the authentication is enabled for the private endpoint.

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

Returns
Type	Description
`$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 should be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: 'vertex-ai-ip-range'.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setReservedIpRanges

Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$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').

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`