@pinecone-database/pulumi/pineconeIndex.d.ts

<img src="img/pinecone.svg" width="50%">

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
import * as enums from "./types/enums";
export declare class PineconeIndex extends pulumi.CustomResource {
    /**
     * Get an existing PineconeIndex resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): PineconeIndex;
    /**
     * Returns true if the given object is an instance of PineconeIndex.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is PineconeIndex;
    /**
     * The dimensions of the vectors in the index. Defaults to 1536.
     */
    readonly dimension: pulumi.Output<number | undefined>;
    /**
     * The URL address where the index is hosted.
     */
    readonly host: pulumi.Output<string>;
    /**
     * The metric used to compute the distance between vectors.
     */
    readonly metric: pulumi.Output<enums.IndexMetric>;
    /**
     * The name of the Pinecone index.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Describe how the index should be deployed.
     */
    readonly spec: pulumi.Output<outputs.PineconeSpec>;
    /**
     * Create a PineconeIndex resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: PineconeIndexArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * The set of arguments for constructing a PineconeIndex resource.
 */
export interface PineconeIndexArgs {
    /**
     * The dimensions of the vectors in the index. Defaults to 1536.
     */
    dimension?: pulumi.Input<number>;
    /**
     * The metric used to compute the distance between vectors.
     */
    metric: pulumi.Input<enums.IndexMetric>;
    /**
     * The name of the Pinecone index.
     */
    name: pulumi.Input<string>;
    /**
     * Describe how the index should be deployed.
     */
    spec: pulumi.Input<inputs.PineconeSpecArgs>;
}