CosmosGrainStorageOptions Class

Reference

Definition

Namespace:: Orleans.Persistence.Cosmos

Assembly:: Orleans.Persistence.Cosmos.dll

Package:: Microsoft.Orleans.Persistence.Cosmos v9.0.0

Package:: Microsoft.Orleans.Persistence.Cosmos v9.1.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Options for Azure Cosmos DB grain persistence.

public class CosmosGrainStorageOptions : Orleans.Persistence.Cosmos.CosmosOptions

type CosmosGrainStorageOptions = class
    inherit CosmosOptions

Public Class CosmosGrainStorageOptions
Inherits CosmosOptions

Inheritance: Object

CosmosOptions
CosmosGrainStorageOptions

Constructors

CosmosGrainStorageOptions()

Initializes a new CosmosGrainStorageOptions instance.

Fields

DEFAULT_INIT_STAGE

Properties

CleanResourcesOnInitialization	Delete the database on initialization. Intended only for testing scenarios. (Inherited from CosmosOptions)
ClientOptions	The options passed to the Cosmos DB client. (Inherited from CosmosOptions)
ContainerName	The name of the container to use to store clustering information. (Inherited from CosmosOptions)
ContainerThroughputProperties	Throughput properties for containers. The default value is `null`, which indicates that the serverless throughput mode will be used. (Inherited from CosmosOptions)
DatabaseName	The name of the database to use for clustering information. Defaults to `Orleans`. (Inherited from CosmosOptions)
DatabaseThroughput	Database configured throughput. If set to `null`, which is the default value, it will not be configured. (Inherited from CosmosOptions)
DeleteStateOnClear	Gets or sets a value indicating whether state should be deleted when ClearStateAsync() is called.
InitStage	Stage of silo lifecycle where storage should be initialized. Storage must be initialized prior to use.
IsResourceCreationEnabled	Tries to create the database and container used for clustering if it does not exist. Defaults to `false`. (Inherited from CosmosOptions)
OperationExecutor	The operation executor used to execute operations using the Cosmos DB client. (Inherited from CosmosOptions)
PartitionKeyPath
StateFieldsToIndex	List of JSON path strings. Each entry on this list represents a property in the State Object that will be included in the document index. The default is to not add any property in the State object.

Methods

ConfigureCosmosClient(Func<IServiceProvider,ValueTask<CosmosClient>>)	Configures the Cosmos DB client. (Inherited from CosmosOptions)
ConfigureCosmosClient(String, AzureKeyCredential)	Configures the Cosmos DB client. (Inherited from CosmosOptions)
ConfigureCosmosClient(String, String)	Configures the Cosmos DB client. (Inherited from CosmosOptions)
ConfigureCosmosClient(String, TokenCredential)	Configures the Cosmos DB client. (Inherited from CosmosOptions)
ConfigureCosmosClient(String)	Configures the Cosmos DB client. (Inherited from CosmosOptions)

Applies to

Dela via