google-native.aiplatform/v1.getIndex

func LookupIndex(ctx *Context, args *LookupIndexArgs, opts ...InvokeOption) (*LookupIndexResult, error)
func LookupIndexOutput(ctx *Context, args *LookupIndexOutputArgs, opts ...InvokeOption) LookupIndexResultOutput

> Note: This function is named LookupIndex in the Go SDK.

IndexId string

Location string

Project string

IndexId string

Location string

Project string

indexId String

location String

project String

indexId string

location string

project string

index_id str

location str

project str

indexId String

location String

project String

CreateTime string

Timestamp when this Index was created.

DeployedIndexes List<Pulumi.GoogleNative.Aiplatform.V1.Outputs.GoogleCloudAiplatformV1DeployedIndexRefResponse>

The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.

Description string

The description of the Index.

DisplayName string

The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

EncryptionSpec Pulumi.GoogleNative.Aiplatform.V1.Outputs.GoogleCloudAiplatformV1EncryptionSpecResponse

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.

Etag string

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

IndexStats Pulumi.GoogleNative.Aiplatform.V1.Outputs.GoogleCloudAiplatformV1IndexStatsResponse

Stats of the index resource.

IndexUpdateMethod string

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

Labels Dictionary<string, string>

The labels with user-defined metadata to organize your Indexes. 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.

Metadata object

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

MetadataSchemaUri string

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 string

The resource name of the Index.

UpdateTime string

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.

CreateTime string

Timestamp when this Index was created.

DeployedIndexes []GoogleCloudAiplatformV1DeployedIndexRefResponse

The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.

Description string

The description of the Index.

DisplayName string

The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

EncryptionSpec GoogleCloudAiplatformV1EncryptionSpecResponse

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.

Etag string

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

IndexStats GoogleCloudAiplatformV1IndexStatsResponse

Stats of the index resource.

IndexUpdateMethod string

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

Labels map[string]string

The labels with user-defined metadata to organize your Indexes. 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.

Metadata interface{}

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

MetadataSchemaUri string

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 string

The resource name of the Index.

UpdateTime string

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.

createTime String

Timestamp when this Index was created.

deployedIndexes List<GoogleCloudAiplatformV1DeployedIndexRefResponse>

The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.

description String

The description of the Index.

displayName String

The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

encryptionSpec GoogleCloudAiplatformV1EncryptionSpecResponse

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.

etag String

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

indexStats GoogleCloudAiplatformV1IndexStatsResponse

Stats of the index resource.

indexUpdateMethod String

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

labels Map<String,String>

The labels with user-defined metadata to organize your Indexes. 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.

metadata Object

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

metadataSchemaUri String

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 String

The resource name of the Index.

updateTime String

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.

createTime string

Timestamp when this Index was created.

deployedIndexes GoogleCloudAiplatformV1DeployedIndexRefResponse[]

The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.

description string

The description of the Index.

displayName string

The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

encryptionSpec GoogleCloudAiplatformV1EncryptionSpecResponse

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.

etag string

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

indexStats GoogleCloudAiplatformV1IndexStatsResponse

Stats of the index resource.

indexUpdateMethod string

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

labels {[key: string]: string}

The labels with user-defined metadata to organize your Indexes. 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.

metadata any

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

metadataSchemaUri string

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 string

The resource name of the Index.

updateTime string

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.

create_time str

Timestamp when this Index was created.

deployed_indexes Sequence[GoogleCloudAiplatformV1DeployedIndexRefResponse]

The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.

description str

The description of the Index.

display_name str

The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

encryption_spec GoogleCloudAiplatformV1EncryptionSpecResponse

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.

etag str

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

index_stats GoogleCloudAiplatformV1IndexStatsResponse

Stats of the index resource.

index_update_method str

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

labels Mapping[str, str]

The labels with user-defined metadata to organize your Indexes. 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.

metadata Any

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

metadata_schema_uri str

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 str

The resource name of the Index.

update_time str

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.

createTime String

Timestamp when this Index was created.

deployedIndexes List<Property Map>

The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.

description String

The description of the Index.

displayName String

The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

encryptionSpec Property Map

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.

etag String

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

indexStats Property Map

Stats of the index resource.

indexUpdateMethod String

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

labels Map<String>

The labels with user-defined metadata to organize your Indexes. 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.

metadata Any

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

metadataSchemaUri String

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 String

The resource name of the Index.

updateTime String

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.

DeployedIndexId string

Immutable. The ID of the DeployedIndex in the above IndexEndpoint.

IndexEndpoint string

Immutable. A resource name of the IndexEndpoint.

DeployedIndexId string

Immutable. The ID of the DeployedIndex in the above IndexEndpoint.

IndexEndpoint string

Immutable. A resource name of the IndexEndpoint.

deployedIndexId String

Immutable. The ID of the DeployedIndex in the above IndexEndpoint.

indexEndpoint String

Immutable. A resource name of the IndexEndpoint.

deployedIndexId string

Immutable. The ID of the DeployedIndex in the above IndexEndpoint.

indexEndpoint string

Immutable. A resource name of the IndexEndpoint.

deployed_index_id str

Immutable. The ID of the DeployedIndex in the above IndexEndpoint.

index_endpoint str

Immutable. A resource name of the IndexEndpoint.

deployedIndexId String

Immutable. The ID of the DeployedIndex in the above IndexEndpoint.

indexEndpoint String

Immutable. A resource name of the IndexEndpoint.

KmsKeyName string

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.

KmsKeyName string

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.

kmsKeyName String

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.

kmsKeyName string

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.

kms_key_name str

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.

kmsKeyName String

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.

ShardsCount int

The number of shards in the Index.

VectorsCount string

The number of vectors in the Index.

ShardsCount int

The number of shards in the Index.

VectorsCount string

The number of vectors in the Index.

shardsCount Integer

The number of shards in the Index.

vectorsCount String

The number of vectors in the Index.

shardsCount number

The number of shards in the Index.

vectorsCount string

The number of vectors in the Index.

shards_count int

The number of shards in the Index.

vectors_count str

The number of vectors in the Index.

shardsCount Number

The number of shards in the Index.

vectorsCount String

The number of vectors in the Index.