Pinecone v2.0.2 published on Wednesday, Nov 5, 2025 by pinecone-io
pinecone.getCollection
Start a Neo task
Explain and create a pinecone.getCollection resource
Collection data source
Using getCollection
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 getCollection(args: GetCollectionArgs, opts?: InvokeOptions): Promise<GetCollectionResult>
function getCollectionOutput(args: GetCollectionOutputArgs, opts?: InvokeOptions): Output<GetCollectionResult>def get_collection(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCollectionResult
def get_collection_output(name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCollectionResult]func LookupCollection(ctx *Context, args *LookupCollectionArgs, opts ...InvokeOption) (*LookupCollectionResult, error)
func LookupCollectionOutput(ctx *Context, args *LookupCollectionOutputArgs, opts ...InvokeOption) LookupCollectionResultOutput> Note: This function is named LookupCollection in the Go SDK.
public static class GetCollection
{
public static Task<GetCollectionResult> InvokeAsync(GetCollectionArgs args, InvokeOptions? opts = null)
public static Output<GetCollectionResult> Invoke(GetCollectionInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetCollectionResult> getCollection(GetCollectionArgs args, InvokeOptions options)
public static Output<GetCollectionResult> getCollection(GetCollectionArgs args, InvokeOptions options)
fn::invoke:
function: pinecone:index/getCollection:getCollection
arguments:
# arguments dictionaryThe following arguments are supported:
- Name string
- The name of the collection.
- Name string
- The name of the collection.
- name String
- The name of the collection.
- name string
- The name of the collection.
- name str
- The name of the collection.
- name String
- The name of the collection.
getCollection Result
The following output properties are available:
- 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
- Collection identifier
- Name string
- The name of the collection.
- Size int
- The size of the collection in bytes.
- Status string
- The status of the collection.
- Vector
Count 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
- Collection identifier
- Name string
- The name of the collection.
- Size int
- The size of the collection in bytes.
- Status string
- The status of the collection.
- Vector
Count 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
- Collection identifier
- name String
- The name of the collection.
- size Integer
- The size of the collection in bytes.
- status String
- The status of the collection.
- vector
Count 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
- Collection identifier
- name string
- The name of the collection.
- size number
- The size of the collection in bytes.
- status string
- The status of the collection.
- vector
Count 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
- Collection identifier
- name str
- The name of the collection.
- size int
- The size of the collection in bytes.
- status str
- The status of the collection.
- 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
- Collection identifier
- name String
- The name of the collection.
- size Number
- The size of the collection in bytes.
- status String
- The status of the collection.
- vector
Count Number - The number of records stored in the collection.
Package Details
- Repository
- pinecone pinecone-io/pulumi-pinecone
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
pineconeTerraform Provider.
