@pinecone-database/pulumi
Version:
<img src="img/pinecone.svg" width="50%">
63 lines (62 loc) • 2.39 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
export declare class PineconeCollection extends pulumi.CustomResource {
/**
* Get an existing PineconeCollection 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): PineconeCollection;
/**
* Returns true if the given object is an instance of PineconeCollection. 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 PineconeCollection;
/**
* The dimension of the vectors stored in each record held in the collection.
*/
readonly dimension: pulumi.Output<number>;
/**
* The environment where the collection is hosted.
*/
readonly environment: pulumi.Output<string>;
/**
* The name of the collection to be created.
*/
readonly name: pulumi.Output<string>;
/**
* The size of the collection in bytes.
*/
readonly size: pulumi.Output<number>;
/**
* The name of the index to be used as the source for the collection.
*/
readonly source: pulumi.Output<string>;
/**
* The number of records stored in the collection.
*/
readonly vectorCount: pulumi.Output<number>;
/**
* Create a PineconeCollection 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: PineconeCollectionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a PineconeCollection resource.
*/
export interface PineconeCollectionArgs {
/**
* The name of the collection to be created.
*/
name: pulumi.Input<string>;
/**
* The name of the index to be used as the source for the collection.
*/
source: pulumi.Input<string>;
}