Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1
  6. getIndex

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.aiplatform/v1.getIndex

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Gets an Index.

Using getIndex

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIndex(args: GetIndexArgs, opts?: InvokeOptions): Promise<GetIndexResult>
function getIndexOutput(args: GetIndexOutputArgs, opts?: InvokeOptions): Output<GetIndexResult>
Copy
def get_index(index_id: Optional[str] = None,
              location: Optional[str] = None,
              project: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetIndexResult
def get_index_output(index_id: Optional[pulumi.Input[str]] = None,
              location: Optional[pulumi.Input[str]] = None,
              project: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetIndexResult]
Copy
func LookupIndex(ctx *Context, args *LookupIndexArgs, opts ...InvokeOption) (*LookupIndexResult, error)
func LookupIndexOutput(ctx *Context, args *LookupIndexOutputArgs, opts ...InvokeOption) LookupIndexResultOutput
Copy

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

public static class GetIndex 
{
    public static Task<GetIndexResult> InvokeAsync(GetIndexArgs args, InvokeOptions? opts = null)
    public static Output<GetIndexResult> Invoke(GetIndexInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)
public static Output<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:aiplatform/v1:getIndex
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

IndexId This property is required. string
Location This property is required. string
Project string
IndexId This property is required. string
Location This property is required. string
Project string
indexId This property is required. String
location This property is required. String
project String
indexId This property is required. string
location This property is required. string
project string
index_id This property is required. str
location This property is required. str
project str
indexId This property is required. String
location This property is required. String
project String

getIndex Result

The following output properties are available:

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.

Supporting Types

GoogleCloudAiplatformV1DeployedIndexRefResponse

DeployedIndexId This property is required. string
Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
IndexEndpoint This property is required. string
Immutable. A resource name of the IndexEndpoint.
DeployedIndexId This property is required. string
Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
IndexEndpoint This property is required. string
Immutable. A resource name of the IndexEndpoint.
deployedIndexId This property is required. String
Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
indexEndpoint This property is required. String
Immutable. A resource name of the IndexEndpoint.
deployedIndexId This property is required. string
Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
indexEndpoint This property is required. string
Immutable. A resource name of the IndexEndpoint.
deployed_index_id This property is required. str
Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
index_endpoint This property is required. str
Immutable. A resource name of the IndexEndpoint.
deployedIndexId This property is required. String
Immutable. The ID of the DeployedIndex in the above IndexEndpoint.
indexEndpoint This property is required. String
Immutable. A resource name of the IndexEndpoint.

GoogleCloudAiplatformV1EncryptionSpecResponse

KmsKeyName This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

GoogleCloudAiplatformV1IndexStatsResponse

ShardsCount This property is required. int
The number of shards in the Index.
VectorsCount This property is required. string
The number of vectors in the Index.
ShardsCount This property is required. int
The number of shards in the Index.
VectorsCount This property is required. string
The number of vectors in the Index.
shardsCount This property is required. Integer
The number of shards in the Index.
vectorsCount This property is required. String
The number of vectors in the Index.
shardsCount This property is required. number
The number of shards in the Index.
vectorsCount This property is required. string
The number of vectors in the Index.
shards_count This property is required. int
The number of shards in the Index.
vectors_count This property is required. str
The number of vectors in the Index.
shardsCount This property is required. Number
The number of shards in the Index.
vectorsCount This property is required. String
The number of vectors in the Index.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native