Docs Packages
  1. Packages
  2. Pinecone
  3. API Docs
  4. PineconeCollection
Pinecone v0.4.3 published on Thursday, May 9, 2024 by pinecone-io
pinecone-io/pulumi-pinecone

pinecone.PineconeCollection

Explore with Pulumi AI

pinecone logo
Pinecone v0.4.3 published on Thursday, May 9, 2024 by pinecone-io
pinecone-io/pulumi-pinecone

    Create PineconeCollection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PineconeCollection(name: string, args: PineconeCollectionArgs, opts?: CustomResourceOptions);
    @overload
def PineconeCollection(resource_name: str,
                       args: PineconeCollectionArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def PineconeCollection(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       name: Optional[str] = None,
                       source: Optional[str] = None)
    func NewPineconeCollection(ctx *Context, name string, args PineconeCollectionArgs, opts ...ResourceOption) (*PineconeCollection, error)
    public PineconeCollection(string name, PineconeCollectionArgs args, CustomResourceOptions? opts = null)
    public PineconeCollection(String name, PineconeCollectionArgs args)
public PineconeCollection(String name, PineconeCollectionArgs args, CustomResourceOptions options)

    type: pinecone:PineconeCollection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PineconeCollectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PineconeCollectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PineconeCollectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PineconeCollectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PineconeCollectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var pineconeCollectionResource = new Pinecone.PineconeCollection("pineconeCollectionResource", new()
{
    Name = "string",
    Source = "string",
});

    example, err := pinecone.NewPineconeCollection(ctx, "pineconeCollectionResource", &pinecone.PineconeCollectionArgs{
	Name:   pulumi.String("string"),
	Source: pulumi.String("string"),
})

    var pineconeCollectionResource = new PineconeCollection("pineconeCollectionResource", PineconeCollectionArgs.builder()
    .name("string")
    .source("string")
    .build());

    pinecone_collection_resource = pinecone.PineconeCollection("pineconeCollectionResource",
    name="string",
    source="string")

    const pineconeCollectionResource = new pinecone.PineconeCollection("pineconeCollectionResource", {
    name: "string",
    source: "string",
});

    type: pinecone:PineconeCollection
properties:
    name: string
    source: string

    PineconeCollection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The PineconeCollection resource accepts the following input properties:

    Name string
    The name of the collection to be created.
    Source string
    The name of the index to be used as the source for the collection.
    Name string
    The name of the collection to be created.
    Source string
    The name of the index to be used as the source for the collection.
    name String
    The name of the collection to be created.
    source String
    The name of the index to be used as the source for the collection.
    name string
    The name of the collection to be created.
    source string
    The name of the index to be used as the source for the collection.
    name str
    The name of the collection to be created.
    source str
    The name of the index to be used as the source for the collection.
    name String
    The name of the collection to be created.
    source String
    The name of the index to be used as the source for the collection.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PineconeCollection resource produces the following output properties:

    Dimension int
    The dimension of the vectors stored in each record held in the collection.
    Environment string
    The environment where the collection is hosted.
    Id string
    The provider-assigned unique ID for this managed resource.
    Size int
    The size of the collection in bytes.
    VectorCount int
    The number of records stored in the collection.
    Dimension int
    The dimension of the vectors stored in each record held in the collection.
    Environment string
    The environment where the collection is hosted.
    Id string
    The provider-assigned unique ID for this managed resource.
    Size int
    The size of the collection in bytes.
    VectorCount int
    The number of records stored in the collection.
    dimension Integer
    The dimension of the vectors stored in each record held in the collection.
    environment String
    The environment where the collection is hosted.
    id String
    The provider-assigned unique ID for this managed resource.
    size Integer
    The size of the collection in bytes.
    vectorCount Integer
    The number of records stored in the collection.
    dimension number
    The dimension of the vectors stored in each record held in the collection.
    environment string
    The environment where the collection is hosted.
    id string
    The provider-assigned unique ID for this managed resource.
    size number
    The size of the collection in bytes.
    vectorCount number
    The number of records stored in the collection.
    dimension int
    The dimension of the vectors stored in each record held in the collection.
    environment str
    The environment where the collection is hosted.
    id str
    The provider-assigned unique ID for this managed resource.
    size int
    The size of the collection in bytes.
    vector_count int
    The number of records stored in the collection.
    dimension Number
    The dimension of the vectors stored in each record held in the collection.
    environment String
    The environment where the collection is hosted.
    id String
    The provider-assigned unique ID for this managed resource.
    size Number
    The size of the collection in bytes.
    vectorCount Number
    The number of records stored in the collection.

    Package Details

    Repository
    pinecone pinecone-io/pulumi-pinecone
    License
    Apache-2.0
    pinecone logo
    Pinecone v0.4.3 published on Thursday, May 9, 2024 by pinecone-io
    pinecone-io/pulumi-pinecone