index_endpoints

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

Overview

Name	`index_endpoints`
Type	Resource
Id	`google.aiplatform.index_endpoints`

Fields

Name	Datatype	Description
`name`	`string`	Output only. The resource name of the IndexEndpoint.
`description`	`string`	The description of the IndexEndpoint.
`createTime`	`string`	Output only. Timestamp when this IndexEndpoint was created.
`deployedIndexes`	`array`	Output only. The indexes deployed in this endpoint.
`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`	Represents a customer-managed encryption key spec that can be applied to a top-level resource.
`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`	Represents configuration for private service connect.
`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`	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

Name	Accessible by	Required Params	Description
`get`	`SELECT`	`indexEndpointsId, locationsId, projectsId`	Gets an IndexEndpoint.
`list`	`SELECT`	`locationsId, projectsId`	Lists IndexEndpoints in a Location.
`create`	`INSERT`	`locationsId, projectsId`	Creates an IndexEndpoint.
`delete`	`DELETE`	`indexEndpointsId, locationsId, projectsId`	Deletes an IndexEndpoint.
`patch`	`UPDATE`	`indexEndpointsId, locationsId, projectsId`	Updates an IndexEndpoint.
`deploy_index`	`EXEC`	`indexEndpointsId, locationsId, projectsId`	Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.
`find_neighbors`	`EXEC`	`indexEndpointsId, locationsId, projectsId`	Finds the nearest neighbors of each vector within the request.
`mutate_deployed_index`	`EXEC`	`indexEndpointsId, locationsId, projectsId`	Update an existing DeployedIndex under an IndexEndpoint.
`read_index_datapoints`	`EXEC`	`indexEndpointsId, locationsId, projectsId`	Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.
`undeploy_index`	`EXEC`	`indexEndpointsId, locationsId, projectsId`	Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

`SELECT` examples

Lists IndexEndpoints in a Location.

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

`INSERT` example

Use the following StackQL query and manifest file to create a new index_endpoints resource.

All Properties
Manifest

/*+ create */
INSERT INTO google.aiplatform.index_endpoints (
locationsId,
projectsId,
encryptionSpec,
publicEndpointEnabled,
network,
privateServiceConnectConfig,
labels,
displayName,
description,
etag,
enablePrivateServiceConnect
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ encryptionSpec }}',
{{ publicEndpointEnabled }},
'{{ network }}',
'{{ privateServiceConnectConfig }}',
'{{ labels }}',
'{{ displayName }}',
'{{ description }}',
'{{ etag }}',
{{ enablePrivateServiceConnect }}
;

- name: your_resource_model_name
  props:
    - name: satisfiesPzi
      value: boolean
    - name: encryptionSpec
      value:
        - name: kmsKeyName
          value: string
    - name: publicEndpointEnabled
      value: boolean
    - name: updateTime
      value: string
    - name: createTime
      value: string
    - name: network
      value: string
    - name: privateServiceConnectConfig
      value:
        - name: serviceAttachment
          value: string
        - name: projectAllowlist
          value:
            - string
        - name: enablePrivateServiceConnect
          value: boolean
    - name: labels
      value: object
    - name: satisfiesPzs
      value: boolean
    - name: displayName
      value: string
    - name: description
      value: string
    - name: name
      value: string
    - name: publicEndpointDomainName
      value: string
    - name: etag
      value: string
    - name: deployedIndexes
      value:
        - - name: deploymentGroup
            value: string
          - name: privateEndpoints
            value:
              - name: matchGrpcAddress
                value: string
              - name: pscAutomatedEndpoints
                value:
                  - - name: projectId
                      value: string
                    - name: network
                      value: string
                    - name: matchAddress
                      value: string
              - name: serviceAttachment
                value: string
          - name: deployedIndexAuthConfig
            value:
              - name: authProvider
                value:
                  - name: audiences
                    value:
                      - string
                  - name: allowedIssuers
                    value:
                      - string
          - name: indexSyncTime
            value: string
          - name: enableAccessLogging
            value: boolean
          - name: dedicatedResources
            value:
              - name: machineSpec
                value:
                  - name: acceleratorCount
                    value: integer
                  - name: tpuTopology
                    value: string
                  - name: machineType
                    value: string
                  - name: acceleratorType
                    value: string
                  - name: reservationAffinity
                    value:
                      - name: reservationAffinityType
                        value: string
                      - name: values
                        value:
                          - string
                      - name: key
                        value: string
              - name: autoscalingMetricSpecs
                value:
                  - - name: target
                      value: integer
                    - name: metricName
                      value: string
              - name: maxReplicaCount
                value: integer
              - name: minReplicaCount
                value: integer
              - name: spot
                value: boolean
          - name: reservedIpRanges
            value:
              - string
          - name: displayName
            value: string
          - name: pscAutomationConfigs
            value:
              - - name: projectId
                  value: string
                - name: network
                  value: string
          - name: id
            value: string
          - name: index
            value: string
          - name: createTime
            value: string
          - name: automaticResources
            value:
              - name: minReplicaCount
                value: integer
              - name: maxReplicaCount
                value: integer
    - name: enablePrivateServiceConnect
      value: boolean

`UPDATE` example

Updates a index_endpoints resource.

/*+ update */
UPDATE google.aiplatform.index_endpoints
SET 
encryptionSpec = '{{ encryptionSpec }}',
publicEndpointEnabled = true|false,
network = '{{ network }}',
privateServiceConnectConfig = '{{ privateServiceConnectConfig }}',
labels = '{{ labels }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
etag = '{{ etag }}',
enablePrivateServiceConnect = true|false
WHERE 
indexEndpointsId = '{{ indexEndpointsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

`DELETE` example

Deletes the specified index_endpoints resource.

/*+ delete */
DELETE FROM google.aiplatform.index_endpoints
WHERE indexEndpointsId = '{{ indexEndpointsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

DELETE example​