Class DedicatedGatewayRequestOptions

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

The Dedicated Gateway request options

public class DedicatedGatewayRequestOptions

Inheritance

object

DedicatedGatewayRequestOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.DocumentId(object)

CosmosLinqExtensions.IsArray(object)

CosmosLinqExtensions.IsBool(object)

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsNumber(object)

CosmosLinqExtensions.IsObject(object)

CosmosLinqExtensions.IsPrimitive(object)

CosmosLinqExtensions.IsString(object)

CosmosLinqExtensions.RegexMatch(object, string, string)

CosmosLinqExtensions.RegexMatch(object, string)

Constructors

DedicatedGatewayRequestOptions()

public DedicatedGatewayRequestOptions()

Properties

BypassIntegratedCache

Gets or sets if bypass the integrated cache or not associated with the request in the Azure Cosmos DB service. When set this value to true, the request will not be served from the integrated cache, and the response will not be cached either.

public bool? BypassIntegratedCache { get; set; }

Property Value

bool?

Default value is false.

Examples

DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions = new DedicatedGatewayRequestOptions
{
    BypassIntegratedCache = true
};

// For ItemRequestOptions
ItemRequestOptions requestOptions = new ItemRequestOptions
{
    DedicatedGatewayRequestOptions = dedicatedGatewayRequestOptions
};

// For QueryRequestOptions
QueryRequestOptions requestOptions = new QueryRequestOptions
{
    DedicatedGatewayRequestOptions = dedicatedGatewayRequestOptions
};

MaxIntegratedCacheStaleness

Gets or sets the staleness value associated with the request in the Azure Cosmos DB service.

public TimeSpan? MaxIntegratedCacheStaleness { get; set; }

Property Value

TimeSpan?

Default value is null.

Remarks

For requests where the ConsistencyLevel is Eventual or Session, responses from the integrated cache are guaranteed to be no staler than value indicated by this MaxIntegratedCacheStaleness. Cache Staleness is supported in milliseconds granularity. Anything smaller than milliseconds will be ignored.