This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project,
feel free to reach out to us!ancestors
Type: UNORDERED_LIST_STRING
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. Timestamp when this Index was created.
deployed_indexes
Type: UNORDERED_LIST_STRUCT
Provider name: deployedIndexes
Description: Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
deployed_index_id
Type: STRING
Provider name: deployedIndexId
Description: Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
gcp_display_name
Type: STRING
Provider name: displayName
Description: Output only. The display name of the DeployedIndex.
index_endpoint
Type: STRING
Provider name: indexEndpoint
Description: Immutable. A resource name of the IndexEndpoint.
description
Type: STRING
Provider name: description
Description: The description of the Index.
encryption_spec
Type: STRUCT
Provider name: encryptionSpec
Description: Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
kms_key_name
Type: STRING
Provider name: kmsKeyName
Description: Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
etag
Type: STRING
Provider name: etag
Description: Used to perform consistent read-modify-write updates. If not set, a blind “overwrite” update happens.
gcp_display_name
Type: STRING
Provider name: displayName
Description: Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
index_stats
Type: STRUCT
Provider name: indexStats
Description: Output only. Stats of the index resource.
shards_count
Type: INT32
Provider name: shardsCount
Description: Output only. The number of shards in the Index.
sparse_vectors_count
Type: INT64
Provider name: sparseVectorsCount
Description: Output only. The number of sparse vectors in the Index.
vectors_count
Type: INT64
Provider name: vectorsCount
Description: Output only. The number of dense vectors in the Index.
index_update_method
Type: STRING
Provider name: indexUpdateMethod
Description: Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
Possible values:
INDEX_UPDATE_METHOD_UNSPECIFIED - Should not be used.
BATCH_UPDATE - BatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update.
STREAM_UPDATE - StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time.
labels
Type: UNORDERED_LIST_STRING
Type: STRING
Provider name: metadataSchemaUri
Description: Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
name
Type: STRING
Provider name: name
Description: Output only. The resource name of the Index.
organization_id
Type: STRING
parent
Type: STRING
project_id
Type: STRING
project_number
Type: STRING
resource_name
Type: STRING
satisfies_pzi
Type: BOOLEAN
Provider name: satisfiesPzi
Description: Output only. Reserved for future use.
satisfies_pzs
Type: BOOLEAN
Provider name: satisfiesPzs
Description: Output only. Reserved for future use.
Type: UNORDERED_LIST_STRING
update_time
Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
