azure-docs-sdk-java/docs-ref-autogen/com.azure.spring.data.cosmo...

144 строки
9.9 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.spring.data.cosmos.config.CosmosConfig"
fullName: "com.azure.spring.data.cosmos.config.CosmosConfig"
name: "CosmosConfig"
nameWithType: "CosmosConfig"
summary: "Config properties of CosmosDB"
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 class **CosmosConfig**"
constructors:
- uid: "com.azure.spring.data.cosmos.config.CosmosConfig.CosmosConfig(com.azure.spring.data.cosmos.core.ResponseDiagnosticsProcessor,boolean)"
fullName: "com.azure.spring.data.cosmos.config.CosmosConfig.CosmosConfig(ResponseDiagnosticsProcessor responseDiagnosticsProcessor, boolean queryMetricsEnabled)"
name: "CosmosConfig(ResponseDiagnosticsProcessor responseDiagnosticsProcessor, boolean queryMetricsEnabled)"
nameWithType: "CosmosConfig.CosmosConfig(ResponseDiagnosticsProcessor responseDiagnosticsProcessor, boolean queryMetricsEnabled)"
summary: "Initialization"
parameters:
- description: "must not be null"
name: "responseDiagnosticsProcessor"
type: "<xref href=\"com.azure.spring.data.cosmos.core.ResponseDiagnosticsProcessor?alt=com.azure.spring.data.cosmos.core.ResponseDiagnosticsProcessor&text=ResponseDiagnosticsProcessor\" data-throw-if-not-resolved=\"False\" />"
- description: "must not be null"
name: "queryMetricsEnabled"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosConfig(ResponseDiagnosticsProcessor responseDiagnosticsProcessor, boolean queryMetricsEnabled)"
desc: "Initialization"
- uid: "com.azure.spring.data.cosmos.config.CosmosConfig.CosmosConfig(com.azure.spring.data.cosmos.core.ResponseDiagnosticsProcessor,com.azure.spring.data.cosmos.config.DatabaseThroughputConfig,boolean)"
fullName: "com.azure.spring.data.cosmos.config.CosmosConfig.CosmosConfig(ResponseDiagnosticsProcessor responseDiagnosticsProcessor, DatabaseThroughputConfig databaseThroughputConfig, boolean queryMetricsEnabled)"
name: "CosmosConfig(ResponseDiagnosticsProcessor responseDiagnosticsProcessor, DatabaseThroughputConfig databaseThroughputConfig, boolean queryMetricsEnabled)"
nameWithType: "CosmosConfig.CosmosConfig(ResponseDiagnosticsProcessor responseDiagnosticsProcessor, DatabaseThroughputConfig databaseThroughputConfig, boolean queryMetricsEnabled)"
summary: "Initialization"
parameters:
- description: "must not be null"
name: "responseDiagnosticsProcessor"
type: "<xref href=\"com.azure.spring.data.cosmos.core.ResponseDiagnosticsProcessor?alt=com.azure.spring.data.cosmos.core.ResponseDiagnosticsProcessor&text=ResponseDiagnosticsProcessor\" data-throw-if-not-resolved=\"False\" />"
- description: "may be null"
name: "databaseThroughputConfig"
type: "<xref href=\"com.azure.spring.data.cosmos.config.DatabaseThroughputConfig?alt=com.azure.spring.data.cosmos.config.DatabaseThroughputConfig&text=DatabaseThroughputConfig\" data-throw-if-not-resolved=\"False\" />"
- description: "must not be null"
name: "queryMetricsEnabled"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CosmosConfig(ResponseDiagnosticsProcessor responseDiagnosticsProcessor, DatabaseThroughputConfig databaseThroughputConfig, boolean queryMetricsEnabled)"
desc: "Initialization"
methods:
- uid: "com.azure.spring.data.cosmos.config.CosmosConfig.builder()"
fullName: "com.azure.spring.data.cosmos.config.CosmosConfig.builder()"
name: "builder()"
nameWithType: "CosmosConfig.builder()"
summary: "Create a Cosmos<wbr>Config<wbr>Builder instance"
modifiers:
- "static"
syntax: "public static CosmosConfig.CosmosConfigBuilder builder()"
desc: "Create a CosmosConfigBuilder instance"
returns:
description: "CosmosConfigBuilder"
type: "<xref href=\"com.azure.spring.data.cosmos.config.CosmosConfig.CosmosConfigBuilder?alt=com.azure.spring.data.cosmos.config.CosmosConfig.CosmosConfigBuilder&text=CosmosConfigBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.spring.data.cosmos.config.CosmosConfig.getDatabaseThroughputConfig()"
fullName: "com.azure.spring.data.cosmos.config.CosmosConfig.getDatabaseThroughputConfig()"
name: "getDatabaseThroughputConfig()"
nameWithType: "CosmosConfig.getDatabaseThroughputConfig()"
summary: "Gets the database throughput configuration."
syntax: "public DatabaseThroughputConfig getDatabaseThroughputConfig()"
desc: "Gets the database throughput configuration."
returns:
description: "DatabaseThroughputConfig, or null if no database throughput is configured"
type: "<xref href=\"com.azure.spring.data.cosmos.config.DatabaseThroughputConfig?alt=com.azure.spring.data.cosmos.config.DatabaseThroughputConfig&text=DatabaseThroughputConfig\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.spring.data.cosmos.config.CosmosConfig.getMaxBufferedItemCount()"
fullName: "com.azure.spring.data.cosmos.config.CosmosConfig.getMaxBufferedItemCount()"
name: "getMaxBufferedItemCount()"
nameWithType: "CosmosConfig.getMaxBufferedItemCount()"
summary: "Gets the value of max<wbr>Buffered<wbr>Item<wbr>Count"
syntax: "public int getMaxBufferedItemCount()"
desc: "Gets the value of maxBufferedItemCount"
returns:
description: "int, value of maxBufferedItemCount"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.spring.data.cosmos.config.CosmosConfig.getMaxDegreeOfParallelism()"
fullName: "com.azure.spring.data.cosmos.config.CosmosConfig.getMaxDegreeOfParallelism()"
name: "getMaxDegreeOfParallelism()"
nameWithType: "CosmosConfig.getMaxDegreeOfParallelism()"
summary: "Gets the value of max<wbr>Degree<wbr>OfParallelism"
syntax: "public int getMaxDegreeOfParallelism()"
desc: "Gets the value of maxDegreeOfParallelism"
returns:
description: "int, value of maxDegreeOfParallelism"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.spring.data.cosmos.config.CosmosConfig.getResponseContinuationTokenLimitInKb()"
fullName: "com.azure.spring.data.cosmos.config.CosmosConfig.getResponseContinuationTokenLimitInKb()"
name: "getResponseContinuationTokenLimitInKb()"
nameWithType: "CosmosConfig.getResponseContinuationTokenLimitInKb()"
summary: "Gets the value of response<wbr>Continuation<wbr>Token<wbr>Limit<wbr>InKb"
syntax: "public int getResponseContinuationTokenLimitInKb()"
desc: "Gets the value of responseContinuationTokenLimitInKb"
returns:
description: "int, value of responseContinuationTokenLimitInKb"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.spring.data.cosmos.config.CosmosConfig.getResponseDiagnosticsProcessor()"
fullName: "com.azure.spring.data.cosmos.config.CosmosConfig.getResponseDiagnosticsProcessor()"
name: "getResponseDiagnosticsProcessor()"
nameWithType: "CosmosConfig.getResponseDiagnosticsProcessor()"
summary: "Gets response diagnostics processor"
syntax: "public ResponseDiagnosticsProcessor getResponseDiagnosticsProcessor()"
desc: "Gets response diagnostics processor"
returns:
description: "ResponseDiagnosticsProcessor"
type: "<xref href=\"com.azure.spring.data.cosmos.core.ResponseDiagnosticsProcessor?alt=com.azure.spring.data.cosmos.core.ResponseDiagnosticsProcessor&text=ResponseDiagnosticsProcessor\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.spring.data.cosmos.config.CosmosConfig.isIndexMetricsEnabled()"
fullName: "com.azure.spring.data.cosmos.config.CosmosConfig.isIndexMetricsEnabled()"
name: "isIndexMetricsEnabled()"
nameWithType: "CosmosConfig.isIndexMetricsEnabled()"
summary: "Gets the option to enable query metrics"
syntax: "public boolean isIndexMetricsEnabled()"
desc: "Gets the option to enable query metrics"
returns:
description: "boolean, whether to enable query metrics"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.spring.data.cosmos.config.CosmosConfig.isQueryMetricsEnabled()"
fullName: "com.azure.spring.data.cosmos.config.CosmosConfig.isQueryMetricsEnabled()"
name: "isQueryMetricsEnabled()"
nameWithType: "CosmosConfig.isQueryMetricsEnabled()"
summary: "Gets the option to enable query metrics"
syntax: "public boolean isQueryMetricsEnabled()"
desc: "Gets the option to enable query metrics"
returns:
description: "boolean, whether to enable query metrics"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Config properties of CosmosDB"
metadata: {}
package: "com.azure.spring.data.cosmos.config"
artifact: com.azure:azure-spring-data-cosmos:5.16.0