1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. vertex
  5. getAiIndex
Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi

gcp.vertex.getAiIndex

Explore with Pulumi AI

gcp logo
Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi

    A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.

    Using getAiIndex

    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 getAiIndex(args: GetAiIndexArgs, opts?: InvokeOptions): Promise<GetAiIndexResult>
    function getAiIndexOutput(args: GetAiIndexOutputArgs, opts?: InvokeOptions): Output<GetAiIndexResult>
    def get_ai_index(name: Optional[str] = None,
                     project: Optional[str] = None,
                     region: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAiIndexResult
    def get_ai_index_output(name: Optional[pulumi.Input[str]] = None,
                     project: Optional[pulumi.Input[str]] = None,
                     region: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAiIndexResult]
    func LookupAiIndex(ctx *Context, args *LookupAiIndexArgs, opts ...InvokeOption) (*LookupAiIndexResult, error)
    func LookupAiIndexOutput(ctx *Context, args *LookupAiIndexOutputArgs, opts ...InvokeOption) LookupAiIndexResultOutput

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

    public static class GetAiIndex 
    {
        public static Task<GetAiIndexResult> InvokeAsync(GetAiIndexArgs args, InvokeOptions? opts = null)
        public static Output<GetAiIndexResult> Invoke(GetAiIndexInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAiIndexResult> getAiIndex(GetAiIndexArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: gcp:vertex/getAiIndex:getAiIndex
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string

    The name of the index.

    Region string

    The region of the index.


    Project string

    The ID of the project in which the resource belongs.

    Name string

    The name of the index.

    Region string

    The region of the index.


    Project string

    The ID of the project in which the resource belongs.

    name String

    The name of the index.

    region String

    The region of the index.


    project String

    The ID of the project in which the resource belongs.

    name string

    The name of the index.

    region string

    The region of the index.


    project string

    The ID of the project in which the resource belongs.

    name str

    The name of the index.

    region str

    The region of the index.


    project str

    The ID of the project in which the resource belongs.

    name String

    The name of the index.

    region String

    The region of the index.


    project String

    The ID of the project in which the resource belongs.

    getAiIndex Result

    The following output properties are available:

    CreateTime string
    DeployedIndexes List<GetAiIndexDeployedIndex>
    Description string
    DisplayName string
    Etag string
    Id string

    The provider-assigned unique ID for this managed resource.

    IndexStats List<GetAiIndexIndexStat>
    IndexUpdateMethod string
    Labels Dictionary<string, string>
    MetadataSchemaUri string
    Metadatas List<GetAiIndexMetadata>
    Name string
    Region string
    UpdateTime string
    Project string
    CreateTime string
    DeployedIndexes []GetAiIndexDeployedIndex
    Description string
    DisplayName string
    Etag string
    Id string

    The provider-assigned unique ID for this managed resource.

    IndexStats []GetAiIndexIndexStat
    IndexUpdateMethod string
    Labels map[string]string
    MetadataSchemaUri string
    Metadatas []GetAiIndexMetadata
    Name string
    Region string
    UpdateTime string
    Project string
    createTime String
    deployedIndexes List<GetAiIndexDeployedIndex>
    description String
    displayName String
    etag String
    id String

    The provider-assigned unique ID for this managed resource.

    indexStats List<GetAiIndexIndexStat>
    indexUpdateMethod String
    labels Map<String,String>
    metadataSchemaUri String
    metadatas List<GetAiIndexMetadata>
    name String
    region String
    updateTime String
    project String
    createTime string
    deployedIndexes GetAiIndexDeployedIndex[]
    description string
    displayName string
    etag string
    id string

    The provider-assigned unique ID for this managed resource.

    indexStats GetAiIndexIndexStat[]
    indexUpdateMethod string
    labels {[key: string]: string}
    metadataSchemaUri string
    metadatas GetAiIndexMetadata[]
    name string
    region string
    updateTime string
    project string
    createTime String
    deployedIndexes List<Property Map>
    description String
    displayName String
    etag String
    id String

    The provider-assigned unique ID for this managed resource.

    indexStats List<Property Map>
    indexUpdateMethod String
    labels Map<String>
    metadataSchemaUri String
    metadatas List<Property Map>
    name String
    region String
    updateTime String
    project String

    Supporting Types

    GetAiIndexDeployedIndex

    GetAiIndexIndexStat

    GetAiIndexMetadata

    GetAiIndexMetadataConfig

    GetAiIndexMetadataConfigAlgorithmConfig

    GetAiIndexMetadataConfigAlgorithmConfigTreeAhConfig

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the google-beta Terraform Provider.

    gcp logo
    Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi