Class GetCollectionOptions

Namespace

DataStax.AstraDB.DataApi.Core

Assembly

DataStax.AstraDB.DataApi.dll

Command options specific to collections.

public class GetCollectionOptions : DatabaseCommandOptions

Inheritance

object

CommandOptions

DatabaseCommandOptions

GetCollectionOptions

Derived

CreateCollectionOptions

Inherited Members

DatabaseCommandOptions.Keyspace

CommandOptions.Token

CommandOptions.RunMode

CommandOptions.Destination

CommandOptions.HttpClientOptions

CommandOptions.APICallers

CommandOptions.TimeoutOptions

CommandOptions.APIVersion

CommandOptions.CancellationToken

CommandOptions.Defaults()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

AWSEmbeddingAPIKey

When specified, the client will send the authentication parameters required for AWS embedding providers (Access ID and Secret ID) with each collection request, via HTTP headers.

public AWSEmbeddingAPIKeyDescriptor AWSEmbeddingAPIKey { get; set; }

Property Value

AWSEmbeddingAPIKeyDescriptor

Examples

// When creating a collection:
var collection = await Database.CreateCollectionAsync<MyDocumentClass>(
    new CreateCollectionOptions() {
        AWSEmbeddingAPIKey = new () { EmbeddingAccessId = "..." , EmbeddingSecretId = "..." }
    }
);
// Similarly for getting a collection:
var collection = Database.GetCollection<MyDocumentClass>(
    new GetCollectionOptions() {
        AWSEmbeddingAPIKey = new () { EmbeddingAccessId = "..." , EmbeddingSecretId = "..." }
    }
);

EmbeddingAPIKey

When specified, the client will send the X-Embedding-Api-Key header with the specified key to any underlying HTTP request that requires vectorize authentication.

public string EmbeddingAPIKey { get; set; }

Property Value

string

RerankingAPIKey

When specified, the client will send the Reranking-Api-Key header with the specified key to any underlying HTTP request that requires reranker authentication.

public string RerankingAPIKey { get; set; }

Property Value

string