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

pinecone.lookupPineconeCollection

Explore with Pulumi AI

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

The result of a get operation on a Pinecone collection.

Using lookupPineconeCollection

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 lookupPineconeCollection(args: LookupPineconeCollectionArgs, opts?: InvokeOptions): Promise<LookupPineconeCollectionResult>
function lookupPineconeCollectionOutput(args: LookupPineconeCollectionOutputArgs, opts?: InvokeOptions): Output<LookupPineconeCollectionResult>
Copy
def lookup_pinecone_collection(name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> LookupPineconeCollectionResult
def lookup_pinecone_collection_output(name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[LookupPineconeCollectionResult]
Copy
func LookupPineconeCollection(ctx *Context, args *LookupPineconeCollectionArgs, opts ...InvokeOption) (*LookupPineconeCollectionResult, error)
func LookupPineconeCollectionOutput(ctx *Context, args *LookupPineconeCollectionOutputArgs, opts ...InvokeOption) LookupPineconeCollectionResultOutput
Copy

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

public static class LookupPineconeCollection 
{
    public static Task<LookupPineconeCollectionResult> InvokeAsync(LookupPineconeCollectionArgs args, InvokeOptions? opts = null)
    public static Output<LookupPineconeCollectionResult> Invoke(LookupPineconeCollectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<LookupPineconeCollectionResult> lookupPineconeCollection(LookupPineconeCollectionArgs args, InvokeOptions options)
public static Output<LookupPineconeCollectionResult> lookupPineconeCollection(LookupPineconeCollectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: pinecone:lookupPineconeCollection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the Pinecone collection.
Name This property is required. string
The name of the Pinecone collection.
name This property is required. String
The name of the Pinecone collection.
name This property is required. string
The name of the Pinecone collection.
name This property is required. str
The name of the Pinecone collection.
name This property is required. String
The name of the Pinecone collection.

lookupPineconeCollection 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.
Name string
The name of the collection to be created.
Size int
The size of the collection in bytes.
Source string
The name of the index to be used as the source for the collection.
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.
Name string
The name of the collection to be created.
Size int
The size of the collection in bytes.
Source string
The name of the index to be used as the source for the collection.
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.
name String
The name of the collection to be created.
size Integer
The size of the collection in bytes.
source String
The name of the index to be used as the source for the collection.
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.
name string
The name of the collection to be created.
size number
The size of the collection in bytes.
source string
The name of the index to be used as the source for the collection.
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.
name str
The name of the collection to be created.
size int
The size of the collection in bytes.
source str
The name of the index to be used as the source for 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.
name String
The name of the collection to be created.
size Number
The size of the collection in bytes.
source String
The name of the index to be used as the source for the collection.
vectorCount Number
The number of records stored in the collection.

Package Details

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