com.azure.cosmos.models.DedicatedGatewayRequestOptions.yml

### YamlMime:JavaType
uid: "com.azure.cosmos.models.DedicatedGatewayRequestOptions"
fullName: "com.azure.cosmos.models.DedicatedGatewayRequestOptions"
name: "DedicatedGatewayRequestOptions"
nameWithType: "DedicatedGatewayRequestOptions"
summary: "Dedicated Gateway Request Options"
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **DedicatedGatewayRequestOptions**</br> implements <a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html\">Serializable</a>"
constructors:
- uid: "com.azure.cosmos.models.DedicatedGatewayRequestOptions.DedicatedGatewayRequestOptions()"
  fullName: "com.azure.cosmos.models.DedicatedGatewayRequestOptions.DedicatedGatewayRequestOptions()"
  name: "DedicatedGatewayRequestOptions()"
  nameWithType: "DedicatedGatewayRequestOptions.DedicatedGatewayRequestOptions()"
  summary: "Constructor"
  syntax: "public DedicatedGatewayRequestOptions()"
  desc: "Constructor"
methods:
- uid: "com.azure.cosmos.models.DedicatedGatewayRequestOptions.getMaxIntegratedCacheStaleness()"
  fullName: "com.azure.cosmos.models.DedicatedGatewayRequestOptions.getMaxIntegratedCacheStaleness()"
  name: "getMaxIntegratedCacheStaleness()"
  nameWithType: "DedicatedGatewayRequestOptions.getMaxIntegratedCacheStaleness()"
  summary: "Gets the staleness value associated with the request in the Azure CosmosDB service."
  syntax: "public Duration getMaxIntegratedCacheStaleness()"
  desc: "Gets the staleness value associated with the request in the Azure CosmosDB service. For requests where the <xref uid=\"com.azure.cosmos.ConsistencyLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.cosmos.ConsistencyLevel\"></xref> is <xref uid=\"com.azure.cosmos.ConsistencyLevel.EVENTUAL\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.cosmos.ConsistencyLevel#EVENTUAL\"></xref> or <xref uid=\"com.azure.cosmos.ConsistencyLevel.SESSION\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.cosmos.ConsistencyLevel#SESSION\"></xref>, responses from the integrated cache are guaranteed to be no staler than value indicated by this maxIntegratedCacheStaleness.\n\nDefault value is null\n\nCache Staleness is supported in milliseconds granularity. Anything smaller than milliseconds will be ignored."
  returns:
    description: "Duration of maxIntegratedCacheStaleness"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.cosmos.models.DedicatedGatewayRequestOptions.isIntegratedCacheBypassed()"
  fullName: "com.azure.cosmos.models.DedicatedGatewayRequestOptions.isIntegratedCacheBypassed()"
  name: "isIntegratedCacheBypassed()"
  nameWithType: "DedicatedGatewayRequestOptions.isIntegratedCacheBypassed()"
  summary: "Gets if the integrated cache is enabled or bypassed with the request in Azure CosmosDB service."
  syntax: "public boolean isIntegratedCacheBypassed()"
  desc: "Gets if the integrated cache is enabled or bypassed with the request in Azure CosmosDB service.\n\nDefault value is false"
  returns:
    description: "bypassIntegratedCache boolean value"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.DedicatedGatewayRequestOptions.setIntegratedCacheBypassed(boolean)"
  fullName: "com.azure.cosmos.models.DedicatedGatewayRequestOptions.setIntegratedCacheBypassed(boolean bypassIntegratedCache)"
  name: "setIntegratedCacheBypassed(boolean bypassIntegratedCache)"
  nameWithType: "DedicatedGatewayRequestOptions.setIntegratedCacheBypassed(boolean bypassIntegratedCache)"
  summary: "Sets if integrated cache should be enabled or bypassed for the request in Azure CosmosDB service."
  parameters:
  - description: "boolean value"
    name: "bypassIntegratedCache"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public DedicatedGatewayRequestOptions setIntegratedCacheBypassed(boolean bypassIntegratedCache)"
  desc: "Sets if integrated cache should be enabled or bypassed for the request in Azure CosmosDB service.\n\nDefault value is false"
  returns:
    description: "this DedicatedGatewayRequestOptions"
    type: "<xref href=\"com.azure.cosmos.models.DedicatedGatewayRequestOptions?alt=com.azure.cosmos.models.DedicatedGatewayRequestOptions&text=DedicatedGatewayRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.DedicatedGatewayRequestOptions.setMaxIntegratedCacheStaleness(java.time.Duration)"
  fullName: "com.azure.cosmos.models.DedicatedGatewayRequestOptions.setMaxIntegratedCacheStaleness(Duration maxIntegratedCacheStaleness)"
  name: "setMaxIntegratedCacheStaleness(Duration maxIntegratedCacheStaleness)"
  nameWithType: "DedicatedGatewayRequestOptions.setMaxIntegratedCacheStaleness(Duration maxIntegratedCacheStaleness)"
  summary: "Sets the staleness value associated with the request in the Azure CosmosDB service."
  parameters:
  - description: "Max Integrated Cache Staleness duration"
    name: "maxIntegratedCacheStaleness"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
  syntax: "public DedicatedGatewayRequestOptions setMaxIntegratedCacheStaleness(Duration maxIntegratedCacheStaleness)"
  desc: "Sets the staleness value associated with the request in the Azure CosmosDB service. For requests where the <xref uid=\"com.azure.cosmos.ConsistencyLevel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.cosmos.ConsistencyLevel\"></xref> is <xref uid=\"com.azure.cosmos.ConsistencyLevel.EVENTUAL\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.cosmos.ConsistencyLevel#EVENTUAL\"></xref> or <xref uid=\"com.azure.cosmos.ConsistencyLevel.SESSION\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.cosmos.ConsistencyLevel#SESSION\"></xref>, responses from the integrated cache are guaranteed to be no staler than value indicated by this maxIntegratedCacheStaleness.\n\nDefault value is null\n\nCache Staleness is supported in milliseconds granularity. Anything smaller than milliseconds will be ignored."
  returns:
    description: "this DedicatedGatewayRequestOptions"
    type: "<xref href=\"com.azure.cosmos.models.DedicatedGatewayRequestOptions?alt=com.azure.cosmos.models.DedicatedGatewayRequestOptions&text=DedicatedGatewayRequestOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Dedicated Gateway Request Options"
implements:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html\">Serializable</a>"
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.62.0