CosmosRequestOptions class

Common request options for cosmosdb requests

Constructors

CosmosRequestOptions({List<String>? partitionKeys, int? maxItemCount, bool? enableCrossPartition, bool? allowTentativeWrites})

Construct common request options for cosmosdb requests

const

Properties

allowTentativeWrites → bool?

When this header is set to true for the Azure Cosmos accounts configured with multiple write locations, Azure Cosmos DB will allow writes to all locations.

final

enableCrossPartition → bool?

When this header is set to true and if your query doesn't have a partition key, Azure Cosmos DB fans out the query across partitions.

final

hashCode → int

The hash code for this object.

no setter, inherited

maxItemCount → int?

An integer indicating the maximum number of items to be returned per page. An maxItemCount of -1 can be specified to let the service determine the optimal item count. This is the recommended configuration value for maxItemCount

final

partitionKeys → List<String>?

The partition key value for the requested document or attachment operation. Required for operations against documents and attachments when the collection definition includes a partition key definition. This value is used to scope your query to documents that match the partition key criteria. By design it's a single partition query. Currently, the SQL API supports a single partition key, so this is an array containing just one value.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toHeaders() → Map<String, String>

Generates HTTP headers for the given options

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited