index_endpoints

Creates, updates, deletes, gets or lists an index_endpoints resource.

Overview

Name	index_endpoints
Type	Resource
Id	google.aiplatform.index_endpoints

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. The resource name of the IndexEndpoint.
createTime	string (google-datetime)	Output only. Timestamp when this IndexEndpoint was created.
deployedIndexes	array	Output only. The indexes deployed in this endpoint.
description	string	The description of the IndexEndpoint.
displayName	string	Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.
enablePrivateServiceConnect	boolean	Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set.
encryptionSpec	object	Immutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be secured by this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
etag	string	Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	The labels with user-defined metadata to organize your IndexEndpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
network	string	Optional. The full name of the Google Compute Engine network to which the IndexEndpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. network and private_service_connect_config are mutually exclusive. Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in '12345', and {network} is network name.
privateServiceConnectConfig	object	Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. (id: GoogleCloudAiplatformV1PrivateServiceConnectConfig)
publicEndpointDomainName	string	Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.
publicEndpointEnabled	boolean	Optional. If true, the deployed index will be accessible through public endpoint.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
updateTime	string (google-datetime)	Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.

list

Name	Datatype	Description
name	string	Output only. The resource name of the IndexEndpoint.
createTime	string (google-datetime)	Output only. Timestamp when this IndexEndpoint was created.
deployedIndexes	array	Output only. The indexes deployed in this endpoint.
description	string	The description of the IndexEndpoint.
displayName	string	Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.
enablePrivateServiceConnect	boolean	Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set.
encryptionSpec	object	Immutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be secured by this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
etag	string	Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	The labels with user-defined metadata to organize your IndexEndpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
network	string	Optional. The full name of the Google Compute Engine network to which the IndexEndpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. network and private_service_connect_config are mutually exclusive. Format: projects/{project}/global/networks/{network}. Where {project} is a project number, as in '12345', and {network} is network name.
privateServiceConnectConfig	object	Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. (id: GoogleCloudAiplatformV1PrivateServiceConnectConfig)
publicEndpointDomainName	string	Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.
publicEndpointEnabled	boolean	Optional. If true, the deployed index will be accessible through public endpoint.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
updateTime	string (google-datetime)	Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, indexEndpointsId		Gets an IndexEndpoint.
list	select	projectsId, locationsId	filter, pageToken, pageSize, readMask	Lists IndexEndpoints in a Location.
create	insert	projectsId, locationsId		Creates an IndexEndpoint.
patch	update	projectsId, locationsId, indexEndpointsId	updateMask	Updates an IndexEndpoint.
delete	delete	projectsId, locationsId, indexEndpointsId		Deletes an IndexEndpoint.
undeploy_index	exec	projectsId, locationsId, indexEndpointsId		Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
mutate_deployed_index	exec	projectsId, locationsId, indexEndpointsId	updateMask	Update an existing DeployedIndex under an IndexEndpoint.
find_neighbors	exec	projectsId, locationsId, indexEndpointsId		Finds the nearest neighbors of each vector within the request.
read_index_datapoints	exec	projectsId, locationsId, indexEndpointsId		Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.
deploy_index	exec	projectsId, locationsId, indexEndpointsId		Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
indexEndpointsId	string
locationsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)
updateMask	string (google-fieldmask)

SELECT examples

get

Gets an IndexEndpoint.

SELECT
name,
createTime,
deployedIndexes,
description,
displayName,
enablePrivateServiceConnect,
encryptionSpec,
etag,
labels,
network,
privateServiceConnectConfig,
publicEndpointDomainName,
publicEndpointEnabled,
satisfiesPzi,
satisfiesPzs,
updateTime
FROM google.aiplatform.index_endpoints
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND indexEndpointsId = '{{ indexEndpointsId }}' -- required
;

list

Lists IndexEndpoints in a Location.

SELECT
name,
createTime,
deployedIndexes,
description,
displayName,
enablePrivateServiceConnect,
encryptionSpec,
etag,
labels,
network,
privateServiceConnectConfig,
publicEndpointDomainName,
publicEndpointEnabled,
satisfiesPzi,
satisfiesPzs,
updateTime
FROM google.aiplatform.index_endpoints
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND readMask = '{{ readMask }}'
;

INSERT examples

create

Creates an IndexEndpoint.

INSERT INTO google.aiplatform.index_endpoints (
data__displayName,
data__etag,
data__description,
data__privateServiceConnectConfig,
data__enablePrivateServiceConnect,
data__network,
data__publicEndpointEnabled,
data__encryptionSpec,
data__labels,
projectsId,
locationsId
)
SELECT 
'{{ displayName }}',
'{{ etag }}',
'{{ description }}',
'{{ privateServiceConnectConfig }}',
{{ enablePrivateServiceConnect }},
'{{ network }}',
{{ publicEndpointEnabled }},
'{{ encryptionSpec }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: index_endpoints
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the index_endpoints resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the index_endpoints resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.
  - name: etag
    value: "{{ etag }}"
    description: |
      Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  - name: description
    value: "{{ description }}"
    description: |
      The description of the IndexEndpoint.
  - name: privateServiceConnectConfig
    description: |
      Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.
    value:
      enablePrivateServiceConnect: {{ enablePrivateServiceConnect }}
      projectAllowlist:
        - "{{ projectAllowlist }}"
      serviceAttachment: "{{ serviceAttachment }}"
      pscAutomationConfigs:
        - network: "{{ network }}"
          forwardingRule: "{{ forwardingRule }}"
          state: "{{ state }}"
          errorMessage: "{{ errorMessage }}"
          ipAddress: "{{ ipAddress }}"
          projectId: "{{ projectId }}"
  - name: enablePrivateServiceConnect
    value: {{ enablePrivateServiceConnect }}
    description: |
      Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set.
  - name: network
    value: "{{ network }}"
    description: |
      Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the IndexEndpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. network and private_service_connect_config are mutually exclusive. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name.
  - name: publicEndpointEnabled
    value: {{ publicEndpointEnabled }}
    description: |
      Optional. If true, the deployed index will be accessible through public endpoint.
  - name: encryptionSpec
    description: |
      Immutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be secured by this key.
    value:
      kmsKeyName: "{{ kmsKeyName }}"
  - name: labels
    value: "{{ labels }}"
    description: |
      The labels with user-defined metadata to organize your IndexEndpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

UPDATE examples

patch

Updates an IndexEndpoint.

UPDATE google.aiplatform.index_endpoints
SET 
data__displayName = '{{ displayName }}',
data__etag = '{{ etag }}',
data__description = '{{ description }}',
data__privateServiceConnectConfig = '{{ privateServiceConnectConfig }}',
data__enablePrivateServiceConnect = {{ enablePrivateServiceConnect }},
data__network = '{{ network }}',
data__publicEndpointEnabled = {{ publicEndpointEnabled }},
data__encryptionSpec = '{{ encryptionSpec }}',
data__labels = '{{ labels }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND indexEndpointsId = '{{ indexEndpointsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
deployedIndexes,
description,
displayName,
enablePrivateServiceConnect,
encryptionSpec,
etag,
labels,
network,
privateServiceConnectConfig,
publicEndpointDomainName,
publicEndpointEnabled,
satisfiesPzi,
satisfiesPzs,
updateTime;

DELETE examples

delete

Deletes an IndexEndpoint.

DELETE FROM google.aiplatform.index_endpoints
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND indexEndpointsId = '{{ indexEndpointsId }}' --required
;

Lifecycle Methods

undeploy_index

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

EXEC google.aiplatform.index_endpoints.undeploy_index 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@indexEndpointsId='{{ indexEndpointsId }}' --required 
@@json=
'{
"deployedIndexId": "{{ deployedIndexId }}"
}'
;

mutate_deployed_index

Update an existing DeployedIndex under an IndexEndpoint.

EXEC google.aiplatform.index_endpoints.mutate_deployed_index 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@indexEndpointsId='{{ indexEndpointsId }}' --required, 
@updateMask='{{ updateMask }}' 
@@json=
'{
"enableAccessLogging": {{ enableAccessLogging }}, 
"deployedIndexAuthConfig": "{{ deployedIndexAuthConfig }}", 
"dedicatedResources": "{{ dedicatedResources }}", 
"id": "{{ id }}", 
"enableDatapointUpsertLogging": {{ enableDatapointUpsertLogging }}, 
"reservedIpRanges": "{{ reservedIpRanges }}", 
"automaticResources": "{{ automaticResources }}", 
"displayName": "{{ displayName }}", 
"index": "{{ index }}", 
"deploymentTier": "{{ deploymentTier }}", 
"deploymentGroup": "{{ deploymentGroup }}", 
"pscAutomationConfigs": "{{ pscAutomationConfigs }}"
}'
;

find_neighbors

Finds the nearest neighbors of each vector within the request.

EXEC google.aiplatform.index_endpoints.find_neighbors 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@indexEndpointsId='{{ indexEndpointsId }}' --required 
@@json=
'{
"queries": "{{ queries }}", 
"deployedIndexId": "{{ deployedIndexId }}", 
"returnFullDatapoint": {{ returnFullDatapoint }}
}'
;

read_index_datapoints

Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.

EXEC google.aiplatform.index_endpoints.read_index_datapoints 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@indexEndpointsId='{{ indexEndpointsId }}' --required 
@@json=
'{
"ids": "{{ ids }}", 
"deployedIndexId": "{{ deployedIndexId }}"
}'
;

deploy_index

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.

EXEC google.aiplatform.index_endpoints.deploy_index 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@indexEndpointsId='{{ indexEndpointsId }}' --required 
@@json=
'{
"deployedIndex": "{{ deployedIndex }}"
}'
;