Package com.azure.cosmos.models

Class DedicatedGatewayRequestOptions

java.lang.Object

com.azure.cosmos.models.DedicatedGatewayRequestOptions

All Implemented Interfaces:

Serializable

public final class DedicatedGatewayRequestOptions
extends Object
implements Serializable

Dedicated Gateway Request Options

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DedicatedGatewayRequestOptions()	Constructor

Method Summary

Modifier and Type	Method	Description
Duration	getMaxIntegratedCacheStaleness()	Gets the staleness value associated with the request in the Azure CosmosDB service.
boolean	isIntegratedCacheBypassed()	Gets if the integrated cache is enabled or bypassed with the request in Azure CosmosDB service.
DedicatedGatewayRequestOptions	setIntegratedCacheBypassed(boolean bypassIntegratedCache)	Sets if integrated cache should be enabled or bypassed for the request in Azure CosmosDB service.
DedicatedGatewayRequestOptions	setMaxIntegratedCacheStaleness(Duration maxIntegratedCacheStaleness)	Sets the staleness value associated with the request in the Azure CosmosDB service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DedicatedGatewayRequestOptions

public DedicatedGatewayRequestOptions()

Constructor

Method Details

getMaxIntegratedCacheStaleness

public Duration getMaxIntegratedCacheStaleness()

Gets the staleness value associated with the request in the Azure CosmosDB service. For requests where the ConsistencyLevel is ConsistencyLevel.EVENTUAL or ConsistencyLevel.SESSION, responses from the integrated cache are guaranteed to be no staler than value indicated by this maxIntegratedCacheStaleness.

Default value is null

Cache Staleness is supported in milliseconds granularity. Anything smaller than milliseconds will be ignored.

Returns:

Duration of maxIntegratedCacheStaleness

setMaxIntegratedCacheStaleness

public DedicatedGatewayRequestOptions setMaxIntegratedCacheStaleness(Duration maxIntegratedCacheStaleness)

Sets the staleness value associated with the request in the Azure CosmosDB service. For requests where the ConsistencyLevel is ConsistencyLevel.EVENTUAL or ConsistencyLevel.SESSION, responses from the integrated cache are guaranteed to be no staler than value indicated by this maxIntegratedCacheStaleness.

Default value is null

Cache Staleness is supported in milliseconds granularity. Anything smaller than milliseconds will be ignored.

Parameters:

maxIntegratedCacheStaleness - Max Integrated Cache Staleness duration

Returns:

this DedicatedGatewayRequestOptions

isIntegratedCacheBypassed

public boolean isIntegratedCacheBypassed()

Gets if the integrated cache is enabled or bypassed with the request in Azure CosmosDB service.

Default value is false

Returns:

bypassIntegratedCache boolean value

setIntegratedCacheBypassed

public DedicatedGatewayRequestOptions setIntegratedCacheBypassed(boolean bypassIntegratedCache)

Sets if integrated cache should be enabled or bypassed for the request in Azure CosmosDB service.

Default value is false

Parameters:

bypassIntegratedCache - boolean value

Returns:

this DedicatedGatewayRequestOptions