DedicatedGatewayRequestOptions Class

Package:

com.azure.cosmos.models

Maven Artifact:

com.azure:azure-cosmos:4.78.0

• java.lang.Object
• • com.azure.cosmos.models.DedicatedGatewayRequestOptions

Implements

Serializable

public final class DedicatedGatewayRequestOptions
implements Serializable

Dedicated Gateway Request Options

Constructor Summary

Constructor	Description
DedicatedGatewayRequestOptions()	Constructor

Method Summary

Modifier and Type	Method and Description
Duration	getMaxIntegratedCacheStaleness() Gets the staleness value associated with the request in the Azure CosmosDB service.
String	getShardKey() Gets the shard key value associated with the request in the Azure CosmosDB service to optionally specify a shard key to use the new sharding feature in dedicated gateway.
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.
DedicatedGatewayRequestOptions	setShardKey(String shardKey) Sets the shard key value associated with the request in the Azure CosmosDB service to optionally specify a shard key to use the new sharding feature in dedicated gateway.

Methods inherited from 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 EVENTUAL or 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

getShardKey

public String getShardKey()

Gets the shard key value associated with the request in the Azure CosmosDB service to optionally specify a shard key to use the new sharding feature in dedicated gateway.

Default value is null

Returns:

shard key value

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

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 EVENTUAL or 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

setShardKey

public DedicatedGatewayRequestOptions setShardKey(String shardKey)

Sets the shard key value associated with the request in the Azure CosmosDB service to optionally specify a shard key to use the new sharding feature in dedicated gateway.

Default value is null

Parameters:

shardKey - shard key value

Returns:

this DedicatedGatewayRequestOptions