103 строки
6.3 KiB
YAML
103 строки
6.3 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.spring.data.cosmos.CosmosFactory"
|
|
fullName: "com.azure.spring.data.cosmos.CosmosFactory"
|
|
name: "CosmosFactory"
|
|
nameWithType: "CosmosFactory"
|
|
summary: "Factory class for Cosmos<wbr>Db to create client"
|
|
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 **CosmosFactory**"
|
|
constructors:
|
|
- uid: "com.azure.spring.data.cosmos.CosmosFactory.CosmosFactory(com.azure.cosmos.CosmosAsyncClient,java.lang.String)"
|
|
fullName: "com.azure.spring.data.cosmos.CosmosFactory.CosmosFactory(CosmosAsyncClient cosmosAsyncClient, String databaseName)"
|
|
name: "CosmosFactory(CosmosAsyncClient cosmosAsyncClient, String databaseName)"
|
|
nameWithType: "CosmosFactory.CosmosFactory(CosmosAsyncClient cosmosAsyncClient, String databaseName)"
|
|
summary: "Validate config and initialization"
|
|
parameters:
|
|
- description: "cosmosAsyncClient"
|
|
name: "cosmosAsyncClient"
|
|
type: "<xref href=\"com.azure.cosmos.CosmosAsyncClient?alt=com.azure.cosmos.CosmosAsyncClient&text=CosmosAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "databaseName"
|
|
name: "databaseName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CosmosFactory(CosmosAsyncClient cosmosAsyncClient, String databaseName)"
|
|
desc: "Validate config and initialization"
|
|
fields:
|
|
- uid: "com.azure.spring.data.cosmos.CosmosFactory.databaseName"
|
|
fullName: "com.azure.spring.data.cosmos.CosmosFactory.databaseName"
|
|
name: "databaseName"
|
|
nameWithType: "CosmosFactory.databaseName"
|
|
summary: "Database Name to be used for operations."
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "protected String databaseName"
|
|
desc: "Database Name to be used for operations. This is not practically tied to CosmosFactory instance. This can be updated even for same cosmosAsyncClient."
|
|
methods:
|
|
- uid: "com.azure.spring.data.cosmos.CosmosFactory.createCosmosAsyncClient(com.azure.cosmos.CosmosClientBuilder)"
|
|
fullName: "com.azure.spring.data.cosmos.CosmosFactory.createCosmosAsyncClient(CosmosClientBuilder cosmosClientBuilder)"
|
|
name: "createCosmosAsyncClient(CosmosClientBuilder cosmosClientBuilder)"
|
|
nameWithType: "CosmosFactory.createCosmosAsyncClient(CosmosClientBuilder cosmosClientBuilder)"
|
|
summary: "Create Cosmos Async Client"
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "CosmosClientBuilder"
|
|
name: "cosmosClientBuilder"
|
|
type: "<xref href=\"com.azure.cosmos.CosmosClientBuilder?alt=com.azure.cosmos.CosmosClientBuilder&text=CosmosClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static CosmosAsyncClient createCosmosAsyncClient(CosmosClientBuilder cosmosClientBuilder)"
|
|
desc: "Create Cosmos Async Client"
|
|
returns:
|
|
description: "CosmosAsyncClient"
|
|
type: "<xref href=\"com.azure.cosmos.CosmosAsyncClient?alt=com.azure.cosmos.CosmosAsyncClient&text=CosmosAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.spring.data.cosmos.CosmosFactory.getCosmosAsyncClient()"
|
|
fullName: "com.azure.spring.data.cosmos.CosmosFactory.getCosmosAsyncClient()"
|
|
name: "getCosmosAsyncClient()"
|
|
nameWithType: "CosmosFactory.getCosmosAsyncClient()"
|
|
summary: "To create a Cosmos<wbr>Async<wbr>Client"
|
|
syntax: "public CosmosAsyncClient getCosmosAsyncClient()"
|
|
desc: "To create a CosmosAsyncClient"
|
|
returns:
|
|
description: "CosmosAsyncClient"
|
|
type: "<xref href=\"com.azure.cosmos.CosmosAsyncClient?alt=com.azure.cosmos.CosmosAsyncClient&text=CosmosAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.spring.data.cosmos.CosmosFactory.getDatabaseName()"
|
|
fullName: "com.azure.spring.data.cosmos.CosmosFactory.getDatabaseName()"
|
|
name: "getDatabaseName()"
|
|
nameWithType: "CosmosFactory.getDatabaseName()"
|
|
summary: "Get Cosmos Database Name"
|
|
syntax: "public String getDatabaseName()"
|
|
desc: "Get Cosmos Database Name"
|
|
returns:
|
|
description: "Cosmos Database Name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.spring.data.cosmos.CosmosFactory.overrideContainerName()"
|
|
fullName: "com.azure.spring.data.cosmos.CosmosFactory.overrideContainerName()"
|
|
name: "overrideContainerName()"
|
|
nameWithType: "CosmosFactory.overrideContainerName()"
|
|
summary: "This returns container name for each operation."
|
|
syntax: "public String overrideContainerName()"
|
|
desc: "This returns container name for each operation. By default, container name will be derived from entity definition. NOTE: Using this API will override container name defined on entity definition."
|
|
returns:
|
|
description: "container name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
type: "class"
|
|
desc: "Factory class for CosmosDb to create client"
|
|
metadata: {}
|
|
package: "com.azure.spring.data.cosmos"
|
|
artifact: com.azure:azure-spring-data-cosmos:5.18.0
|